Manage api from Cachet Settings page (#235)

database/migrations/2025_02_09_073310_add_api_settings.php

@@ -0,0 +1,25 @@
+<?php
+
+use Spatie\LaravelSettings\Migrations\SettingsMigration;
+
+return new class extends SettingsMigration
+{
+    /**
+     * Run the migrations.
+     */
+    public function up(): void
+    {
+        // Theme settings...
+        rescue(fn () => $this->migrator->add('app.api_enabled', true));
+        rescue(fn () => $this->migrator->add('app.api_protected', false));
+    }
+    /**
+     * Run the migrations.
+     */
+    public function down(): void
+    {
+        // Theme settings...
+        rescue(fn () => $this->migrator->deleteIfExists('app.api_enabled'));
+        rescue(fn () => $this->migrator->deleteIfExists('app.api_protected'));
+    }
+};

database/seeders/DatabaseSeeder.php

@@ -222,6 +222,8 @@ public function run(): void
         $appSettings->major_outage_threshold = 25;
         $appSettings->recent_incidents_only = false;
         $appSettings->recent_incidents_days = 7;
+        $appSettings->api_enabled = true;
+        $appSettings->api_protected = false;
         $appSettings->save();
 
         $customizationSettings = app(CustomizationSettings::class);

resources/lang/de/settings.php

@@ -18,6 +18,8 @@
             'only_show_disrupted_days' => 'Nur Tage mit Vorfällen anzeigen',
             'recent_incidents_only' => 'Nur aktuelle Vorfälle anzeigen',
             'recent_incidents_days' => 'Anzahl der Tage, an denen aktuelle Vorfälle angezeigt werden sollen',
+            'api_enabled' => 'API aktiviert',
+            'api_protected' => 'API erfordert Authentifizierung',
         ],
     ],
     'manage_customization' => [

resources/lang/de_AT/settings.php

@@ -18,6 +18,8 @@
             'only_show_disrupted_days' => 'Nur Tage mit Vorfällen anzeigen',
             'recent_incidents_only' => 'Nur aktuelle Vorfälle anzeigen',
             'recent_incidents_days' => 'Anzahl der Tage, an denen aktuelle Vorfälle angezeigt werden sollen',
+            'api_enabled' => 'API aktiviert',
+            'api_protected' => 'API erfordert Authentifizierung',
         ],
     ],
     'manage_customization' => [

resources/lang/de_CH/settings.php

@@ -18,6 +18,8 @@
             'only_show_disrupted_days' => 'Nur Tage mit Vorfällen anzeigen',
             'recent_incidents_only' => 'Nur aktuelle Vorfälle anzeigen',
             'recent_incidents_days' => 'Anzahl der Tage, an denen aktuelle Vorfälle angezeigt werden sollen',
+            'api_enabled' => 'API aktiviert',
+            'api_protected' => 'API erfordert Authentifizierung',
         ],
     ],
     'manage_customization' => [

resources/lang/en/settings.php

@@ -18,6 +18,8 @@
             'only_show_disrupted_days' => 'Only Show Disrupted Days',
             'recent_incidents_only' => 'Show Recent Incidents Only',
             'recent_incidents_days' => 'Number of Days to Show Recent Incidents',
+            'api_enabled' => 'API Enabled',
+            'api_protected' => 'API requires authentication',
         ],
     ],
     'manage_customization' => [

resources/lang/nl/settings.php

@@ -18,6 +18,8 @@
             'only_show_disrupted_days' => 'Alleen dagen met incidenten weergeven',
             'recent_incidents_only' => 'Toon alleen actuele incidenten',
             'recent_incidents_days' => 'Aantal dagen waarop actuele incidenten moeten worden weergegeven',
+            'api_enabled' => 'API geactiveerd',
+            'api_protected' => 'API authenticatie vereist',
         ],
     ],
     'manage_customization' => [

resources/lang/ph/settings.php

@@ -18,6 +18,8 @@
             'only_show_disrupted_days' => 'Ipakita lamang ang Mga Araw ng Pagka-aberya',
             'recent_incidents_only' => 'Ipakita lamang ang Mga Kamakailang Insidente',
             'recent_incidents_days' => 'Bilang ng Araw para Ipakita ang Mga Kamakailang Insidente',
+            'api_enabled' => 'Api Pinagana',
+            'api_protected' => 'Ang Api ay nangangailangan ng pagpapatunay',
         ],
     ],
     'manage_customization' => [

resources/lang/pt_BR/settings.php

@@ -18,6 +18,8 @@
             'only_show_disrupted_days' => 'Exibir Apenas Dias com Interrupções',
             'recent_incidents_only' => 'Exibir Apenas Incidentes Recentes',
             'recent_incidents_days' => 'Número de Dias para Exibir Incidentes Recentes',
+            'api_enabled' => 'API Ativada',
+            'api_protected' => 'API requer autenticação',
         ],
     ],
     'manage_customization' => [

resources/lang/zh_CN/settings.php

@@ -18,6 +18,11 @@
             'only_show_disrupted_days' => '仅显示受干扰天数',
             'recent_incidents_only' => '仅显示最近事件',
             'recent_incidents_days' => '显示最近事件的天数',
+            'manage_customization' => [
+                'header_label' => '自定义 Header HTML',
+                'footer_label' => '自定义 Footer HTML',
+                'stylesheet_label' => '自定义 CSS',
+            ],
         ],
     ],
     'manage_customization' => [

resources/lang/zh_TW/settings.php

@@ -18,6 +18,8 @@
             'only_show_disrupted_days' => '僅顯示受干擾天數',
             'recent_incidents_only' => '僅顯示最近事件',
             'recent_incidents_days' => '顯示最近事件的天數',
+            'api_enabled' => '啟用 Api',
+            'api_protected' => 'Api 需要身份驗證',
         ],
     ],
     'manage_customization' => [

src/CachetCoreServiceProvider.php

@@ -26,6 +26,7 @@
 use Illuminate\Support\Facades\RateLimiter;
 use Illuminate\Support\Facades\Route;
 use Illuminate\Support\ServiceProvider;
+use Spatie\LaravelSettings\Exceptions\MissingSettings;
 use Spatie\WebhookServer\Events\WebhookCallFailedEvent;
 use Spatie\WebhookServer\Events\WebhookCallSucceededEvent;
 
@@ -111,14 +112,36 @@ private function configureRateLimiting(): void
     private function registerRoutes(): void
     {
         $this->callAfterResolving('router', function (Router $router, Application $application) {
-            $router->group([
-                'domain' => config('cachet.domain'),
-                'as' => 'cachet.api.',
-                'prefix' => Cachet::path().'/api',
-                'middleware' => ['cachet:api', 'throttle:cachet-api'],
-            ], function (Router $router) {
-                $this->loadRoutesFrom(__DIR__.'/../routes/api.php');
-            });
+            $apiEnabled = true;
+            $apiProtected = false;
+            try {
+                $settings = app(AppSettings::class);
+                $apiEnabled = $settings->api_enabled;
+                $apiProtected = $settings->api_protected;
+
+            } catch (MissingSettings $exception) {
+                if(! $application->runningInConsole()) {
+                    throw new \Exception("Please run `php artisan migrate` to load missing settings.");
+                }
+            } catch (\Exception $exception) {
+                // do nothing
+            }
+
+            if ($apiEnabled) {
+                $middleware = ['cachet:api', 'throttle:cachet-api'];
+                if ($apiProtected) {
+                    $middleware[] = 'auth:sanctum';
+                }
+
+                $router->group([
+                    'domain' => config('cachet.domain'),
+                    'as' => 'cachet.api.',
+                    'prefix' => Cachet::path().'/api',
+                    'middleware' => $middleware,
+                ], function (Router $router) {
+                    $this->loadRoutesFrom(__DIR__.'/../routes/api.php');
+                });
+            }
 
             Cachet::routes()
                 ->register();

src/Filament/Pages/Settings/ManageCachet.php

@@ -84,6 +84,8 @@ public function form(Form $form): Form
                         ->label(__('cachet::settings.manage_cachet.toggles.only_show_disrupted_days')),
                     Forms\Components\Toggle::make('dashboard_login_link')
                         ->label(__('cachet::settings.manage_cachet.toggles.show_dashboard_link')),
+
+
                     Forms\Components\Grid::make(2)
                         ->schema([
                             Forms\Components\Toggle::make('recent_incidents_only')
@@ -98,6 +100,18 @@ public function form(Form $form): Form
                                 ->suffix(__('cachet::settings.manage_cachet.recent_incidents_days_suffix_days'))
                                 ->hidden(fn (Get $get) => $get('recent_incidents_only') !== true),
                         ]),
+
+
+                    Forms\Components\Grid::make(2)
+                        ->schema([
+                            Forms\Components\Toggle::make('api_enabled')
+                                ->label(__('cachet::settings.manage_cachet.toggles.api_enabled'))
+                                ->reactive(),
+                            Forms\Components\Toggle::make('api_protected')
+                                ->label(__('cachet::settings.manage_cachet.toggles.api_protected'))
+                                ->visible(fn (Get $get) => $get('api_enabled'))
+                                ->reactive(),
+                        ]),
                 ]),
             ]);
     }

src/Settings/AppSettings.php

@@ -32,6 +32,10 @@ class AppSettings extends Settings
 
     public int $recent_incidents_days = 7;
 
+    public bool $api_enabled = true;
+
+    public bool $api_protected = false;
+
     public static function group(): string
     {
         return 'app';