]> git.mxchange.org Git - friendica.git/blob - src/BaseModule.php
spelling: occurred
[friendica.git] / 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\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          * @return void
106          */
107         protected function rawContent(array $request = [])
108         {
109                 // echo '';
110                 // exit;
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 other comparable stuff.
238                 $this->rawContent($request);
239
240                 try {
241                         $arr = ['content' => ''];
242                         Hook::callAll(static::class . '_mod_content', $arr);
243                         $this->response->addContent($arr['content']);
244                         $this->response->addContent($this->content($request));
245                 } catch (HTTPException $e) {
246                         // In case of System::externalRedirects(), we don't want to prettyprint the exception
247                         // just redirect to the new location
248                         if (($e instanceof HTTPException\FoundException) ||
249                                 ($e instanceof HTTPException\MovedPermanentlyException) ||
250                                 ($e instanceof HTTPException\TemporaryRedirectException)) {
251                                 throw $e;
252                         }
253
254                         $this->response->addContent($httpException->content($e));
255                 } finally {
256                         $this->profiler->set(microtime(true) - $timestamp, 'content');
257                 }
258
259                 return $this->response->generate();
260         }
261
262         /**
263          * Checks request inputs and sets default parameters
264          *
265          * @param array $defaults Associative array of expected request keys and their default typed value. A null
266          *                        value will remove the request key from the resulting value array.
267          * @param array $input    Custom REQUEST array, superglobal instead
268          *
269          * @return array Request data
270          */
271         protected function checkDefaults(array $defaults, array $input): array
272         {
273                 $request = [];
274
275                 foreach ($defaults as $parameter => $defaultvalue) {
276                         $request[$parameter] = $this->getRequestValue($input, $parameter, $defaultvalue);
277                 }
278
279                 foreach ($input ?? [] as $parameter => $value) {
280                         if ($parameter == 'pagename') {
281                                 continue;
282                         }
283                         if (!in_array($parameter, array_keys($defaults))) {
284                                 $this->logger->notice('Unhandled request field', ['parameter' => $parameter, 'value' => $value, 'command' => $this->args->getCommand()]);
285                         }
286                 }
287
288                 $this->logger->debug('Got request parameters', ['request' => $request, 'command' => $this->args->getCommand()]);
289                 return $request;
290         }
291
292         /**
293          * Fetch a request value and apply default values and check against minimal and maximal values
294          *
295          * @param array $input Input fields
296          * @param string $parameter Parameter
297          * @param mixed $default Default
298          * @param mixed $minimal_value Minimal value
299          * @param mixed $maximum_value Maximum value
300          * @return mixed null on error anything else on success (?)
301          */
302         public function getRequestValue(array $input, string $parameter, $default = null, $minimal_value = null, $maximum_value = null)
303         {
304                 if (is_string($default)) {
305                         $value = (string)($input[$parameter] ?? $default);
306                 } elseif (is_int($default)) {
307                         $value = filter_var($input[$parameter] ?? $default, FILTER_VALIDATE_INT);
308                         if (!is_null($minimal_value)) {
309                                 $value = max(filter_var($minimal_value, FILTER_VALIDATE_INT), $value);
310                         }
311                         if (!is_null($maximum_value)) {
312                                 $value = min(filter_var($maximum_value, FILTER_VALIDATE_INT), $value);
313                         }
314                 } elseif (is_float($default)) {
315                         $value = filter_var($input[$parameter] ?? $default, FILTER_VALIDATE_FLOAT);
316                         if (!is_null($minimal_value)) {
317                                 $value = max(filter_var($minimal_value, FILTER_VALIDATE_FLOAT), $value);
318                         }
319                         if (!is_null($maximum_value)) {
320                                 $value = min(filter_var($maximum_value, FILTER_VALIDATE_FLOAT), $value);
321                         }
322                 } elseif (is_array($default)) {
323                         $value = filter_var($input[$parameter] ?? $default, FILTER_DEFAULT, ['flags' => FILTER_FORCE_ARRAY]);
324                 } elseif (is_bool($default)) {
325                         $value = filter_var($input[$parameter] ?? $default, FILTER_VALIDATE_BOOLEAN);
326                 } elseif (is_null($default)) {
327                         $value = $input[$parameter] ?? null;
328                 } else {
329                         $this->logger->notice('Unhandled default value type', ['parameter' => $parameter, 'type' => gettype($default)]);
330                         $value = null;
331                 }
332
333                 return $value;
334         }
335
336         /**
337          * Functions used to protect against Cross-Site Request Forgery
338          * 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.
339          * In this implementation, a security token is reusable (if the user submits a form, goes back and resubmits the form, maybe with small changes;
340          * or if the security token is used for ajax-calls that happen several times), but only valid for a certain amount of time (3hours).
341          * The "typename" separates the security tokens of different types of forms. This could be relevant in the following case:
342          *    A security token is used to protect a link from CSRF (e.g. the "delete this profile"-link).
343          *    If the new page contains by any chance external elements, then the used security token is exposed by the referrer.
344          *    Actually, important actions should not be triggered by Links / GET-Requests at all, but sometimes they still are,
345          *    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).
346          *
347          * @param string $typename Type name
348          * @return string Security hash with timestamp
349          */
350         public static function getFormSecurityToken(string $typename = ''): string
351         {
352                 $user      = User::getById(DI::app()->getLoggedInUserId(), ['guid', 'prvkey']);
353                 $timestamp = time();
354                 $sec_hash  = hash('whirlpool', ($user['guid'] ?? '') . ($user['prvkey'] ?? '') . session_id() . $timestamp . $typename);
355
356                 return $timestamp . '.' . $sec_hash;
357         }
358
359         /**
360          * Checks if form's security (CSRF) token is valid.
361          *
362          * @param string $typename ???
363          * @param string $formname Name of form/field (???)
364          * @return bool Whether it is valid
365          */
366         public static function checkFormSecurityToken(string $typename = '', string $formname = 'form_security_token'): bool
367         {
368                 $hash = null;
369
370                 if (!empty($_REQUEST[$formname])) {
371                         /// @TODO Careful, not secured!
372                         $hash = $_REQUEST[$formname];
373                 }
374
375                 if (!empty($_SERVER['HTTP_X_CSRF_TOKEN'])) {
376                         /// @TODO Careful, not secured!
377                         $hash = $_SERVER['HTTP_X_CSRF_TOKEN'];
378                 }
379
380                 if (empty($hash)) {
381                         return false;
382                 }
383
384                 $max_livetime = 10800; // 3 hours
385
386                 $user = User::getById(DI::app()->getLoggedInUserId(), ['guid', 'prvkey']);
387
388                 $x = explode('.', $hash);
389                 if (time() > (intval($x[0]) + $max_livetime)) {
390                         return false;
391                 }
392
393                 $sec_hash = hash('whirlpool', ($user['guid'] ?? '') . ($user['prvkey'] ?? '') . session_id() . $x[0] . $typename);
394
395                 return ($sec_hash == $x[1]);
396         }
397
398         public static function getFormSecurityStandardErrorMessage(): string
399         {
400                 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.");
401         }
402
403         public static function checkFormSecurityTokenRedirectOnError(string $err_redirect, string $typename = '', string $formname = 'form_security_token')
404         {
405                 if (!self::checkFormSecurityToken($typename, $formname)) {
406                         Logger::notice('checkFormSecurityToken failed: user ' . DI::app()->getLoggedInUserNickname() . ' - form element ' . $typename);
407                         Logger::debug('checkFormSecurityToken failed', ['request' => $_REQUEST]);
408                         DI::sysmsg()->addNotice(self::getFormSecurityStandardErrorMessage());
409                         DI::baseUrl()->redirect($err_redirect);
410                 }
411         }
412
413         public static function checkFormSecurityTokenForbiddenOnError(string $typename = '', string $formname = 'form_security_token')
414         {
415                 if (!self::checkFormSecurityToken($typename, $formname)) {
416                         Logger::notice('checkFormSecurityToken failed: user ' . DI::app()->getLoggedInUserNickname() . ' - form element ' . $typename);
417                         Logger::debug('checkFormSecurityToken failed', ['request' => $_REQUEST]);
418
419                         throw new \Friendica\Network\HTTPException\ForbiddenException();
420                 }
421         }
422
423         protected static function getContactFilterTabs(string $baseUrl, string $current, bool $displayCommonTab): array
424         {
425                 $tabs = [
426                         [
427                                 'label' => DI::l10n()->t('All contacts'),
428                                 'url'   => $baseUrl . '/contacts',
429                                 'sel'   => !$current || $current == 'all' ? 'active' : '',
430                         ],
431                         [
432                                 'label' => DI::l10n()->t('Followers'),
433                                 'url'   => $baseUrl . '/contacts/followers',
434                                 'sel'   => $current == 'followers' ? 'active' : '',
435                         ],
436                         [
437                                 'label' => DI::l10n()->t('Following'),
438                                 'url'   => $baseUrl . '/contacts/following',
439                                 'sel'   => $current == 'following' ? 'active' : '',
440                         ],
441                         [
442                                 'label' => DI::l10n()->t('Mutual friends'),
443                                 'url'   => $baseUrl . '/contacts/mutuals',
444                                 'sel'   => $current == 'mutuals' ? 'active' : '',
445                         ],
446                 ];
447
448                 if ($displayCommonTab) {
449                         $tabs[] = [
450                                 'label' => DI::l10n()->t('Common'),
451                                 'url'   => $baseUrl . '/contacts/common',
452                                 'sel'   => $current == 'common' ? 'active' : '',
453                         ];
454                 }
455
456                 return $tabs;
457         }
458 }