Legacy license field improvements

changelog/update-license-field-improvements

@@ -0,0 +1,4 @@
+Significance: minor
+Type: fix
+
+Warn users when they attempt to enter a Unified license key into the standalone license key field

composer.json

@@ -31,7 +31,7 @@
     "stellarwp/assets": "^1.5",
     "stellarwp/container-contract": "^1.0.4",
     "stellarwp/db": "^1.0.3",
-    "stellarwp/harbor": "^1.4",
+    "stellarwp/harbor": "dev-SMTNC-1895",
     "stellarwp/installer": "^1.1.0",
     "stellarwp/telemetry": "^2.3.4",
     "stellarwp/uplink": "2.2.2",

src/Common/Integrations/Harbor/PUE.php

@@ -41,6 +41,9 @@ protected function do_register(): void {
 		add_filter( 'stellarwp/uplink/tec/license_get_key', [ $this, 'filter_stellarwp_uplink_tec_license_get_key' ], 10, 2 );
 		add_filter( 'tec_common_uplink_auth_url', [ $this, 'filter_stellarwp_uplink_tec_authorize_button_url' ], 10, 2 );
 		add_filter( 'pue_get_update_url', [ $this, 'filter_pue_get_update_url' ], 10, 2 );
+		add_filter( 'tribe_puc_pre_validate_key', [ $this, 'filter_tribe_puc_pre_validate_key' ], 10, 3 );
+		add_filter( 'tribe_settings_save_field_value', [ $this, 'prevent_storing_unified_license_key' ], 10, 2 );
+		add_filter( 'tribe_license_fields', [ $this, 'readonly_and_disable_harbor_managed_license_fields' ], 30 );
 	}
 
 	/**
@@ -56,6 +59,154 @@ public function unregister(): void {
 		remove_filter( 'stellarwp/uplink/tec/license_get_key', [ $this, 'filter_stellarwp_uplink_tec_license_get_key' ] );
 		remove_filter( 'tec_common_uplink_auth_url', [ $this, 'filter_stellarwp_uplink_tec_authorize_button_url' ] );
 		remove_filter( 'pue_get_update_url', [ $this, 'filter_pue_get_update_url' ] );
+		remove_filter( 'tribe_puc_pre_validate_key', [ $this, 'filter_tribe_puc_pre_validate_key' ] );
+		remove_filter( 'tribe_settings_save_field_value', [ $this, 'prevent_storing_unified_license_key' ] );
+		remove_filter( 'tribe_license_fields', [ $this, 'readonly_and_disable_harbor_managed_license_fields' ], 30 );
+	}
+
+	/**
+	 * Modify the Harbor-managed legacy fields and make them
+	 * readonly and disabled when the product is licensed via Harbor.
+	 *
+	 * @since TBD
+	 *
+	 * @param array $fields The license fields.
+	 *
+	 * @return array
+	 */
+	public function readonly_and_disable_harbor_managed_license_fields( array $fields ): array {
+		foreach ( $fields as $field_id => &$field ) {
+			if ( ! is_array( $field ) || ! is_string( $field_id ) ) {
+				continue;
+			}
+
+			if ( ! str_starts_with( $field_id, 'pue_install_key_' ) ) {
+				continue;
+			}
+
+			if ( ( $field['type'] ?? '' ) !== 'license_key' ) {
+				continue;
+			}
+
+			$product = str_replace( [ 'pue_install_key_', '_' ], [ '', '-' ], $field_id );
+			if ( ! $this->harbor->is_license_field_managed_by_harbor( $product ) ) {
+				continue;
+			}
+
+			$field['attributes'] = array_merge(
+				$field['attributes'] ?? [],
+				[
+					'disabled' => 'disabled',
+					'readonly' => 'readonly',
+				]
+			);
+		}
+
+		return $fields;
+	}
+
+	/**
+	 * Short-circuit legacy PUE key validation for Harbor unified licenses.
+	 *
+	 * Harbor-managed products already use the unified key, so remote validation is
+	 * skipped. Unified keys pasted into non-managed product fields are rejected with
+	 * a link to the LW License Manager.
+	 *
+	 * @since TBD
+	 *
+	 * @param array|null                $response Early response, or null to continue.
+	 * @param string                    $key      The license key being validated.
+	 * @param \Tribe__PUE__Checker|null $checker  The PUE checker instance.
+	 *
+	 * @return array|null
+	 */
+	public function filter_tribe_puc_pre_validate_key( $response, string $key, $checker ) {
+		if ( null !== $response ) {
+			return $response;
+		}
+
+		if ( ! $checker instanceof \Tribe__PUE__Checker ) {
+			return $response;
+		}
+
+		$slug = $checker->get_slug();
+
+		if ( $this->harbor->is_license_field_managed_by_harbor( $slug ) ) {
+			return [
+				'status'  => 1,
+				'message' => sprintf(
+					/* translators: URL to the Liquid Web License Manager */
+					__( 'Licensed via <a href="%s" target="_blank">Liquid Web License Manager</a>', 'tribe-common' ),
+					esc_url( lw_harbor_get_license_page_url() ),
+				),
+			];
+		}
+
+		if ( $this->harbor->is_unified_license_key( $key ) ) {
+			return [
+				'status'  => 0,
+				'message' => $this->harbor->get_unified_license_key_entry_error_message(),
+			];
+		}
+
+		return $response;
+	}
+
+	/**
+	 * Prevent storing unified license keys in per-product PUE options.
+	 *
+	 * Harbor-managed fields ignore submitted values so the unified key is not written
+	 * into product options. Unified keys pasted into non-managed fields are rejected
+	 * and the previously stored product key is kept.
+	 *
+	 * @since TBD
+	 *
+	 * @param mixed  $value    The field value about to be saved.
+	 * @param string $field_id The settings field ID.
+	 *
+	 * @return mixed
+	 */
+	public function prevent_storing_unified_license_key( $value, $field_id ) {
+		if ( ! is_string( $field_id ) || ! str_starts_with( $field_id, 'pue_install_key_' ) ) {
+			return $value;
+		}
+
+		$product = str_replace( [ 'pue_install_key_', '_' ], [ '', '-' ], $field_id );
+
+		if ( $this->harbor->is_license_field_managed_by_harbor( $product ) ) {
+			return $this->get_stored_product_license_key( $field_id );
+		}
+
+		if ( is_string( $value ) && $this->harbor->is_unified_license_key( $value ) ) {
+			return $this->get_stored_product_license_key( $field_id );
+		}
+
+		return $value;
+	}
+
+	/**
+	 * Get the stored product license key without Harbor option overlays.
+	 *
+	 * @since TBD
+	 *
+	 * @param string $option_name The option name.
+	 *
+	 * @return string
+	 */
+	private function get_stored_product_license_key( string $option_name ): string {
+		$had_filter = has_filter( 'pre_option', [ $this, 'filter_pre_get_option' ] );
+
+		if ( $had_filter ) {
+			remove_filter( 'pre_option', [ $this, 'filter_pre_get_option' ], 10 );
+		}
+
+		$stored = (string) get_option( $option_name, '' );
+
+		if ( $had_filter ) {
+			add_filter( 'pre_option', [ $this, 'filter_pre_get_option' ], 10, 3 );
+		}
+
+		return $stored;
 	}
 
 	/**
@@ -122,7 +273,19 @@ public function filter_pre_get_option( $value, $option, $default_value ) {
 	}
 
 	/**
-	 * Filter the pre HTTP request.
+	 * Short-circuit PUE license validation HTTP requests for Harbor-licensed products.
+	 *
+	 * Legacy PUE code (e.g. Tribe__PUE__Checker) validates license keys by POSTing to
+	 * `/api/plugins/v2/license/validate` on Stellar's licensing servers. For unified licensed
+	 * sites, the license is managed by Harbor and at the whole site level, so those remote
+	 * calls are unnecessary and may fail or return stale data.
+	 *
+	 * This filter intercepts those license validation requests via `pre_http_request` and returns
+	 * a synthetic HTTP 200 response shaped like the PUE API, built from Harbor's cached
+	 * license and catalog data.
+	 *
+	 * Only requests to the validate endpoint for products reported as licensed by Harbor
+	 * are intercepted. All other HTTP traffic is left unchanged.
 	 *
 	 * @since 6.11.0
 	 *

src/Common/Libraries/Harbor.php

@@ -20,6 +20,7 @@
 use function lw_harbor_get_unified_license_key;
 use function lw_harbor_is_feature_enabled;
 use function lw_harbor_is_feature_available;
+use function lw_harbor_is_capability_license_active;
 
 /**
  * Controller for setting up the Harbor library.
@@ -29,12 +30,21 @@
  * @package TEC\Common\Libraries\Harbor
  */
 class Harbor extends Controller_Contract {
+	/**
+	 * Prefix for Liquid Web unified license keys.
+	 *
+	 * @since 6.12.0
+	 *
+	 * @var string
+	 */
+	public const UNIFIED_LICENSE_KEY_PREFIX = 'LWSW-';
+
 	/**
 	 * The TEC product slug to Harbor product slug map.
 	 *
 	 * @since 6.11.0
 	 *
-	 * @var array
+	 * @var array<string, string>
 	 */
 	private const TEC_PRODUCT_SLUG_TO_HARBOR_PRODUCT_SLUG_MAP = [
 		'the-events-calendar'    => 'the-events-calendar',
@@ -232,7 +242,7 @@ public function register_legacy_licenses( array $licenses ): array {
 		return array_values(
 			array_filter(
 				$licenses,
-				static fn( array $license ): bool => ! empty( $license['key'] ) && ! str_starts_with( $license['key'], 'LWSW-' )
+				fn( array $license ): bool => ! empty( $license['key'] ) && ! $this->is_unified_license_key( $license['key'] )
 			)
 		);
 	}
@@ -265,6 +275,65 @@ public function is_product_licensed( string $product ): bool {
 		return lw_harbor_is_feature_available( $product );
 	}
 
+	/**
+	 * Whether a license key uses the unified Liquid Web format.
+	 *
+	 * @since 6.12.0
+	 *
+	 * @param string $key The license key.
+	 *
+	 * @return bool
+	 */
+	public function is_unified_license_key( string $key ): bool {
+		return str_starts_with( trim( $key ), self::UNIFIED_LICENSE_KEY_PREFIX );
+	}
+
+	/**
+	 * Whether a TEC product license field is managed by Harbor.
+	 *
+	 * When true, the unified license key should be shown read-only and should not
+	 * be validated through legacy PUE per-product fields.
+	 *
+	 * Checks that the product's license is actually active/valid for this site, not
+	 * merely that the customer's tier entitles them to it — a customer can be entitled
+	 * to a product without having activated it here, in which case a legacy per-product
+	 * key should still be accepted.
+	 *
+	 * @since 6.12.0
+	 * @since TBD Check per-site license activation of the product's capability via
+	 *            `lw_harbor_is_capability_license_active()` instead of tier entitlement via
+	 *            `is_product_licensed()`.
+	 *
+	 * @param string $tec_product_slug The TEC product slug.
+	 *
+	 * @return bool
+	 */
+	public function is_license_field_managed_by_harbor( string $tec_product_slug ): bool {
+		if ( ! lw_harbor_has_unified_license_key() ) {
+			return false;
+		}
+
+		return lw_harbor_is_capability_license_active(
+			$this->get_harbor_product_slug( $tec_product_slug )
+		);
+	}
+
+	/**
+	 * Error message shown when a unified license key is entered in a per-product field.
+	 *
+	 * @since 6.12.0
+	 *
+	 * @return string
+	 */
+	public function get_unified_license_key_entry_error_message(): string {
+		return sprintf(
+			/* translators: %1$s: opening anchor tag, %2$s: closing anchor tag. */
+			__( 'It seems to be a unified license key. Please %1$sclick here%2$s to enter it in the LW License Manager.', 'tribe-common' ),
+			'<a href="' . esc_url( lw_harbor_get_license_page_url() ) . '" target=_blank >',
+			'</a>'
+		);
+	}
+
 	/**
 	 * Get the unified license key if the feature is enabled.
 	 *

src/Tribe/PUE/Checker.php

@@ -1238,6 +1238,23 @@ public function validate_key( string $key, bool $network = false ): array {
 				return [];
 			}
 
+			/**
+			 * Filter early license key validation before remote PUE checks.
+			 *
+			 * Returning a non-null array short-circuits remote validation and is used as
+			 * the AJAX/validation response. Return null to continue normal validation.
+			 *
+			 * @since 6.12.0
+			 *
+			 * @param array|null          $response Early response, or null to continue.
+			 * @param string              $key      The license key being validated.
+			 * @param Tribe__PUE__Checker $checker  The PUE checker instance.
+			 */
+			$pre_validate = apply_filters( 'tribe_puc_pre_validate_key', null, $key, $this );
+			if ( is_array( $pre_validate ) ) {
+				return $pre_validate;
+			}
+
 			$uplink_resource = $this->get_uplink_resource( $this->get_slug() );
 
 			if ( $uplink_resource ) {