Create background events for URL validation

includes/cli/class-amp-cli-validation-command.php

@@ -11,6 +11,7 @@
 use AmpProject\AmpWP\Option;
 use AmpProject\AmpWP\Validation\URLValidationProvider;
 use AmpProject\AmpWP\Validation\ScannableURLProvider;
+use AmpProject\AmpWP\Validation\URLScanningContext;
 use WP_CLI\Utils;
 
 /**
@@ -141,16 +142,7 @@ public function run( $args, $assoc_args ) {
 			$number_urls_to_crawl
 		);
 
-		$result = $url_validation_provider->with_lock(
-			function () use ( $urls ) {
-				$this->validate_urls( $urls );
-			}
-		);
-
-		if ( is_wp_error( $result ) ) {
-			WP_CLI::error( 'The site cannot be crawled at this time because validation is running in another process.' );
-			return;
-		}
+		$this->validate_urls( $urls );
 
 		$this->wp_cli_progress->finish();
 
@@ -248,9 +240,11 @@ private function get_validation_url_provider() {
 		}
 
 		$this->scannable_url_provider = new ScannableURLProvider(
-			$limit_type_validate_count,
-			$include_conditionals,
-			$force_crawl_urls
+			new URLScanningContext(
+				$limit_type_validate_count,
+				$include_conditionals,
+				$force_crawl_urls
+			)
 		);
 
 		return $this->scannable_url_provider;
@@ -284,12 +278,7 @@ private function validate_urls( $urls = null ) {
 			$urls                   = $scannable_url_provider->get_urls();
 		}
 
-		foreach ( $urls as $index => $url ) {
-			// Reset lock between every five URLs.
-			if ( 0 === $index % 5 ) {
-				$this->url_validation_provider->reset_lock();
-			}
-
+		foreach ( $urls as $url ) {
 			$validity = $url_validation_provider->get_url_validation( $url['url'], $url['type'], true );
 
 			if ( $this->wp_cli_progress ) {

src/AmpWpPlugin.php

@@ -9,8 +9,11 @@
 
 use AmpProject\AmpWP\Admin;
 use AmpProject\AmpWP\BackgroundTask;
+use AmpProject\AmpWP\Infrastructure\Injector;
 use AmpProject\AmpWP\Infrastructure\ServiceBasedPlugin;
 use AmpProject\AmpWP\Instrumentation;
+use AmpProject\AmpWP\Validation\SavePostValidationEvent;
+use AmpProject\AmpWP\Validation\URLValidationCron;
 
 use function is_user_logged_in;
 
@@ -80,6 +83,8 @@ final class AmpWpPlugin extends ServiceBasedPlugin {
 		'server_timing'                     => Instrumentation\ServerTiming::class,
 		'site_health_integration'           => Admin\SiteHealth::class,
 		'validated_url_stylesheet_gc'       => BackgroundTask\ValidatedUrlStylesheetDataGarbageCollection::class,
+		'url_validation_cron'               => URLValidationCron::class,
+		'save_post_validation_single_event' => SavePostValidationEvent::class,
 	];
 
 	/**
@@ -161,6 +166,7 @@ protected function get_shared_instances() {
 			DevTools\CallbackReflection::class,
 			DevTools\FileReflection::class,
 			ReaderThemeLoader::class,
+			BackgroundTask\BackgroundTaskDeactivator::class,
 		];
 	}
 

src/BackgroundTask/BackgroundTaskDeactivator.php

@@ -0,0 +1,171 @@
+<?php
+/**
+ * BackgroundTaskDeactivator service for clearing background tasks on plugin deactivation.
+ *
+ * @package AmpProject\AmpWP
+ */
+
+namespace AmpProject\AmpWP\BackgroundTask;
+
+use AmpProject\AmpWP\Icon;
+use AmpProject\AmpWP\Infrastructure\Conditional;
+use AmpProject\AmpWP\Infrastructure\Deactivateable;
+use AmpProject\AmpWP\Infrastructure\Registerable;
+use AmpProject\AmpWP\Infrastructure\Service;
+
+/**
+ * Clears background tasks when the plugin is deactivated.
+ *
+ * @package AmpProject\AmpWP
+ * @since 2.1
+ * @internal
+ */
+final class BackgroundTaskDeactivator implements Service, Conditional, Registerable, Deactivateable {
+
+	/**
+	 * List of event names to deactivate.
+	 *
+	 * @var string[]
+	 */
+	private $events_to_deactivate = [];
+
+	/**
+	 * Name of the plugin as WordPress is expecting it.
+	 *
+	 * This should usually have the form "amp/amp.php".
+	 *
+	 * @var string
+	 */
+	private $plugin_file;
+
+	/**
+	 * Check whether the conditional object is currently needed.
+	 *
+	 * @return bool Whether the conditional object is needed.
+	 */
+	public static function is_needed() {
+		return is_admin() || wp_doing_cron();
+	}
+
+	/**
+	 * Class constructor.
+	 */
+	public function __construct() {
+		$this->plugin_file = plugin_basename( AMP__FILE__ );
+	}
+
+	/**
+	 * Register the service with the system.
+	 *
+	 * @return void
+	 */
+	public function register() {
+		add_action( "network_admin_plugin_action_links_{$this->plugin_file}", [ $this, 'add_warning_sign_to_network_deactivate_action' ], 10, 1 );
+		add_action( 'plugin_row_meta', [ $this, 'add_warning_to_plugin_meta' ], 10, 2 );
+	}
+
+	/**
+	 * Get warning icon markup.
+	 *
+	 * @return string Warning icon markup.
+	 */
+	private function get_warning_icon() {
+		return sprintf( '<span style="vertical-align: middle">%s</span>', Icon::warning()->to_html() );
+	}
+
+	/**
+	 * Adds an event to the deactivate queue.
+	 *
+	 * @param string $event_name The event name.
+	 */
+	public function add_event( $event_name ) {
+		if ( ! in_array( $event_name, $this->events_to_deactivate, true ) ) {
+			$this->events_to_deactivate[] = $event_name;
+		}
+	}
+
+	/**
+	 * Run deactivation logic.
+	 *
+	 * This should be hooked up to the WordPress deactivation hook.
+	 *
+	 * @param bool $network_wide Whether the deactivation was done network-wide.
+	 * @return void
+	 */
+	public function deactivate( $network_wide ) {
+		if ( $network_wide && is_multisite() && ! wp_is_large_network( 'sites' ) ) {
+			foreach ( get_sites(
+				[
+					'fields' => 'ids',
+					'number' => 0, // Disables pagination to retrieve all sites.
+				]
+			) as $blog_id ) {
+				switch_to_blog( $blog_id );
+
+				foreach ( $this->events_to_deactivate as $event_name ) {
+					wp_clear_scheduled_hook( $event_name );
+				}
+
+				restore_current_blog();
+			}
+		} else {
+			foreach ( $this->events_to_deactivate as $event_name ) {
+				wp_clear_scheduled_hook( $event_name );
+			}
+		}
+	}
+
+	/**
+	 * Add a warning sign to the network deactivate action on the network plugins screen.
+	 *
+	 * @param string[] $actions     An array of plugin action links. By default this can include 'activate',
+	 *                              'deactivate', and 'delete'.
+	 * @return string[]
+	 */
+	public function add_warning_sign_to_network_deactivate_action( $actions ) {
+		if ( ! wp_is_large_network() ) {
+			return $actions;
+		}
+
+		if ( ! array_key_exists( 'deactivate', $actions ) ) {
+			return $actions;
+		}
+
+		wp_enqueue_style( 'amp-icons' );
+
+		$warning_icon = $this->get_warning_icon();
+		if ( false === strpos( $actions['deactivate'], $warning_icon ) ) {
+			$actions['deactivate'] = preg_replace( '#(?=</a>)#i', ' ' . $warning_icon, $actions['deactivate'] );
+		}
+
+		return $actions;
+	}
+
+	/**
+	 * Add a warning to the plugin meta row on the network plugins screen.
+	 *
+	 * @param string[] $plugin_meta An array of the plugin's metadata, including the version, author, author URI, and
+	 *                              plugin URI.
+	 * @param string   $plugin_file Path to the plugin file relative to the plugins directory.
+	 * @return string[]
+	 */
+	public function add_warning_to_plugin_meta( $plugin_meta, $plugin_file ) {
+		if ( ! is_multisite() || ! wp_is_large_network() ) {
+			return $plugin_meta;
+		}
+
+		if ( $plugin_file !== $this->plugin_file ) {
+			return $plugin_meta;
+		}
+
+		wp_enqueue_style( 'amp-icons' );
+
+		$warning = $this->get_warning_icon() . ' ' . esc_html__( 'Large site detected. Deactivation will leave orphaned scheduled events behind.', 'amp' ) . ' ' . $this->get_warning_icon();
+
+		if ( ! in_array( $warning, $plugin_meta, true ) ) {
+			$plugin_meta[] = $warning;
+		}
+
+		return $plugin_meta;
+	}
+}