Adds Parsely as VIP Integration

integrations/block-data-api.php

@@ -1,4 +1,9 @@
 <?php
+/**
+ * Integration: Block Data API.
+ *
+ * @package Automattic\VIP\Integrations
+ */
 
 namespace Automattic\VIP\Integrations;
 
@@ -7,35 +12,37 @@
  *
  * @private
  */
-class BlockDataApi extends Integration {
+class BlockDataApiIntegration extends Integration {
 
 	/**
 	 * The version of the Block Data API plugin to load, that's set to the latest version.
-	 * This should be higher than the lowestVersion set in https://github.com/Automattic/vip-go-mu-plugins-ext/blob/trunk/config.json#L63
-	 * 
+	 * This should be higher than the lowestVersion set in "vip-block-data-api" config (https://github.com/Automattic/vip-go-mu-plugins-ext/blob/trunk/config.json)
+	 *
 	 * @var string
 	 */
 	protected string $version = '1.0';
 
 	/**
 	 * Applies hooks to load Block Data API plugin.
 	 *
+	 * @param array $config Configuration array for this integration.
+	 *
 	 * @private
 	 */
 	public function load( array $config ): void {
-		// Wait until plugins_loaded to give precedence to the plugin in the customer repo
+		// Wait until plugins_loaded to give precedence to the plugin in the customer repo.
 		add_action( 'plugins_loaded', function() {
-			// Do not load plugin if already loaded by customer code
+			// Do not load plugin if already loaded by customer code.
 			if ( defined( 'VIP_BLOCK_DATA_API_LOADED' ) ) {
 				return;
 			}
 
-			// Load the version of the plugin that should be set to the latest version, otherwise if it's not found deactivate the integration
+			// Load the version of the plugin that should be set to the latest version, otherwise if it's not found deactivate the integration.
 			$load_path = WPMU_PLUGIN_DIR . '/vip-integrations/vip-block-data-api-' . $this->version . '/vip-block-data-api.php';
 			if ( file_exists( $load_path ) ) {
 				require_once $load_path;
 			} else {
-				$this->is_active = false;
+				$this->is_active_by_customer = false;
 			}
 		} );
 	}

integrations/integration.php

@@ -1,57 +1,226 @@
 <?php
+/**
+ * Base class for Integration.
+ *
+ * @package Automattic\VIP\Integrations
+ */
 
 namespace Automattic\VIP\Integrations;
 
+// phpcs:disable Generic.Files.OneObjectStructurePerFile.MultipleFound -- Disabling due to enums.
+
+/**
+ * Enum which represent all possible status for the client integration via VIP.
+ *
+ * These should be in sync with the statuses on the backend.
+ */
+abstract class Client_Integration_Status {
+	const BLOCKED = 'blocked';
+}
+
+/**
+ * Enum which represent all possible status for the site integration via VIP.
+ *
+ * These should be in sync with the statuses on the backend.
+ */
+abstract class Site_Integration_Status {
+	const ENABLED  = 'enabled';
+	const DISABLED = 'disabled';
+	const BLOCKED  = 'blocked';
+}
+
 /**
  * Abstract base class for all integration implementations.
  *
  * @private
  */
 abstract class Integration {
+	/**
+	 * Slug of the integration.
+	 *
+	 * @var string
+	 */
+	private string $slug;
+
 	/**
 	 * An optional configuration array for this integration, added during activation.
 	 *
 	 * @var array
 	 */
-	protected array $config = [];
+	private array $config = [];
+
+	/**
+	 * Configurations provided by VIP for setup.
+	 *
+	 * @var array {
+	 *   'client'        => array<string, string>,
+	 *   'site'          => array<string, string>,
+	 *   'network-sites' => array<string, array<string, string>>,
+	 * }
+	 *
+	 * @example
+	 * array(
+	 *  'client'        => array( 'status' => 'blocked' ),
+	 *  'site'          => array( 'status' => 'disabled' ),
+	 *  'network-sites' => array (
+	 *      1 => array (
+	 *          'status' => 'disabled',
+	 *      ),
+	 *      2 => array (
+	 *          'status' => 'enabled',
+	 *      ),
+	 *      3 => array (
+	 *          'status' => 'blocked',
+	 *      ),
+	 *  )
+	 * );
+	 */
+	private array $vip_config = [];
 
 	/**
-	 * A boolean indicating if this integration should be loaded. Defaults to false.
+	 * A boolean indicating if this integration is activated by customer.
 	 *
 	 * @var bool
 	 */
-	protected bool $is_active = false;
+	public bool $is_active_by_customer = false;
+
+	/**
+	 * Constructor.
+	 *
+	 * @param string $slug Slug of the integration.
+	 */
+	public function __construct( string $slug ) {
+		$this->slug = $slug;
+
+		$this->set_vip_config();
+	}
 
 	/**
 	 * Activates this integration with an optional configuration value.
 	 *
-	 * @param array  $config An associative array of configuration values for the integration.
+	 * @param array $config An associative array of configuration values for the integration.
 	 *
 	 * @private
 	 */
 	public function activate( array $config = [] ): void {
-		$this->is_active = true;
-		$this->config    = $config;
+		$this->is_active_by_customer = true;
+		$this->config                = $config;
 	}
 
 	/**
 	 * Returns true if this integration has been activated.
 	 *
+	 * @return bool
+	 *
 	 * @private
 	 */
 	public function is_active(): bool {
-		return $this->is_active;
+		if ( $this->is_active_by_customer ) {
+			return true;
+		}
+
+		if ( $this->is_active_by_vip() ) {
+			return true;
+		}
+
+		return false;
 	}
 
 	/**
 	 * Return the activation configuration for this integration.
 	 *
+	 * @return array<mixed>
+	 *
 	 * @private
 	 */
 	public function get_config(): array {
 		return $this->config;
 	}
 
+	/**
+	 * Set setup configs provided by VIP.
+	 */
+	private function set_vip_config(): void {
+		$config_file_path = ABSPATH . 'config/integrations-config/' . $this->slug . '-config.php';
+
+		if ( ! is_readable( $config_file_path ) ) {
+			return;
+		}
+
+		$configs = require_once $config_file_path;
+
+		if ( is_array( $configs ) ) {
+			$this->vip_config = $configs;
+		}
+	}
+
+	/**
+	 * Returns true if the integration is active by VIP.
+	 *
+	 * @return bool
+	 */
+	private function is_active_by_vip(): bool {
+		// Return false if client is blocked.
+		if ( $this->get_value_from_vip_config( 'client', 'status' ) === Client_Integration_Status::BLOCKED ) {
+			return false;
+		}
+
+		$site_status = $this->get_value_from_vip_config( 'site', 'status' );
+
+		// Return false if site is blocked.
+		if ( Site_Integration_Status::BLOCKED === $site_status ) {
+			return false;
+		}
+
+		// Check for network-site enablement if multisite.
+		if ( is_multisite() ) {
+			if ( is_network_admin() ) {
+				return false;
+			}
+
+			return $this->get_value_from_vip_config( 'network-sites', 'status' ) === Site_Integration_Status::ENABLED;
+		}
+
+		return Site_Integration_Status::ENABLED === $site_status; // Return site status if not multisite.
+	}
+
+	/**
+	 * Get config value based on given type and key.
+	 *
+	 * @param string $config_type Type of the config whose data is needed i.e. client, site, network-sites etc.
+	 * @param string $key Key of the config from which we have to extract the data.
+	 *
+	 * @return string
+	 */
+	private function get_value_from_vip_config( string $config_type, string $key ): string {
+		if ( ! isset( $this->vip_config[ $config_type ] ) ) {
+			return '';
+		}
+
+		// Look for key inside client or site config.
+		if ( 'network-sites' !== $config_type && isset( $this->vip_config[ $config_type ][ $key ] ) ) {
+			return $this->vip_config[ $config_type ][ $key ];
+		}
+
+		// Look for key inside network-sites config.
+		if ( 'network-sites' === $config_type && isset( $this->vip_config[ $config_type ][ get_current_blog_id() ] ) ) {
+			if ( isset( $this->vip_config[ $config_type ][ get_current_blog_id() ][ $key ] ) ) {
+				return $this->vip_config[ $config_type ][ get_current_blog_id() ][ $key ];
+			}
+		}
+
+		return '';
+	}
+
+	/**
+	 * Get slug of the integration.
+	 *
+	 * @private
+	 */
+	public function get_slug(): string {
+		return $this->slug;
+	}
+
 	/**
 	 * Abstract base for integration functionality.
 	 * Implement custom action and filter calls to load integration here.
@@ -60,6 +229,8 @@ public function get_config(): array {
 	 * the implementation should hook into plugins_loaded and check if 
 	 * the plugin is already loaded first.
 	 * 
+	 * @param array $config Configuration for this integration.
+	 *
 	 * @private
 	 */
 	abstract public function load( array $config ): void;

integrations/integrations.php

@@ -1,4 +1,9 @@
 <?php
+/**
+ * Integrations.
+ *
+ * @package Automattic\VIP\Integrations
+ */
 
 namespace Automattic\VIP\Integrations;
 
@@ -20,41 +25,32 @@ class Integrations {
 	/**
 	 * Registers an integration.
 	 *
-	 * @param string             $slug            A unique identifier for the integration.
-	 * @param string|Integration $class_or_object Fully-qualified class or instantiated Integration object.
+	 * @param Integration $integration Instantiated integration object.
+	 *
+	 * @throws InvalidArgumentException Excpetion if invalid argument are passed.
 	 *
 	 * @private
 	 */
-	public function register( string $slug, $class_or_object ): void {
-		if ( isset( $this->integrations[ $slug ] ) ) {
-			throw new InvalidArgumentException( sprintf( 'Integration with slug "%s" is already registered.', $slug ) );
+	public function register( $integration ): void {
+		if ( ! is_subclass_of( $integration, Integration::class ) ) {
+			throw new InvalidArgumentException( sprintf( 'Integration class "%s" must extend %s.', get_class( $integration ), Integration::class ) );
 		}
 
-		if ( is_object( $class_or_object ) ) {
-			$integration_object = $class_or_object;
-		} else {
-			if ( ! class_exists( $class_or_object ) ) {
-				throw new InvalidArgumentException( sprintf( 'Integration class "%s" does not exist.', $class_or_object ) );
-			}
-
-			$integration_object = new $class_or_object();
-		}
+		$slug = $integration->get_slug();
 
-		if ( ! is_subclass_of( $integration_object, Integration::class ) ) {
-			throw new InvalidArgumentException( sprintf( 'Integration class "%s" must extend %s.', get_class( $integration_object ), Integration::class ) );
+		if ( isset( $this->integrations[ $slug ] ) ) {
+			throw new InvalidArgumentException( sprintf( 'Integration with slug "%s" is already registered.', $slug ) );
 		}
 
-		$this->integrations[ $slug ] = $integration_object;
+		$this->integrations[ $slug ] = $integration;
 	}
 
 	/**
 	 * Returns a registered integration for a key, or null if not found.
 	 *
 	 * @param string $slug A unique identifier for the integration.
-	 *
-	 * @private
 	 */
-	public function get( string $slug ): ?Integration {
+	private function get( string $slug ): ?Integration {
 		return $this->integrations[ $slug ] ?? null;
 	}
 
@@ -77,13 +73,15 @@ public function load_active(): void {
 	 * @param string $slug   A unique identifier for the integration.
 	 * @param array  $config An associative array of configuration values for the integration.
 	 *
+	 * @throws InvalidArgumentException Excpetion if invalid argument are passed.
+	 *
 	 * @private
 	 */
-	public function activate( string $integration_slug, array $config = [] ): void {
-		$integration = $this->get( $integration_slug );
+	public function activate( string $slug, array $config = [] ): void {
+		$integration = $this->get( $slug );
 
 		if ( null === $integration ) {
-			throw new InvalidArgumentException( sprintf( 'VIP Integration with slug "%s" is not a registered integration.', $integration_slug ) );
+			throw new InvalidArgumentException( sprintf( 'VIP Integration with slug "%s" is not a registered integration.', $integration ) );
 		}
 
 		$integration->activate( $config );