added read-only mode #28nd2px

app/Http/Kernel.php

@@ -54,6 +54,7 @@ class Kernel extends HttpKernel
             'permission:read-api',
             'company.identify',
             'bindings',
+            'read.only',
             'language',
             'firewall.all',
         ],
@@ -62,12 +63,14 @@ class Kernel extends HttpKernel
             'web',
             'company.identify',
             'bindings',
+            'read.only',
             'wizard.redirect',
         ],
 
         'guest' => [
             'web',
             'auth.redirect',
+            'read.only',
         ],
 
         'admin' => [
@@ -76,6 +79,7 @@ class Kernel extends HttpKernel
             'auth.disabled',
             'company.identify',
             'bindings',
+            'read.only',
             'wizard.redirect',
             'menu.admin',
             'permission:read-admin-panel',
@@ -96,6 +100,7 @@ class Kernel extends HttpKernel
             'auth.disabled',
             'company.identify',
             'bindings',
+            'read.only',
             'menu.portal',
             'permission:read-client-portal',
         ],
@@ -109,6 +114,7 @@ class Kernel extends HttpKernel
             'signature',
             'company.identify',
             'bindings',
+            'read.only',
             'header.x',
             'language',
             'firewall.all',
@@ -157,6 +163,7 @@ class Kernel extends HttpKernel
         'install.can' => \App\Http\Middleware\CanInstall::class,
         'install.redirect' => \App\Http\Middleware\RedirectIfNotInstalled::class,
         'money' => \App\Http\Middleware\Money::class,
+        'read.only' => \App\Http\Middleware\CheckForReadOnlyMode::class,
         'wizard.redirect' => \App\Http\Middleware\RedirectIfWizardNotCompleted::class,
 
         // Vendor

app/Http/Middleware/CheckForReadOnlyMode.php

@@ -0,0 +1,68 @@
+<?php
+
+namespace App\Http\Middleware;
+
+use Closure;
+use Illuminate\Http\Request;
+use Illuminate\Http\Response;
+
+class CheckForReadOnlyMode
+{
+    /**
+     * Handle an incoming request.
+     *
+     * @param  \Illuminate\Http\Request  $request
+     * @param  \Closure  $next
+     * @return mixed
+     */
+    public function handle(Request $request, Closure $next)
+    {
+        if (! config('read-only.enabled')) {
+            return $next($request);
+        }
+
+        if (config('read-only.allow_login')) {
+            $is_login = $request->routeIs(config('read-only.login_route'));
+            $is_logout = $request->routeIs(config('read-only.logout_route'));
+
+            if ($is_login || $is_logout) {
+                return $next($request);
+            }
+        }
+
+        foreach (config('read-only.whitelist') as $method => $route) {
+            if (! $request->isMethod($method) || ! $request->routeIs($route)) {
+                continue;
+            }
+
+            return $next($request);
+        }
+
+        foreach (config('read-only.livewire') as $path) {
+            $url = company_id() . '/livewire/message/' . $path;
+
+            if (! $request->isMethod('post') || ! $request->is($url)) {
+                continue;
+            }
+
+            return $next($request);
+        }
+
+        foreach (config('read-only.methods') as $method) {
+            if (! $request->isMethod(strtolower($method))) {
+                continue;
+            }
+
+            //abort(Response::HTTP_UNAUTHORIZED);
+
+            return response()->json([
+                'success' => false,
+                'error' => true,
+                'data' => null,
+                'message' => trans('maintenance.read_only'),
+            ], Response::HTTP_UNAUTHORIZED);
+        }
+
+        return $next($request);
+    }
+}

app/Http/ViewComposers/ReadOnlyNotification.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace App\Http\ViewComposers;
+
+use Illuminate\View\View;
+
+class ReadOnlyNotification
+{
+    public function compose(View $view): void
+    {
+        if (! config('read-only.enabled')) {
+            return;
+        }
+
+        $view->getFactory()->startPush('content_content_start', view('partials.read-only'));
+    }
+}

app/Listeners/Common/SkipScheduleInReadOnlyMode.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace App\Listeners\Common;
+
+use Illuminate\Console\Events\CommandStarting as Event;
+use Illuminate\Console\Scheduling\Schedule;
+
+class SkipScheduleInReadOnlyMode
+{
+    /**
+     * Handle the event.
+     *
+     * @param  $event
+     * @return void
+     */
+    public function handle(Event $event)
+    {
+        if (! config('read-only.enabled')) {
+            return;
+        }
+
+        //$event->task->skip(true);
+
+        $schedule = app(Schedule::class);
+
+        foreach ($schedule->events() as $task) {
+            $task->skip(true);
+        }
+    }
+}

app/Providers/Blade.php

@@ -24,6 +24,10 @@ class Blade extends ServiceProvider
         Facade::directive('widget', function ($expression) {
             return "<?php echo show_widget($expression); ?>";
         });
+
+        Facade::if('readonly', function () {
+            return config('read-only.enabled');
+        });
     }
 
     /**

app/Providers/Event.php

@@ -48,6 +48,10 @@ class Event extends Provider
         'Illuminate\Auth\Events\Logout' => [
             'App\Listeners\Auth\Logout',
         ],
+        //'Illuminate\Console\Events\ScheduledTaskStarting' => [
+        'Illuminate\Console\Events\CommandStarting' => [
+            'App\Listeners\Common\SkipScheduleInReadOnlyMode',
+        ],
         'App\Events\Auth\LandingPageShowing' => [
             'App\Listeners\Auth\AddLandingPages',
         ],

app/Providers/ViewComposer.php

@@ -66,6 +66,11 @@ class ViewComposer extends Provider
         View::composer(
             'layouts.wizard', 'App\Http\ViewComposers\Wizard'
         );
+
+        View::composer(
+            ['partials.admin.content'],
+            'App\Http\ViewComposers\ReadOnlyNotification'
+        );
     }
 
     /**

config/read-only.php

@@ -0,0 +1,50 @@
+<?php
+
+return [
+
+    /*
+    |--------------------------------------------------------------------------
+    | Flag to enable/disable read-only mode from the .env file
+    |--------------------------------------------------------------------------
+    */
+    'enabled'       => env('READ_ONLY_ENABLED', false),
+
+    /*
+    |--------------------------------------------------------------------------
+    | Enable read-only mode but still allow users to login
+    |--------------------------------------------------------------------------
+    */
+    'allow_login'   => env('READ_ONLY_LOGIN', true),
+
+    /*
+    |--------------------------------------------------------------------------
+    | The login/logout routes to allow if allow_login=true
+    |--------------------------------------------------------------------------
+    */
+    'login_route'   => 'login.store',
+    'logout_route'  => 'logout',
+
+    /*
+    |--------------------------------------------------------------------------
+    | The request methods that you want to block
+    |--------------------------------------------------------------------------
+    */
+    'methods'       => explode(',', env('READ_ONLY_METHODS', 'post,put,patch,delete')),
+
+    /*
+    |--------------------------------------------------------------------------
+    | Whitelist certain request methods to certain routes
+    |--------------------------------------------------------------------------
+    */
+    'whitelist' => [
+        // 'post'   => 'dashboard',
+    ],
+
+    /*
+    |--------------------------------------------------------------------------
+    | Skip livewire paths
+    |--------------------------------------------------------------------------
+    */
+    'livewire'      => explode(',', env('READ_ONLY_LIVEWIRE', 'common.search')),
+
+];

resources/lang/en-GB/maintenance.php

@@ -6,4 +6,6 @@ return [
 
     'message' => 'Sorry, we\'re down for maintenance. Please, try again later!',
 
+    'read_only' => 'Read-only mode is enabled. You are allowed to view but not change anything!',
+
 ];

resources/views/partials/read-only.blade.php

@@ -0,0 +1,3 @@
+<div class="alert alert-warning" role="alert">
+  {{ trans('maintenance.read_only') }}
+</div>

routes/guest.php

@@ -11,10 +11,10 @@ use Illuminate\Support\Facades\Route;
 
 Route::group(['prefix' => 'auth'], function () {
     Route::get('login', 'Auth\Login@create')->name('login');
-    Route::post('login', 'Auth\Login@store');
+    Route::post('login', 'Auth\Login@store')->name('login.store');
 
     Route::get('forgot', 'Auth\Forgot@create')->name('forgot');
-    Route::post('forgot', 'Auth\Forgot@store');
+    Route::post('forgot', 'Auth\Forgot@store')->name('forgot.store');
 
     //Route::get('reset', 'Auth\Reset@create');
     Route::get('reset/{token}', 'Auth\Reset@create')->name('reset');