X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=src%2FBaseModule.php;h=b43e984772f6cfd7b6ecfa220f8dc6ea52c999a6;hb=993d45d2f5617fab07c74e3b19849b459290674a;hp=cb8f8c790de7317e064db3ee88b97c704e02b3bb;hpb=852d148efdfb737ea192b296cf07055194ac7706;p=friendica.git diff --git a/src/BaseModule.php b/src/BaseModule.php index cb8f8c790d..b43e984772 100644 --- a/src/BaseModule.php +++ b/src/BaseModule.php @@ -1,6 +1,6 @@ */ -abstract class BaseModule +abstract class BaseModule implements ICanHandleRequests { + /** @var array */ + protected $parameters = []; + /** @var L10n */ + protected $l10n; + /** @var App\BaseURL */ + protected $baseUrl; + /** @var App\Arguments */ + protected $args; + /** @var LoggerInterface */ + protected $logger; + /** @var Profiler */ + protected $profiler; + /** @var array */ + protected $server; + /** @var ICanCreateResponses */ + protected $response; + + public function __construct(L10n $l10n, App\BaseURL $baseUrl, App\Arguments $args, LoggerInterface $logger, Profiler $profiler, Response $response, array $server, array $parameters = []) + { + $this->parameters = $parameters; + $this->l10n = $l10n; + $this->baseUrl = $baseUrl; + $this->args = $args; + $this->logger = $logger; + $this->profiler = $profiler; + $this->server = $server; + $this->response = $response; + } + /** - * Initialization method common to both content() and post() + * Wraps the L10n::t() function for Modules * - * Extend this method if you need to do any shared processing before both - * content() or post() + * @see L10n::t() */ - public static function init(array $parameters = []) + protected function t(string $s, ...$args): string { + return $this->l10n->t($s, ...$args); + } + + /** + * Wraps the L10n::tt() function for Modules + * + * @see L10n::tt() + */ + protected function tt(string $singular, string $plural, int $count): string + { + return $this->l10n->tt($singular, $plural, $count); } /** @@ -49,8 +100,11 @@ abstract class BaseModule * * Extend this method if the module is supposed to return communication data, * e.g. from protocol implementations. + * + * @param string[] $request The $_REQUEST content + * @return void */ - public static function rawContent(array $parameters = []) + protected function rawContent(array $request = []) { // echo ''; // exit; @@ -63,13 +117,12 @@ abstract class BaseModule * through a GET request. It can be an HTML page through templating or a * XML feed or a JSON output. * + * @param string[] $request The $_REQUEST content * @return string */ - public static function content(array $parameters = []) + protected function content(array $request = []): string { - $o = ''; - - return $o; + return ''; } /** @@ -77,8 +130,11 @@ abstract class BaseModule * * Extend this method if the module is supposed to process DELETE requests. * Doesn't display any content + * + * @param string[] $request The $_REQUEST content + * @return void */ - public static function delete(array $parameters = []) + protected function delete(array $request = []) { } @@ -87,8 +143,11 @@ abstract class BaseModule * * Extend this method if the module is supposed to process PATCH requests. * Doesn't display any content + * + * @param string[] $request The $_REQUEST content + * @return void */ - public static function patch(array $parameters = []) + protected function patch(array $request = []) { } @@ -97,32 +156,184 @@ abstract class BaseModule * * Extend this method if the module is supposed to process POST requests. * Doesn't display any content + * + * @param string[] $request The $_REQUEST content + * @return void */ - public static function post(array $parameters = []) + protected function post(array $request = []) { - // DI::baseurl()->redirect('module'); + // $this->baseUrl->redirect('module'); } /** - * Called after post() + * Module PUT method to process submitted data + * + * Extend this method if the module is supposed to process PUT requests. + * Doesn't display any content * - * Unknown purpose + * @param string[] $request The $_REQUEST content + * @return void */ - public static function afterpost(array $parameters = []) + protected function put(array $request = []) { } /** - * Module PUT method to process submitted data + * {@inheritDoc} + */ + public function run(ModuleHTTPException $httpException, array $request = []): ResponseInterface + { + // @see https://github.com/tootsuite/mastodon/blob/c3aef491d66aec743a3a53e934a494f653745b61/config/initializers/cors.rb + if (substr($this->args->getQueryString(), 0, 12) == '.well-known/') { + $this->response->setHeader('*', 'Access-Control-Allow-Origin'); + $this->response->setHeader('*', 'Access-Control-Allow-Headers'); + $this->response->setHeader(Router::GET, 'Access-Control-Allow-Methods'); + $this->response->setHeader('false', 'Access-Control-Allow-Credentials'); + } elseif (substr($this->args->getQueryString(), 0, 8) == 'profile/') { + $this->response->setHeader('*', 'Access-Control-Allow-Origin'); + $this->response->setHeader('*', 'Access-Control-Allow-Headers'); + $this->response->setHeader(Router::GET, 'Access-Control-Allow-Methods'); + $this->response->setHeader('false', 'Access-Control-Allow-Credentials'); + } elseif (substr($this->args->getQueryString(), 0, 4) == 'api/') { + $this->response->setHeader('*', 'Access-Control-Allow-Origin'); + $this->response->setHeader('*', 'Access-Control-Allow-Headers'); + $this->response->setHeader(implode(',', Router::ALLOWED_METHODS), 'Access-Control-Allow-Methods'); + $this->response->setHeader('false', 'Access-Control-Allow-Credentials'); + $this->response->setHeader('Link', 'Access-Control-Expose-Headers'); + } elseif (substr($this->args->getQueryString(), 0, 11) == 'oauth/token') { + $this->response->setHeader('*', 'Access-Control-Allow-Origin'); + $this->response->setHeader('*', 'Access-Control-Allow-Headers'); + $this->response->setHeader(Router::POST, 'Access-Control-Allow-Methods'); + $this->response->setHeader('false', 'Access-Control-Allow-Credentials'); + } + + $placeholder = ''; + + $this->profiler->set(microtime(true), 'ready'); + $timestamp = microtime(true); + + Core\Hook::callAll($this->args->getModuleName() . '_mod_init', $placeholder); + + $this->profiler->set(microtime(true) - $timestamp, 'init'); + + switch ($this->args->getMethod()) { + case Router::DELETE: + $this->delete($request); + break; + case Router::PATCH: + $this->patch($request); + break; + case Router::POST: + Core\Hook::callAll($this->args->getModuleName() . '_mod_post', $request); + $this->post($request); + break; + case Router::PUT: + $this->put($request); + break; + } + + $timestamp = microtime(true); + // "rawContent" is especially meant for technical endpoints. + // This endpoint doesn't need any theme initialization or other comparable stuff. + $this->rawContent($request); + + try { + $arr = ['content' => '']; + Hook::callAll(static::class . '_mod_content', $arr); + $this->response->addContent($arr['content']); + $this->response->addContent($this->content($request)); + } catch (HTTPException $e) { + // In case of System::externalRedirects(), we don't want to prettyprint the exception + // just redirect to the new location + if (($e instanceof HTTPException\FoundException) || + ($e instanceof HTTPException\MovedPermanentlyException) || + ($e instanceof HTTPException\TemporaryRedirectException)) { + throw $e; + } + + $this->response->addContent($httpException->content($e)); + } finally { + $this->profiler->set(microtime(true) - $timestamp, 'content'); + } + + return $this->response->generate(); + } + + /** + * Checks request inputs and sets default parameters * - * Extend this method if the module is supposed to process PUT requests. - * Doesn't display any content + * @param array $defaults Associative array of expected request keys and their default typed value. A null + * value will remove the request key from the resulting value array. + * @param array $input Custom REQUEST array, superglobal instead + * + * @return array Request data */ - public static function put(array $parameters = []) + protected function checkDefaults(array $defaults, array $input): array { + $request = []; + + foreach ($defaults as $parameter => $defaultvalue) { + $request[$parameter] = $this->getRequestValue($input, $parameter, $defaultvalue); + } + + foreach ($input ?? [] as $parameter => $value) { + if ($parameter == 'pagename') { + continue; + } + if (!in_array($parameter, array_keys($defaults))) { + $this->logger->notice('Unhandled request field', ['parameter' => $parameter, 'value' => $value, 'command' => $this->args->getCommand()]); + } + } + + $this->logger->debug('Got request parameters', ['request' => $request, 'command' => $this->args->getCommand()]); + return $request; } - /* + /** + * Fetch a request value and apply default values and check against minimal and maximal values + * + * @param array $input Input fields + * @param string $parameter Parameter + * @param mixed $default Default + * @param mixed $minimal_value Minimal value + * @param mixed $maximum_value Maximum value + * @return mixed null on error anything else on success (?) + */ + public function getRequestValue(array $input, string $parameter, $default = null, $minimal_value = null, $maximum_value = null) + { + if (is_string($default)) { + $value = (string)($input[$parameter] ?? $default); + } elseif (is_int($default)) { + $value = filter_var($input[$parameter] ?? $default, FILTER_VALIDATE_INT); + if (!is_null($minimal_value)) { + $value = max(filter_var($minimal_value, FILTER_VALIDATE_INT), $value); + } + if (!is_null($maximum_value)) { + $value = min(filter_var($maximum_value, FILTER_VALIDATE_INT), $value); + } + } elseif (is_float($default)) { + $value = filter_var($input[$parameter] ?? $default, FILTER_VALIDATE_FLOAT); + if (!is_null($minimal_value)) { + $value = max(filter_var($minimal_value, FILTER_VALIDATE_FLOAT), $value); + } + if (!is_null($maximum_value)) { + $value = min(filter_var($maximum_value, FILTER_VALIDATE_FLOAT), $value); + } + } elseif (is_array($default)) { + $value = filter_var($input[$parameter] ?? $default, FILTER_DEFAULT, ['flags' => FILTER_FORCE_ARRAY]); + } elseif (is_bool($default)) { + $value = filter_var($input[$parameter] ?? $default, FILTER_VALIDATE_BOOLEAN); + } elseif (is_null($default)) { + $value = $input[$parameter] ?? null; + } else { + $this->logger->notice('Unhandled default value type', ['parameter' => $parameter, 'type' => gettype($default)]); + $value = null; + } + + return $value; + } + + /** * Functions used to protect against Cross-Site Request Forgery * 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. * In this implementation, a security token is reusable (if the user submits a form, goes back and resubmits the form, maybe with small changes; @@ -132,18 +343,27 @@ abstract class BaseModule * If the new page contains by any chance external elements, then the used security token is exposed by the referrer. * Actually, important actions should not be triggered by Links / GET-Requests at all, but sometimes they still are, * 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). + * + * @param string $typename Type name + * @return string Security hash with timestamp */ - public static function getFormSecurityToken($typename = '') + public static function getFormSecurityToken(string $typename = ''): string { - $a = DI::app(); - + $user = User::getById(DI::app()->getLoggedInUserId(), ['guid', 'prvkey']); $timestamp = time(); - $sec_hash = hash('whirlpool', ($a->user['guid'] ?? '') . ($a->user['prvkey'] ?? '') . session_id() . $timestamp . $typename); + $sec_hash = hash('whirlpool', ($user['guid'] ?? '') . ($user['prvkey'] ?? '') . session_id() . $timestamp . $typename); return $timestamp . '.' . $sec_hash; } - public static function checkFormSecurityToken($typename = '', $formname = 'form_security_token') + /** + * Checks if form's security (CSRF) token is valid. + * + * @param string $typename ??? + * @param string $formname Name of form/field (???) + * @return bool Whether it is valid + */ + public static function checkFormSecurityToken(string $typename = '', string $formname = 'form_security_token'): bool { $hash = null; @@ -163,46 +383,44 @@ abstract class BaseModule $max_livetime = 10800; // 3 hours - $a = DI::app(); + $user = User::getById(DI::app()->getLoggedInUserId(), ['guid', 'prvkey']); $x = explode('.', $hash); if (time() > (intval($x[0]) + $max_livetime)) { return false; } - $sec_hash = hash('whirlpool', ($a->user['guid'] ?? '') . ($a->user['prvkey'] ?? '') . session_id() . $x[0] . $typename); + $sec_hash = hash('whirlpool', ($user['guid'] ?? '') . ($user['prvkey'] ?? '') . session_id() . $x[0] . $typename); return ($sec_hash == $x[1]); } - public static function getFormSecurityStandardErrorMessage() + public static function getFormSecurityStandardErrorMessage(): string { - 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; + 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."); } - public static function checkFormSecurityTokenRedirectOnError($err_redirect, $typename = '', $formname = 'form_security_token') + public static function checkFormSecurityTokenRedirectOnError(string $err_redirect, string $typename = '', string $formname = 'form_security_token') { if (!self::checkFormSecurityToken($typename, $formname)) { - $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()); + Logger::notice('checkFormSecurityToken failed: user ' . DI::app()->getLoggedInUserNickname() . ' - form element ' . $typename); + Logger::debug('checkFormSecurityToken failed', ['request' => $_REQUEST]); + DI::sysmsg()->addNotice(self::getFormSecurityStandardErrorMessage()); DI::baseUrl()->redirect($err_redirect); } } - public static function checkFormSecurityTokenForbiddenOnError($typename = '', $formname = 'form_security_token') + public static function checkFormSecurityTokenForbiddenOnError(string $typename = '', string $formname = 'form_security_token') { if (!self::checkFormSecurityToken($typename, $formname)) { - $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); + Logger::notice('checkFormSecurityToken failed: user ' . DI::app()->getLoggedInUserNickname() . ' - form element ' . $typename); + Logger::debug('checkFormSecurityToken failed', ['request' => $_REQUEST]); throw new \Friendica\Network\HTTPException\ForbiddenException(); } } - protected static function getContactFilterTabs(string $baseUrl, string $current, bool $displayCommonTab) + protected static function getContactFilterTabs(string $baseUrl, string $current, bool $displayCommonTab): array { $tabs = [ [