Merge pull request #6367 from christianbeeznest/ofaj-22701

Internal: Improve custom error handling for NotAllowedException with styled feedback - refs BT#22701

Author: NicoDucou

public/main/inc/global.inc.php

@@ -4,6 +4,7 @@
 
 use Chamilo\CoreBundle\Controller\ExceptionController;
 use Chamilo\CoreBundle\EventListener\ExceptionListener;
+use Chamilo\CoreBundle\Exception\NotAllowedException;
 use Chamilo\CoreBundle\Framework\Container;
 use Symfony\Component\Dotenv\Dotenv;
 use Symfony\Component\ErrorHandler\Debug;
@@ -92,18 +93,35 @@
     $router->setContext($context);
 
     set_exception_handler(function ($exception) use ($kernel, $container, $request) {
-        if (\in_array($kernel->getEnvironment(), ['dev', 'test'], true)) {
+        if (
+            in_array($kernel->getEnvironment(), ['dev', 'test'], true) &&
+            !($exception instanceof NotAllowedException)
+        ) {
             throw $exception;
         }
 
-        $event = new ExceptionEvent($kernel, $request, HttpKernelInterface::MAIN_REQUEST, $exception);
+        $event = new ExceptionEvent(
+            $kernel,
+            $request,
+            HttpKernelInterface::MAIN_REQUEST,
+            $exception
+        );
+
+        /** @var callable $listener */
         $listener = $container->get(ExceptionListener::class);
         if (is_callable($listener)) {
             $listener($event);
         }
         $response = $event->getResponse();
         if (!$response) {
-            $response = new Response('An error occurred', Response::HTTP_INTERNAL_SERVER_ERROR);
+            $statusCode = $exception instanceof NotAllowedException
+                ? Response::HTTP_OK
+                : Response::HTTP_INTERNAL_SERVER_ERROR;
+
+            $response = new Response(
+                $exception->getMessage(),
+                $statusCode
+            );
         }
         $response->send();
     });

public/main/inc/lib/api.lib.php

@@ -3553,19 +3553,21 @@ function api_is_anonymous()
 
 /**
  * Displays message "You are not allowed here..." and exits the entire script.
- *
- * @param bool $print_headers Whether to print headers (default = false -> does not print them)
- * @param string $message
- * @param int $responseCode
- *
- * @throws Exception
  */
 function api_not_allowed(
-    $print_headers = false,
-    $message = null,
-    $responseCode = 0
+    bool $printHeaders = false,
+    string $message = null,
+    int $responseCode = 0,
+    string $severity = 'warning'
 ): never {
-    throw new NotAllowedException($message ?: 'You are not allowed', null, $responseCode);
+    throw new NotAllowedException(
+        $message ?: get_lang('You are not allowed'),
+        $severity,
+        403,
+        [],
+        $responseCode,
+        null
+    );
 }
 
 /**

src/CoreBundle/EventListener/ExceptionListener.php

@@ -45,6 +45,17 @@ public function __invoke(ExceptionEvent $event): void
 
                 return;
             }
+
+            $severity = $exception->getSeverity();
+            $message = $exception->getMessage();
+            if (in_array($severity, ['info', 'warning', 'success'], true)) {
+                $html = $this->twig->render('@ChamiloCore/Exception/not_allowed_message.html.twig', [
+                    'message' => $message,
+                    'severity' => $severity,
+                ]);
+                $event->setResponse(new Response($html, 200));
+                return;
+            }
         }
 
         if (isset($_SERVER['APP_ENV']) && \in_array($_SERVER['APP_ENV'], ['dev', 'test'], true)) {

src/CoreBundle/Exception/NotAllowedException.php

@@ -6,14 +6,27 @@
 
 namespace Chamilo\CoreBundle\Exception;
 
-use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\Exception\HttpException;
 use Throwable;
 
 class NotAllowedException extends HttpException
 {
-    public function __construct(?string $message = 'Not allowed', ?Throwable $previous = null, int $code = 0, array $headers = [])
+    private string $severity;
+
+    public function __construct(
+        string $message = 'Not allowed',
+        string $severity = 'warning',
+        int $statusCode = 403,
+        array $headers = [],
+        int $code = 0,
+        Throwable $previous = null
+    ) {
+        $this->severity = $severity;
+        parent::__construct($statusCode, $message, $previous, $headers, $code);
+    }
+
+    public function getSeverity(): string
     {
-        parent::__construct(Response::HTTP_FORBIDDEN, $message, $previous, $headers, $code);
+        return $this->severity;
     }
 }

src/CoreBundle/Resources/views/Exception/not_allowed_message.html.twig

@@ -0,0 +1,19 @@
+{% extends '@ChamiloCore/Layout/layout_one_col.html.twig' %}
+
+{% block content %}
+    {% set style = {
+        'info':    { 'bg': 'bg-info',    'txt': 'text-white',    'icon': 'mdi mdi-information-outline' },
+        'success': { 'bg': 'bg-success', 'txt': 'text-white', 'icon': 'mdi mdi-check-circle-outline' },
+        'warning': { 'bg': 'bg-warning', 'txt': 'text-white', 'icon': 'mdi mdi-alert-outline' },
+        'danger':  { 'bg': 'bg-danger',  'txt': 'text-white',  'icon': 'mdi mdi-alert-octagon-outline' }
+    }[severity|default('info')] %}
+
+    <div class="container max-w-2xl mx-auto mt-10">
+        <div class="flex items-center gap-4 rounded-2xl p-6 {{ style.bg }} {{ style.txt }}/80 shadow text-bold">
+            <i class="{{ style.icon }} text-4xl {{ style.txt }}"></i>
+            <p class="font-extrabold text-xl {{ style.txt }}">
+                {{ message|trans|striptags|raw }}
+            </p>
+        </div>
+    </div>
+{% endblock %}