Merge pull request #608 from ProgressPlanner/convert-meta/prpl_task_id

WIP: Migrate the `prpl_task_id` post-meta to the post's slug

Author: aristath

classes/class-suggested-tasks-db.php

@@ -52,20 +52,25 @@ public function add( $data ) {
 		}
 
 		// Check if we have an existing task with the same title.
-		$posts = $this->get_tasks_by(
+		$posts         = $this->get_tasks_by(
 			[
 				'post_status' => [ 'publish', 'trash', 'draft', 'future', 'pending' ], // 'any' doesn't include statuses which have 'exclude_from_search' set to true (trash and pending).
 				'numberposts' => 1,
-				'meta_query'  => [ // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_query
-					[
-						'key'     => 'prpl_task_id',
-						'value'   => $data['task_id'],
-						'compare' => '=',
-					],
-				],
+				'name'        => \progress_planner()->get_suggested_tasks()->get_task_id_from_slug( $data['task_id'] ),
+			]
+		);
+		$posts_trashed = $this->get_tasks_by(
+			[
+				'post_status' => [ 'trash' ],
+				'numberposts' => 1,
+				'name'        => \progress_planner()->get_suggested_tasks()->get_task_id_from_slug( $data['task_id'] ) . '__trashed',
 			]
 		);
 
+		if ( empty( $posts ) && ! empty( $posts_trashed ) ) {
+			$posts = $posts_trashed;
+		}
+
 		// If we have an existing task, skip.
 		if ( ! empty( $posts ) ) {
 			\delete_option( $lock_key );
@@ -83,6 +88,7 @@ public function add( $data ) {
 			'post_title'   => $data['post_title'],
 			'post_content' => $data['description'] ?? '',
 			'menu_order'   => $data['order'] ?? 0,
+			'post_name'    => \progress_planner()->get_suggested_tasks()->get_task_id_from_slug( $data['task_id'] ),
 		];
 		switch ( $data['post_status'] ) {
 			case 'pending':
@@ -313,12 +319,7 @@ public function get_tasks_by( $params ) {
 					break;
 
 				case 'task_id':
-					$args['meta_query']   = isset( $args['meta_query'] ) ? $args['meta_query'] : []; // phpcs:ignore WordPress.DB.SlowDBQuery
-					$args['meta_query'][] = [
-						'key'   => 'prpl_task_id',
-						'value' => $value,
-					];
-
+					$args['name'] = \progress_planner()->get_suggested_tasks()->get_task_id_from_slug( $value );
 					unset( $params[ $param ] );
 					break;
 
@@ -359,6 +360,23 @@ public function get( $args = [] ) {
 		$results = $this->format_recommendations(
 			\get_posts( $args )
 		);
+		if ( ! empty( $args['post_status'] )
+			&& \in_array( 'trash', (array) $args['post_status'], true )
+			&& isset( $args['name'] )
+		) {
+			$results_trashed = $this->format_recommendations(
+				\get_posts(
+					\wp_parse_args(
+						$args,
+						[
+							'post_status' => [ 'trash' ],
+							'name'        => \progress_planner()->get_suggested_tasks()->get_task_id_from_slug( $args['name'] ) . '__trashed',
+						]
+					)
+				)
+			);
+			$results         = array_merge( $results, $results_trashed );
+		}
 
 		\wp_cache_set( $cache_key, $results, static::GET_TASKS_CACHE_GROUP );
 

classes/class-suggested-tasks.php

@@ -80,15 +80,15 @@ public function init(): void {
 		$completed_tasks = $this->tasks_manager->evaluate_tasks();
 
 		foreach ( $completed_tasks as $task ) {
-			if ( ! $task->task_id && $task->ID ) {
+			if ( ! $task->post_name && $task->ID ) {
 				continue;
 			}
 
 			// Change the task status to pending.
 			$task->celebrate();
 
 			// Insert an activity.
-			$this->insert_activity( $task->task_id );
+			$this->insert_activity( \progress_planner()->get_suggested_tasks()->get_task_id_from_slug( $task->post_name ) );
 		}
 	}
 
@@ -156,7 +156,7 @@ public function on_automatic_updates_complete(): void {
 		\progress_planner()->get_suggested_tasks_db()->update_recommendation( $pending_tasks[0]->ID, [ 'post_status' => 'trash' ] );
 
 		// Insert an activity.
-		$this->insert_activity( $pending_tasks[0]->task_id );
+		$this->insert_activity( \progress_planner()->get_suggested_tasks()->get_task_id_from_slug( $pending_tasks[0]->post_name ) );
 	}
 
 	/**
@@ -247,13 +247,13 @@ public function suggested_task_action() {
 		switch ( $action ) {
 			case 'complete':
 				// Insert an activity.
-				$this->insert_activity( $task->task_id );
+				$this->insert_activity( \progress_planner()->get_suggested_tasks()->get_task_id_from_slug( $task->post_name ) );
 				$updated = true;
 				break;
 
 			case 'pending': // User task was marked as pending.
 			case 'delete':
-				$this->delete_activity( $task->task_id );
+				$this->delete_activity( \progress_planner()->get_suggested_tasks()->get_task_id_from_slug( $task->post_name ) );
 				$updated = true;
 				break;
 		}
@@ -298,17 +298,12 @@ public function register_post_type() {
 		);
 
 		$rest_meta_fields = [
-			'prpl_task_id' => [
+			'prpl_url'   => [
 				'type'         => 'string',
 				'single'       => true,
 				'show_in_rest' => true,
 			],
-			'prpl_url'     => [
-				'type'         => 'string',
-				'single'       => true,
-				'show_in_rest' => true,
-			],
-			'menu_order'   => [
+			'menu_order' => [
 				'type'         => 'number',
 				'single'       => true,
 				'show_in_rest' => true,
@@ -429,6 +424,8 @@ public function rest_prepare_recommendation( $response, $post ) {
 			$provider = \progress_planner()->get_suggested_tasks()->get_tasks_manager()->get_task_provider( $provider_term[0]->slug );
 		}
 
+		$response->data['slug'] = \progress_planner()->get_suggested_tasks()->get_task_id_from_slug( $response->data['slug'] );
+
 		if ( $provider ) {
 			$response->data['prpl_provider'] = $provider_term[0];
 			// Link should be added during run time, since it is not added for users without required capability.
@@ -437,18 +434,18 @@ public function rest_prepare_recommendation( $response, $post ) {
 				: '';
 
 			$response->data['prpl_popover_id'] = $provider->get_popover_id();
-
-			// This has to be the last item to be added because actions use data from previous items.
-			$response->data['prpl_task_actions'] = $provider->get_task_actions( $response->data );
-			$response->data['prpl_points']       = $provider->get_points();
+			$response->data['prpl_points']     = $provider->get_points();
 
 			/*
 			 * Check if task was completed before - for example, comments were disabled and then re-enabled, and remove points if so.
 			 * Those are tasks which are completed by toggling an option, so non repetitive & not user tasks.
 			 */
-			if ( ! \has_term( 'user', 'prpl_recommendations_provider', $post->ID ) && ! $provider->is_repetitive() && $provider->task_has_activity( $response->data['meta']['prpl_task_id'] ) ) {
+			if ( ! \has_term( 'user', 'prpl_recommendations_provider', $post->ID ) && ! $provider->is_repetitive() && $provider->task_has_activity( $response->data['slug'] ) ) {
 				$response->data['prpl_points'] = 0;
 			}
+
+			// This has to be the last item to be added because actions use data from previous items.
+			$response->data['prpl_task_actions'] = $provider->get_task_actions( $response->data );
 		}
 
 		// Category taxonomy removed - no longer adding prpl_category to response.
@@ -520,4 +517,14 @@ function ( $task ) use ( $args ) {
 		 */
 		return \apply_filters( 'progress_planner_suggested_tasks_in_rest_format', $tasks, $args );
 	}
+
+	/**
+	 * Get the task ID from a slug.
+	 *
+	 * @param string $slug The slug.
+	 * @return string
+	 */
+	public function get_task_id_from_slug( $slug ) {
+		return explode( '__trashed', $slug )[0];
+	}
 }

classes/class-todo.php

@@ -81,7 +81,12 @@ public function handle_creating_user_task( $post, $request, $creating ) {
 		}
 
 		// Add task_id to the post.
-		\update_post_meta( $post->ID, 'prpl_task_id', 'user-' . $post->ID );
+		\wp_update_post(
+			[
+				'ID'        => $post->ID,
+				'post_name' => 'user-' . $post->ID,
+			]
+		);
 
 		// If it is first task ever created, it should be golden.
 		$pending_items = \progress_planner()->get_suggested_tasks_db()->get_tasks_by(

classes/suggested-tasks/class-task.php

@@ -13,10 +13,10 @@
  * @property int $ID The task ID
  * @property string $post_status The task status
  * @property string $post_title The task title
+ * @property string $post_name The task name
  * @property string $post_date The task date
  * @property int $menu_order The task menu order (priority)
  * @property \stdClass|null $provider The task provider object with slug property
- * @property string $task_id The task identifier
  * @property string $provider_id The provider identifier
  * @property int $priority The task priority (0-100, 0 being highest and 100 being lowest).
  * @property int $points The task points

classes/suggested-tasks/class-tasks-manager.php

@@ -268,7 +268,7 @@ public function evaluate_task( Task $task ) {
 			return false;
 		}
 
-		return $task_provider->evaluate_task( $task->task_id );
+		return $task_provider->evaluate_task( \progress_planner()->get_suggested_tasks()->get_task_id_from_slug( $task->post_name ) );
 	}
 
 	/**

classes/suggested-tasks/providers/class-core-update.php

@@ -87,7 +87,7 @@ public function add_core_update_link( $update_actions ) {
 		// All updates are completed and there is a 'update-core' task in the published tasks.
 		if ( $this->is_task_completed() ) {
 			foreach ( \progress_planner()->get_suggested_tasks_db()->get_tasks_by( [ 'post_status' => 'publish' ] ) as $task ) {
-				if ( $this->get_task_id() === $task->task_id ) {
+				if ( $this->get_task_id() === \progress_planner()->get_suggested_tasks()->get_task_id_from_slug( $task->post_name ) ) {
 					$update_actions['prpl_core_update'] =
 						'<img src="' . \esc_attr( \constant( 'PROGRESS_PLANNER_URL' ) . '/assets/images/icon_progress_planner.svg' ) . '" style="width:1rem;padding-left:0.25rem;padding-right:0.25rem;vertical-align:middle;" alt="Progress Planner" />' .
 						'<a href="' . \esc_url( \admin_url( 'admin.php?page=progress-planner' ) ) . '" target="_parent">' . \esc_html__( 'Click here to celebrate your completed task!', 'progress-planner' ) . '</a>';

classes/suggested-tasks/providers/class-tasks.php

@@ -396,7 +396,7 @@ public function is_onboarding_task() {
 	 */
 	public function is_task_snoozed() {
 		foreach ( \progress_planner()->get_suggested_tasks_db()->get_tasks_by( [ 'post_status' => 'future' ] ) as $task ) {
-			$task        = \progress_planner()->get_suggested_tasks_db()->get_post( $task->task_id );
+			$task        = \progress_planner()->get_suggested_tasks_db()->get_post( \progress_planner()->get_suggested_tasks()->get_task_id_from_slug( $task->post_name ) );
 			$provider_id = $task ? $task->get_provider_id() : '';
 
 			if ( $provider_id === $this->get_provider_id() ) {
@@ -439,18 +439,18 @@ public function evaluate_task( $task_id ) {
 
 		if ( ! $this->is_repetitive() ) {
 			// Collaborator tasks have custom task_ids, so strpos check does not work for them.
-			if ( ! $task->task_id || ( 0 !== \strpos( $task->task_id, $this->get_task_id() ) && 'collaborator' !== $this->get_provider_id() ) ) {
+			if ( ! $task->post_name || ( 0 !== \strpos( $task->post_name, $this->get_task_id() ) && 'collaborator' !== $this->get_provider_id() ) ) {
 				return false;
 			}
-			return $this->is_task_completed( $task->task_id ) ? $task : false;
+			return $this->is_task_completed( \progress_planner()->get_suggested_tasks()->get_task_id_from_slug( $task->post_name ) ) ? $task : false;
 		}
 
 		if (
 			$task->provider &&
 			$task->provider->slug === $this->get_provider_id() &&
 			\DateTime::createFromFormat( 'Y-m-d H:i:s', $task->post_date ) &&
 			\gmdate( 'YW' ) === \gmdate( 'YW', \DateTime::createFromFormat( 'Y-m-d H:i:s', $task->post_date )->getTimestamp() ) && // @phpstan-ignore-line
-			$this->is_task_completed( $task->task_id )
+			$this->is_task_completed( \progress_planner()->get_suggested_tasks()->get_task_id_from_slug( $task->post_name ) )
 		) {
 			// Allow adding more data, for example in case of 'create-post' tasks we are adding the post_id.
 			$task_data = $this->modify_evaluated_task_data( $task->get_data() );
@@ -635,12 +635,12 @@ public function get_task_actions( $data = [] ) {
 		if ( $this->capability_required() && $this->is_dismissable() && 'user' !== static::PROVIDER_ID ) {
 			$actions[] = [
 				'priority' => 20,
-				'html'     => '<button type="button" class="prpl-suggested-task-button" data-task-id="' . \esc_attr( $data['meta']['prpl_task_id'] ) . '" data-task-title="' . \esc_attr( $data['title']['rendered'] ) . '" data-action="complete" data-target="complete" title="' . \esc_html__( 'Mark as complete', 'progress-planner' ) . '" onclick="prplSuggestedTask.maybeComplete(' . (int) $data['id'] . ');"><span class="prpl-tooltip-action-text">' . \esc_html__( 'Mark as complete', 'progress-planner' ) . '</span><span class="screen-reader-text">' . \esc_html__( 'Mark as complete', 'progress-planner' ) . '</span></button>',
+				'html'     => '<button type="button" class="prpl-suggested-task-button" data-task-id="' . \esc_attr( \progress_planner()->get_suggested_tasks()->get_task_id_from_slug( $data['slug'] ) ) . '" data-task-title="' . \esc_attr( $data['title']['rendered'] ) . '" data-action="complete" data-target="complete" title="' . \esc_html__( 'Mark as complete', 'progress-planner' ) . '" onclick="prplSuggestedTask.maybeComplete(' . (int) $data['id'] . ');"><span class="prpl-tooltip-action-text">' . \esc_html__( 'Mark as complete', 'progress-planner' ) . '</span><span class="screen-reader-text">' . \esc_html__( 'Mark as complete', 'progress-planner' ) . '</span></button>',
 			];
 		}
 
 		if ( $this->capability_required() && $this->is_snoozable() ) {
-			$snooze_html  = '<prpl-tooltip class="prpl-suggested-task-snooze"><slot name="open"><button type="button" class="prpl-suggested-task-button" data-task-id="' . \esc_attr( $data['meta']['prpl_task_id'] ) . '" data-task-title="' . \esc_attr( $data['title']['rendered'] ) . '" data-action="snooze" data-target="snooze" title="' . \esc_attr__( 'Snooze', 'progress-planner' ) . '"><span class="prpl-tooltip-action-text">' . \esc_html__( 'Snooze', 'progress-planner' ) . '</span><span class="screen-reader-text">' . \esc_html__( 'Snooze', 'progress-planner' ) . '</span></button></slot><slot name="content">';
+			$snooze_html  = '<prpl-tooltip class="prpl-suggested-task-snooze"><slot name="open"><button type="button" class="prpl-suggested-task-button" data-task-id="' . \esc_attr( \progress_planner()->get_suggested_tasks()->get_task_id_from_slug( $data['slug'] ) ) . '" data-task-title="' . \esc_attr( $data['title']['rendered'] ) . '" data-action="snooze" data-target="snooze" title="' . \esc_attr__( 'Snooze', 'progress-planner' ) . '"><span class="prpl-tooltip-action-text">' . \esc_html__( 'Snooze', 'progress-planner' ) . '</span><span class="screen-reader-text">' . \esc_html__( 'Snooze', 'progress-planner' ) . '</span></button></slot><slot name="content">';
 			$snooze_html .= '<fieldset><legend><span>' . \esc_html__( 'Snooze this task?', 'progress-planner' ) . '</span><button type="button" class="prpl-toggle-radio-group" onclick="this.closest(\'.prpl-suggested-task-snooze\').classList.toggle(\'prpl-toggle-radio-group-open\');"><span class="prpl-toggle-radio-group-text">' . \esc_html__( 'How long?', 'progress-planner' ) . '</span><span class="prpl-toggle-radio-group-arrow">&rsaquo;</span></button></legend><div class="prpl-snooze-duration-radio-group">';
 			foreach (
 				[
@@ -651,7 +651,7 @@ public function get_task_actions( $data = [] ) {
 					'1-year'   => \esc_html__( '1 year', 'progress-planner' ),
 					'forever'  => \esc_html__( 'forever', 'progress-planner' ),
 				] as $snooze_key => $snooze_value ) {
-					$snooze_html .= '<label><input type="radio" name="snooze-duration-' . \esc_attr( $data['meta']['prpl_task_id'] ) . '" value="' . \esc_attr( $snooze_key ) . '" onchange="prplSuggestedTask.snooze(' . (int) $data['id'] . ', \'' . \esc_attr( $snooze_key ) . '\');">' . \esc_html( $snooze_value ) . '</label>';
+					$snooze_html .= '<label><input type="radio" name="snooze-duration-' . \esc_attr( \progress_planner()->get_suggested_tasks()->get_task_id_from_slug( $data['slug'] ) ) . '" value="' . \esc_attr( $snooze_key ) . '" onchange="prplSuggestedTask.snooze(' . (int) $data['id'] . ', \'' . \esc_attr( $snooze_key ) . '\');">' . \esc_html( $snooze_value ) . '</label>';
 			}
 			$snooze_html .= '</div></fieldset></slot></prpl-tooltip>';
 			$actions[]    = [
@@ -668,7 +668,7 @@ public function get_task_actions( $data = [] ) {
 		} elseif ( isset( $data['content']['rendered'] ) && $data['content']['rendered'] !== '' && ! $this instanceof Tasks_Interactive ) {
 			$actions[] = [
 				'priority' => 40,
-				'html'     => '<prpl-tooltip><slot name="open"><button type="button" class="prpl-suggested-task-button" data-task-id="' . \esc_attr( $data['meta']['prpl_task_id'] ) . '" data-task-title="' . \esc_attr( $data['title']['rendered'] ) . '" data-action="info" data-target="info" title="' . \esc_html__( 'Info', 'progress-planner' ) . '"><span class="prpl-tooltip-action-text">' . \esc_html__( 'Info', 'progress-planner' ) . '</span><span class="screen-reader-text">' . \esc_html__( 'Info', 'progress-planner' ) . '</span></button></slot><slot name="content">' . \wp_kses_post( $data['content']['rendered'] ) . '</slot></prpl-tooltip>',
+				'html'     => '<prpl-tooltip><slot name="open"><button type="button" class="prpl-suggested-task-button" data-task-id="' . \esc_attr( \progress_planner()->get_suggested_tasks()->get_task_id_from_slug( $data['slug'] ) ) . '" data-task-title="' . \esc_attr( $data['title']['rendered'] ) . '" data-action="info" data-target="info" title="' . \esc_html__( 'Info', 'progress-planner' ) . '"><span class="prpl-tooltip-action-text">' . \esc_html__( 'Info', 'progress-planner' ) . '</span><span class="screen-reader-text">' . \esc_html__( 'Info', 'progress-planner' ) . '</span></button></slot><slot name="content">' . \wp_kses_post( $data['content']['rendered'] ) . '</slot></prpl-tooltip>',
 			];
 		}
 

classes/suggested-tasks/providers/class-update-term-description.php

@@ -290,11 +290,11 @@ public function exclude_completed_terms( $exclude_term_ids ) {
 	 * @return array
 	 */
 	public function add_task_actions( $data = [], $actions = [] ) {
-		if ( ! isset( $data['meta']['prpl_task_id'] ) ) {
+		if ( ! isset( $data['slug'] ) ) {
 			return $actions;
 		}
 
-		$term = $this->get_term_from_task_id( $data['meta']['prpl_task_id'] );
+		$term = $this->get_term_from_task_id( \progress_planner()->get_suggested_tasks()->get_task_id_from_slug( $data['slug'] ) );
 		if ( ! $term ) {
 			return $actions;
 		}