Feature: [saved export] Create a "saved export"

src/Bundle/ChillMainBundle/Controller/ExportController.php

@@ -11,11 +11,15 @@ declare(strict_types=1);
 
 namespace Chill\MainBundle\Controller;
 
+use Chill\MainBundle\Entity\SavedExport;
+use Chill\MainBundle\Entity\User;
 use Chill\MainBundle\Export\ExportManager;
+use Chill\MainBundle\Form\SavedExportType;
 use Chill\MainBundle\Form\Type\Export\ExportType;
 use Chill\MainBundle\Form\Type\Export\FormatterType;
 use Chill\MainBundle\Form\Type\Export\PickCenterType;
 use Chill\MainBundle\Redis\ChillRedis;
+use Doctrine\ORM\EntityManagerInterface;
 use LogicException;
 use Psr\Log\LoggerInterface;
 use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
@@ -26,6 +30,8 @@ use Symfony\Component\Form\FormInterface;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpFoundation\Session\SessionInterface;
+use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
+use Symfony\Component\Routing\Annotation\Route;
 use Symfony\Contracts\Translation\TranslatorInterface;
 
 use function count;
@@ -38,35 +44,37 @@ use function unserialize;
  */
 class ExportController extends AbstractController
 {
+    private EntityManagerInterface $entityManager;
+
     /**
      * @var ExportManager
      */
-    protected $exportManager;
+    private $exportManager;
 
     /**
      * @var FormFactoryInterface
      */
-    protected $formFactory;
+    private $formFactory;
 
     /**
      * @var LoggerInterface
      */
-    protected $logger;
+    private $logger;
 
     /**
      * @var ChillRedis
      */
-    protected $redis;
+    private $redis;
 
     /**
      * @var SessionInterface
      */
-    protected $session;
+    private $session;
 
     /**
      * @var TranslatorInterface
      */
-    protected $translator;
+    private $translator;
 
     public function __construct(
         ChillRedis $chillRedis,
@@ -74,8 +82,10 @@ class ExportController extends AbstractController
         FormFactoryInterface $formFactory,
         LoggerInterface $logger,
         SessionInterface $session,
-        TranslatorInterface $translator
+        TranslatorInterface $translator,
+        EntityManagerInterface $entityManager
     ) {
+        $this->entityManager = $entityManager;
         $this->redis = $chillRedis;
         $this->exportManager = $exportManager;
         $this->formFactory = $formFactory;
@@ -203,6 +213,46 @@ class ExportController extends AbstractController
         }
     }
 
+    /**
+     * @Route("/{_locale}/export/save-from-key/{alias}/{key}", name="chill_main_export_save_from_key")
+     */
+    public function saveFromKey(string $alias, string $key, Request $request): Response
+    {
+        $this->denyAccessUnlessGranted('ROLE_USER');
+        $user = $this->getUser();
+
+        if (!$user instanceof User) {
+            throw new AccessDeniedHttpException();
+        }
+
+        $data = $this->rebuildRawData($key);
+
+        $savedExport = new SavedExport();
+        $savedExport
+            ->setOptions($data)
+            ->setExportAlias($alias)
+            ->setUser($user);
+
+        $form = $this->createForm(SavedExportType::class, $savedExport);
+
+        $form->handleRequest($request);
+
+        if ($form->isSubmitted() && $form->isValid()) {
+            $this->entityManager->persist($savedExport);
+            $this->entityManager->flush();
+
+            return $this->redirectToRoute('chill_main_export_index');
+        }
+
+        return $this->render(
+            '@ChillMain/SavedExport/new.html.twig',
+            [
+                'form' => $form->createView(),
+                'saved_export' => $savedExport,
+            ]
+        );
+    }
+
     /**
      * create a form to show on different steps.
      *
@@ -418,28 +468,7 @@ class ExportController extends AbstractController
 
     protected function rebuildData($key)
     {
-        if (null === $key) {
-            throw $this->createNotFoundException('key does not exists');
-        }
-
-        if ($this->redis->exists($key) !== 1) {
-            $this->addFlash('error', $this->translator->trans('This report is not available any more'));
-
-            throw $this->createNotFoundException('key does not exists');
-        }
-
-        $serialized = $this->redis->get($key);
-
-        if (false === $serialized) {
-            throw new LogicException('the key could not be reached from redis');
-        }
-
-        $rawData = unserialize($serialized);
-
-        $this->logger->notice('[export] choices for an export unserialized', [
-            'key' => $key,
-            'rawData' => json_encode($rawData),
-        ]);
+        $rawData = $this->rebuildRawData($key);
 
         $alias = $rawData['alias'];
 
@@ -585,4 +614,32 @@ class ExportController extends AbstractController
                 throw new LogicException("the step {$step} is not defined.");
         }
     }
+
+    private function rebuildRawData(string $key): array
+    {
+        if (null === $key) {
+            throw $this->createNotFoundException('key does not exists');
+        }
+
+        if ($this->redis->exists($key) !== 1) {
+            $this->addFlash('error', $this->translator->trans('This report is not available any more'));
+
+            throw $this->createNotFoundException('key does not exists');
+        }
+
+        $serialized = $this->redis->get($key);
+
+        if (false === $serialized) {
+            throw new LogicException('the key could not be reached from redis');
+        }
+
+        $rawData = unserialize($serialized);
+
+        $this->logger->notice('[export] choices for an export unserialized', [
+            'key' => $key,
+            'rawData' => json_encode($rawData),
+        ]);
+
+        return $rawData;
+    }
 }

src/Bundle/ChillMainBundle/Entity/SavedExport.php

@@ -0,0 +1,133 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * Chill is a software for social workers
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+namespace Chill\MainBundle\Entity;
+
+use Chill\MainBundle\Doctrine\Model\TrackCreationInterface;
+use Chill\MainBundle\Doctrine\Model\TrackCreationTrait;
+use Chill\MainBundle\Doctrine\Model\TrackUpdateInterface;
+use Chill\MainBundle\Doctrine\Model\TrackUpdateTrait;
+use Doctrine\ORM\Mapping as ORM;
+use Ramsey\Uuid\Uuid;
+use Ramsey\Uuid\UuidInterface;
+
+/**
+ * @ORM\Entity
+ * @ORM\Table(name="chill_main_saved_export")
+ */
+class SavedExport implements TrackCreationInterface, TrackUpdateInterface
+{
+    use TrackCreationTrait;
+
+    use TrackUpdateTrait;
+
+    /**
+     * @ORM\Column(type="text", nullable=false, options={"default": ""})
+     */
+    private string $description = '';
+
+    /**
+     * @ORM\Column(type="text", nullable=false, options={"default": ""})
+     */
+    private string $exportAlias;
+
+    /**
+     * @ORM\Id
+     * @ORM\Column(name="id", type="uuid", unique="true")
+     * @ORM\GeneratedValue(strategy="NONE")
+     */
+    private UuidInterface $id;
+
+    /**
+     * @ORM\Column(type="json", nullable=false, options={"default": "[]"})
+     */
+    private array $options = [];
+
+    /**
+     * @ORM\Column(type="text", nullable=false, options={"default": ""})
+     */
+    private string $title = '';
+
+    /**
+     * @ORM\ManyToOne(targetEntity=User::class)
+     */
+    private User $user;
+
+    public function __construct()
+    {
+        $this->id = Uuid::uuid4();
+    }
+
+    public function getDescription(): string
+    {
+        return $this->description;
+    }
+
+    public function getExportAlias(): string
+    {
+        return $this->exportAlias;
+    }
+
+    public function getId(): UuidInterface
+    {
+        return $this->id;
+    }
+
+    public function getOptions(): array
+    {
+        return $this->options;
+    }
+
+    public function getTitle(): string
+    {
+        return $this->title;
+    }
+
+    public function getUser(): User
+    {
+        return $this->user;
+    }
+
+    public function setDescription(string $description): SavedExport
+    {
+        $this->description = $description;
+
+        return $this;
+    }
+
+    public function setExportAlias(string $exportAlias): SavedExport
+    {
+        $this->exportAlias = $exportAlias;
+
+        return $this;
+    }
+
+    public function setOptions(array $options): SavedExport
+    {
+        $this->options = $options;
+
+        return $this;
+    }
+
+    public function setTitle(string $title): SavedExport
+    {
+        $this->title = $title;
+
+        return $this;
+    }
+
+    public function setUser(User $user): SavedExport
+    {
+        $this->user = $user;
+
+        return $this;
+    }
+}

src/Bundle/ChillMainBundle/Form/SavedExportType.php

@@ -0,0 +1,40 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * Chill is a software for social workers
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+namespace Chill\MainBundle\Form;
+
+use Chill\MainBundle\Entity\SavedExport;
+use Chill\MainBundle\Form\Type\ChillTextareaType;
+use Symfony\Component\Form\AbstractType;
+use Symfony\Component\Form\Extension\Core\Type\TextType;
+use Symfony\Component\Form\FormBuilderInterface;
+use Symfony\Component\OptionsResolver\OptionsResolver;
+
+class SavedExportType extends AbstractType
+{
+    public function buildForm(FormBuilderInterface $builder, array $options)
+    {
+        $builder
+            ->add('title', TextType::class, [
+                'required' => true,
+            ])
+            ->add('description', ChillTextareaType::class, [
+                'required' => false,
+            ]);
+    }
+
+    public function configureOptions(OptionsResolver $resolver)
+    {
+        $resolver->setDefaults([
+            'class' => SavedExport::class,
+        ]);
+    }
+}

src/Bundle/ChillMainBundle/Resources/views/Export/download.html.twig

@@ -49,5 +49,9 @@ window.addEventListener("DOMContentLoaded", function(e) {
              data-download-text="{{ "Download your report"|trans|escape('html_attr') }}"
         ><span id="waiting_text">{{ "Waiting for your report"|trans ~ '...' }}</span></div>
 
+        <div>
+            <a href="{{ chill_path_add_return_path('chill_main_export_save_from_key', { alias: alias, key: app.request.query.get('key')}) }}">{{ 'Save'|trans }}</a>
+        </div>
+
     </div>
 {% endblock content %}

src/Bundle/ChillMainBundle/Resources/views/SavedExport/new.html.twig

@@ -0,0 +1,21 @@
+{% extends "@ChillMain/layout.html.twig" %}
+
+{% block title %}{{ 'saved_export.New'|trans }}{% endblock %}
+
+{% block content %}
+    <h1>{{ block('title') }}</h1>
+
+    {{ form_start(form) }}
+    {{ form_row(form.title) }}
+    {{ form_row(form.description) }}
+
+    <ul class="record_actions sticky-form-buttons">
+        <li class="cancel">
+            <a href="{{ chill_return_path_or('chill_main_homepage') }}" class="btn btn-cancel">{{ 'Cancel'|trans }}</a>
+        </li>
+        <li>
+            <button type="submit" class="btn btn-save">{{ 'Save'|trans }}</button>
+        </li>
+    </ul>
+    {{ form_end(form) }}
+{% endblock %}

src/Bundle/ChillMainBundle/migrations/Version20221107212201.php

@@ -0,0 +1,43 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * Chill is a software for social workers
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+namespace Chill\Migrations\Main;
+
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\Migrations\AbstractMigration;
+
+final class Version20221107212201 extends AbstractMigration
+{
+    public function down(Schema $schema): void
+    {
+        $this->addSql('DROP TABLE chill_main_saved_export');
+    }
+
+    public function getDescription(): string
+    {
+        return 'Create table for saved exports';
+    }
+
+    public function up(Schema $schema): void
+    {
+        $this->addSql('CREATE TABLE chill_main_saved_export (id UUID NOT NULL, user_id INT DEFAULT NULL, description TEXT DEFAULT \'\' NOT NULL, exportAlias TEXT DEFAULT \'\' NOT NULL, options JSONB DEFAULT \'[]\' NOT NULL, title TEXT DEFAULT \'\' NOT NULL, createdAt TIMESTAMP(0) WITHOUT TIME ZONE DEFAULT NULL, updatedAt TIMESTAMP(0) WITHOUT TIME ZONE DEFAULT NULL, createdBy_id INT DEFAULT NULL, updatedBy_id INT DEFAULT NULL, PRIMARY KEY(id))');
+        $this->addSql('CREATE INDEX IDX_C2029B22A76ED395 ON chill_main_saved_export (user_id)');
+        $this->addSql('CREATE INDEX IDX_C2029B223174800F ON chill_main_saved_export (createdBy_id)');
+        $this->addSql('CREATE INDEX IDX_C2029B2265FF1AEC ON chill_main_saved_export (updatedBy_id)');
+        $this->addSql('COMMENT ON COLUMN chill_main_saved_export.id IS \'(DC2Type:uuid)\'');
+        $this->addSql('COMMENT ON COLUMN chill_main_saved_export.options IS \'(DC2Type:json)\'');
+        $this->addSql('COMMENT ON COLUMN chill_main_saved_export.createdAt IS \'(DC2Type:datetime_immutable)\'');
+        $this->addSql('COMMENT ON COLUMN chill_main_saved_export.updatedAt IS \'(DC2Type:datetime_immutable)\'');
+        $this->addSql('ALTER TABLE chill_main_saved_export ADD CONSTRAINT FK_C2029B22A76ED395 FOREIGN KEY (user_id) REFERENCES users (id) NOT DEFERRABLE INITIALLY IMMEDIATE');
+        $this->addSql('ALTER TABLE chill_main_saved_export ADD CONSTRAINT FK_C2029B223174800F FOREIGN KEY (createdBy_id) REFERENCES users (id) NOT DEFERRABLE INITIALLY IMMEDIATE');
+        $this->addSql('ALTER TABLE chill_main_saved_export ADD CONSTRAINT FK_C2029B2265FF1AEC FOREIGN KEY (updatedBy_id) REFERENCES users (id) NOT DEFERRABLE INITIALLY IMMEDIATE');
+    }
+}

src/Bundle/ChillMainBundle/translations/messages.fr.yml

@@ -557,3 +557,5 @@ rolling_date:
     roll_movement: Modification par rapport à aujourd'hui
     fixed_date_date: Date fixe
 
+saved_export:
+    New: Nouveau rapport enregistré