Adjust: give the request object to ApiCore

Jan-Schuppik · Jan-Schuppik · commit 9c2277f29845 · 2025-08-22T15:35:27.000+02:00
diff --git a/application/controllers/ApiController.php b/application/controllers/ApiController.php
@@ -53,7 +53,6 @@ public function indexAction(): never
     private function dispatchEndpoint(Request $request, Response $response): void
     {
         $params = $request->getParams();
-        $getParams = Url::fromRequest()->getQueryString();
         $method = $request->getMethod();
         $methodName = strtolower($method);
         $moduleName = $request->getModuleName();
@@ -74,6 +73,7 @@ private function dispatchEndpoint(Request $request, Response $response): void
             $this->httpNotFound(404, "Endpoint $endpoint does not exist.");
         }
 
+        // TODO: move this to an api core or version class?
         $parsedMethodName = ($method === 'GET' && empty($identifier)) ? $methodName . 'Any' : $methodName;
 
         if (!in_array($parsedMethodName, get_class_methods($className))) {
@@ -84,25 +84,12 @@ private function dispatchEndpoint(Request $request, Response $response): void
             }
         }
 
-        // Validate that Method with parameters or identifier is allowed
-        if ($method !== 'GET' && !empty($getParams)) {
-            $this->httpBadRequest(
-                "Invalid request: $method with query parameters, only GET is allowed with query parameters."
-            );
-        } elseif ($method === 'GET' && !empty($identifier) && !empty($getParams)) {
-            $this->httpBadRequest(
-                "Invalid request: $method with identifier and query parameters, it's not allowed to use both together."
-            );
-        }
-
         // Choose the correct constructor call based on the endpoint
-        if (strtolower($endpoint) === ApiCore::OPENAPI_ENDPOINT) {
-            (new $className($moduleName, $response))->$parsedMethodName();
-        } elseif (in_array($method, ['POST', 'PUT'])) {
+        if (in_array($method, ['POST', 'PUT'])) {
             $data = $this->getValidatedJsonContent($request);
-            (new $className($response, $getParams, $identifier))->$parsedMethodName($data);
+            (new $className($request, $response))->$parsedMethodName($data);
         } else {
-            (new $className($response, $getParams, $identifier))->$parsedMethodName();
+            (new $className($request, $response))->$parsedMethodName();
         }
     }
 
diff --git a/library/Notifications/Api/ApiCore.php b/library/Notifications/Api/ApiCore.php
@@ -8,11 +8,9 @@
 use Icinga\Exception\ProgrammingError;
 use Icinga\Module\Notifications\Common\Database;
 use Icinga\Util\Environment;
+use Icinga\Web\Request;
 use Icinga\Web\Response;
 use ipl\Sql\Connection;
-use OpenApi\Attributes as OA;
-
-
 
 abstract class ApiCore
 {
@@ -30,12 +28,6 @@ abstract class ApiCore
      * @var array
      */
     protected array $results = [];
-    /**
-     * The HTTP response code to be returned.
-     *
-     * @var int
-     */
-    protected int $responseCode = 200;
     /**
      * The database connection used for API operations.
      *
@@ -50,47 +42,32 @@ abstract class ApiCore
     protected string $version;
 
     public function __construct(
+        /**
+         * The HTTP request object containing the API request data.
+         *
+         * @var Request
+         */
+        readonly private Request $request,
         /**
          * The HTTP response object used to send responses back to the client.
          *
          * @var Response
          */
-        protected Response $response,
-    )
-    {
+        readonly private Response $response,
+    ) {
         $this->db = Database::get();
+        $this->init();
     }
 
     /**
-     * Immediately respond w/ HTTP 400
-     *
-     * @param string $message Exception message or exception format string
-     * @param mixed ...$arg Format string argument
-     *
-     * @return never
-     *
-     * @throws  HttpBadRequestException
-     */
-    public function httpBadRequest(string $message, mixed ...$arg) :never
-    {
-        throw HttpBadRequestException::create(func_get_args());
-    }
-
-
-    /**
-     * Immediately respond w/ HTTP 404
+     * Initialize the API core.
      *
-     * @param string $message Exception message or exception format string
-     * @param mixed ...$arg Format string argument
+     * This method is called in the constructor and should be implemented by subclasses
+     * to perform any necessary initialization tasks.
      *
-     * @return never
-     *
-     * @throws  HttpNotFoundException
+     * @return void
      */
-    public function httpNotFound(string $message, mixed ...$arg): never
-    {
-        throw HttpNotFoundException::create(func_get_args());
-    }
+    abstract protected function init(): void;
 
     /**
      * Get the files including the ApiCore.php file and any other files matching the given filter.
@@ -128,17 +105,80 @@ protected function getFilesIncludingDocs(string $fileFilter = '*'): array
         return $files;
     }
 
+    /**
+     * Get the Request object
+     *
+     * @return Request
+     */
+    protected function getRequest(): Request
+    {
+        return $this->request;
+    }
+
+    /**
+     * Get the Response object
+     *
+     * This method returns the response object that is used to send back the API response.
+     *
+     * @return Response
+     */
+    protected function getResponse(): Response
+    {
+        return $this->response;
+    }
+
+    /**
+     * Immediately respond w/ HTTP 400
+     *
+     * @param string $message Exception message or exception format string
+     * @param mixed ...$arg Format string argument
+     *
+     * @return never
+     *
+     * @throws  HttpBadRequestException
+     */
+    public function httpBadRequest(string $message, mixed ...$arg): never
+    {
+        throw HttpBadRequestException::create(func_get_args());
+    }
+
+
+    /**
+     * Immediately respond w/ HTTP 404
+     *
+     * @param string $message Exception message or exception format string
+     * @param mixed ...$arg Format string argument
+     *
+     * @return never
+     *
+     * @throws  HttpNotFoundException
+     */
+    public function httpNotFound(string $message, mixed ...$arg): never
+    {
+        throw HttpNotFoundException::create(func_get_args());
+    }
+
+    /**
+     * Send a JSON response with the given print function.
+     *
+     * This method clears the output buffer, raises the execution time,
+     * sets the appropriate headers for a JSON response, and then calls
+     * the provided print function to output the JSON data.
+     *
+     * @param callable $printFunc A function that prints the JSON data.
+     *
+     * @return void
+     */
     protected function sendJsonResponse(callable $printFunc): void
     {
         ob_end_clean();
         Environment::raiseExecutionTime();
 
         $this->getResponse()
-        ->setHeader('Content-Type', 'application/json')
-        ->setHeader('Cache-Control', 'no-store')
-        ->sendResponse();
+            ->setHeader('Content-Type', 'application/json')
+            ->setHeader('Cache-Control', 'no-store')
+            ->sendResponse();
 
         $printFunc();
     }
-
 }
diff --git a/library/Notifications/Api/V1/ApiV1.php b/library/Notifications/Api/V1/ApiV1.php
@@ -5,9 +5,9 @@
 use Exception;
 use Icinga\Exception\Http\HttpBadRequestException;
 use Icinga\Module\Notifications\Api\ApiCore;
-use Icinga\Web\Response;
 use ipl\Sql\Compat\FilterProcessor;
 use ipl\Web\Filter\QueryString;
+use ipl\Web\Url;
 use Ramsey\Uuid\Uuid;
 use OpenApi\Attributes as OA;
 
@@ -58,50 +58,47 @@
 )]
 abstract class ApiV1 extends ApiCore
 {
-    public function __construct(
-        Response $response,
-        /**
-         * The filter string used to filter results.
-         * This is typically a query string parameter that specifies conditions for filtering.
-         *
-         * @var string|null
-         */
-        protected ?string $filterStr = null,
-        /**
-         * The identifier for the resource being accessed.
-         *
-         * @var string|null
-         */
-        protected ?string $identifier = null
-    ) {
-        parent::__construct($response);
-        $this->version = 'v1';
-//        var_dump($response, $params, $identifier);
-        $this->validateIdentifier();
-    }
-
+    protected string $identifier;
     /**
-     * Get the Response object
+     * Initialize the API
      *
-     * @return Response
+     * @return void
+     * @throws HttpBadRequestException
      */
-    public function getResponse(): Response
+    protected function init(): void
     {
-        return $this->response;
+        $this->version = 'v1';
+        $this->validateIdentifier();
+        $method = $this->getRequest()->getMethod();
+        $filterStr = Url::fromRequest()->getQueryString();
+
+        // Validate that Method with parameters or identifier is allowed
+        if ($method !== 'GET' && !empty($filterStr)) {
+            $this->httpBadRequest(
+                "Invalid request: $method with query parameters, only GET is allowed with query parameters."
+            );
+        } elseif ($method === 'GET' && !empty($this->identifier) && !empty($filterStr)) {
+            $this->httpBadRequest(
+                "Invalid request: $method with identifier and query parameters, it's not allowed to use both together."
+            );
+        }
     }
 
     /**
      * Validate the identifier to ensure it is a valid UUID.
-     *
      * If the identifier is not valid, it will throw a Bad Request HTTP exception.
+     * If a valid identifier is provided, it will be stored in the `identifier` property.
      *
      * @return void
      * @throws HttpBadRequestException
      */
     protected function validateIdentifier(): void
     {
-        if (($i = $this->identifier) && !Uuid::isValid($i)) {
-            $this->httpBadRequest('The given identifier is not a valid UUID');
+        if ($identifier = $this->getRequest()->getParams()['identifier'] ?? null) {
+            if (!Uuid::isValid($identifier)) {
+                $this->httpBadRequest('The given identifier is not a valid UUID');
+            }
+            $this->identifier = $identifier;
         }
     }
 
@@ -117,9 +114,9 @@ protected function validateIdentifier(): void
      */
     protected function createFilterFromFilterStr(callable $listener): array|bool
     {
-        if (!empty($this->filterStr)) {
+        if (!empty($filterStr = Url::fromRequest()->getQueryString())) {
             try {
-                $filterRule = QueryString::fromString($this->filterStr)
+                $filterRule = QueryString::fromString($filterStr)
                     ->on(
                         QueryString::ON_CONDITION,
                         $listener
diff --git a/library/Notifications/Api/V1/OpenApi.php b/library/Notifications/Api/V1/OpenApi.php
@@ -67,19 +67,6 @@
 )]
 class OpenApi extends ApiV1
 {
-    public function __construct(
-        /**
-         * The name of the module for which the OpenAPI documentation is generated.
-         * This is used to identify the module in the API documentation.
-         *
-         * @var string
-         */
-        protected string $moduleName,
-        Response $response
-    ) {
-        parent::__construct($response);
-    }
-
     /**
      * Generate OpenAPI documentation for the Notifications API
      *
