src/BaseModule.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2022, 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\App\Router;
  25 use Friendica\Capabilities\ICanHandleRequests;
  26 use Friendica\Capabilities\ICanCreateResponses;
  27 use Friendica\Core\Hook;
  28 use Friendica\Core\L10n;
  29 use Friendica\Core\Logger;
  30 use Friendica\Model\User;
  31 use Friendica\Module\Response;
  32 use Friendica\Module\Special\HTTPException as ModuleHTTPException;
  33 use Friendica\Network\HTTPException;
  34 use Friendica\Util\Profiler;
  35 use Psr\Http\Message\ResponseInterface;
  36 use Psr\Log\LoggerInterface;
  37
  38 /**
  39  * All modules in Friendica should extend BaseModule, although not all modules
  40  * need to extend all the methods described here
  41  *
  42  * The filename of the module in src/Module needs to match the class name
  43  * exactly to make the module available.
  44  *
  45  * @author Hypolite Petovan <hypolite@mrpetovan.com>
  46  */
  47 abstract class BaseModule implements ICanHandleRequests
  48 {
  49         /** @var array */
  50         protected $parameters = [];
  51         /** @var L10n */
  52         protected $l10n;
  53         /** @var App\BaseURL */
  54         protected $baseUrl;
  55         /** @var App\Arguments */
  56         protected $args;
  57         /** @var LoggerInterface */
  58         protected $logger;
  59         /** @var Profiler */
  60         protected $profiler;
  61         /** @var array */
  62         protected $server;
  63         /** @var ICanCreateResponses */
  64         protected $response;
  65
  66         public function __construct(L10n $l10n, App\BaseURL $baseUrl, App\Arguments $args, LoggerInterface $logger, Profiler $profiler, Response $response, array $server, array $parameters = [])
  67         {
  68                 $this->parameters = $parameters;
  69                 $this->l10n       = $l10n;
  70                 $this->baseUrl    = $baseUrl;
  71                 $this->args       = $args;
  72                 $this->logger     = $logger;
  73                 $this->profiler   = $profiler;
  74                 $this->server     = $server;
  75                 $this->response   = $response;
  76         }
  77
  78         /**
  79          * Wraps the L10n::t() function for Modules
  80          *
  81          * @see L10n::t()
  82          */
  83         protected function t(string $s, ...$args): string
  84         {
  85                 return $this->l10n->t($s, ...$args);
  86         }
  87
  88         /**
  89          * Wraps the L10n::tt() function for Modules
  90          *
  91          * @see L10n::tt()
  92          */
  93         protected function tt(string $singular, string $plurarl, int $count): string
  94         {
  95                 return $this->l10n->tt($singular, $plurarl, $count);
  96         }
  97
  98         /**
  99          * Module GET method to display raw content from technical endpoints
 100          *
 101          * Extend this method if the module is supposed to return communication data,
 102          * e.g. from protocol implementations.
 103          *
 104          * @param string[] $request The $_REQUEST content
 105          */
 106         protected function rawContent(array $request = [])
 107         {
 108                 // echo '';
 109                 // exit;
 110         }
 111
 112         /**
 113          * Module GET method to display any content
 114          *
 115          * Extend this method if the module is supposed to return any display
 116          * through a GET request. It can be an HTML page through templating or a
 117          * XML feed or a JSON output.
 118          *
 119          * @param string[] $request The $_REQUEST content
 120          */
 121         protected function content(array $request = []): string
 122         {
 123                 return '';
 124         }
 125
 126         /**
 127          * Module DELETE method to process submitted data
 128          *
 129          * Extend this method if the module is supposed to process DELETE requests.
 130          * Doesn't display any content
 131          *
 132          * @param string[] $request The $_REQUEST content
 133          */
 134         protected function delete(array $request = [])
 135         {
 136         }
 137
 138         /**
 139          * Module PATCH method to process submitted data
 140          *
 141          * Extend this method if the module is supposed to process PATCH requests.
 142          * Doesn't display any content
 143          *
 144          * @param string[] $request The $_REQUEST content
 145          */
 146         protected function patch(array $request = [])
 147         {
 148         }
 149
 150         /**
 151          * Module POST method to process submitted data
 152          *
 153          * Extend this method if the module is supposed to process POST requests.
 154          * Doesn't display any content
 155          *
 156          * @param string[] $request The $_REQUEST content
 157          *
 158          */
 159         protected function post(array $request = [])
 160         {
 161                 // $this->baseUrl->redirect('module');
 162         }
 163
 164         /**
 165          * Module PUT method to process submitted data
 166          *
 167          * Extend this method if the module is supposed to process PUT requests.
 168          * Doesn't display any content
 169          *
 170          * @param string[] $request The $_REQUEST content
 171          */
 172         protected function put(array $request = [])
 173         {
 174         }
 175
 176         /**
 177          * {@inheritDoc}
 178          */
 179         public function run(array $request = []): ResponseInterface
 180         {
 181                 // @see https://github.com/tootsuite/mastodon/blob/c3aef491d66aec743a3a53e934a494f653745b61/config/initializers/cors.rb
 182                 if (substr($this->args->getQueryString(), 0, 12) == '.well-known/') {
 183                         $this->response->setHeader('*', 'Access-Control-Allow-Origin');
 184                         $this->response->setHeader('*', 'Access-Control-Allow-Headers');
 185                         $this->response->setHeader(Router::GET, 'Access-Control-Allow-Methods');
 186                         $this->response->setHeader('false', 'Access-Control-Allow-Credentials');
 187                 } elseif (substr($this->args->getQueryString(), 0, 8) == 'profile/') {
 188                         $this->response->setHeader('*', 'Access-Control-Allow-Origin');
 189                         $this->response->setHeader('*', 'Access-Control-Allow-Headers');
 190                         $this->response->setHeader(Router::GET, 'Access-Control-Allow-Methods');
 191                         $this->response->setHeader('false', 'Access-Control-Allow-Credentials');
 192                 } elseif (substr($this->args->getQueryString(), 0, 4) == 'api/') {
 193                         $this->response->setHeader('*', 'Access-Control-Allow-Origin');
 194                         $this->response->setHeader('*', 'Access-Control-Allow-Headers');
 195                         $this->response->setHeader(implode(',', Router::ALLOWED_METHODS), 'Access-Control-Allow-Methods');
 196                         $this->response->setHeader('false', 'Access-Control-Allow-Credentials');
 197                         $this->response->setHeader('Link', 'Access-Control-Expose-Headers');
 198                 } elseif (substr($this->args->getQueryString(), 0, 11) == 'oauth/token') {
 199                         $this->response->setHeader('*', 'Access-Control-Allow-Origin');
 200                         $this->response->setHeader('*', 'Access-Control-Allow-Headers');
 201                         $this->response->setHeader(Router::POST, 'Access-Control-Allow-Methods');
 202                         $this->response->setHeader('false', 'Access-Control-Allow-Credentials');
 203                 }
 204
 205                 $placeholder = '';
 206
 207                 $this->profiler->set(microtime(true), 'ready');
 208                 $timestamp = microtime(true);
 209
 210                 Core\Hook::callAll($this->args->getModuleName() . '_mod_init', $placeholder);
 211
 212                 $this->profiler->set(microtime(true) - $timestamp, 'init');
 213
 214                 switch ($this->args->getMethod()) {
 215                         case Router::DELETE:
 216                                 $this->delete($request);
 217                                 break;
 218                         case Router::PATCH:
 219                                 $this->patch($request);
 220                                 break;
 221                         case Router::POST:
 222                                 Core\Hook::callAll($this->args->getModuleName() . '_mod_post', $request);
 223                                 $this->post($request);
 224                                 break;
 225                         case Router::PUT:
 226                                 $this->put($request);
 227                                 break;
 228                 }
 229
 230                 $timestamp = microtime(true);
 231                 // "rawContent" is especially meant for technical endpoints.
 232                 // This endpoint doesn't need any theme initialization or other comparable stuff.
 233                 $this->rawContent($request);
 234
 235                 try {
 236                         $arr = ['content' => ''];
 237                         Hook::callAll(static::class . '_mod_content', $arr);
 238                         $this->response->addContent($arr['content']);
 239                         $this->response->addContent($this->content($request));
 240                 } catch (HTTPException $e) {
 241                         $this->response->addContent((new ModuleHTTPException())->content($e));
 242                 } finally {
 243                         $this->profiler->set(microtime(true) - $timestamp, 'content');
 244                 }
 245
 246                 return $this->response->generate();
 247         }
 248
 249         /**
 250          * Checks request inputs and sets default parameters
 251          *
 252          * @param array $defaults Associative array of expected request keys and their default typed value. A null
 253          *                        value will remove the request key from the resulting value array.
 254          * @param array $input    Custom REQUEST array, superglobal instead
 255          *
 256          * @return array Request data
 257          */
 258         protected function checkDefaults(array $defaults, array $input): array
 259         {
 260                 $request = [];
 261
 262                 foreach ($defaults as $parameter => $defaultvalue) {
 263                         $request[$parameter] = $this->getRequestValue($input, $parameter, $defaultvalue);
 264                 }
 265
 266                 foreach ($input ?? [] as $parameter => $value) {
 267                         if ($parameter == 'pagename') {
 268                                 continue;
 269                         }
 270                         if (!in_array($parameter, array_keys($defaults))) {
 271                                 $this->logger->notice('Unhandled request field', ['parameter' => $parameter, 'value' => $value, 'command' => $this->args->getCommand()]);
 272                         }
 273                 }
 274
 275                 $this->logger->debug('Got request parameters', ['request' => $request, 'command' => $this->args->getCommand()]);
 276                 return $request;
 277         }
 278
 279         /**
 280          * Fetch a request value and apply default values and check against minimal and maximal values
 281          *
 282          * @param array $input
 283          * @param string $parameter
 284          * @param mixed $default
 285          * @param mixed $minimal_value
 286          * @param mixed $maximum_value
 287          * @return mixed
 288          */
 289         public function getRequestValue(array $input, string $parameter, $default = null, $minimal_value = null, $maximum_value = null)
 290         {
 291                 if (is_string($default)) {
 292                         $value = (string)($input[$parameter] ?? $default);
 293                 } elseif (is_int($default)) {
 294                         $value = filter_var($input[$parameter] ?? $default, FILTER_VALIDATE_INT);
 295                         if (!is_null($minimal_value)) {
 296                                 $value = max(filter_var($minimal_value, FILTER_VALIDATE_INT), $value);
 297                         }
 298                         if (!is_null($maximum_value)) {
 299                                 $value = min(filter_var($maximum_value, FILTER_VALIDATE_INT), $value);
 300                         }
 301                 } elseif (is_float($default)) {
 302                         $value = filter_var($input[$parameter] ?? $default, FILTER_VALIDATE_FLOAT);
 303                         if (!is_null($minimal_value)) {
 304                                 $value = max(filter_var($minimal_value, FILTER_VALIDATE_FLOAT), $value);
 305                         }
 306                         if (!is_null($maximum_value)) {
 307                                 $value = min(filter_var($maximum_value, FILTER_VALIDATE_FLOAT), $value);
 308                         }
 309                 } elseif (is_array($default)) {
 310                         $value = filter_var($input[$parameter] ?? $default, FILTER_DEFAULT, ['flags' => FILTER_FORCE_ARRAY]);
 311                 } elseif (is_bool($default)) {
 312                         $value = filter_var($input[$parameter] ?? $default, FILTER_VALIDATE_BOOLEAN);
 313                 } elseif (is_null($default)) {
 314                         $value = $input[$parameter] ?? null;
 315                 } else {
 316                         $this->logger->notice('Unhandled default value type', ['parameter' => $parameter, 'type' => gettype($default)]);
 317                         $value = null;
 318                 }
 319
 320                 return $value;
 321         }
 322
 323         /*
 324          * Functions used to protect against Cross-Site Request Forgery
 325          * 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.
 326          * In this implementation, a security token is reusable (if the user submits a form, goes back and resubmits the form, maybe with small changes;
 327          * or if the security token is used for ajax-calls that happen several times), but only valid for a certain amount of time (3hours).
 328          * The "typename" separates the security tokens of different types of forms. This could be relevant in the following case:
 329          *    A security token is used to protect a link from CSRF (e.g. the "delete this profile"-link).
 330          *    If the new page contains by any chance external elements, then the used security token is exposed by the referrer.
 331          *    Actually, important actions should not be triggered by Links / GET-Requests at all, but sometimes they still are,
 332          *    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).
 333          */
 334         public static function getFormSecurityToken($typename = '')
 335         {
 336                 $user      = User::getById(DI::app()->getLoggedInUserId(), ['guid', 'prvkey']);
 337                 $timestamp = time();
 338                 $sec_hash  = hash('whirlpool', ($user['guid'] ?? '') . ($user['prvkey'] ?? '') . session_id() . $timestamp . $typename);
 339
 340                 return $timestamp . '.' . $sec_hash;
 341         }
 342
 343         public static function checkFormSecurityToken($typename = '', $formname = 'form_security_token')
 344         {
 345                 $hash = null;
 346
 347                 if (!empty($_REQUEST[$formname])) {
 348                         /// @TODO Careful, not secured!
 349                         $hash = $_REQUEST[$formname];
 350                 }
 351
 352                 if (!empty($_SERVER['HTTP_X_CSRF_TOKEN'])) {
 353                         /// @TODO Careful, not secured!
 354                         $hash = $_SERVER['HTTP_X_CSRF_TOKEN'];
 355                 }
 356
 357                 if (empty($hash)) {
 358                         return false;
 359                 }
 360
 361                 $max_livetime = 10800; // 3 hours
 362
 363                 $user = User::getById(DI::app()->getLoggedInUserId(), ['guid', 'prvkey']);
 364
 365                 $x = explode('.', $hash);
 366                 if (time() > (intval($x[0]) + $max_livetime)) {
 367                         return false;
 368                 }
 369
 370                 $sec_hash = hash('whirlpool', ($user['guid'] ?? '') . ($user['prvkey'] ?? '') . session_id() . $x[0] . $typename);
 371
 372                 return ($sec_hash == $x[1]);
 373         }
 374
 375         public static function getFormSecurityStandardErrorMessage()
 376         {
 377                 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;
 378         }
 379
 380         public static function checkFormSecurityTokenRedirectOnError($err_redirect, $typename = '', $formname = 'form_security_token')
 381         {
 382                 if (!self::checkFormSecurityToken($typename, $formname)) {
 383                         Logger::notice('checkFormSecurityToken failed: user ' . DI::app()->getLoggedInUserNickname() . ' - form element ' . $typename);
 384                         Logger::debug('checkFormSecurityToken failed', ['request' => $_REQUEST]);
 385                         notice(self::getFormSecurityStandardErrorMessage());
 386                         DI::baseUrl()->redirect($err_redirect);
 387                 }
 388         }
 389
 390         public static function checkFormSecurityTokenForbiddenOnError($typename = '', $formname = 'form_security_token')
 391         {
 392                 if (!self::checkFormSecurityToken($typename, $formname)) {
 393                         Logger::notice('checkFormSecurityToken failed: user ' . DI::app()->getLoggedInUserNickname() . ' - form element ' . $typename);
 394                         Logger::debug('checkFormSecurityToken failed', ['request' => $_REQUEST]);
 395
 396                         throw new \Friendica\Network\HTTPException\ForbiddenException();
 397                 }
 398         }
 399
 400         protected static function getContactFilterTabs(string $baseUrl, string $current, bool $displayCommonTab)
 401         {
 402                 $tabs = [
 403                         [
 404                                 'label' => DI::l10n()->t('All contacts'),
 405                                 'url'   => $baseUrl . '/contacts',
 406                                 'sel'   => !$current || $current == 'all' ? 'active' : '',
 407                         ],
 408                         [
 409                                 'label' => DI::l10n()->t('Followers'),
 410                                 'url'   => $baseUrl . '/contacts/followers',
 411                                 'sel'   => $current == 'followers' ? 'active' : '',
 412                         ],
 413                         [
 414                                 'label' => DI::l10n()->t('Following'),
 415                                 'url'   => $baseUrl . '/contacts/following',
 416                                 'sel'   => $current == 'following' ? 'active' : '',
 417                         ],
 418                         [
 419                                 'label' => DI::l10n()->t('Mutual friends'),
 420                                 'url'   => $baseUrl . '/contacts/mutuals',
 421                                 'sel'   => $current == 'mutuals' ? 'active' : '',
 422                         ],
 423                 ];
 424
 425                 if ($displayCommonTab) {
 426                         $tabs[] = [
 427                                 'label' => DI::l10n()->t('Common'),
 428                                 'url'   => $baseUrl . '/contacts/common',
 429                                 'sel'   => $current == 'common' ? 'active' : '',
 430                         ];
 431                 }
 432
 433                 return $tabs;
 434         }
 435 }