Merge remote-tracking branch 'upstream/develop' into write-tags

[friendica.git] / src / BaseModule.php

diff --git a/src/BaseModule.php b/src/BaseModule.php
index 6c14d6ba77aa6b6838c90316cdd30773f2a9460d..1dbf3f38d5245fb890eb686169787814c0e0f81c 100644 (file)
--- a/src/BaseModule.php
+++ b/src/BaseModule.php
@@ -1,10 +1,27 @@
 <?php
+/**
+ * @copyright Copyright (C) 2020, Friendica
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ *
+ */
 
 namespace Friendica;
 
-use Friendica\Core\L10n;
 use Friendica\Core\Logger;
-use Friendica\Core\System;
 
 /**
  * All modules in Friendica should extend BaseModule, although not all modules
@@ -15,30 +32,32 @@ use Friendica\Core\System;
  *
  * @author Hypolite Petovan <hypolite@mrpetovan.com>
  */
-abstract class BaseModule extends BaseObject
+abstract class BaseModule
 {
        /**
-        * @brief Initialization method common to both content() and post()
+        * 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()
+       public static function init(array $parameters = [])
        {
        }
 
        /**
-        * @brief Module GET method to display raw content from technical endpoints
+        * 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.
         */
-       public static function rawContent()
+       public static function rawContent(array $parameters = [])
        {
+               // echo '';
+               // exit;
        }
 
        /**
-        * @brief Module GET method to display any content
+        * 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
@@ -46,7 +65,7 @@ abstract class BaseModule extends BaseObject
         *
         * @return string
         */
-       public static function content()
+       public static function content(array $parameters = [])
        {
                $o = '';
 
@@ -54,25 +73,23 @@ abstract class BaseModule extends BaseObject
        }
 
        /**
-        * @brief Module POST method to process submitted data
+        * Module POST method to process submitted data
         *
         * Extend this method if the module is supposed to process POST requests.
         * Doesn't display any content
         */
-       public static function post()
+       public static function post(array $parameters = [])
        {
-               // $a = self::getApp();
-               // $a->internalRedirect('module');
+               // DI::baseurl()->redirect('module');
        }
 
        /**
-        * @brief Called after post()
+        * Called after post()
         *
         * Unknown purpose
         */
-       public static function afterpost()
+       public static function afterpost(array $parameters = [])
        {
-
        }
 
        /*
@@ -88,7 +105,7 @@ abstract class BaseModule extends BaseObject
         */
        public static function getFormSecurityToken($typename = '')
        {
-               $a = \get_app();
+               $a = DI::app();
 
                $timestamp = time();
                $sec_hash = hash('whirlpool', $a->user['guid'] . $a->user['prvkey'] . session_id() . $timestamp . $typename);
@@ -116,10 +133,10 @@ abstract class BaseModule extends BaseObject
 
                $max_livetime = 10800; // 3 hours
 
-               $a = \get_app();
+               $a = DI::app();
 
                $x = explode('.', $hash);
-               if (time() > (IntVal($x[0]) + $max_livetime)) {
+               if (time() > (intval($x[0]) + $max_livetime)) {
                        return false;
                }
 
@@ -130,28 +147,28 @@ abstract class BaseModule extends BaseObject
 
        public static function getFormSecurityStandardErrorMessage()
        {
-               return L10n::t("The form security token was not correct. This probably happened because the form has been opened for too long \x28>3 hours\x29 before submitting it.") . EOL;
+               return DI::l10n()->t("The form security token was not correct. This probably happened because the form has been opened for too long \x28>3 hours\x29 before submitting it.") . EOL;
        }
 
        public static function checkFormSecurityTokenRedirectOnError($err_redirect, $typename = '', $formname = 'form_security_token')
        {
                if (!self::checkFormSecurityToken($typename, $formname)) {
-                       $a = \get_app();
+                       $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);
                        notice(self::getFormSecurityStandardErrorMessage());
-                       $a->internalRedirect($err_redirect);
+                       DI::baseUrl()->redirect($err_redirect);
                }
        }
 
        public static function checkFormSecurityTokenForbiddenOnError($typename = '', $formname = 'form_security_token')
        {
                if (!self::checkFormSecurityToken($typename, $formname)) {
-                       $a = \get_app();
+                       $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);
-                       header('HTTP/1.1 403 Forbidden');
-                       killme();
+
+                       throw new \Friendica\Network\HTTPException\ForbiddenException();
                }
        }
 }