Merge pull request #436 from canyongbs/advapp-184

[ADVAPP-184]: Unlicensed user should see a message on the dashboard that indicates they do not have an active license

app-modules/authorization/resources/views/filament/widgets/unlicensed-notice.blade.php

@@ -0,0 +1,49 @@
+{{--
+<COPYRIGHT>
+
+    Copyright © 2022-2023, Canyon GBS LLC. All rights reserved.
+
+    Advising App™ is licensed under the Elastic License 2.0. For more details,
+    see https://github.com/canyongbs/advisingapp/blob/main/LICENSE.
+
+    Notice:
+
+    - You may not provide the software to third parties as a hosted or managed
+      service, where the service provides users with access to any substantial set of
+      the features or functionality of the software.
+    - You may not move, change, disable, or circumvent the license key functionality
+      in the software, and you may not remove or obscure any functionality in the
+      software that is protected by the license key.
+    - You may not alter, remove, or obscure any licensing, copyright, or other notices
+      of the licensor in the software. Any use of the licensor’s trademarks is subject
+      to applicable law.
+    - Canyon GBS LLC respects the intellectual property rights of others and expects the
+      same in return. Canyon GBS™ and Advising App™ are registered trademarks of
+      Canyon GBS LLC, and we are committed to enforcing and protecting our trademarks
+      vigorously.
+    - The software solution, including services, infrastructure, and code, is offered as a
+      Software as a Service (SaaS) by Canyon GBS LLC.
+    - Use of this software implies agreement to the license terms and conditions as stated
+      in the Elastic License 2.0.
+
+    For more information or inquiries please visit our website at
+    https://www.canyongbs.com or contact us via email at legal@canyongbs.com.
+
+</COPYRIGHT>
+--}}
+<x-filament-widgets::widget>
+    <x-filament::section class="!bg-warning-50 dark:!bg-gray-900">
+        <div class="flex gap-3">
+            <div class="flex-shrink-0">
+                <x-heroicon-o-exclamation-triangle
+                    class="h-5 w-5 text-warning-400"
+                    aria-hidden="true"
+                />
+            </div>
+
+            <h3 class="text-sm font-medium text-warning-800 dark:text-warning-200">
+                Your account currently does not have a license to access features in Advising App.
+            </h3>
+        </div>
+    </x-filament::section>
+</x-filament-widgets::widget>

app-modules/authorization/src/AuthorizationPlugin.php

@@ -58,6 +58,10 @@ public function register(Panel $panel): void
                 in: __DIR__ . '/Filament/Resources',
                 for: 'AdvisingApp\\Authorization\\Filament\\Resources'
             )
+            ->discoverWidgets(
+                in: __DIR__ . '/Filament/Widgets',
+                for: 'AdvisingApp\\Authorization\\Filament\\Widgets'
+            )
             ->databaseNotifications()
             ->databaseNotificationsPolling('10s')
             ->authMiddleware([

app-modules/authorization/src/Filament/Widgets/UnlicensedNotice.php

@@ -0,0 +1,58 @@
+<?php
+
+/*
+<COPYRIGHT>
+
+    Copyright © 2022-2023, Canyon GBS LLC. All rights reserved.
+
+    Advising App™ is licensed under the Elastic License 2.0. For more details,
+    see https://github.com/canyongbs/advisingapp/blob/main/LICENSE.
+
+    Notice:
+
+    - You may not provide the software to third parties as a hosted or managed
+      service, where the service provides users with access to any substantial set of
+      the features or functionality of the software.
+    - You may not move, change, disable, or circumvent the license key functionality
+      in the software, and you may not remove or obscure any functionality in the
+      software that is protected by the license key.
+    - You may not alter, remove, or obscure any licensing, copyright, or other notices
+      of the licensor in the software. Any use of the licensor’s trademarks is subject
+      to applicable law.
+    - Canyon GBS LLC respects the intellectual property rights of others and expects the
+      same in return. Canyon GBS™ and Advising App™ are registered trademarks of
+      Canyon GBS LLC, and we are committed to enforcing and protecting our trademarks
+      vigorously.
+    - The software solution, including services, infrastructure, and code, is offered as a
+      Software as a Service (SaaS) by Canyon GBS LLC.
+    - Use of this software implies agreement to the license terms and conditions as stated
+      in the Elastic License 2.0.
+
+    For more information or inquiries please visit our website at
+    https://www.canyongbs.com or contact us via email at legal@canyongbs.com.
+
+</COPYRIGHT>
+*/
+
+namespace AdvisingApp\Authorization\Filament\Widgets;
+
+use Filament\Widgets\Widget;
+use App\Models\Authenticatable;
+use AdvisingApp\Authorization\Enums\LicenseType;
+
+class UnlicensedNotice extends Widget
+{
+    protected static string $view = 'authorization::filament.widgets.unlicensed-notice';
+
+    protected static bool $isLazy = false;
+
+    protected int | string | array $columnSpan = 'full';
+
+    public static function canView(): bool
+    {
+        /** @var Authenticatable $user */
+        $user = auth()->user();
+
+        return ! $user->hasAnyLicense(LicenseType::cases());
+    }
+}

app/Filament/Pages/Dashboard.php

@@ -48,6 +48,7 @@
 use App\Filament\Widgets\ProspectGrowthChart;
 use App\Filament\Widgets\RecentProspectsList;
 use App\Filament\Widgets\RecentKnowledgeBaseArticlesList;
+use AdvisingApp\Authorization\Filament\Widgets\UnlicensedNotice;
 
 class Dashboard extends BasePage
 {
@@ -60,25 +61,35 @@ public function getWidgets(): array
         /** @var User $user */
         $user = auth()->user();
 
-        return $user->can('authorization.view_dashboard') ? [
-            //1
-            WelcomeWidget::class,
-            //2
-            TotalStudents::class,
-            TotalProspects::class,
-            MyStudents::class,
-            MyProspects::class,
-            //3
-            ProspectGrowthChart::class,
-            //4
-            RecentProspectsList::class,
-            RecentKnowledgeBaseArticlesList::class,
-            //5
-            MyServiceRequests::class,
-            MyTasks::class,
-        ] : [
+        $widgets = [
             WelcomeWidget::class,
         ];
+
+        if (UnlicensedNotice::canView()) {
+            $widgets[] = UnlicensedNotice::class;
+        }
+
+        if ($user->can('authorization.view_dashboard')) {
+            $widgets = [
+                // 1
+                ...$widgets,
+                // 2
+                TotalStudents::class,
+                TotalProspects::class,
+                MyStudents::class,
+                MyProspects::class,
+                // 3
+                ProspectGrowthChart::class,
+                // 4
+                RecentProspectsList::class,
+                RecentKnowledgeBaseArticlesList::class,
+                // 5
+                MyServiceRequests::class,
+                MyTasks::class,
+            ];
+        }
+
+        return $widgets;
     }
 
     public function getColumns(): int | string | array

app/Filament/Widgets/WelcomeWidget.php

@@ -42,5 +42,7 @@ class WelcomeWidget extends Widget
 {
     protected static string $view = 'filament.widgets.welcome-widget';
 
+    protected static bool $isLazy = false;
+
     protected int | string | array $columnSpan = 'full';
 }