src/BaseModule.php

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