Display the 404 and 500 custom error pages

OpenConext · Jan 24, 2024 · fdf01ed · fdf01ed
1 parent 89b1cf1
commit fdf01ed
Show file tree

Hide file tree

Showing 6 changed files with 102 additions and 5 deletions.
diff --git a/composer.lock b/composer.lock
diff --git a/config/packages/framework.yaml b/config/packages/framework.yaml
@@ -19,6 +19,7 @@ framework:
         cookie_samesite: lax
 
     fragments: false
+    error_controller: Surfnet\StepupSelfService\SelfServiceBundle\Controller\ExceptionController::show
     http_method_override: true
     php_errors:
         log: true

diff --git a/config/packages/monolog.yaml b/config/packages/monolog.yaml
@@ -7,6 +7,7 @@ monolog:
       action_level: ERROR
       passthru_level: NOTICE # this means that all message of level NOTICE or higher are always logged
       handler: main_stdout
+      channels: [ "!event" ]
       bubble: false # if we handle it, nothing else should
     main_stdout:
       type: stream
@@ -20,6 +21,7 @@ when@dev:
       prod-signaler:
         action_level: ERROR
         passthru_level: DEBUG # DEV setting: this means that all message of level DEBUG or higher are always logged
+        channels: [ "!event" ]
         bubble: true
       main_logfile:
         type: stream

diff --git a/src/Surfnet/StepupSelfService/SelfServiceBundle/Controller/ExceptionController.php b/src/Surfnet/StepupSelfService/SelfServiceBundle/Controller/ExceptionController.php
@@ -20,6 +20,11 @@
 
 namespace Surfnet\StepupSelfService\SelfServiceBundle\Controller;
 
+use DateTime;
+use DateTimeInterface;
+use Surfnet\StepupBundle\Exception\Art;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
 use Throwable;
 use Surfnet\StepupBundle\Controller\ExceptionController as BaseExceptionController;
 use Surfnet\StepupSelfService\SelfServiceBundle\Exception\MissingRequiredAttributeException;
@@ -48,4 +53,36 @@ protected function getPageTitleAndDescription(Throwable $exception): array
 
         return parent::getPageTitleAndDescription($exception);
     }
+
+    public function show(Request $request, Throwable $exception): Response
+    {
+        $statusCode = $this->getStatusCode($exception);
+
+        $template = '@default/bundles/TwigBundle/Exception/error.html.twig';
+        if ($statusCode == 404) {
+            $template = '@default/bundles/TwigBundle/Exception/error404.html.twig';
+        }
+
+        $response = new Response('', $statusCode);
+
+        $timestamp = (new DateTime)->format(DateTimeInterface::ATOM);
+        $hostname  = $request->getHost();
+        $requestId = $this->requestId;
+        $errorCode = Art::forException($exception);
+        $userAgent = $request->headers->get('User-Agent');
+        $ipAddress = $request->getClientIp();
+
+        return $this->render(
+            $template,
+            [
+                'timestamp'   => $timestamp,
+                'hostname'    => $hostname,
+                'request_id'  => $requestId->get(),
+                'error_code'  => $errorCode,
+                'user_agent'  => $userAgent,
+                'ip_address'  => $ipAddress,
+            ] + $this->getPageTitleAndDescription($exception),
+            $response
+        );
+    }
 }
diff --git a/templates/bundles/TwigBundle/Exception/error.html.twig b/templates/bundles/TwigBundle/Exception/error.html.twig
@@ -0,0 +1,42 @@
+{% extends 'base.html.twig' %}
+
+{% block title %}{{ 'Error - ' ~ title }}{% endblock %}
+
+{% block content %}
+    <p class="error-description">{{ description }}</p>
+
+    <table class="table table-bordered">
+        <tr>
+            <th>{{ 'stepup.error.timestamp'|trans }}</th>
+            <td>{{ timestamp }}</td>
+        </tr>
+        <tr>
+            <th>{{ 'stepup.error.hostname'|trans }}</th>
+            <td>{{ hostname }}</td>
+        </tr>
+        <tr>
+            <th>{{ 'stepup.error.request_id'|trans }}</th>
+            <td>{{ request_id }}</td>
+        </tr>
+        <tr>
+            <th>{{ 'stepup.error.error_code'|trans }}</th>
+            <td>{{ error_code }}</td>
+        </tr>
+        {% if user_agent %}
+        <tr>
+            <th>{{ 'stepup.error.user_agent'|trans }}</th>
+            <td>{{ user_agent }}</td>
+        </tr>
+        {% endif %}
+        <tr>
+            <th>{{ 'stepup.error.ip_address'|trans }}</th>
+            <td>{{ ip_address }}</td>
+        </tr>
+    </table>
+
+    <p class="error-description">{{ 'stepup.error.support_page.text'|trans({'%support_url%': global_view_parameters.supportUrl })|raw }}</p>
+
+    {# For now the back button is not shown on the error page until a more intelligent solution is thought of #}
+    {% block back_button %}{% endblock %}
+
+{% endblock %}
diff --git a/templates/bundles/TwigBundle/Exception/error404.html.twig b/templates/bundles/TwigBundle/Exception/error404.html.twig
@@ -0,0 +1,15 @@
+{% extends 'base.html.twig' %}
+
+{% block title %}{{ 'stepup.error.page_not_found.title'|trans }}{% endblock %}
+
+{% block content %}
+    <p>{{ 'stepup.error.page_not_found.text'|trans }}</p>
+
+    <hr>
+
+    <p>{{ 'stepup.error.support_page.text'|trans({'%support_url%': global_view_parameters.supportUrl })|raw }}</p>
+
+    {# For now the back button is not shown on the error page until a more intelligent solution is thought of #}
+    {% block back_button %}{% endblock %}
+
+{% endblock %}