Replace Module::init() with Constructors

[friendica.git] / src / BaseModule.php

diff --git a/src/BaseModule.php b/src/BaseModule.php
index c1f35533be1e5651f2cc45a2a0eb0c16a068c26b..5d752bb4f7450065bec2642c8f997fa8f067c91c 100644 (file)
--- a/src/BaseModule.php
+++ b/src/BaseModule.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * @copyright Copyright (C) 2020, Friendica
+ * @copyright Copyright (C) 2010-2021, the Friendica project
  *
  * @license GNU AGPL version 3 or any later version
  *
@@ -21,7 +21,10 @@
 
 namespace Friendica;
 
+use Friendica\Capabilities\ICanHandleRequests;
+use Friendica\Core\L10n;
 use Friendica\Core\Logger;
+use Friendica\Model\User;
 
 /**
  * All modules in Friendica should extend BaseModule, although not all modules
@@ -32,66 +35,72 @@ use Friendica\Core\Logger;
  *
  * @author Hypolite Petovan <hypolite@mrpetovan.com>
  */
-abstract class BaseModule
+abstract class BaseModule implements ICanHandleRequests
 {
-       /**
-        * Initialization method common to both content() and post()
-        *
-        * Extend this method if you need to do any shared processing before both
-        * content() or post()
-        */
-       public static function init(array $parameters = [])
+       /** @var array */
+       protected $parameters = [];
+
+       /** @var L10n */
+       protected $l10n;
+
+       public function __construct(L10n $l10n, array $parameters = [])
        {
+               $this->parameters = $parameters;
+               $this->l10n       = $l10n;
        }
 
        /**
-        * Module GET method to display raw content from technical endpoints
-        *
-        * Extend this method if the module is supposed to return communication data,
-        * e.g. from protocol implementations.
+        * {@inheritDoc}
         */
-       public static function rawContent(array $parameters = [])
+       public function rawContent()
        {
                // echo '';
                // exit;
        }
 
        /**
-        * Module GET method to display any content
-        *
-        * Extend this method if the module is supposed to return any display
-        * through a GET request. It can be an HTML page through templating or a
-        * XML feed or a JSON output.
-        *
-        * @return string
+        * {@inheritDoc}
         */
-       public static function content(array $parameters = [])
+       public function content(): string
        {
-               $o = '';
+               return '';
+       }
 
-               return $o;
+       /**
+        * {@inheritDoc}
+        */
+       public function delete()
+       {
        }
 
        /**
-        * Module POST method to process submitted data
-        *
-        * Extend this method if the module is supposed to process POST requests.
-        * Doesn't display any content
+        * {@inheritDoc}
         */
-       public static function post(array $parameters = [])
+       public function patch()
+       {
+       }
+
+       /**
+        * {@inheritDoc}
+        */
+       public function post()
        {
                // DI::baseurl()->redirect('module');
        }
 
        /**
-        * Called after post()
-        *
-        * Unknown purpose
+        * {@inheritDoc}
         */
-       public static function afterpost(array $parameters = [])
+       public function put()
        {
        }
 
+       /** Gets the name of the current class */
+       public function getClassName(): string
+       {
+               return static::class;
+       }
+
        /*
         * 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.
@@ -105,10 +114,9 @@ abstract class BaseModule
         */
        public static function getFormSecurityToken($typename = '')
        {
-               $a = DI::app();
-
+               $user = User::getById(DI::app()->getLoggedInUserId(), ['guid', 'prvkey']);
                $timestamp = time();
-               $sec_hash = hash('whirlpool', ($a->user['guid'] ?? '') . ($a->user['prvkey'] ?? '') . session_id() . $timestamp . $typename);
+               $sec_hash = hash('whirlpool', ($user['guid'] ?? '') . ($user['prvkey'] ?? '') . session_id() . $timestamp . $typename);
 
                return $timestamp . '.' . $sec_hash;
        }
@@ -133,14 +141,14 @@ abstract class BaseModule
 
                $max_livetime = 10800; // 3 hours
 
-               $a = DI::app();
+               $user = User::getById(DI::app()->getLoggedInUserId(), ['guid', 'prvkey']);
 
                $x = explode('.', $hash);
                if (time() > (intval($x[0]) + $max_livetime)) {
                        return false;
                }
 
-               $sec_hash = hash('whirlpool', ($a->user['guid'] ?? '') . ($a->user['prvkey'] ?? '') . session_id() . $x[0] . $typename);
+               $sec_hash = hash('whirlpool', ($user['guid'] ?? '') . ($user['prvkey'] ?? '') . session_id() . $x[0] . $typename);
 
                return ($sec_hash == $x[1]);
        }
@@ -153,9 +161,8 @@ abstract class BaseModule
        public static function checkFormSecurityTokenRedirectOnError($err_redirect, $typename = '', $formname = 'form_security_token')
        {
                if (!self::checkFormSecurityToken($typename, $formname)) {
-                       $a = DI::app();
-                       Logger::log('checkFormSecurityToken failed: user ' . $a->user['guid'] . ' - form element ' . $typename);
-                       Logger::log('checkFormSecurityToken failed: _REQUEST data: ' . print_r($_REQUEST, true), Logger::DATA);
+                       Logger::notice('checkFormSecurityToken failed: user ' . DI::app()->getLoggedInUserNickname() . ' - form element ' . $typename);
+                       Logger::debug('checkFormSecurityToken failed', ['request' => $_REQUEST]);
                        notice(self::getFormSecurityStandardErrorMessage());
                        DI::baseUrl()->redirect($err_redirect);
                }
@@ -164,9 +171,8 @@ abstract class BaseModule
        public static function checkFormSecurityTokenForbiddenOnError($typename = '', $formname = 'form_security_token')
        {
                if (!self::checkFormSecurityToken($typename, $formname)) {
-                       $a = DI::app();
-                       Logger::log('checkFormSecurityToken failed: user ' . $a->user['guid'] . ' - form element ' . $typename);
-                       Logger::log('checkFormSecurityToken failed: _REQUEST data: ' . print_r($_REQUEST, true), Logger::DATA);
+                       Logger::notice('checkFormSecurityToken failed: user ' . DI::app()->getLoggedInUserNickname() . ' - form element ' . $typename);
+                       Logger::debug('checkFormSecurityToken failed', ['request' => $_REQUEST]);
 
                        throw new \Friendica\Network\HTTPException\ForbiddenException();
                }