Suppression de la dépendance avec unicaen/app (l'envoi du jeton par mail est...

Suppression de la dépendance avec unicaen/app (l'envoi du jeton par mail est désormais à la charge de l'appli).

CHANGELOG.md

 CHANGELOG
 =========
 
+7.1.0
+-----
+- Suppression de la dépendance avec unicaen/app (l'envoi du jeton par mail est désormais à la charge de l'appli).
+
 7.0.0
 -----
 - Requiert les nouvelles bibliotèques unicaen/authentification et privilege.

composer.json

@@ -8,11 +8,9 @@
         }
     ],
     "require": {
-        "unicaen/app": "^6.0",
         "unicaen/authentification": "^6.2",
         "unicaen/privilege": "^6.0",
-        "ramsey/uuid": "^3.7",
-        "laminas/laminas-dependency-plugin": "^2.1"
+        "ramsey/uuid": "^3.7"
     },
     "require-dev": {
         "phpunit/phpunit": "^8.0"
@@ -26,10 +24,5 @@
         "classmap": [
             "./Module.php"
         ]
-    },
-    "config": {
-        "allow-plugins": {
-            "laminas/laminas-dependency-plugin": true
-        }
     }
 }

config/module.config.php

@@ -4,6 +4,8 @@ namespace UnicaenAuthToken;
 
 use Doctrine\Persistence\Mapping\Driver\MappingDriverChain;
 use Doctrine\ORM\Mapping\Driver\XmlDriver;
+use UnicaenAuthToken\Mvc\RedirectResponse;
+use UnicaenAuthToken\Mvc\RedirectResponseFactory;
 use UnicaenPrivilege\Guard\PrivilegeController;
 use UnicaenPrivilege\Provider\Rule\PrivilegeRuleProvider;
 use UnicaenAuthToken\Authentication\Adapter\TokenAdapter;
@@ -272,6 +274,7 @@ return [
             TokenService::class => TokenServiceFactory::class,
             TokenLoginForm::class => TokenLoginFormFactory::class,
             TokenAdapter::class => TokenAdapterFactory::class,
+            RedirectResponse::class => RedirectResponseFactory::class,
         ],
     ],
 

src/UnicaenAuthToken/Controller/TokenController.php

@@ -9,8 +9,7 @@ use Laminas\Mvc\Plugin\FlashMessenger\FlashMessenger;
 use Laminas\View\Model\ViewModel;
 use RuntimeException;
 use UnexpectedValueException;
-use UnicaenApp\Mvc\RedirectResponse;
-use UnicaenApp\Service\Mailer\MailerServiceAwareTrait;
+use UnicaenAuthToken\Mvc\RedirectResponse;
 use UnicaenUtilisateur\Entity\Db\UserInterface;
 use UnicaenAuthentification\Service\Traits\UserServiceAwareTrait;
 use UnicaenAuthToken\Entity\Db\AbstractUserToken;
@@ -27,7 +26,6 @@ class TokenController extends AbstractActionController
 {
     use TokenServiceAwareTrait;
     use UserServiceAwareTrait;
-    use MailerServiceAwareTrait;
 
     const PROLONG_SPEC = '+1 week';
     const PROLONG_SPEC_TOSTRING = '1 semaine';
@@ -40,8 +38,6 @@ class TokenController extends AbstractActionController
     const EVENT_TOKEN_DELETE_AFTER = 'EVENT_TOKEN_DELETE_AFTER';
     const EVENT_TOKEN_PROLONGATE_BEFORE_SAVE = 'EVENT_TOKEN_PROLONGATE_BEFORE_SAVE';
     const EVENT_TOKEN_PROLONGATE_AFTER_SAVE = 'EVENT_TOKEN_PROLONGATE_AFTER_SAVE';
-    const EVENT_TOKEN_SEND_BEFORE = 'EVENT_TOKEN_SEND_BEFORE';
-    const EVENT_TOKEN_SEND_AFTER = 'EVENT_TOKEN_SEND_AFTER';
 
     /**
      * @var UserTokenForm
@@ -84,10 +80,7 @@ class TokenController extends AbstractActionController
         ];
     }
 
-    /**
-     * @return \Laminas\Http\Response|\Laminas\View\Model\ViewModel
-     */
-    public function creerAction()
+    public function creerAction(): Response|ViewModel
     {
         $userId = $this->params('user');
 
@@ -127,7 +120,14 @@ class TokenController extends AbstractActionController
                         $userToken->getExpiredOnToString()
                     ));
 
-                    $response = $this->triggerEvent(static::EVENT_TOKEN_CREATE_AFTER_SAVE, ['userToken' => $userToken, 'data' => $data]);
+                    // un message mail par défaut est fourni dans l'événement, son envoi éventuel restant à la charge de l'appli.
+                    try {
+                        $mailMessage = $this->tokenService->createUserTokenMail($userToken);
+                    } catch (\InvalidArgumentException $e) {
+                        $mailMessage = null;
+                    }
+
+                    $response = $this->triggerEvent(static::EVENT_TOKEN_CREATE_AFTER_SAVE, ['userToken' => $userToken, 'data' => $data, 'mailMessage' => $mailMessage]);
                     if ($response instanceof Response) {
                         return $response;
                     }
@@ -261,35 +261,19 @@ class TokenController extends AbstractActionController
         return $redirectCallback('unicaen-auth-token/token');
     }
 
+    /**
+     * @deprecated
+     */
     public function envoyerAction(): Response
     {
         $userToken = $this->getRequestedUserToken();
-        try {
-            $this->triggerEvent(static::EVENT_TOKEN_SEND_BEFORE, ['userToken' => $userToken]);
-
         $message = $this->tokenService->createUserTokenMail($userToken);
-            try {
-                $message = $this->mailerService->send($message);
-            } catch (\Exception $e) {
-                throw new TokenServiceException("L'envoi du token par mail a échoué", null, $e);
-            }
-
-            $userToken->setSentOn(new \DateTime('now'));
-            $this->tokenService->saveUserToken($userToken);
 
-            $this->flashMessenger()->addSuccessMessage(sprintf(
-                "Le jeton utilisateur a été envoyé avec succès à %s.",
+        $this->flashMessenger()->addErrorMessage(sprintf(
+            "Le jeton utilisateur n'a pas été envoyé à %s, la bibliothèque n'envoie plus de mail !",
             $message->getTo()->rewind()->getEmail()
         ));
 
-            $response = $this->triggerEvent(static::EVENT_TOKEN_SEND_AFTER, ['userToken' => $userToken, 'message' => $message]);
-            if ($response instanceof Response) {
-                return $response;
-            }
-        } catch (TokenServiceException $e) {
-            throw new RuntimeException("Erreur rencontrée lors de l'envoi du jeton utilisateur.");
-        }
-
         $redirectCallback = $this->redirectResponse;
 
         return $redirectCallback('unicaen-auth-token/token');

src/UnicaenAuthToken/Controller/TokenControllerFactory.php

@@ -3,8 +3,7 @@
 namespace UnicaenAuthToken\Controller;
 
 use Interop\Container\ContainerInterface;
-use UnicaenApp\Mvc\RedirectResponse;
-use UnicaenApp\Service\Mailer\MailerService;
+use UnicaenAuthToken\Mvc\RedirectResponse;
 use UnicaenAuthToken\Form\UserTokenForm;
 use UnicaenAuthToken\Service\TokenService;
 use UnicaenAuthentification\Service\User as UserService;
@@ -33,9 +32,6 @@ class TokenControllerFactory
         $redirectResponse = $container->get(RedirectResponse::class);
         $controller->setRedirectResponse($redirectResponse);
 
-        $mailerService = $container->get(MailerService::class);
-        $controller->setMailerService($mailerService);
-
         return $controller;
     }
 }
\ No newline at end of file

src/UnicaenAuthToken/Mvc/RedirectResponse.php

+<?php
+
+namespace UnicaenAuthToken\Mvc;
+
+use Laminas\Http\PhpEnvironment\Request;
+use Laminas\Http\PhpEnvironment\Response;
+use Laminas\Mvc\Application;
+use Laminas\Router\Exception;
+use Laminas\Router\RouteInterface;
+
+/**
+ * Buils a redirect response based on the current routing and parameters
+ */
+class RedirectResponse
+{
+    /** @var RouteInterface  */
+    private $router;
+
+    /** @var Application */
+    private $application;
+
+    /**
+     * @param Application $application
+     * @param RouteInterface $router
+     */
+    public function __construct(Application $application, RouteInterface $router)
+    {
+        $this->router = $router;
+        $this->application = $application;
+    }
+
+    /**
+     * @param string $defaultRedirect
+     * @return Response
+     */
+    public function __invoke(string $defaultRedirect): Response
+    {
+        $redirect = $this->getRedirect($defaultRedirect);
+
+        /** @var Response $response */
+        $response = $this->application->getResponse();
+        $response->getHeaders()->addHeaderLine('Location', $redirect);
+        $response->setStatusCode(302);
+
+        return $response;
+    }
+
+    /**
+     * @param string $defaultRedirect
+     * @return string|null
+     */
+    protected function getRedirect(string $defaultRedirect): ?string
+    {
+        $redirect = $this->getRedirectFromRequest() ?: $defaultRedirect;
+
+        if ($this->routeExists($redirect)) {
+            return $this->router->assemble([], ['name' => $redirect]);
+        }
+
+        return $redirect;
+    }
+
+    /**
+     * @return string
+     */
+    private function getRedirectFromRequest(): ?string
+    {
+        /** @var Request $request */
+        $request  = $this->application->getRequest();
+
+        if ($redirectFromQuery = $request->getQuery('redirect')) {
+            return $redirectFromQuery;
+        }
+        if ($redirectFromPost = $request->getPost('redirect')) {
+            return $redirectFromPost;
+        }
+
+        return null;
+    }
+
+    /**
+     * @param string $route
+     * @return bool
+     */
+    private function routeExists(string $route): bool
+    {
+        try {
+            $this->router->assemble([], ['name' => $route]);
+        } catch (Exception\RuntimeException $e) {
+            return false;
+        }
+        return true;
+    }
+}

src/UnicaenAuthToken/Mvc/RedirectResponseFactory.php

+<?php
+
+namespace UnicaenAuthToken\Mvc;
+
+use Psr\Container\ContainerInterface;
+use Laminas\Mvc\Application;
+use Laminas\Router\RouteInterface;
+
+class RedirectResponseFactory
+{
+    /**
+     * @throws \Psr\Container\ContainerExceptionInterface
+     * @throws \Psr\Container\NotFoundExceptionInterface
+     */
+    public function __invoke(ContainerInterface $container, $requestedName, array $options = null): RedirectResponse
+    {
+        /* @var RouteInterface $router */
+        $router = $container->get('Router');
+
+        /* @var Application $application */
+        $application = $container->get('Application');
+
+        return new RedirectResponse($application, $router);
+    }
+}

view/unicaen-auth-token/token/partial/add-button.phtml

 <?php
 /**
+ * @var string|null $route
  * @var string|null $redirect
  * @var \UnicaenUtilisateur\Entity\Db\UserInterface|int|null $user
  * @var \Application\View\Renderer\PhpRenderer $this
@@ -24,7 +25,7 @@ $creable = $this->isAllowed(new UserToken(), TokenPrivilege::CREER);
         'redirect' => $redirect ?: 'unicaen-auth-token/token',
     ];
     ?>
-    <a href="<?php echo $this->url('unicaen-auth-token/token/creer', $options, ['query' => $queryParams]) ?>"
+    <a href="<?php echo $this->url($route ?: 'unicaen-auth-token/token/creer', $options, ['query' => $queryParams]) ?>"
        class="btn btn-primary" title="Créer un nouveau jeton utilisateur">Nouveau jeton utilisateur</span></a>
 </p>
 <?php endif ?>