Feature: multisite license storage

README.md

@@ -45,6 +45,12 @@ add_action( 'plugins_loaded', function() {
 	 */
 	Config::set_token_auth_prefix( 'my_origin' );
 
+	// Optionally, change the default auth token caching.
+	Config::set_auth_cache_expiration( WEEK_IN_SECONDS );
+
+	// Or, disable it completely.
+	Config::set_auth_cache_expiration( -1 );
+
 	Uplink::init();
 }, 0 );
 ```

docs/features.md

@@ -89,6 +89,8 @@ On the _Plugins_ page in the WP Dashboard, any plugin that has an update availab
 
 ### Multisite Licenses
 
+TODO: Notes about stored license file?
+
 Out of the box, Uplink treats all sub-sites as their _own independent site_, storing license keys and authorization tokens
 in the options table of that sub-site.
 
@@ -97,15 +99,15 @@ multisite network across multiple situations.
 
 > 💡 To operate at the network level, your plugin **must be network activated** and the proper configuration options enabled.
 
-| Install Type               | Network Activated? | Clause | Uplink Config Option (default is false)             | License & Token Storage Location |
-|----------------------------|--------------------|--------|-----------------------------------------------------|----------------------------------|
-| Standard                   | –                  | –      | –                                                   | Site level                       |
-| Multisite (subfolders)     | Yes                | AND    | `Config::set_network_subfolder_license(true)`       | Network level                    |
-| Multisite (subfolders)     | No                 | OR     | `Config::set_network_subfolder_license(false)`      | Site Level                       |
-| Multisite (subdomains)     | Yes                | AND    | `Config::set_network_subdomain_license(true)`       | Network level                    |
-| Multisite (subdomains)     | No                 | OR     | `Config::set_network_subdomain_license(false)`      | Site Level                       |
-| Multisite (domain mapping) | Yes                | AND    | `Config::set_network_domain_mapping_license(true)`  | Network level                    |
-| Multisite (domain mapping) | No                 | OR     | `Config::set_network_domain_mapping_license(false)` | Site Level                       |
+| Install Type               | Network Activated? | Clause | Uplink Config Option (default is false)                                | License & Token Storage Location |
+|----------------------------|--------------------|--------|------------------------------------------------------------------------|----------------------------------|
+| Standard                   | –                  | –      | –                                                                      | Site level                       |
+| Multisite (subfolders)     | Yes                | AND    | `Config::allow_site_level_licenses_for_subfolder_multisite(true)`      | Network level                    |
+| Multisite (subfolders)     | No                 | OR     | `Config::allow_site_level_licenses_for_subfolder_multisite(false)`     | Site Level                       |
+| Multisite (subdomains)     | Yes                | AND    | `Config::allow_site_level_licenses_for_subdomain_multisite(true)`      | Network level                    |
+| Multisite (subdomains)     | No                 | OR     | `Config::allow_site_level_licenses_for_subdomain_multisite(false)`     | Site Level                       |
+| Multisite (domain mapping) | Yes                | AND    | `Config::allow_site_level_licenses_for_mapped_domain_multisite(true)`  | Network level                    |
+| Multisite (domain mapping) | No                 | OR     | `Config::allow_site_level_licenses_for_mapped_domain_multisite(false)` | Site Level                       |
 
 
 #### Examples
@@ -118,13 +120,13 @@ use StellarWP\Uplink\Uplink;
 // ...other config above
 
 // Allow a single network license for multisite subfolders.
-Config::set_network_subfolder_license( true );
+Config::allow_site_level_licenses_for_subfolder_multisite( true );
 
 // Allow a single network license for multisite using subdomains.
-Config::set_network_subdomain_license( true );
+Config::allow_site_level_licenses_for_subdomain_multisite( true );
 
 // Allow a single network license for custom domains/mapped domains.
-Config::set_network_domain_mapping_license( true );
+Config::allow_site_level_licenses_for_mapped_domain_multisite( true );
 
 Uplink::init();
 ```
@@ -140,17 +142,17 @@ add_action( 'init', static function(): void {
 	// Replace with a call to your own plugin's config/option to check whether it should be managed in the network.
 	$network_enabled = true;
 
-	add_filter( 'stellarwp/uplink/my-plugin-slug/allows_network_subfolder_license',
+	add_filter( 'stellarwp/uplink/my-plugin-slug/supports_site_level_licenses_for_subfolder_multisite',
 		static function () use ( $network_enabled ): bool {
 			return $network_enabled;
 		}, 10 );
 
-	add_filter( 'stellarwp/uplink/my-plugin-slug/allows_network_subdomain_license',
+	add_filter( 'stellarwp/uplink/my-plugin-slug/supports_site_level_licenses_for_subdomain_multisite',
 		static function () use ( $network_enabled ): bool {
 			return $network_enabled;
 		}, 10 );
 
-	add_filter( 'stellarwp/uplink/my-plugin-slug/allows_network_domain_mapping_license',
+	add_filter( 'stellarwp/uplink/my-plugin-slug/supports_site_level_licenses_for_mapped_domain_multisite',
 		static function () use ( $network_enabled ): bool {
 			return $network_enabled;
 		}, 10 );
@@ -185,7 +187,4 @@ the correct location.
 
 // Gets the local URL to disconnect a token (delete it locally).
 \StellarWP\Uplink\get_disconnect_url( 'my-plugin-slug' );
-
-// Checks if the current site (e.g. the sub-site on multisite) would support multisite licensing.
-\StellarWP\Uplink\allows_multisite_license( 'my-plugin-slug' );
 ```

src/Uplink/API/Client.php

@@ -18,6 +18,7 @@
  * @property-read ContainerInterface $container Container instance.
  */
 class Client {
+
 	/**
 	 * API base endpoint.
 	 *
@@ -187,16 +188,15 @@ protected function request( $method, $endpoint, $args ) {
 	 *
 	 * @since 1.0.0
 	 *
-	 * @param  Resource     $resource         Resource to validate.
-	 * @param  string|null  $key              License key.
-	 * @param  string       $validation_type  Validation type (local or network).
-	 * @param  bool         $force            Force the validation.
+	 * @param  Resource     $resource  Resource to validate.
+	 * @param  string|null  $key       License key.
+	 * @param  bool         $force     Force the validation.
 	 *
 	 * @throws \RuntimeException
 	 *
-	 * @return mixed
+	 * @return Validation_Response|mixed
 	 */
-	public function validate_license( Resource $resource, ?string $key = null, string $validation_type = 'local', bool $force = false ) {
+	public function validate_license( Resource $resource, ?string $key = null, bool $force = false ) {
 		/** @var Data */
 		$site_data = $this->container->get( Data::class );
 		$args      = $resource->get_validation_args();
@@ -235,7 +235,7 @@ public function validate_license( Resource $resource, ?string $key = null, strin
 			$results = null;
 		}
 
-		$results = new Validation_Response( $key, $validation_type, $results, $resource );
+		$results = new Validation_Response( $key, $results, $resource );
 
 		/**
 		 * Filter the license validation results.

src/Uplink/API/V3/Auth/Contracts/Token_Authorizer.php

@@ -0,0 +1,21 @@
+<?php declare( strict_types=1 );
+
+namespace StellarWP\Uplink\API\V3\Auth\Contracts;
+
+interface Token_Authorizer {
+
+	/**
+	 * Check if a license is authorized.
+	 *
+	 * @see is_authorized()
+	 * @see \StellarWP\Uplink\API\V3\Auth\Token_Authorizer
+	 *
+	 * @param  string  $license  The license key.
+	 * @param  string  $token    The stored token.
+	 * @param  string  $domain   The user's domain.
+	 *
+	 * @return bool
+	 */
+	public function is_authorized( string $license, string $token, string $domain ): bool;
+
+}

src/Uplink/API/V3/Auth/Token_Authorizer.php

@@ -12,7 +12,7 @@
 /**
  * Manages authorization.
  */
-final class Token_Authorizer {
+class Token_Authorizer implements Contracts\Token_Authorizer {
 
 	use With_Debugging;
 

src/Uplink/API/V3/Auth/Token_Authorizer_Cache_Decorator.php

@@ -0,0 +1,86 @@
+<?php declare( strict_types=1 );
+
+namespace StellarWP\Uplink\API\V3\Auth;
+
+use StellarWP\Uplink\API\V3\Provider;
+use StellarWP\Uplink\Config;
+
+/**
+ * Token Authorizer Cache Decorator.
+ *
+ * @see Config::set_auth_cache_expiration() to enable.
+ */
+final class Token_Authorizer_Cache_Decorator implements Contracts\Token_Authorizer {
+
+	public const TRANSIENT_PREFIX = 'stellarwp_auth_';
+
+	/**
+	 * @var Token_Authorizer
+	 */
+	private $authorizer;
+
+	/**
+	 * The cache expiration in seconds.
+	 *
+	 * @var int
+	 */
+	private $expiration;
+
+	/**
+	 * @see Config::set_auth_cache_expiration()
+	 * @see Provider::register_token_authorizer()
+	 *
+	 * @param  Token_Authorizer  $authorizer The original authorizer.
+	 * @param  int               $expiration The expiration time in seconds.
+	 */
+	public function __construct(
+		Token_Authorizer $authorizer,
+		int $expiration = 21600
+	) {
+		$this->authorizer = $authorizer;
+		$this->expiration = $expiration;
+	}
+
+	/**
+	 * Check if a license is authorized and cache successful responses.
+	 *
+	 * @see Config::set_auth_cache_expiration()
+	 * @see is_authorized()
+	 * @see Token_Authorizer
+	 *
+	 * @param  string  $license  The license key.
+	 * @param  string  $token    The stored token.
+	 * @param  string  $domain   The user's domain.
+	 *
+	 * @return bool
+	 */
+	public function is_authorized( string $license, string $token, string $domain ): bool {
+		$transient     = $this->build_transient( [ $license, $token, $domain ] );
+		$is_authorized = get_transient( $transient );
+
+		if ( $is_authorized === true ) {
+			return true;
+		}
+
+		$is_authorized = $this->authorizer->is_authorized( $license, $token, $domain );
+
+		// Only cache successful responses.
+		if ( $is_authorized ) {
+			set_transient( $transient, true, $this->expiration );
+		}
+
+		return $is_authorized;
+	}
+
+	/**
+	 * Build a transient key.
+	 *
+	 * @param  array<int, string>  ...$args
+	 *
+	 * @return string
+	 */
+	public function build_transient( array ...$args ): string {
+		return self::TRANSIENT_PREFIX . hash( 'sha256', json_encode( $args ) );
+	}
+
+}

src/Uplink/API/V3/Provider.php

@@ -4,6 +4,8 @@
 
 use StellarWP\Uplink\API\V3\Auth\Auth_Url_Cache_Decorator;
 use StellarWP\Uplink\API\V3\Auth\Contracts\Auth_Url;
+use StellarWP\Uplink\API\V3\Auth\Contracts\Token_Authorizer;
+use StellarWP\Uplink\API\V3\Auth\Token_Authorizer_Cache_Decorator;
 use StellarWP\Uplink\API\V3\Contracts\Client_V3;
 use StellarWP\Uplink\Config;
 use StellarWP\Uplink\Contracts\Abstract_Provider;
@@ -54,6 +56,36 @@ public function register() {
 
 			return new Client( $api_root, $base_url, $request_args, new WP_Http() );
 		} );
+
+		$this->register_token_authorizer();
+	}
+
+	/**
+	 * Based on the developer's configuration, determine if we will enable Token Authorization caching.
+	 *
+	 * @return void
+	 */
+	private function register_token_authorizer(): void {
+		$expiration = Config::get_auth_cache_expiration();
+
+		if ( $expiration >= 0 ) {
+			$this->container->bind(
+				Token_Authorizer::class,
+				static function ( $c ) use ( $expiration ): Token_Authorizer {
+					return new Token_Authorizer_Cache_Decorator(
+						$c->get( Auth\Token_Authorizer::class ),
+						$expiration
+					);
+				}
+			);
+
+			return;
+		}
+
+		$this->container->bind(
+			Token_Authorizer::class,
+			Auth\Token_Authorizer::class
+		);
 	}
 
 }

src/Uplink/API/Validation_Response.php

@@ -98,15 +98,6 @@ class Validation_Response {
 	 */
 	protected $result = 'success';
 
-	/**
-	 * Validation type.
-	 *
-	 * @since 1.0.0
-	 *
-	 * @var string
-	 */
-	protected $validation_type;
-
 	/**
 	 * Version from validation response.
 	 *
@@ -121,16 +112,14 @@ class Validation_Response {
 	 *
 	 * @since 1.0.0
 	 *
-	 * @param  string|null    $key              License key.
-	 * @param  string         $validation_type  Validation type (local or network).
-	 * @param  stdClass|null  $response         Validation response.
-	 * @param  Resource       $resource         Resource instance.
+	 * @param  string|null    $key       License key.
+	 * @param  stdClass|null  $response  Validation response.
+	 * @param  Resource       $resource  Resource instance.
 	 */
-	public function __construct( ?string $key, string $validation_type, ?stdClass $response, Resource $resource ) {
-		$this->key             = $key ?: '';
-		$this->validation_type = 'network' === $validation_type ? 'network' : 'local';
-		$this->response        = $response;
-		$this->resource        = $resource;
+	public function __construct( ?string $key, ?stdClass $response, Resource $resource ) {
+		$this->key      = (string) $key;
+		$this->response = $response;
+		$this->resource = $resource;
 
 		if ( isset( $this->response->results ) ) {
 			$this->response = is_array( $this->response->results ) ? reset( $this->response->results ) : $this->response->results;
@@ -406,7 +395,7 @@ public function set_is_valid( bool $is_valid ): void {
 	 * @return void
 	 */
 	private function parse(): void {
-		$this->current_key = $this->resource->get_license_key( $this->validation_type );
+		$this->current_key = $this->resource->get_license_key();
 		$this->expiration  = $this->response->expiration ?? __( 'unknown date', '%TEXTDOMAIN%' );
 
 		if ( ! empty( $this->response->api_inline_invalid_message ) ) {

src/Uplink/Admin/Ajax.php

@@ -2,7 +2,6 @@
 
 namespace StellarWP\Uplink\Admin;
 
-use StellarWP\Uplink\Auth\License\License_Manager;
 use StellarWP\Uplink\Resources\Collection;
 use StellarWP\Uplink\Utils;
 
@@ -18,26 +17,18 @@ class Ajax {
 	 */
 	protected $field;
 
-	/**
-	 * @var License_Manager
-	 */
-	protected $license_manager;
-
 	/**
 	 * Constructor.
 	 *
-	 * @param  Collection       $resources        The plugin/services collection.
-	 * @param  License_Field    $field            The license field.
-	 * @param  License_Manager  $license_manager  The license manager.
+	 * @param  Collection     $resources  The plugin/services collection.
+	 * @param  License_Field  $field      The license field.
 	 */
 	public function __construct(
 		Collection $resources,
-		License_Field $field,
-		License_Manager $license_manager
+		License_Field $field
 	) {
-		$this->resources       = $resources;
-		$this->field           = $field;
-		$this->license_manager = $license_manager;
+		$this->resources = $resources;
+		$this->field     = $field;
 	}
 
 	/**
@@ -70,9 +61,8 @@ public function validate_license(): void {
 			] );
 		}
 
-		$network_validate = $this->license_manager->allows_multisite_license( $plugin );
-		$results          = $plugin->validate_license( $submission['key'], $network_validate );
-		$message          = $network_validate ? $results->get_network_message()->get() : $results->get_message()->get();
+		$results = $plugin->validate_license( $submission['key'] );
+		$message = $plugin->uses_network_licensing() ? $results->get_network_message()->get() : $results->get_message()->get();
 
 		wp_send_json( [
 			'status'  => absint( $results->is_valid() ),