[9.x] Move maintenance mode logic (#40070)

* chore (maintenance): move maintenance mode logic

Moving the maintenance mode logic to its own class. This enables users to extend/overwrite the class with their own logic.

Overwriting the logic may be needed if for example the application is running on multiple servers.

Fixes #36474

* refactor (maintenance): add isUp method

Adding the isUp method to check if the application is up or is down for maintenance.

Relates to #36474

* doc (maintenance): document code

Extend the documentation about what the code does. Also use FQN.

Relates to #36474

* fix (maintenance): correctly check if in maintenance

Relates to #36474

* refactor (maintenance): use make method

Use the make method instead of the app function to retrieve an instance of the MaintenanceMode container.

Relates to #36474

* doc (maintenance): update docblock

Update the docblock with the newly added method param.

Relates to #36474

* doc (maintenance): update docblock

Update the docblock with the newly added method param.

Relates to #36474

* style (doc): update documentation style

Updating documentation style to comply to the style used within the Laravel codebase.

* style (doc): update documentation style

Updating documentation style to comply to the style used within the Laravel codebase.

* refactor (maintenance): change namespace

Move the class from its own namespace to the Foundation namespace.

Relates to #36474

* style (doc): update documentation style

Updating documentation style to comply to the style used within the Laravel codebase.

* style (doc): update documentation style

Updating documentation style to comply to the style used within the Laravel codebase.

* Update src/Illuminate/Foundation/Http/Middleware/PreventRequestsDuringMaintenance.php

Co-authored-by: Dries Vints <[email protected]>

* Update src/Illuminate/Foundation/Http/Middleware/PreventRequestsDuringMaintenance.php

Co-authored-by: Dries Vints <[email protected]>

* refactor (maintenance): move to application

Create an application methode to retrieve the MaintenanceMode instance. This method reduces the need to fetch the MaintenanceMode with the usage of an additional argument in the middleware.

Relates to #36474

* doc (maintenance): add DockBlock

Adding documentation for the newly added methods.

Relates to #36474

* refactor (maintenance): use application method

Use the application method instead of using autowiring. The application method provides the MaintenanceMode instance which removes the requirement to inject the class in the handler method.

Relates to #36474

* Update src/Illuminate/Foundation/MaintenanceMode.php

Co-authored-by: Dries Vints <[email protected]>

* Update src/Illuminate/Foundation/MaintenanceMode.php

Co-authored-by: Dries Vints <[email protected]>

* refactor (maintenance): remove comparison

Remove the comparison with the false value. The method always returns a bool which only allows a true or false return value. This make the comparison redundant.

Relates to #36474

* chore (code): remove unused import

Remove the unused import. Because the FQN is used in the DocBlock the import has become redundant.

* refactor (maintenance): add interface

Add an interface under the contracts to enable developers to easily extend the MaintenanceMode class.

* style (doc): update documentation style

Updating documentation style to comply to the style used within the Laravel codebase.

* refactor (maintenance): bind instance to contract

Bind the default MaintenanceMode class to the contract reference in the service container.

This enables users to set-up their own contract binding to overwrite the default Maintenance Mode behavior.

* style (doc): update documentation style

Updating documentation style to comply to the style used within the Laravel codebase.

* Update src/Illuminate/Foundation/Providers/FoundationServiceProvider.php

Co-authored-by: Choraimy Kroonstuiver <[email protected]>

* formatting and renaming

Co-authored-by: Wim Ulkeman <[email protected]>
Co-authored-by: Dries Vints <[email protected]>
Co-authored-by: Choraimy Kroonstuiver <[email protected]>
Co-authored-by: Taylor Otwell <[email protected]>

Author: 5 people

src/Illuminate/Contracts/Foundation/Application.php

@@ -83,6 +83,13 @@ public function runningInConsole();
      */
     public function runningUnitTests();
 
+    /**
+     * Get an instance of the maintenance mode manager implementation.
+     *
+     * @return \Illuminate\Contracts\Foundation\MaintenanceMode
+     */
+    public function maintenanceMode();
+
     /**
      * Determine if the application is currently down for maintenance.
      *

src/Illuminate/Contracts/Foundation/MaintenanceMode.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace Illuminate\Contracts\Foundation;
+
+interface MaintenanceMode
+{
+    /**
+     * Take the application down for maintenance.
+     *
+     * @param  array  $payload
+     * @return void
+     */
+    public function activate(array $payload): void;
+
+    /**
+     * Take the application out of maintenance.
+     *
+     * @return void
+     */
+    public function deactivate(): void;
+
+    /**
+     * Determine if the application is currently down for maintenance.
+     *
+     * @return bool
+     */
+    public function active(): bool;
+
+    /**
+     * Get the data array which was provided when the application was placed into maintenance.
+     *
+     * @return array
+     */
+    public function data(): array;
+}

src/Illuminate/Foundation/Application.php

@@ -7,6 +7,7 @@
 use Illuminate\Contracts\Foundation\Application as ApplicationContract;
 use Illuminate\Contracts\Foundation\CachesConfiguration;
 use Illuminate\Contracts\Foundation\CachesRoutes;
+use Illuminate\Contracts\Foundation\MaintenanceMode as MaintenanceModeContract;
 use Illuminate\Contracts\Http\Kernel as HttpKernelContract;
 use Illuminate\Events\EventServiceProvider;
 use Illuminate\Filesystem\Filesystem;
@@ -1105,14 +1106,24 @@ public function addAbsoluteCachePathPrefix($prefix)
         return $this;
     }
 
+    /**
+     * Get an instance of the maintenance mode manager implementation.
+     *
+     * @return \Illuminate\Contracts\Foundation\MaintenanceMode
+     */
+    public function maintenanceMode()
+    {
+        return $this->make(MaintenanceModeContract::class);
+    }
+
     /**
      * Determine if the application is currently down for maintenance.
      *
      * @return bool
      */
     public function isDownForMaintenance()
     {
-        return file_exists($this->storagePath().'/framework/down');
+        return $this->maintenanceMode()->active();
     }
 
     /**

src/Illuminate/Foundation/Console/DownCommand.php

@@ -47,16 +47,13 @@ class DownCommand extends Command
     public function handle()
     {
         try {
-            if (is_file(storage_path('framework/down'))) {
+            if ($this->laravel->maintenanceMode()->active()) {
                 $this->comment('Application is already down.');
 
                 return 0;
             }
 
-            file_put_contents(
-                storage_path('framework/down'),
-                json_encode($this->getDownFilePayload(), JSON_PRETTY_PRINT)
-            );
+            $this->laravel->maintenanceMode()->activate($this->getDownFilePayload());
 
             file_put_contents(
                 storage_path('framework/maintenance.php'),

src/Illuminate/Foundation/Console/UpCommand.php

@@ -39,13 +39,13 @@ class UpCommand extends Command
     public function handle()
     {
         try {
-            if (! is_file(storage_path('framework/down'))) {
+            if (! $this->laravel->maintenanceMode()->active()) {
                 $this->comment('Application is already up.');
 
                 return 0;
             }
 
-            unlink(storage_path('framework/down'));
+            $this->laravel->maintenanceMode()->deactivate();
 
             if (is_file(storage_path('framework/maintenance.php'))) {
                 unlink(storage_path('framework/maintenance.php'));

src/Illuminate/Foundation/FileBasedMaintenanceMode.php

@@ -0,0 +1,64 @@
+<?php
+
+namespace Illuminate\Foundation;
+
+use Illuminate\Contracts\Foundation\MaintenanceMode as MaintenanceModeContract;
+
+class FileBasedMaintenanceMode implements MaintenanceModeContract
+{
+    /**
+     * Take the application down for maintenance.
+     *
+     * @param  array  $payload
+     * @return void
+     */
+    public function activate(array $payload): void
+    {
+        file_put_contents(
+            $this->path(),
+            json_encode($payload, JSON_PRETTY_PRINT)
+        );
+    }
+
+    /**
+     * Take the application out of maintenance.
+     *
+     * @return void
+     */
+    public function deactivate(): void
+    {
+        if ($this->active()) {
+            unlink($this->path());
+        }
+    }
+
+    /**
+     * Determine if the application is currently down for maintenance.
+     *
+     * @return bool
+     */
+    public function active(): bool
+    {
+        return file_exists($this->path());
+    }
+
+    /**
+     * Get the data array which was provided when the application was placed into maintenance.
+     *
+     * @return array
+     */
+    public function data(): array
+    {
+        return json_decode(file_get_contents($this->path()), true);
+    }
+
+    /**
+     * Get the path where the file is stored that signals that the application is down for maintenance.
+     *
+     * @return string
+     */
+    protected function path(): string
+    {
+        return storage_path('framework/down');
+    }
+}

src/Illuminate/Foundation/Http/Middleware/PreventRequestsDuringMaintenance.php

@@ -45,8 +45,8 @@ public function __construct(Application $app)
      */
     public function handle($request, Closure $next)
     {
-        if ($this->app->isDownForMaintenance()) {
-            $data = json_decode(file_get_contents($this->app->storagePath().'/framework/down'), true);
+        if ($this->app->maintenanceMode()->active()) {
+            $data = $this->app->maintenanceMode()->data();
 
             if (isset($data['secret']) && $request->path() === $data['secret']) {
                 return $this->bypassResponse($data['secret']);

src/Illuminate/Foundation/Providers/FoundationServiceProvider.php

@@ -2,6 +2,9 @@
 
 namespace Illuminate\Foundation\Providers;
 
+use Illuminate\Contracts\Foundation\MaintenanceMode as MaintenanceModeContract;
+use Illuminate\Foundation\FileBasedMaintenanceMode;
+use Illuminate\Foundation\MaintenanceMode;
 use Illuminate\Http\Request;
 use Illuminate\Log\Events\MessageLogged;
 use Illuminate\Support\AggregateServiceProvider;
@@ -48,6 +51,7 @@ public function register()
         $this->registerRequestValidation();
         $this->registerRequestSignatureValidation();
         $this->registerExceptionTracking();
+        $this->registerMaintenanceModeManager();
     }
 
     /**
@@ -117,4 +121,14 @@ protected function registerExceptionTracking()
             }
         });
     }
+
+    /**
+     * Register the maintenance mode manager service.
+     *
+     * @return void
+     */
+    public function registerMaintenanceModeManager()
+    {
+        $this->app->bind(MaintenanceModeContract::class, FileBasedMaintenanceMode::class);
+    }
 }