Merge pull request #43 from guavestudios/feature/allow-admins

Feature/allow admins

Author: maxperei

README.md

@@ -76,13 +76,18 @@
     ``` shell
     php bin/console maintenance:enable 172.16.254.1 255.255.255.255 192.0.0.255
     ```
-3. Disable the plugin
+3.Enable the plugin and disable admin access
+
+    ``` shell
+    php bin/console maintenance:enable --disable-admin
+    ```
+4.Disable the plugin
 
     ``` shell
     php bin/console maintenance:disable
     ```
 
-4. Remove configuration file using CLI
+5.Remove configuration file using CLI
 
 By default, **maintenance.yaml** configuration file remains when running `maintenance:disable` or via admin panel using toggle disable
 Nevertheless passing option `[-c|--clear]` to command line above will reset previous saved configuration
@@ -91,9 +96,10 @@ Nevertheless passing option `[-c|--clear]` to command line above will reset prev
 
 - Enable/disable the plugin
 - Allow access for one or multiple ips addresses (optional)
-- Allow access for secret token (optional)
+- Allow access for secret token (session and request) (optional)
 - Create your custom message (optional)
 - Grant access to search bots during maintenance (optional)
+- Grant access to admins during maintenance (optional)
 
 ### If you want to put the **maintenance.yaml** in a directory, please add your directory in .env:
 
@@ -123,6 +129,11 @@ framework:
                 adapter: cache.adapter.redis
 ```
 
+### Precisions for access token
+
+Once token is generated, disallowing maintenance will be available thought request as well.
+So you can use it as query parameter `?synolia_maintenance_token={$token}` or in headers `HTTP_SYNOLIA_MAINTENANCE_TOKEN: token` for a particular request to bypass maintenance mode.
+
 ## Development
 
 See [How to contribute](CONTRIBUTING.md).

src/Checker/AdminChecker.php

@@ -40,14 +40,16 @@ public function isMaintenance(MaintenanceConfiguration $configuration, Request $
             $request = $this->requestStack->getMainRequest();
             Assert::isInstanceOf($request, Request::class);
 
-            if ($request === $this->requestStack->getCurrentRequest()) {
-                $flashBag = $request->getSession()->getBag('flashes');
-                if ($flashBag instanceof FlashBagInterface) {
-                    $flashBag->add('info', $this->translator->trans('maintenance.ui.message_info_admin'));
+            if ($configuration->isAllowAdmins()) {
+                if ($request === $this->requestStack->getCurrentRequest()) {
+                    $flashBag = $request->getSession()->getBag('flashes');
+                    if ($flashBag instanceof FlashBagInterface) {
+                        $flashBag->add('info', $this->translator->trans('maintenance.ui.message_info_admin'));
+                    }
                 }
-            }
 
-            return IsMaintenanceVoterInterface::ACCESS_GRANTED;
+                return IsMaintenanceVoterInterface::ACCESS_GRANTED;
+            }
         }
 
         return IsMaintenanceVoterInterface::ACCESS_DENIED;

src/Checker/TokenChecker.php

@@ -20,6 +20,14 @@ public static function getDefaultPriority(): int
 
     public function isMaintenance(MaintenanceConfiguration $configuration, Request $request): bool
     {
+        if ($request->query->get(TokenStorage::MAINTENANCE_TOKEN_NAME) === $configuration->getToken()) {
+            return IsMaintenanceVoterInterface::ACCESS_GRANTED;
+        }
+
+        if ($request->headers->get(TokenStorage::MAINTENANCE_TOKEN_NAME) === $configuration->getToken()) {
+            return IsMaintenanceVoterInterface::ACCESS_GRANTED;
+        }
+
         if ($request->getSession()->get(TokenStorage::MAINTENANCE_TOKEN_NAME) === $configuration->getToken()) {
             return IsMaintenanceVoterInterface::ACCESS_GRANTED;
         }

src/Command/EnableMaintenanceCommand.php

@@ -10,6 +10,7 @@
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Contracts\Cache\CacheInterface;
 use Symfony\Contracts\Translation\TranslatorInterface;
@@ -35,6 +36,7 @@ protected function configure(): void
     {
         $this
             ->addArgument('ips_address', InputArgument::IS_ARRAY, 'Add ips addresses (separate multiple ips with a space)')
+            ->addOption('disable-admin', null, InputOption::VALUE_NONE, 'disable admin access')
             ->setHelp('This command allows you to create the maintenance.yaml and also allows you to put the ips into this file.')
         ;
     }
@@ -68,6 +70,9 @@ private function getMaintenanceConfiguration(InputInterface $input): Maintenance
         $maintenanceConfiguration->setChannels($this->getChannels());
         $maintenanceConfiguration->setEnabled(true);
 
+        $disableAdmin = (bool) $input->getOption('disable-admin');
+        $maintenanceConfiguration->setAllowAdmins(!$disableAdmin);
+
         /** @var array $ipsAddress */
         $ipsAddress = $input->getArgument('ips_address');
         if ([] !== $ipsAddress) {

src/Controller/MaintenanceConfigurationController.php

@@ -56,7 +56,8 @@ public function __invoke(Request $request): Response
         }
 
         return $this->render('@SynoliaSyliusMaintenancePlugin/Admin/maintenanceConfiguration.html.twig', [
-            'form' => $form,
+            'maintenanceConfiguration' => $maintenanceConfiguration,
+            'form' => $form->createView(),
         ]);
     }
 }

src/EventSubscriber/MaintenanceEventsubscriber.php

@@ -6,6 +6,7 @@
 
 use Symfony\Component\DependencyInjection\Attribute\Autowire;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use Symfony\Component\HttpFoundation\JsonResponse;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\Event\RequestEvent;
 use Symfony\Contracts\Cache\CacheInterface;
@@ -51,6 +52,15 @@ public function handle(RequestEvent $event): void
             'custom_message' => $configuration->getCustomMessage(),
         ]);
 
+        if ('json' === $event->getRequest()->getContentTypeFormat()) {
+            $event->setResponse(new JsonResponse([
+                'key' => 'maintenance',
+                'message' => $configuration->getCustomMessage(),
+            ], Response::HTTP_SERVICE_UNAVAILABLE));
+
+            return;
+        }
+
         $event->setResponse(new Response($responseContent, Response::HTTP_SERVICE_UNAVAILABLE));
     }
 

src/Exporter/MaintenanceConfigurationExporter.php

@@ -38,6 +38,7 @@ public function export(MaintenanceConfiguration $configuration): void
         }
         $dataToExport['enabled'] = $configuration->isEnabled();
         $scheduler = $this->getSchedulerArray($configuration->getStartDate(), $configuration->getEndDate());
+        $dataToExport['allow_admins'] = $configuration->isAllowAdmins();
 
         $this->configurationFileManager->createMaintenanceFile(array_merge(
             $scheduler,

src/Factory/MaintenanceConfigurationFactory.php

@@ -46,6 +46,7 @@ public static function map(MaintenanceConfiguration $maintenanceConfiguration, ?
             'custom_message' => '',
             'token' => '',
             'allow_bots' => false,
+            'allow_admins' => true,
             'enabled' => true,
         ]);
         /**
@@ -56,6 +57,7 @@ public static function map(MaintenanceConfiguration $maintenanceConfiguration, ?
          *     'custom_message': string,
          *     'token': string,
          *     'allow_bots': bool,
+         *     'allow_admins': bool,
          *     'enabled': bool,
          *  } $options
          */
@@ -79,6 +81,7 @@ public static function map(MaintenanceConfiguration $maintenanceConfiguration, ?
             ->setCustomMessage($options['custom_message'])
             ->setToken($options['token'])
             ->setAllowBots($options['allow_bots'])
+            ->setAllowAdmins($options['allow_admins'])
             ->setEnabled($options['enabled'])
         ;
     }

src/Form/Type/MaintenanceConfigurationType.php

@@ -67,6 +67,10 @@ public function buildForm(FormBuilderInterface $builder, array $options): void
                 'label' => 'maintenance.ui.form.allow_bots',
                 'required' => true,
             ])
+            ->add('allowAdmins', CheckboxType::class, [
+                'label' => 'maintenance.ui.form.allow_admins',
+                'required' => true,
+            ])
         ;
 
         if ($this->channelRepository->count([]) > 1) {

src/Model/MaintenanceConfiguration.php

@@ -24,6 +24,8 @@ class MaintenanceConfiguration
 
     private bool $allowBots = false;
 
+    private bool $allowAdmins = true;
+
     public function __construct()
     {
         $this->token = bin2hex(random_bytes(16));
@@ -158,4 +160,16 @@ public function setAllowBots(bool $allowBots): self
 
         return $this;
     }
+
+    public function isAllowAdmins(): bool
+    {
+        return $this->allowAdmins;
+    }
+
+    public function setAllowAdmins(bool $allowAdmins): self
+    {
+        $this->allowAdmins = $allowAdmins;
+
+        return $this;
+    }
 }