feat: enhance license verification with detailed failure reasons

Author: cklei-carly

src/Http/Middleware/LicenseCheck.php

@@ -29,18 +29,18 @@ public function handle(Request $request, Closure $next)
                 ], 403);
             }
 
-            $this->addWarningAlert();
+            $this->addWarningAlert($result->getReason());
         }
 
         return $next($request);
     }
 
-    private function addWarningAlert()
+    private function addWarningAlert($reason = null)
     {
         FilamentView::registerRenderHook(
             PanelsRenderHook::BODY_START,
-            function () {
-                $alert = Alert::make(fn () => (string) __('inspirecms::messages.invalid_license'))
+            function () use ($reason) {
+                $alert = Alert::make(fn () => str_contains($reason, 'expired') ? 'License has expired. Please renew your license.' : __('inspirecms::messages.invalid_license'))
                     ->type('warn')
                     ->size('sm')
                     ->withAttributes([

src/Licensing/LicenseManager.php

@@ -42,7 +42,9 @@ public function canUpgrade(): bool
                 if (($verificationResult = $this->cache()->get($cacheKey)) && $verificationResult instanceof LicenseVerificationResult) {
                     $data = $verificationResult->getData();
 
-                    return ($data['custom_data']['can_upgrade'] ?? false) === true;
+                    $pvSlug = data_get($data, 'meta.product_variant_slug', '');
+
+                    return is_string($pvSlug) && $pvSlug == 'free';
                 }
 
             } catch (\Throwable $th) {
@@ -72,7 +74,7 @@ public function verify()
             return $offlineResult;
         }
 
-        $failedMessage = null;
+        $failedReason = null;
 
         try {
 
@@ -82,6 +84,7 @@ public function verify()
             $response = Http::timeout(self::REQUEST_TIMEOUT)->post($this->fetchActionPath('validate'), $payload);
 
             if ($response->successful()) {
+                
                 $data = $response->json();
 
                 if ($data['valid'] === true) {
@@ -100,7 +103,7 @@ public function verify()
 
                     return $result;
                 } else {
-                    $failedMessage = $data['reason'] ?? null;
+                    $failedReason = $data['reason'] ?? null;
                 }
             }
 
@@ -111,9 +114,8 @@ public function verify()
         }
 
         return LicenseVerificationResult::failureOnline(
-            str('License verification failed')->finish(
-                $failedMessage ? ": {$failedMessage}" : ''
-            )->toString(),
+            message: 'License verification failed',
+            reason: $failedReason,
         );
     }
 
@@ -140,7 +142,7 @@ public function getSupportEmail(): ?string
     protected function verifyOffline()
     {
         if (! $this->usingLicenseKeyFile()) {
-            return LicenseVerificationResult::failureOffline('License file not found');
+            return LicenseVerificationResult::failureOffline(message: 'License file not found');
         }
 
         try {
@@ -153,7 +155,7 @@ protected function verifyOffline()
 
             logger()->warning('Failed to read license file', ['exception' => $th]);
 
-            return LicenseVerificationResult::failureOffline('Failed to read license file');
+            return LicenseVerificationResult::failureOffline(message: 'Failed to read license file');
 
         }
     }
@@ -162,22 +164,22 @@ protected function dataVerification($licenseData): ?LicenseVerificationResult
     {
         // Verify the license key is the same
         if ($licenseData['license_key'] !== $this->getLicenseKey()) {
-            return LicenseVerificationResult::failureOffline('The license key in the file does not match the configured license key');
+            return LicenseVerificationResult::failureOffline(reason: 'The license key in the file does not match the configured license key');
         }
 
         // Verify the data is for the current domain
         if ($licenseData['domain'] !== $this->getCurrentDomain()) {
-            return LicenseVerificationResult::failureOffline('License file does not match the current domain');
+            return LicenseVerificationResult::failureOffline(reason: 'domain_mismatch');
         }
 
         // Verify the license is not expired
         if (Carbon::parse($licenseData['expiry_date'])->isPast(Carbon::now('UTC'))) {
-            return LicenseVerificationResult::failureOffline('License expired');
+            return LicenseVerificationResult::failureOffline(reason: 'expired');
         }
 
         // Verify the checksum
         if ($licenseData['checksum'] !== $this->calculateChecksum(Arr::except($licenseData, 'checksum'))) {
-            return LicenseVerificationResult::failureOffline('License file verification failed due to checksum mismatch');
+            return LicenseVerificationResult::failureOffline(reason: 'checksum mismatch');
         }
 
         return null;

src/Licensing/LicenseVerificationResult.php

@@ -7,14 +7,16 @@ class LicenseVerificationResult
     /**
      * @param  bool  $isSuccess  Whether the license verification was successful
      * @param  string  $message  The verification message or error details
+     * @param  ?string  $reason  Optional reason for failure, if applicable
      * @param  bool  $isOnline  Whether the license verification was performed online
      */
     public function __construct(
         protected bool $isSuccess,
         protected string $message = '',
+        protected ?string $reason = null,
         protected bool $isOnline = false,
         /** @var ?array */
-        protected $data = null
+        protected $data = null,
     ) {
         if (! is_array($data)) {
             unset($this->data);
@@ -42,36 +44,41 @@ public function getData(): ?array
         return $this->data;
     }
 
+    public function getReason(): ?string
+    {
+        return $this->reason;
+    }
+
     /**
      * Create a successful online verification result.
      */
     public static function successOnline(?string $message = null, $data = null): static
     {
-        return new static(true, $message ?? 'License is valid (online)', true, $data);
+        return new static(isSuccess: true, message: $message ?? 'License is valid (online)', isOnline: true, data: $data);
     }
 
     /**
      * Create a successful offline verification result.
      */
     public static function successOffline(?string $message = null, $data = null): static
     {
-        return new static(true, $message ?? 'License is valid (offline)', false, $data);
+        return new static(isSuccess: true, message: $message ?? 'License is valid (offline)', isOnline: false, data: $data);
     }
 
     /**
      * Create a failed online verification result.
      */
-    public static function failureOnline(string $message, $data = null): static
+    public static function failureOnline(?string $message = null, $reason = null, $data = null): static
     {
-        return new static(false, $message, true, $data);
+        return new static(isSuccess: false, message: $message ?? 'License verification failed (online)', reason: $reason, isOnline: true, data: $data);
     }
 
     /**
      * Create a failed offline verification result.
      */
-    public static function failureOffline(string $message, $data = null): static
+    public static function failureOffline(?string $message = null, $reason = null, $data = null): static
     {
-        return new static(false, $message, false, $data);
+        return new static(isSuccess: false, message: $message ?? 'License verification failed (offline)', reason: $reason, isOnline: false, data: $data);
     }
 
     /**