From 4d784f5948b13f35b5549dd4c12ede732bad12cc Mon Sep 17 00:00:00 2001
From: Simon Vieille <simon@deblan.fr>
Date: Mon, 24 May 2021 18:41:57 +0200
Subject: [PATCH 1/2] add tasks

---
 assets/js/addons/modal.js                     | 12 +++-
 core/Cache/SymfonyCacheManager.php            |  8 ++-
 core/Controller/Task/TaskAdminController.php  | 59 +++++++++++++++++++
 core/Event/Task/TaskInitEvent.php             | 39 ++++++++++++
 core/Event/Task/TaskRunRequestedEvent.php     | 44 ++++++++++++++
 .../EventSuscriber/SettingEventSubscriber.php |  2 +-
 .../Task/CacheCleanTaskEventSubscriber.php    | 36 +++++++++++
 .../Task/TaskEventSubscriber.php              | 34 +++++++++++
 core/Resources/translations/messages.fr.yaml  |  4 ++
 .../views/admin/module/menu.html.twig         | 10 ++++
 .../views/task/task_admin/_form.html.twig     |  5 ++
 .../views/task/task_admin/index.html.twig     | 56 ++++++++++++++++++
 .../task_admin/run.html.twig}                 | 10 ++--
 13 files changed, 307 insertions(+), 12 deletions(-)
 create mode 100644 core/Controller/Task/TaskAdminController.php
 create mode 100644 core/Event/Task/TaskInitEvent.php
 create mode 100644 core/Event/Task/TaskRunRequestedEvent.php
 create mode 100644 core/EventSuscriber/Task/CacheCleanTaskEventSubscriber.php
 create mode 100644 core/EventSuscriber/Task/TaskEventSubscriber.php
 create mode 100644 core/Resources/views/task/task_admin/_form.html.twig
 create mode 100644 core/Resources/views/task/task_admin/index.html.twig
 rename core/Resources/views/{setting/setting_admin/filters.html.twig => task/task_admin/run.html.twig} (51%)

diff --git a/assets/js/addons/modal.js b/assets/js/addons/modal.js
index 0e389f2..af17e32 100644
--- a/assets/js/addons/modal.js
+++ b/assets/js/addons/modal.js
@@ -6,19 +6,25 @@ module.exports = function() {
         e.stopPropagation();
 
         let container = $('#modal-container');
+        const body = $('body')
 
         if (!container.length) {
             container = $('<div id="modal-container" class="modal">');
 
-            $('body').append(container);
+            body.append(container);
         }
 
-        container.html('');
+        const loader = $('<div style="position: absolute; top: 25vh; left: 50vw; z-index: 2000">')
+        loader.html('<div class="spinner-border text-primary" role="status"><span class="sr-only">Loading...</span></div>')
+        body.append(loader)
+
+        container.html();
 
         const url = $(e.target).attr('data-modal');
+            $(container).modal('show');
 
         container.load(url, function() {
-            $(container).modal('show');
+            loader.remove()
         });
     });
 
diff --git a/core/Cache/SymfonyCacheManager.php b/core/Cache/SymfonyCacheManager.php
index f296142..6ddba95 100644
--- a/core/Cache/SymfonyCacheManager.php
+++ b/core/Cache/SymfonyCacheManager.php
@@ -10,6 +10,7 @@ use Symfony\Component\HttpKernel\KernelInterface;
 use Symfony\Contracts\HttpClient\HttpClientInterface;
 use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
 use Symfony\Component\HttpClient\Exception\ClientException;
+use Symfony\Component\Console\Output\OutputInterface;
 
 /**
  * class SymfonyCacheManager.
@@ -51,11 +52,14 @@ class SymfonyCacheManager
         }
     }
 
-    public function cleanAll()
+    public function cleanAll(OutputInterface $output = null)
     {
         $application = new Application($this->kernel);
         $application->setAutoExit(false);
-        $output = new BufferedOutput();
+
+        if (null === $output) {
+            $output = new BufferedOutput();
+        }
 
         $input = new ArrayInput([
             'command' => 'cache:clear',
diff --git a/core/Controller/Task/TaskAdminController.php b/core/Controller/Task/TaskAdminController.php
new file mode 100644
index 0000000..29b9b05
--- /dev/null
+++ b/core/Controller/Task/TaskAdminController.php
@@ -0,0 +1,59 @@
+<?php
+
+namespace App\Core\Controller\Task;
+
+use App\Core\Controller\Admin\AdminController;
+use App\Core\Event\Task\TaskInitEvent;
+use Symfony\Component\Console\Output\BufferedOutput;
+use Symfony\Component\EventDispatcher\EventDispatcherInterface;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\Routing\Annotation\Route;
+use App\Core\Event\Task\TaskRunRequestedEvent;
+
+/**
+ * @Route("/admin/task")
+ */
+class TaskAdminController extends AdminController
+{
+    /**
+     * @Route("/", name="admin_task_index")
+     */
+    public function index(EventDispatcherInterface $eventDispatcher): Response
+    {
+        $event = new TaskInitEvent();
+        $eventDispatcher->dispatch($event, TaskInitEvent::INIT_EVENT);
+
+        return $this->render('@Core/task/task_admin/index.html.twig', [
+            'pager' => $event->getTasks(),
+        ]);
+    }
+
+    /**
+     * @Route("/run/{task}", name="admin_task_run", methods={"GET"})
+     */
+    public function run(
+        string $task,
+        Request $request,
+        EventDispatcherInterface $eventDispatcher
+    ): Response {
+        if (!$this->isCsrfTokenValid('task_run', $request->query->get('_token'))) {
+            throw $this->createAccessDeniedException();
+        }
+
+        $output = new BufferedOutput();
+        $event = new TaskRunRequestedEvent($task, $request->query, $output);
+        $eventDispatcher->dispatch($event, TaskRunRequestedEvent::RUN_REQUEST_EVENT);
+
+        $content = $output->fetch();
+
+        return $this->render('@Core/task/task_admin/run.html.twig', [
+            'output' => $content,
+        ]);
+    }
+
+    public function getSection(): string
+    {
+        return 'task';
+    }
+}
diff --git a/core/Event/Task/TaskInitEvent.php b/core/Event/Task/TaskInitEvent.php
new file mode 100644
index 0000000..ac18168
--- /dev/null
+++ b/core/Event/Task/TaskInitEvent.php
@@ -0,0 +1,39 @@
+<?php
+
+namespace App\Core\Event\Task;
+
+use Symfony\Component\Console\Output\BufferedOutput;
+use Symfony\Component\DependencyInjection\ParameterBag\ParameterBagInterface;
+use Symfony\Contracts\EventDispatcher\Event;
+
+/**
+ * class TaskInitEvent.
+ *
+ * @author Simon Vieille <simon@deblan.fr>
+ */
+class TaskInitEvent extends Event
+{
+    const INIT_EVENT = 'task_event.init';
+
+    protected array $tasks = [];
+
+    public function getTasks(): array
+    {
+        usort($this->tasks, function($t1, $t2) {
+            return $t1['section'] <> $t2['section'];
+        });
+
+        return $this->tasks;
+    }
+
+    public function addTask(string $task, string $label, string $section): self
+    {
+        $this->tasks[$task] = [
+            'label' => $label,
+            'section' => $section,
+            'task' => $task,
+        ];
+
+        return $this;
+    }
+}
diff --git a/core/Event/Task/TaskRunRequestedEvent.php b/core/Event/Task/TaskRunRequestedEvent.php
new file mode 100644
index 0000000..d25ed89
--- /dev/null
+++ b/core/Event/Task/TaskRunRequestedEvent.php
@@ -0,0 +1,44 @@
+<?php
+
+namespace App\Core\Event\Task;
+
+use Symfony\Component\Console\Output\BufferedOutput;
+use Symfony\Component\DependencyInjection\ParameterBag\ParameterBagInterface;
+use Symfony\Component\HttpFoundation\InputBag;
+use Symfony\Contracts\EventDispatcher\Event;
+
+/**
+ * class TaskRunRequestedEvent.
+ *
+ * @author Simon Vieille <simon@deblan.fr>
+ */
+class TaskRunRequestedEvent extends Event
+{
+    const RUN_REQUEST_EVENT = 'task_event.run_request';
+
+    protected string $task;
+    protected InputBag $parameters;
+    protected BufferedOutput $output;
+
+    public function __construct(string $task, InputBag $parameters, BufferedOutput $output)
+    {
+        $this->task = $task;
+        $this->parameters = $parameters;
+        $this->output = $output;
+    }
+
+    public function getTask(): string
+    {
+        return $this->task;
+    }
+
+    public function getParameters(): ParameterBagInterface
+    {
+        return $this->parameters;
+    }
+
+    public function getOutput(): BufferedOutput
+    {
+        return $this->output;
+    }
+}
diff --git a/core/EventSuscriber/SettingEventSubscriber.php b/core/EventSuscriber/SettingEventSubscriber.php
index d65e783..d8db765 100644
--- a/core/EventSuscriber/SettingEventSubscriber.php
+++ b/core/EventSuscriber/SettingEventSubscriber.php
@@ -10,7 +10,7 @@ use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  *
  * @author Simon Vieille <simon@deblan.fr>
  */
-class SettingEventSubscriber implements EventSubscriberInterface
+abstract class SettingEventSubscriber implements EventSubscriberInterface
 {
     protected static int $priority = 0;
 
diff --git a/core/EventSuscriber/Task/CacheCleanTaskEventSubscriber.php b/core/EventSuscriber/Task/CacheCleanTaskEventSubscriber.php
new file mode 100644
index 0000000..d682d48
--- /dev/null
+++ b/core/EventSuscriber/Task/CacheCleanTaskEventSubscriber.php
@@ -0,0 +1,36 @@
+<?php
+
+namespace App\Core\EventSuscriber\Task;
+
+use App\Core\Cache\SymfonyCacheManager;
+use App\Core\Event\Task\TaskInitEvent;
+use App\Core\Event\Task\TaskRunRequestedEvent;
+
+/**
+ * class CacheCleanTaskEventSubscriber.
+ *
+ * @author Simon Vieille <simon@deblan.fr>
+ */
+class CacheCleanTaskEventSubscriber extends TaskEventSubscriber
+{
+    protected SymfonyCacheManager $cacheManager;
+
+    public function __construct(SymfonyCacheManager $cacheManager)
+    {
+        $this->cacheManager = $cacheManager;
+    }
+
+    public function onInit(TaskInitEvent $event)
+    {
+        $event->addTask('cache:clear', 'Clean all cache', '♻️ Cache');
+    }
+
+    public function onRunRequest(TaskRunRequestedEvent $event)
+    {
+        if ('cache:clear' !== $event->getTask()) {
+            return;
+        }
+
+        $this->cacheManager->cleanAll($event->getOutput());
+    }
+}
diff --git a/core/EventSuscriber/Task/TaskEventSubscriber.php b/core/EventSuscriber/Task/TaskEventSubscriber.php
new file mode 100644
index 0000000..fb207e7
--- /dev/null
+++ b/core/EventSuscriber/Task/TaskEventSubscriber.php
@@ -0,0 +1,34 @@
+<?php
+
+namespace App\Core\EventSuscriber\Task;
+
+use App\Core\Event\Setting\SettingEvent;
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use App\Core\Event\Task\TaskRunRequestedEvent;
+use App\Core\Event\Task\TaskInitEvent;
+
+/**
+ * class TaskEventSubscriber.
+ *
+ * @author Simon Vieille <simon@deblan.fr>
+ */
+abstract class TaskEventSubscriber implements EventSubscriberInterface
+{
+    protected static int $priority = 0;
+
+    public static function getSubscribedEvents()
+    {
+        return [
+            TaskInitEvent::INIT_EVENT => ['onInit', self::$priority],
+            TaskRunRequestedEvent::RUN_REQUEST_EVENT => ['onRunRequest', self::$priority],
+        ];
+    }
+
+    public function onInit(TaskInitEvent $event)
+    {
+    }
+
+    public function onRunRequest(TaskRunRequestedEvent $event)
+    {
+    }
+}
diff --git a/core/Resources/translations/messages.fr.yaml b/core/Resources/translations/messages.fr.yaml
index 0e160d0..b6fe635 100644
--- a/core/Resources/translations/messages.fr.yaml
+++ b/core/Resources/translations/messages.fr.yaml
@@ -153,3 +153,7 @@
 "Regular expression: do not add the delimiter": "Expréssion régulière : ne pas ajouter de délimiteur"
 "Content type": "Type de contenu"
 'Leave blank equals "text/html"': 'Laissez vide équivaut à "text/html"'
+"Close": "Fermer"
+"Tasks": "Tâches"
+"Results": "Résultats"
+"Clean all cache": "Nettoyer tout le cache"
diff --git a/core/Resources/views/admin/module/menu.html.twig b/core/Resources/views/admin/module/menu.html.twig
index e684a6b..d09222d 100644
--- a/core/Resources/views/admin/module/menu.html.twig
+++ b/core/Resources/views/admin/module/menu.html.twig
@@ -68,6 +68,16 @@
             </a>
         </li>
 
+        <li class="nav-item">
+            <a class="nav-link {{ macros_menu.active_class('task', section) }}" href="{{ path('admin_task_index') }}">
+                <span class="fa fa-play"></span>
+
+                <span class="nav-item-label">
+                    {{ 'Tasks'|trans }}
+                </span>
+            </a>
+        </li>
+
         <li class="nav-item">
             <a class="nav-link {{ macros_menu.active_class('setting', section) }}" href="{{ path('admin_setting_index') }}">
                 <span class="fa fa-sliders-h"></span>
diff --git a/core/Resources/views/task/task_admin/_form.html.twig b/core/Resources/views/task/task_admin/_form.html.twig
new file mode 100644
index 0000000..f73d2c4
--- /dev/null
+++ b/core/Resources/views/task/task_admin/_form.html.twig
@@ -0,0 +1,5 @@
+<div class="row">
+    <div class="col-md-12">
+        {{ form_widget(form) }}
+    </div>
+</div>
diff --git a/core/Resources/views/task/task_admin/index.html.twig b/core/Resources/views/task/task_admin/index.html.twig
new file mode 100644
index 0000000..9080176
--- /dev/null
+++ b/core/Resources/views/task/task_admin/index.html.twig
@@ -0,0 +1,56 @@
+{% extends '@Core/admin/layout.html.twig' %}
+
+{% block title %}{{ 'Tasks'|trans }} - {{ parent() }}{% endblock %}
+
+{% block body %}
+    <div class="bg-light pl-5 pr-4 pt-5 pb-5">
+        <div class="crud-header">
+            <h1 class="crud-header-title">{{ 'Tasks'|trans }}</h1>
+        </div>
+    </div>
+
+    <div class="table-responsive">
+        <table class="table">
+            <thead class="thead-light">
+                <tr>
+                    <th class="col-5">{{ 'Label'|trans }}</th>
+                    <th class="col-5">{{ 'Section'|trans }}</th>
+                    <th class="col-2 miw-100 text-right">{{ 'Actions'|trans }}</th>
+                </tr>
+            </thead>
+            <tbody>
+                {% for item in pager %}
+                    {% set run = path('admin_task_run', {
+                        task: item.task,
+                        _token: csrf_token('task_run')
+                    }) %}
+
+                    <tr>
+                        <td class="col-5">
+                            {{ item.label|trans }}
+                        </td>
+                        <td class="col-5">
+                            <span class="btn btn-light">{{ item.section|trans }}</span>
+                        </td>
+                        <td class="col-2 miw-100 text-right">
+                            <span data-modal="{{ run }}" class="btn btn-sm btn-primary mr-1">
+                                <span data-modal="{{ run }}" class="fa fa-play"></span>
+                            </span>
+                        </td>
+                    </tr>
+                {% else %}
+                    <tr>
+                        <td class="col-12 text-center p-4 text-black-50" colspan="3">
+                            <div class="display-1">
+                                <span class="fa fa-search"></span>
+                            </div>
+                            <div class="display-5 mt-3">
+                                {{ 'No result'|trans }}
+                            </div>
+                        </td>
+                    </tr>
+                {% endfor %}
+            </tbody>
+        </table>
+    </div>
+{% endblock %}
diff --git a/core/Resources/views/setting/setting_admin/filters.html.twig b/core/Resources/views/task/task_admin/run.html.twig
similarity index 51%
rename from core/Resources/views/setting/setting_admin/filters.html.twig
rename to core/Resources/views/task/task_admin/run.html.twig
index 5cb33d8..dcfa3c1 100644
--- a/core/Resources/views/setting/setting_admin/filters.html.twig
+++ b/core/Resources/views/task/task_admin/run.html.twig
@@ -2,20 +2,18 @@
     <div class="modal-content">
         <div class="modal-header">
             <h5 class="modal-title">
-                {{ 'Filter'|trans }}
+                {{ 'Results'|trans }}
             </h5>
             <button type="button" class="close" data-dismiss="modal" aria-label="Close">
                 <span aria-hidden="true">&times;</span>
             </button>
         </div>
         <div class="modal-body">
-            <form action="{{ path('admin_site_page_index') }}" id="form-filters" method="GET">
-                {{ form_widget(form) }}
-            </form>
+            <pre>{{ output|trim }}</pre>
         </div>
         <div class="modal-footer">
-            <a href="{{ path('admin_site_page_index', {page_filter: 0}) }}" class="btn btn-secondary">{{ 'Vider'|trans }}</a>
-            <button type="submit" form="form-filters" class="btn btn-primary">{{ 'Filter'|trans }}</button>
+            <button type="button" class="btn btn-secondary" data-dismiss="modal">{{ 'Close'|trans }}</button>
         </div>
     </div>
 </div>
+

From 3de2342567198f8fbb38373cb99ae24e30e99782 Mon Sep 17 00:00:00 2001
From: Simon Vieille <simon@deblan.fr>
Date: Mon, 24 May 2021 18:42:44 +0200
Subject: [PATCH 2/2] add PSR 2 compliance

---
 core/Controller/Task/TaskAdminController.php     | 2 +-
 core/Event/Task/TaskInitEvent.php                | 6 ++----
 core/EventSuscriber/Task/TaskEventSubscriber.php | 5 ++---
 3 files changed, 5 insertions(+), 8 deletions(-)

diff --git a/core/Controller/Task/TaskAdminController.php b/core/Controller/Task/TaskAdminController.php
index 29b9b05..51a3098 100644
--- a/core/Controller/Task/TaskAdminController.php
+++ b/core/Controller/Task/TaskAdminController.php
@@ -4,12 +4,12 @@ namespace App\Core\Controller\Task;
 
 use App\Core\Controller\Admin\AdminController;
 use App\Core\Event\Task\TaskInitEvent;
+use App\Core\Event\Task\TaskRunRequestedEvent;
 use Symfony\Component\Console\Output\BufferedOutput;
 use Symfony\Component\EventDispatcher\EventDispatcherInterface;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\Routing\Annotation\Route;
-use App\Core\Event\Task\TaskRunRequestedEvent;
 
 /**
  * @Route("/admin/task")
diff --git a/core/Event/Task/TaskInitEvent.php b/core/Event/Task/TaskInitEvent.php
index ac18168..ce9a45f 100644
--- a/core/Event/Task/TaskInitEvent.php
+++ b/core/Event/Task/TaskInitEvent.php
@@ -2,8 +2,6 @@
 
 namespace App\Core\Event\Task;
 
-use Symfony\Component\Console\Output\BufferedOutput;
-use Symfony\Component\DependencyInjection\ParameterBag\ParameterBagInterface;
 use Symfony\Contracts\EventDispatcher\Event;
 
 /**
@@ -19,8 +17,8 @@ class TaskInitEvent extends Event
 
     public function getTasks(): array
     {
-        usort($this->tasks, function($t1, $t2) {
-            return $t1['section'] <> $t2['section'];
+        usort($this->tasks, function ($t1, $t2) {
+            return $t1['section'] != $t2['section'];
         });
 
         return $this->tasks;
diff --git a/core/EventSuscriber/Task/TaskEventSubscriber.php b/core/EventSuscriber/Task/TaskEventSubscriber.php
index fb207e7..a6ab5d8 100644
--- a/core/EventSuscriber/Task/TaskEventSubscriber.php
+++ b/core/EventSuscriber/Task/TaskEventSubscriber.php
@@ -2,10 +2,9 @@
 
 namespace App\Core\EventSuscriber\Task;
 
-use App\Core\Event\Setting\SettingEvent;
-use Symfony\Component\EventDispatcher\EventSubscriberInterface;
-use App\Core\Event\Task\TaskRunRequestedEvent;
 use App\Core\Event\Task\TaskInitEvent;
+use App\Core\Event\Task\TaskRunRequestedEvent;
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 
 /**
  * class TaskEventSubscriber.