X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=src%2FBaseModule.php;h=c04b835c52ff4bb324c388dae1ebc940ffbc5a88;hb=40a126306621fe9eadb58101bd19a0be32e4c163;hp=48677e64fc6b41ec52c154ee504261d4ca3371ae;hpb=853670dae7b2ce40f3dd4b47a90937b0d3fae8d3;p=friendica.git diff --git a/src/BaseModule.php b/src/BaseModule.php index 48677e64fc..c04b835c52 100644 --- a/src/BaseModule.php +++ b/src/BaseModule.php @@ -1,6 +1,6 @@ parameters = $parameters; $this->l10n = $l10n; + $this->baseUrl = $baseUrl; + $this->args = $args; + $this->logger = $logger; + $this->profiler = $profiler; + $this->server = $server; + $this->response = $response; } /** @@ -64,64 +91,256 @@ abstract class BaseModule implements ICanHandleRequests * * @see L10n::tt() */ - protected function tt(string $singular, string $plurarl, int $count): string + protected function tt(string $singular, string $plural, int $count): string { - return $this->l10n->tt($singular, $plurarl, $count); + return $this->l10n->tt($singular, $plural, $count); } /** - * {@inheritDoc} + * Module GET method to display raw content from technical endpoints + * + * 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 function rawContent() + protected function rawContent(array $request = []) { - // echo ''; - // exit; + // $this->httpExit(...); } /** - * {@inheritDoc} + * Module GET method to display any content + * + * Extend this method if the module is supposed to return any display + * 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 function content(): string + protected function content(array $request = []): string { return ''; } /** - * {@inheritDoc} + * Module DELETE method to process submitted data + * + * 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 function delete() + protected function delete(array $request = []) { } /** - * {@inheritDoc} + * Module PATCH method to process submitted data + * + * 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 function patch() + protected function patch(array $request = []) { } /** - * {@inheritDoc} + * Module POST method to process submitted data + * + * 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 + */ + protected function post(array $request = []) + { + // $this->baseUrl->redirect('module'); + } + + /** + * Module PUT method to process submitted data + * + * Extend this method if the module is supposed to process PUT requests. + * Doesn't display any content + * + * @param string[] $request The $_REQUEST content + * @return void */ - public function post() + protected function put(array $request = []) { - // DI::baseurl()->redirect('module'); } /** * {@inheritDoc} */ - public function put() + 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, 9) == 'nodeinfo/') { + $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 + // templating and is expected to exit on its own if it is set. + $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->setStatus($e->getCode(), $e->getMessage()); + $this->response->addContent($httpException->content($e)); + } finally { + $this->profiler->set(microtime(true) - $timestamp, 'content'); + } + + return $this->response->generate(); } - /** Gets the name of the current class */ - public function getClassName(): string + /** + * Checks request inputs and sets default parameters + * + * @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 + */ + protected function checkDefaults(array $defaults, array $input): array { - return static::class; + $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; @@ -131,17 +350,27 @@ abstract class BaseModule implements ICanHandleRequests * 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 { - $user = User::getById(DI::app()->getLoggedInUserId(), ['guid', 'prvkey']); + $user = User::getById(DI::app()->getLoggedInUserId(), ['guid', 'prvkey']); $timestamp = time(); - $sec_hash = hash('whirlpool', ($user['guid'] ?? '') . ($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; @@ -173,22 +402,22 @@ abstract class BaseModule implements ICanHandleRequests 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)) { Logger::notice('checkFormSecurityToken failed: user ' . DI::app()->getLoggedInUserNickname() . ' - form element ' . $typename); Logger::debug('checkFormSecurityToken failed', ['request' => $_REQUEST]); - notice(self::getFormSecurityStandardErrorMessage()); + 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)) { Logger::notice('checkFormSecurityToken failed: user ' . DI::app()->getLoggedInUserNickname() . ' - form element ' . $typename); @@ -198,7 +427,7 @@ abstract class BaseModule implements ICanHandleRequests } } - protected static function getContactFilterTabs(string $baseUrl, string $current, bool $displayCommonTab) + protected static function getContactFilterTabs(string $baseUrl, string $current, bool $displayCommonTab): array { $tabs = [ [ @@ -233,4 +462,76 @@ abstract class BaseModule implements ICanHandleRequests return $tabs; } + + /** + * This function adds the content and a content-type HTTP header to the output. + * After finishing the process is getting killed. + * + * @param string $content + * @param string $type + * @param string|null $content_type + * @return void + * @throws HTTPException\InternalServerErrorException + */ + public function httpExit(string $content, string $type = Response::TYPE_HTML, ?string $content_type = null) + { + $this->response->setType($type, $content_type); + $this->response->addContent($content); + System::echoResponse($this->response->generate()); + + System::exit(); + } + + /** + * Send HTTP status header and exit. + * + * @param integer $httpCode HTTP status result value + * @param string $message Error message. Optional. + * @param mixed $content Response body. Optional. + * @throws \Exception + */ + public function httpError(int $httpCode, string $message = '', $content = '') + { + if ($httpCode >= 400) { + $this->logger->debug('Exit with error', ['code' => $httpCode, 'message' => $message, 'method' => $this->args->getMethod(), 'agent' => $this->server['HTTP_USER_AGENT'] ?? '']); + } + + $this->response->setStatus($httpCode, $message); + + $this->httpExit($content); + } + + /** + * Display the response using JSON to encode the content + * + * @param mixed $content + * @param string $content_type + * @param int $options A combination of json_encode() binary flags + * @return void + * @throws HTTPException\InternalServerErrorException + * @see json_encode() + */ + public function jsonExit($content, string $content_type = 'application/json', int $options = JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE | JSON_PRETTY_PRINT) + { + $this->httpExit(json_encode($content, $options), ICanCreateResponses::TYPE_JSON, $content_type); + } + + /** + * Display a non-200 HTTP code response using JSON to encode the content and exit + * + * @param int $httpCode + * @param mixed $content + * @param string $content_type + * @return void + * @throws HTTPException\InternalServerErrorException + */ + public function jsonError(int $httpCode, $content, string $content_type = 'application/json') + { + if ($httpCode >= 400) { + $this->logger->debug('Exit with error', ['code' => $httpCode, 'content_type' => $content_type, 'method' => $this->args->getMethod(), 'agent' => $this->server['HTTP_USER_AGENT'] ?? '']); + } + + $this->response->setStatus($httpCode); + $this->jsonExit($content, $content_type); + } }