Merge pull request #54 from Automattic/28/cli-improvements

Introduce command to delete events by ID or action

includes/wp-cli/class-events.php

@@ -12,6 +12,7 @@ class Events extends \WP_CLI_Command {
 	 * Intentionally bypasses caching to ensure latest data is shown
 	 *
 	 * @subcommand list
+	 * @synopsis [--status=<pending|completed>] [--page=<page>] [--limit=<limit>] [--format=<format>]
 	 */
 	public function list_events( $args, $assoc_args ) {
 		$events = $this->get_events( $args, $assoc_args );
@@ -63,6 +64,28 @@ class Events extends \WP_CLI_Command {
 		}
 	}
 
+	/**
+	 * Remove events by ID or action
+	 *
+	 * @subcommand delete
+	 * @synopsis [--event_id=<event_id>] [--action=<action>]
+	 */
+	public function delete_events( $args, $assoc_args ) {
+		// Remove a specific event
+		if ( isset( $assoc_args['event_id'] ) ) {
+			$this->delete_event_by_id( $args, $assoc_args );
+			return;
+		}
+
+		// Remove all events with a given action
+		if ( isset( $assoc_args['action'] ) ) {
+			$this->delete_event_by_action( $args, $assoc_args );
+			return;
+		}
+
+		\WP_CLI::error( __( 'Specify something to delete, or see the `cron-control-fixers` command to remove all data.', 'automattic-cron-control' ) );
+	}
+
 	/**
 	 * Retrieve list of events, and related data, for a given request
 	 */
@@ -106,7 +129,7 @@ class Events extends \WP_CLI_Command {
 		$offset = absint( ( $page - 1 ) * $limit );
 
 		// Query
-		$items = $wpdb->get_results( $wpdb->prepare( "SELECT SQL_CALC_FOUND_ROWS ID, post_content_filtered, post_date_gmt, post_modified_gmt FROM {$wpdb->posts} WHERE post_type = %s AND post_status = %s ORDER BY post_date ASC LIMIT %d,%d", \Automattic\WP\Cron_Control\Cron_Options_CPT::POST_TYPE, $post_status, $offset, $limit ) );
+		$items = $wpdb->get_results( $wpdb->prepare( "SELECT SQL_CALC_FOUND_ROWS ID, post_title, post_content_filtered, post_date_gmt, post_modified_gmt FROM {$wpdb->posts} WHERE post_type = %s AND post_status = %s ORDER BY post_date ASC LIMIT %d,%d", \Automattic\WP\Cron_Control\Cron_Options_CPT::POST_TYPE, $post_status, $offset, $limit ) );
 
 		// Bail if we don't get results
 		if ( ! is_array( $items ) ) {
@@ -242,6 +265,232 @@ class Events extends \WP_CLI_Command {
 
 		return $output;
 	}
+
+	/**
+	 * Delete an event by ID
+	 */
+	private function delete_event_by_id( $args, $assoc_args ) {
+		$jid = absint( $assoc_args['event_id'] );
+
+		// Validate ID
+		if ( ! $jid ) {
+			\WP_CLI::error( __( 'Invalid event ID', 'automattic-cron-control' ) );
+		}
+
+		\WP_CLI::line( __( 'Locating event...', 'automattic-cron-control' ) . "\n" );
+
+		// Look up full object and confirm that the entry belongs to this plugin's CPT
+		global $wpdb;
+
+		$event_post = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM {$wpdb->posts} WHERE post_type = %s AND ID = %d LIMIT 1", \Automattic\WP\Cron_Control\Cron_Options_CPT::POST_TYPE, $jid ) );
+
+		if ( is_object( $event_post ) && ! is_wp_error( $event_post ) ) {
+			// Parse basic event data and output, lest someone delete the wrong thing
+			$event_details = $this->get_event_details_from_post_title( $event_post->post_title );
+
+			// Warning about Internal Events
+			if ( \Automattic\WP\Cron_Control\is_internal_event( $event_details['action'] ) ) {
+				\WP_CLI::warning( __( 'This is an event created by the Cron Control plugin. It will recreated automatically.', 'automattic-cron-control' ) );
+			}
+
+			\WP_CLI::line( sprintf( __( 'Execution time: %s GMT', 'automattic-cron-control' ), date( TIME_FORMAT, $event_details['timestamp'] ) ) );
+			\WP_CLI::line( sprintf( __( 'Action: %s', 'automattic-cron-control' ), $event_details['action'] ) );
+			\WP_CLI::line( sprintf( __( 'Instance identifier: %s', 'automattic-cron-control' ), $event_details['instance'] ) );
+			\WP_CLI::line( '' );
+			\WP_CLI::confirm( sprintf( __( 'Are you sure you want to delete this event?', 'automattic-cron-control' ) ) );
+
+			// Try to delete the item and provide some relevant output
+			$trashed = wp_delete_post( $event_post->ID, true );
+
+			if ( false === $trashed ) {
+				\WP_CLI::error( sprintf( __( 'Failed to delete event %d', 'automattic-cron-control' ), $jid ) );
+			} else {
+				\Automattic\WP\Cron_Control\_flush_internal_caches();
+				\WP_CLI::success( sprintf( __( 'Removed event %d', 'automattic-cron-control' ), $jid ) );
+				return;
+			}
+		}
+
+		\WP_CLI::error( sprintf( __( 'Failed to delete event %d. Please confirm that the entry exists and that the ID is that of an event.', 'automattic-cron-control' ), $jid ) );
+	}
+
+	/**
+	 * Delete all events of the same action
+	 */
+	private function delete_event_by_action( $args, $assoc_args ) {
+		$action = $assoc_args['action'];
+
+		// Validate entry
+		if ( empty( $action ) ) {
+			\WP_CLI::error( __( 'Invalid action', 'automattic-cron-control' ) );
+		}
+
+		// Warning about Internal Events
+		if ( \Automattic\WP\Cron_Control\is_internal_event( $action ) ) {
+			\WP_CLI::warning( __( 'This is an event created by the Cron Control plugin. It will recreated automatically.', 'automattic-cron-control' ) );
+		}
+
+		// Set defaults needed to gather all events
+		$assoc_args['page']  = 1;
+		$assoc_args['limit'] = 50;
+
+		// Gather events
+		\WP_CLI::line( __( 'Gathering events...', 'automattic-cron-control' ) );
+
+		$events_to_delete = array();
+
+		$events = $this->get_events( $args, $assoc_args );
+
+		\WP_CLI::line( sprintf( _n( 'Found one event to check', 'Found %s events to check', $events['total_items'], 'automattic-cron-control' ), number_format_i18n( $events['total_items'] ) ) );
+
+		$search_progress = \WP_CLI\Utils\make_progress_bar( sprintf( __( 'Searching events for those with the action `%s`', 'automattic-cron-control' ), $action ), $events['total_items'] );
+
+		// Loop and pull out events to be deleted
+		do {
+			if ( ! is_array( $events ) || empty( $events['items'] ) ) {
+				break;
+			}
+
+			// Check events for those that should be deleted
+			foreach ( $events['items'] as $single_event ) {
+				$event_details = $this->get_event_details_from_post_title( $single_event->post_title );
+
+				if ( $event_details['action'] === $action ) {
+					$events_to_delete[] = array_merge( $event_details, array(
+						'ID'                => (int) $single_event->ID,
+						'post_date_gmt'     => $single_event->post_date_gmt,
+						'post_modified_gmt' => $single_event->post_modified_gmt,
+					) );
+				}
+
+				$search_progress->tick();
+			}
+
+			// Proceed to next batch
+			$assoc_args['page']++;
+
+			if ( $assoc_args['page'] > $events['total_pages'] ) {
+				break;
+			}
+
+			$events = $this->get_events( $args, $assoc_args );
+		} while( $events['page'] <= $events['total_pages'] );
+
+		$search_progress->finish();
+
+		\WP_CLI::line( '' );
+
+		// Nothing more to do
+		if ( empty( $events_to_delete ) ) {
+			\WP_CLI::error( sprintf( __( 'No events with action `%s` found', 'automattic-cron-control' ), $action ) );
+		}
+
+		// List the items to remove
+		$total_to_delete = count( $events_to_delete );
+
+		\WP_CLI::line( sprintf( _n( 'Found one event with action `%2$s`:', 'Found %1$s events with action `%2$s`:', $total_to_delete, 'automattic-cron-control' ), number_format_i18n( $total_to_delete ), $action ) );
+
+		if ( $total_to_delete <= $assoc_args['limit'] ) {
+			\WP_CLI\Utils\format_items( 'table', $events_to_delete, array(
+				'ID',
+				'post_date_gmt',
+				'post_modified_gmt',
+				'timestamp',
+				'instance',
+			) );
+		} else {
+			\WP_CLI::warning( sprintf( __( 'Events are not displayed as there are more than %s to remove', 'automattic-cron-control' ), number_format_i18n( $assoc_args['limit'] ) ) );
+		}
+
+		\WP_CLI::line( '' );
+		\WP_CLI::confirm( _n( 'Are you sure you want to delete this event?', 'Are you sure you want to delete these events?', $total_to_delete, 'automattic-cron-control' ) );
+
+		// Remove the items
+		$delete_progress = \WP_CLI\Utils\make_progress_bar( __( 'Deleting events', 'automattic-cron-control' ), $total_to_delete );
+
+		$events_deleted       = array();
+		$events_deleted_count = $events_failed_delete = 0;
+
+		foreach ( $events_to_delete as $event_to_delete ) {
+			$deleted = wp_delete_post( $event_to_delete['ID'], true );
+
+			$events_deleted[] = array(
+				'ID'      => $event_to_delete['ID'],
+				'deleted' => false === $deleted ? 'no' : 'yes',
+			);
+
+			if ( $deleted ) {
+				$events_deleted_count++;
+			} else {
+				$events_failed_delete++;
+			}
+
+			$delete_progress->tick();
+		}
+
+		$delete_progress->finish();
+
+		// When deletes succeed, sync internal caches
+		if ( $events_deleted_count > 0 ) {
+			\Automattic\WP\Cron_Control\_flush_internal_caches();
+		}
+
+		// List the removed items
+		\WP_CLI::line( "\n" . __( 'RESULTS:', 'automattic-cron-control' ) );
+
+		if ( 1 === $total_to_delete && 1 === $events_deleted_count ) {
+			\WP_CLI::success( sprintf( __( 'Deleted one event: %d', 'automattic-cron-control' ), $events_deleted[0]['ID'] ) );
+		} else {
+			if ( $events_deleted_count === $total_to_delete ) {
+				\WP_CLI::success( sprintf( __( 'Deleted %s events', 'automattic-cron-control' ), number_format_i18n( $events_deleted_count ) ) );
+			} else {
+				\WP_CLI::warning( sprintf( __( 'Expected to delete %1$s events, but could only delete %2$s events. It\'s likely that some events were executed while this command ran.', 'automattic-cron-control' ), number_format_i18n( $total_to_delete ), number_format_i18n( $events_deleted_count ) ) );
+			}
+
+			// Limit just to failed deletes when many events are removed
+			if ( count( $events_deleted ) > $assoc_args['limit'] ) {
+				$events_deleted_unfiltered = $events_deleted;
+
+				$events_deleted = array_filter( $events_deleted, function( $event ) {
+					if ( 'no' === $event['deleted'] ) {
+						return $event;
+					} else {
+						return false;
+					}
+				} );
+
+				if ( count( $events_deleted ) > 0 ) {
+					\WP_CLI::line( "\n" . __( 'Events that couldn\'t be deleted:', 'automattic-cron-control' ) );
+				}
+			} else {
+				\WP_CLI::line( "\n" . __( 'Events deleted:', 'automattic-cron-control' ) );
+			}
+
+			// Don't display a table if there's nothing to display
+			if ( count( $events_deleted ) > 0 ) {
+				\WP_CLI\Utils\format_items( 'table', $events_deleted, array(
+					'ID',
+					'deleted',
+				) );
+			}
+		}
+
+		return;
+	}
+
+	/**
+	 * Parse event details stored in an item's post_title
+	 */
+	private function get_event_details_from_post_title( $title ) {
+		$event_details = explode( '|', $title );
+		$event_details = array_map( 'trim', $event_details );
+
+		return array(
+			'timestamp' => (int) $event_details[0],
+			'action'    => $event_details[1],
+			'instance'  => $event_details[2],
+		);
+	}
 }
 
 \WP_CLI::add_command( 'cron-control events', 'Automattic\WP\Cron_Control\CLI\Events' );