Add DecodeExceptionAgent.

Author: prwater

composer.json

@@ -15,6 +15,7 @@
     "plaisio/exception": "^1.1",
     "plaisio/exception-handler": "^1.1",
     "plaisio/kernel": "^1.1",
+    "plaisio/obfuscator": "^1.2",
     "plaisio/response-core": "^1.1",
     "setbased/helper-code-store-php": "^2.3",
     "setbased/php-stratum-middle": "^5.2",

src/DecodeExceptionAgent.php

@@ -0,0 +1,72 @@
+<?php
+declare(strict_types=1);
+
+namespace Plaisio\ExceptionHandler;
+
+use Plaisio\Kernel\Nub;
+use Plaisio\Obfuscator\Exception\DecodeException;
+use Plaisio\Response\BadRequestResponse;
+
+/**
+ * An agent that handles DecodeException exceptions.
+ */
+class DecodeExceptionAgent
+{
+  //--------------------------------------------------------------------------------------------------------------------
+  /**
+   * Handles a DecodeException thrown in the constructor of a page object.
+   *
+   * @param DecodeException $exception The exception.
+   *
+   * @since 1.2.0
+   * @api
+   */
+  public function handleConstructException(DecodeException $exception): void
+  {
+    $this->handleException($exception);
+  }
+
+  //--------------------------------------------------------------------------------------------------------------------
+  /**
+   * Handles a DecodeException thrown during generating the response by a page object.
+   *
+   * @param DecodeException $exception The exception.
+   *
+   * @since 1.2.0
+   * @api
+   */
+  public function handleResponseException(DecodeException $exception): void
+  {
+    $this->handleException($exception);
+  }
+
+  //--------------------------------------------------------------------------------------------------------------------
+  /**
+   * Handles a DecodeException.
+   *
+   * @param DecodeException $exception The exception.
+   */
+  private function handleException(DecodeException $exception): void
+  {
+    Nub::$DL->rollback();
+
+    // Set the HTTP status to 400 (Bad Request).
+    $response = new BadRequestResponse();
+    $response->send();
+
+    // Log the bad request.
+    Nub::$requestLogger->logRequest($response->getStatus());
+    Nub::$DL->commit();
+
+    // Only on development environment log the error.
+    if (Nub::$request->isEnvDev())
+    {
+      $logger = Nub::$nub->getErrorLogger();
+      $logger->logError($exception);
+    }
+  }
+
+  //--------------------------------------------------------------------------------------------------------------------
+}
+
+//----------------------------------------------------------------------------------------------------------------------

test/Command/Foo.txt

@@ -58,6 +58,12 @@ class Foo implements ExceptionHandler
         $handler->handleConstructException($exception);
         break;
 
+      case is_a($exception, 'Plaisio\Obfuscator\Exception\DecodeException'):
+        /** @var \Plaisio\Obfuscator\Exception\DecodeException $exception */
+        $handler = new \Plaisio\ExceptionHandler\DecodeExceptionAgent();
+        $handler->handleConstructException($exception);
+        break;
+
       case is_a($exception, 'Plaisio\Exception\InvalidUrlException'):
         /** @var \Plaisio\Exception\InvalidUrlException $exception */
         $handler = new \Plaisio\ExceptionHandler\InvalidUrlExceptionAgent();
@@ -98,6 +104,12 @@ class Foo implements ExceptionHandler
         $handler->handleResponseException($exception);
         break;
 
+      case is_a($exception, 'Plaisio\Obfuscator\Exception\DecodeException'):
+        /** @var \Plaisio\Obfuscator\Exception\DecodeException $exception */
+        $handler = new \Plaisio\ExceptionHandler\DecodeExceptionAgent();
+        $handler->handleResponseException($exception);
+        break;
+
       case is_a($exception, 'Plaisio\Exception\InvalidUrlException'):
         /** @var \Plaisio\Exception\InvalidUrlException $exception */
         $handler = new \Plaisio\ExceptionHandler\InvalidUrlExceptionAgent();

test/Command/plaisio.xml

@@ -3,12 +3,13 @@
         <class>\SetBased\Stratum\Test\Application\Foo</class>
         <path>test/Command/Foo.php</path>
         <agents>
-            <agent>\Plaisio\ExceptionHandler\ThrowableAgent</agent>
+            <agent>\Plaisio\ExceptionHandler\BadRequestExceptionAgent</agent>
+            <agent>\Plaisio\ExceptionHandler\DecodeExceptionAgent</agent>
             <agent>\Plaisio\ExceptionHandler\InvalidUrlExceptionAgent</agent>
             <agent>\Plaisio\ExceptionHandler\NotAuthorizedExceptionAgent</agent>
             <agent>\Plaisio\ExceptionHandler\NotPreferredUrlExceptionAgent</agent>
-            <agent>\Plaisio\ExceptionHandler\BadRequestExceptionAgent</agent>
             <agent>\Plaisio\ExceptionHandler\ResultExceptionAgent</agent>
+            <agent>\Plaisio\ExceptionHandler\ThrowableAgent</agent>
         </agents>
     </exception>
 </plaisio>