├── .gitignore
├── .gitattributes
├── ArtgrisMaintenanceBundle.php
├── Resources
    ├── config
    │   └── services.yml
    └── views
    │   └── maintenance.html.twig
├── Tests
    └── MaintenanceTest.php
├── composer.json
├── .php_cs
├── DependencyInjection
    ├── ArtgrisMaintenanceExtension.php
    └── Configuration.php
├── README.md
├── EventListener
    └── MaintenanceListener.php
└── index.html


/.gitignore:
--------------------------------------------------------------------------------
1 | .idea/
2 | 


--------------------------------------------------------------------------------
/.gitattributes:
--------------------------------------------------------------------------------
1 | *.html  linguist-vendored


--------------------------------------------------------------------------------
/ArtgrisMaintenanceBundle.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Artgris\MaintenanceBundle;
 4 | 
 5 | use Symfony\Component\HttpKernel\Bundle\Bundle;
 6 | 
 7 | class ArtgrisMaintenanceBundle extends Bundle
 8 | {
 9 | }
10 | 


--------------------------------------------------------------------------------
/Resources/config/services.yml:
--------------------------------------------------------------------------------
1 | services:
2 |     maintenance_listener:
3 |         class: Artgris\MaintenanceBundle\EventListener\MaintenanceListener
4 |         arguments: ['%artgris_maintenance%', '@kernel', '@twig']
5 |         tags:
6 |             - { name: kernel.event_listener, event: kernel.request, method: onKernelRequest }


--------------------------------------------------------------------------------
/Tests/MaintenanceTest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | 
 4 | namespace Artgris\MaintenanceBundle\Tests;
 5 | 
 6 | 
 7 | use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;
 8 | use Symfony\Component\HttpFoundation\Response;
 9 | 
10 | /**
11 |  * Maintenance Test
12 |  *
13 |  * @author Arthur Gribet <a.gribet@gmail.com>
14 |  */
15 | class MaintenanceTest extends WebTestCase
16 | {
17 | 	public function testMaintenance()
18 | 	{
19 | 		$client = static::createClient();
20 | 		$client->request('GET', '/');
21 | 		static::assertEquals(
22 | 			Response::HTTP_SERVICE_UNAVAILABLE,
23 | 			$client->getResponse()->getStatusCode());
24 | 	}
25 | 
26 | }


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "artgris/maintenance-bundle",
 3 |   "type": "symfony-bundle",
 4 |   "description": "Symfony Bundle to place your Symfony website in maintenance mode",
 5 |   "keywords": [
 6 |     "symfony",
 7 |     "maintenance",
 8 |     "bundle"
 9 |   ],
10 |   "homepage": "https://github.com/artgris/MaintenanceBundle",
11 |   "license": "MIT",
12 |   "authors": [
13 |     {
14 |       "name": "Arthur Gribet",
15 |       "email": "a.gribet@gmail.com"
16 |     }
17 |   ],
18 |   "require": {
19 |     "php": ">=8.0.2",
20 |     "twig/twig": "^2.12|^3.0",
21 |     "symfony/config": "^5.0|^6.0|^7.0"
22 |   },
23 |   "require-dev": {
24 |     "phpunit/phpunit": "~3.7"
25 |   },
26 |   "autoload": {
27 |     "psr-0": {
28 |       "Artgris\\MaintenanceBundle": ""
29 |     }
30 |   },
31 |   "target-dir": "Artgris/MaintenanceBundle"
32 | }
33 | 


--------------------------------------------------------------------------------
/.php_cs:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | $finder = PhpCsFixer\Finder::create()
 4 |     ->in(__DIR__)
 5 |     ->ignoreDotFiles(true)
 6 |     ->ignoreVCS(true)
 7 |     ->exclude(array('build', 'vendor'))
 8 |     ->files()
 9 |     ->name('*.php')
10 | ;
11 | return PhpCsFixer\Config::create()
12 |     ->setUsingCache(true)
13 |     ->setRiskyAllowed(true)
14 |     ->setFinder($finder)
15 |     ->setRules(array(
16 |         '@Symfony' => true,
17 |         '@Symfony:risky' => true,
18 |         'array_syntax' => array('syntax' => 'short'),
19 |         'binary_operator_spaces' => array(
20 |             'align_double_arrow' => false,
21 |         ),
22 |         'combine_consecutive_unsets' => true,
23 |         'no_useless_else' => true,
24 |         'no_useless_return' => true,
25 |         'ordered_imports' => true,
26 |         'php_unit_strict' => true,
27 |         'phpdoc_summary' => false,
28 |         'strict_comparison' => true,
29 |     ))
30 | ;


--------------------------------------------------------------------------------
/DependencyInjection/ArtgrisMaintenanceExtension.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Artgris\MaintenanceBundle\DependencyInjection;
 4 | 
 5 | use Symfony\Component\DependencyInjection\ContainerBuilder;
 6 | use Symfony\Component\Config\FileLocator;
 7 | use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
 8 | use Symfony\Component\HttpKernel\DependencyInjection\Extension;
 9 | use Symfony\Component\DependencyInjection\Loader;
10 | 
11 | /**
12 |  * This is the class that loads and manages your bundle configuration.
13 |  *
14 |  * @link http://symfony.com/doc/current/cookbook/bundles/extension.html
15 |  */
16 | class ArtgrisMaintenanceExtension extends Extension
17 | {
18 |     /**
19 |      * {@inheritdoc}
20 |      */
21 |     public function load(array $configs, ContainerBuilder $container): void
22 |     {
23 |         $configuration = new Configuration();
24 |         $config = $this->processConfiguration($configuration, $configs);
25 | 
26 | 	    $container->setParameter('artgris_maintenance', $config);
27 | 
28 |         $loader = new YamlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
29 |         $loader->load('services.yml');
30 |     }
31 | }
32 | 


--------------------------------------------------------------------------------
/DependencyInjection/Configuration.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Artgris\MaintenanceBundle\DependencyInjection;
 4 | 
 5 | use Symfony\Component\Config\Definition\Builder\TreeBuilder;
 6 | use Symfony\Component\Config\Definition\ConfigurationInterface;
 7 | use Symfony\Component\HttpFoundation\Response;
 8 | 
 9 | /**
10 |  * This is the class that validates and merges configuration from your app/config files.
11 |  *
12 |  * To learn more see {@link http://symfony.com/doc/current/cookbook/bundles/configuration.html}
13 |  */
14 | class Configuration implements ConfigurationInterface
15 | {
16 |     /**
17 |      * {@inheritdoc}
18 |      */
19 |     public function getConfigTreeBuilder(): TreeBuilder
20 |     {
21 |         $treeBuilder = new TreeBuilder("artgris_maintenance");
22 |         $rootNode = $treeBuilder->getRootNode();
23 | 
24 | 	    $rootNode
25 | 		    ->children()
26 |                 ->scalarNode("enable")->defaultValue(false)->end()
27 |                 ->scalarNode("response")->defaultValue(Response::HTTP_SERVICE_UNAVAILABLE)->end()
28 |                 ->arrayNode("ips")
29 |                     ->prototype('scalar')->end()
30 |                 ->end()
31 | 		    ->end();
32 | 
33 |         return $treeBuilder;
34 |     }
35 | }
36 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # MaintenanceBundle
 2 | Symfony Bundle  to place your Symfony website in maintenance mode - [**Default Maintenance Page**](https://artgris.github.io/MaintenanceBundle/)
 3 | 
 4 | Installation
 5 | ============
 6 | 
 7 | ### 1) Download 
 8 | 
 9 | `composer require artgris/maintenance-bundle`
10 | 
11 | ### 2) Configure the Bundle 
12 | 
13 | Adds following configurations 
14 | 
15 | to ` config/packages/artgris_maintenance.yaml` :
16 | 
17 | ```yml  
18 | artgris_maintenance:
19 |     enable: true                 # Enable|Disable maintenance - default: false
20 |     ips: ["127.0.0.1","::1",...] # IPs allow (prod) - default: []
21 |     response: 503                # Maintenance Page HTTP Status Code - default: 503
22 | ``` 
23 |  
24 | ### 3) Override maintenance.html.twig (optional)
25 | 
26 | in `templates/bundles/ArtgrisMaintenanceBundle/maintenance.html.twig`
27 | 
28 | ex:
29 | ```twig  
30 | {% extends "@!ArtgrisMaintenance/maintenance.html.twig" %}
31 | 
32 | {% block content %}
33 |     <h1>Site en cours de maintenance</h1>
34 |     <h2>Nous reviendrons bientôt. Désolé pour le dérangement.</h2>
35 | {% endblock %}
36 | ```  
37 | 
38 | Usage
39 | =====
40 | 
41 | The `dev` environment was not affected by maintenance.
42 | 
43 | - Enable|Disable maintenance : `enable: true|false`
44 | - Add authorized IPs to prod : `ips: ["127.0.0.1","::1",...]`
45 | - Maintenance Page HTTP Status Code : `response: 503`
46 | 
47 | 
48 | Don't forget to clear the `prod` cache :
49 | 
50 |     php bin/console cache:clear
51 | 
52 | 


--------------------------------------------------------------------------------
/EventListener/MaintenanceListener.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | 
 4 | namespace Artgris\MaintenanceBundle\EventListener;
 5 | 
 6 | 
 7 | use Symfony\Component\HttpFoundation\IpUtils;
 8 | use Symfony\Component\HttpFoundation\Response;
 9 | use Symfony\Component\HttpKernel\Event\RequestEvent;
10 | use Symfony\Component\HttpKernel\KernelInterface;
11 | use Twig\Environment;
12 | 
13 | /**
14 |  * Maintenance Listener
15 |  *
16 |  * @author Arthur Gribet <a.gribet@gmail.com>
17 |  */
18 | class MaintenanceListener
19 | {
20 |     /**
21 |      * @var bool
22 |      */
23 |     private $enable;
24 |     /**
25 |      * @var array
26 |      */
27 |     private $ips;
28 |     /**
29 |      * @var KernelInterface
30 |      */
31 |     private $kernel;
32 |     /**
33 |      * @var Environment
34 |      */
35 |     private $twig_Environment;
36 |     /**
37 |      * @var mixed
38 |      */
39 |     private $response;
40 | 
41 |     /**
42 |      * MaintenanceListener constructor.
43 |      *
44 |      * @param array $maintenance
45 |      * @param KernelInterface $kernel
46 |      * @param Environment $twig_Environment
47 |      */
48 |     public function __construct(array $maintenance, KernelInterface $kernel, Environment $twig_Environment)
49 |     {
50 |         $this->enable = $maintenance['enable'] ?: false;
51 |         $this->ips = $maintenance['ips'] ?: [];
52 |         $this->response = $maintenance['response'];
53 |         $this->kernel = $kernel;
54 |         $this->twig_Environment = $twig_Environment;
55 |     }
56 | 
57 |     public function onKernelRequest(RequestEvent $event)
58 |     {
59 | 
60 |         if (!$event->isMainRequest()) {
61 |             return;
62 |         }
63 | 
64 |         $request = $event->getRequest();
65 | 
66 |         if ($this->enable && $this->kernel->getEnvironment() != 'dev' && !IpUtils::checkIp($request->getClientIp(), $this->ips)) {
67 |             $content = $this->twig_Environment->render('@ArtgrisMaintenance/maintenance.html.twig');
68 |             $event->setResponse(new Response($content, $this->response));
69 |         }
70 |     }
71 | 
72 | 
73 | }
74 | 


--------------------------------------------------------------------------------
/index.html:
--------------------------------------------------------------------------------
 1 | <!doctype html>
 2 | <html lang="en">
 3 | <head>
 4 |     <meta charset="UTF-8">
 5 |     <meta name="viewport"
 6 |           content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
 7 |     <meta http-equiv="X-UA-Compatible" content="ie=edge">
 8 |     <title>Maintenance</title>
 9 |     <link href="https://fonts.googleapis.com/css?family=Raleway" rel="stylesheet">
10 |     <style>
11 |         body, html {
12 |             font-family: 'Raleway', sans-serif;
13 |             width: 100%;
14 |             height: 100%;
15 |             margin: 0;
16 |             padding: 0;
17 |             overflow: hidden;
18 |             position: relative;
19 |             color: #4d4d4d;
20 | 
21 |         }
22 | 
23 |         .content {
24 |             position: absolute;
25 |             top: 50%;
26 |             transform: translateY(-50%);
27 |             z-index: 1000;
28 |             text-align: center;
29 |             width: 100%;
30 |             overflow: auto;
31 |             margin: auto;
32 |             left: 0;
33 |             right: 0;
34 |         }
35 | 
36 |         h1 {
37 |             font-size: 40px;
38 |             font-weight: 100;
39 |         }
40 | 
41 |         h2 {
42 |             font-size: 20px;
43 |             font-weight: 100;
44 |         }
45 | 
46 |         svg {
47 |             position: absolute;
48 |             min-width: 100%;
49 |             top: 0;
50 |             left: 0;
51 |         }
52 | 
53 |         @media screen and (min-width: 640px) {
54 |             h1 {
55 |                 font-size: 80px;
56 |             }
57 | 
58 |             h2 {
59 |                 font-size: 30px;
60 |             }
61 |         }
62 | 
63 |     </style>
64 | </head>
65 | <body>
66 | <div class="content">
67 |     <h1>Site under maintenance</h1>
68 |     <h2>We'll be back soon. Sorry for inconvenience.</h2>
69 | </div>
70 | <script src="https://cdnjs.cloudflare.com/ajax/libs/trianglify/0.4.0/trianglify.min.js"></script>
71 | <script>
72 | 
73 |     function generateTrianglify(withadd) {
74 |         var trianglify = Trianglify({
75 |             width: window.innerWidth,
76 |             height: window.innerHeight,
77 |             cell_size: 40,
78 |             seed: 'u3c38'
79 |         });
80 | 
81 |         if (withadd) {
82 |             document.body.appendChild(trianglify.svg())
83 |         }
84 |         return trianglify
85 |     }
86 | 
87 |     generateTrianglify(true);
88 | 
89 |     window.onresize = function (event) {
90 |         var element = document.getElementsByTagName("svg")[0]
91 |         var trianglify = generateTrianglify(false)
92 |         element.parentNode.replaceChild(trianglify.svg(), element)
93 | 
94 |     }
95 | 
96 | </script>
97 | </body>
98 | </html>


--------------------------------------------------------------------------------
/Resources/views/maintenance.html.twig:
--------------------------------------------------------------------------------
  1 | <!doctype html>
  2 | <html lang="{{ app.request.locale }}">
  3 | <head>
  4 |     <meta charset="UTF-8">
  5 |     <meta name="viewport"
  6 |           content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
  7 |     <meta http-equiv="X-UA-Compatible" content="ie=edge">
  8 |     <title>{% block title %}Maintenance{% endblock %}</title>
  9 |     {% block stylesheets %}
 10 |         <link href="https://fonts.googleapis.com/css?family=Raleway" rel="stylesheet">
 11 |         <style>
 12 |             body, html {
 13 |                 font-family: 'Raleway', sans-serif;
 14 |                 width: 100%;
 15 |                 height: 100%;
 16 |                 margin: 0;
 17 |                 padding: 0;
 18 |                 overflow: hidden;
 19 |                 position: relative;
 20 |                 color: #4d4d4d;
 21 | 
 22 |             }
 23 | 
 24 |             .content {
 25 |                 position: absolute;
 26 |                 top: 50%;
 27 |                 transform: translateY(-50%);
 28 |                 z-index: 1000;
 29 |                 text-align: center;
 30 |                 width: 100%;
 31 |                 overflow: auto;
 32 |                 margin: auto;
 33 |                 left: 0;
 34 |                 right: 0;
 35 |             }
 36 | 
 37 |             h1 {
 38 |                 font-size: 40px;
 39 |                 font-weight: 100;
 40 |             }
 41 | 
 42 |             h2 {
 43 |                 font-size: 20px;
 44 |                 font-weight: 100;
 45 |             }
 46 | 
 47 |             svg {
 48 |                 position: absolute;
 49 |                 min-width: 100%;
 50 |                 top: 0;
 51 |                 left: 0;
 52 |             }
 53 | 
 54 |             @media screen and (min-width: 640px) {
 55 |                 h1 {
 56 |                     font-size: 80px;
 57 |                 }
 58 | 
 59 |                 h2 {
 60 |                     font-size: 30px;
 61 |                 }
 62 |             }
 63 |         </style>
 64 |     {% endblock %}
 65 | </head>
 66 | <body>
 67 | {% block body %}
 68 |     <div class="content">
 69 |         {% block content %}
 70 |             <h1>Site under maintenance</h1>
 71 |             <h2>We'll be back soon. Sorry for inconvenience.</h2>
 72 |         {% endblock %}
 73 |     </div>
 74 | {% endblock %}
 75 | 
 76 | {% block javascripts %}
 77 |     <script src="https://cdnjs.cloudflare.com/ajax/libs/trianglify/0.4.0/trianglify.min.js"></script>
 78 |     <script>
 79 | 
 80 |         function generateTrianglify(withadd) {
 81 |             var trianglify = Trianglify({
 82 |                 width: window.innerWidth,
 83 |                 height: window.innerHeight,
 84 |                 cell_size: 40,
 85 |                 seed: 'u3c38'
 86 |             });
 87 | 
 88 |             if (withadd) {
 89 |                 document.body.appendChild(trianglify.svg())
 90 |             }
 91 |             return trianglify
 92 |         }
 93 | 
 94 |         generateTrianglify(true);
 95 | 
 96 |         window.onresize = function (event) {
 97 |             var element = document.getElementsByTagName("svg")[0]
 98 |             var trianglify = generateTrianglify(false)
 99 |             element.parentNode.replaceChild(trianglify.svg(), element)
100 | 
101 |         }
102 | 
103 |     </script>
104 | {% endblock %}
105 | </body>
106 | </html>


--------------------------------------------------------------------------------