Merge pull request #11086 from nupplaphil/feat/profile_dice

[friendica.git] / src / BaseModule.php

diff --git a/src/BaseModule.php b/src/BaseModule.php
index 86dd5e7c064d1d83b035da29ba91ec6ccc5e5543..7dcd821e49510c33c68669d51816bb45e747effe 100644 (file)
--- a/src/BaseModule.php
+++ b/src/BaseModule.php
@@ -128,8 +128,10 @@ abstract class BaseModule implements ICanHandleRequests
         *
         * Extend this method if the module is supposed to process DELETE requests.
         * Doesn't display any content
+        *
+        * @param string[] $request The $_REQUEST content
         */
-       protected function delete()
+       protected function delete(array $request = [])
        {
        }
 
@@ -138,8 +140,10 @@ abstract class BaseModule implements ICanHandleRequests
         *
         * Extend this method if the module is supposed to process PATCH requests.
         * Doesn't display any content
+        *
+        * @param string[] $request The $_REQUEST content
         */
-       protected function patch()
+       protected function patch(array $request = [])
        {
        }
 
@@ -150,10 +154,9 @@ abstract class BaseModule implements ICanHandleRequests
         * Doesn't display any content
         *
         * @param string[] $request The $_REQUEST content
-        * @param string[] $post    The $_POST content
         *
         */
-       protected function post(array $request = [], array $post = [])
+       protected function post(array $request = [])
        {
                // $this->baseUrl->redirect('module');
        }
@@ -163,15 +166,17 @@ abstract class BaseModule implements ICanHandleRequests
         *
         * Extend this method if the module is supposed to process PUT requests.
         * Doesn't display any content
+        *
+        * @param string[] $request The $_REQUEST content
         */
-       protected function put()
+       protected function put(array $request = [])
        {
        }
 
        /**
         * {@inheritDoc}
         */
-       public function run(array $post = [], array $request = []): ResponseInterface
+       public function run(array $request = []): ResponseInterface
        {
                // @see https://github.com/tootsuite/mastodon/blob/c3aef491d66aec743a3a53e934a494f653745b61/config/initializers/cors.rb
                if (substr($request['pagename'] ?? '', 0, 12) == '.well-known/') {
@@ -208,17 +213,17 @@ abstract class BaseModule implements ICanHandleRequests
 
                switch ($this->server['REQUEST_METHOD'] ?? Router::GET) {
                        case Router::DELETE:
-                               $this->delete();
+                               $this->delete($request);
                                break;
                        case Router::PATCH:
-                               $this->patch();
+                               $this->patch($request);
                                break;
                        case Router::POST:
-                               Core\Hook::callAll($this->args->getModuleName() . '_mod_post', $post);
-                               $this->post($request, $post);
+                               Core\Hook::callAll($this->args->getModuleName() . '_mod_post', $request);
+                               $this->post($request);
                                break;
                        case Router::PUT:
-                               $this->put();
+                               $this->put($request);
                                break;
                }
 
@@ -231,7 +236,7 @@ abstract class BaseModule implements ICanHandleRequests
                        $arr = ['content' => ''];
                        Hook::callAll(static::class . '_mod_content', $arr);
                        $this->response->addContent($arr['content']);
-                       $this->response->addContent($this->content($_REQUEST));
+                       $this->response->addContent($this->content($request));
                } catch (HTTPException $e) {
                        $this->response->addContent((new ModuleHTTPException())->content($e));
                } finally {
@@ -241,6 +246,48 @@ abstract class BaseModule implements ICanHandleRequests
                return $this->response->generate();
        }
 
+       /**
+        * Checks request inputs and sets default parameters
+        *
+        * @param array $defaults Associative array of expected request keys and their default typed value. A null
+        *                        value will remove the request key from the resulting value array.
+        * @param array $input    Custom REQUEST array, superglobal instead
+        *
+        * @return array Request data
+        */
+       protected function checkDefaults(array $defaults, array $input): array
+       {
+               $request = [];
+
+               foreach ($defaults as $parameter => $defaultvalue) {
+                       if (is_string($defaultvalue)) {
+                               $request[$parameter] = $input[$parameter] ?? $defaultvalue;
+                       } elseif (is_int($defaultvalue)) {
+                               $request[$parameter] = (int)($input[$parameter] ?? $defaultvalue);
+                       } elseif (is_float($defaultvalue)) {
+                               $request[$parameter] = (float)($input[$parameter] ?? $defaultvalue);
+                       } elseif (is_array($defaultvalue)) {
+                               $request[$parameter] = $input[$parameter] ?? [];
+                       } elseif (is_bool($defaultvalue)) {
+                               $request[$parameter] = in_array(strtolower($input[$parameter] ?? ''), ['true', '1']);
+                       } else {
+                               $this->logger->notice('Unhandled default value type', ['parameter' => $parameter, 'type' => gettype($defaultvalue)]);
+                       }
+               }
+
+               foreach ($input ?? [] as $parameter => $value) {
+                       if ($parameter == 'pagename') {
+                               continue;
+                       }
+                       if (!in_array($parameter, array_keys($defaults))) {
+                               $this->logger->notice('Unhandled request field', ['parameter' => $parameter, 'value' => $value, 'command' => $this->args->getCommand()]);
+                       }
+               }
+
+               $this->logger->debug('Got request parameters', ['request' => $request, 'command' => $this->args->getCommand()]);
+               return $request;
+       }
+
        /*
         * Functions used to protect against Cross-Site Request Forgery
         * The security token has to base on at least one value that an attacker can't know - here it's the session ID and the private key.