src/BaseModule.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2021, the Friendica project
   4  *
   5  * @license GNU AGPL version 3 or any later version
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU Affero General Public License as
   9  * published by the Free Software Foundation, either version 3 of the
  10  * License, or (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU Affero General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Affero General Public License
  18  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  19  *
  20  */
  21
  22 namespace Friendica;
  23
  24 use Friendica\Capabilities\ICanHandleRequests;
  25 use Friendica\Core\L10n;
  26 use Friendica\Core\Logger;
  27 use Friendica\Model\User;
  28
  29 /**
  30  * All modules in Friendica should extend BaseModule, although not all modules
  31  * need to extend all the methods described here
  32  *
  33  * The filename of the module in src/Module needs to match the class name
  34  * exactly to make the module available.
  35  *
  36  * @author Hypolite Petovan <hypolite@mrpetovan.com>
  37  */
  38 abstract class BaseModule implements ICanHandleRequests
  39 {
  40         /** @var array */
  41         protected $parameters = [];
  42
  43         /** @var L10n */
  44         protected $l10n;
  45
  46         public function __construct(L10n $l10n, array $parameters = [])
  47         {
  48                 $this->parameters = $parameters;
  49                 $this->l10n       = $l10n;
  50         }
  51
  52         /**
  53          * Wraps the L10n::t() function for Modules
  54          *
  55          * @see L10n::t()
  56          */
  57         protected function t(string $s, ...$args): string
  58         {
  59                 return $this->l10n->t($s, ...$args);
  60         }
  61
  62         /**
  63          * Wraps the L10n::tt() function for Modules
  64          *
  65          * @see L10n::tt()
  66          */
  67         protected function tt(string $singular, string $plurarl, int $count): string
  68         {
  69                 return $this->l10n->tt($singular, $plurarl, $count);
  70         }
  71
  72         /**
  73          * {@inheritDoc}
  74          */
  75         public function rawContent()
  76         {
  77                 // echo '';
  78                 // exit;
  79         }
  80
  81         /**
  82          * {@inheritDoc}
  83          */
  84         public function content(): string
  85         {
  86                 return '';
  87         }
  88
  89         /**
  90          * {@inheritDoc}
  91          */
  92         public function delete()
  93         {
  94         }
  95
  96         /**
  97          * {@inheritDoc}
  98          */
  99         public function patch()
 100         {
 101         }
 102
 103         /**
 104          * {@inheritDoc}
 105          */
 106         public function post()
 107         {
 108                 // DI::baseurl()->redirect('module');
 109         }
 110
 111         /**
 112          * {@inheritDoc}
 113          */
 114         public function put()
 115         {
 116         }
 117
 118         /** Gets the name of the current class */
 119         public function getClassName(): string
 120         {
 121                 return static::class;
 122         }
 123
 124         /*
 125          * Functions used to protect against Cross-Site Request Forgery
 126          * 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.
 127          * In this implementation, a security token is reusable (if the user submits a form, goes back and resubmits the form, maybe with small changes;
 128          * or if the security token is used for ajax-calls that happen several times), but only valid for a certain amount of time (3hours).
 129          * The "typename" separates the security tokens of different types of forms. This could be relevant in the following case:
 130          *    A security token is used to protect a link from CSRF (e.g. the "delete this profile"-link).
 131          *    If the new page contains by any chance external elements, then the used security token is exposed by the referrer.
 132          *    Actually, important actions should not be triggered by Links / GET-Requests at all, but sometimes they still are,
 133          *    so this mechanism brings in some damage control (the attacker would be able to forge a request to a form of this type, but not to forms of other types).
 134          */
 135         public static function getFormSecurityToken($typename = '')
 136         {
 137                 $user = User::getById(DI::app()->getLoggedInUserId(), ['guid', 'prvkey']);
 138                 $timestamp = time();
 139                 $sec_hash = hash('whirlpool', ($user['guid'] ?? '') . ($user['prvkey'] ?? '') . session_id() . $timestamp . $typename);
 140
 141                 return $timestamp . '.' . $sec_hash;
 142         }
 143
 144         public static function checkFormSecurityToken($typename = '', $formname = 'form_security_token')
 145         {
 146                 $hash = null;
 147
 148                 if (!empty($_REQUEST[$formname])) {
 149                         /// @TODO Careful, not secured!
 150                         $hash = $_REQUEST[$formname];
 151                 }
 152
 153                 if (!empty($_SERVER['HTTP_X_CSRF_TOKEN'])) {
 154                         /// @TODO Careful, not secured!
 155                         $hash = $_SERVER['HTTP_X_CSRF_TOKEN'];
 156                 }
 157
 158                 if (empty($hash)) {
 159                         return false;
 160                 }
 161
 162                 $max_livetime = 10800; // 3 hours
 163
 164                 $user = User::getById(DI::app()->getLoggedInUserId(), ['guid', 'prvkey']);
 165
 166                 $x = explode('.', $hash);
 167                 if (time() > (intval($x[0]) + $max_livetime)) {
 168                         return false;
 169                 }
 170
 171                 $sec_hash = hash('whirlpool', ($user['guid'] ?? '') . ($user['prvkey'] ?? '') . session_id() . $x[0] . $typename);
 172
 173                 return ($sec_hash == $x[1]);
 174         }
 175
 176         public static function getFormSecurityStandardErrorMessage()
 177         {
 178                 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;
 179         }
 180
 181         public static function checkFormSecurityTokenRedirectOnError($err_redirect, $typename = '', $formname = 'form_security_token')
 182         {
 183                 if (!self::checkFormSecurityToken($typename, $formname)) {
 184                         Logger::notice('checkFormSecurityToken failed: user ' . DI::app()->getLoggedInUserNickname() . ' - form element ' . $typename);
 185                         Logger::debug('checkFormSecurityToken failed', ['request' => $_REQUEST]);
 186                         notice(self::getFormSecurityStandardErrorMessage());
 187                         DI::baseUrl()->redirect($err_redirect);
 188                 }
 189         }
 190
 191         public static function checkFormSecurityTokenForbiddenOnError($typename = '', $formname = 'form_security_token')
 192         {
 193                 if (!self::checkFormSecurityToken($typename, $formname)) {
 194                         Logger::notice('checkFormSecurityToken failed: user ' . DI::app()->getLoggedInUserNickname() . ' - form element ' . $typename);
 195                         Logger::debug('checkFormSecurityToken failed', ['request' => $_REQUEST]);
 196
 197                         throw new \Friendica\Network\HTTPException\ForbiddenException();
 198                 }
 199         }
 200
 201         protected static function getContactFilterTabs(string $baseUrl, string $current, bool $displayCommonTab)
 202         {
 203                 $tabs = [
 204                         [
 205                                 'label' => DI::l10n()->t('All contacts'),
 206                                 'url'   => $baseUrl . '/contacts',
 207                                 'sel'   => !$current || $current == 'all' ? 'active' : '',
 208                         ],
 209                         [
 210                                 'label' => DI::l10n()->t('Followers'),
 211                                 'url'   => $baseUrl . '/contacts/followers',
 212                                 'sel'   => $current == 'followers' ? 'active' : '',
 213                         ],
 214                         [
 215                                 'label' => DI::l10n()->t('Following'),
 216                                 'url'   => $baseUrl . '/contacts/following',
 217                                 'sel'   => $current == 'following' ? 'active' : '',
 218                         ],
 219                         [
 220                                 'label' => DI::l10n()->t('Mutual friends'),
 221                                 'url'   => $baseUrl . '/contacts/mutuals',
 222                                 'sel'   => $current == 'mutuals' ? 'active' : '',
 223                         ],
 224                 ];
 225
 226                 if ($displayCommonTab) {
 227                         $tabs[] = [
 228                                 'label' => DI::l10n()->t('Common'),
 229                                 'url'   => $baseUrl . '/contacts/common',
 230                                 'sel'   => $current == 'common' ? 'active' : '',
 231                         ];
 232                 }
 233
 234                 return $tabs;
 235         }
 236 }