X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=src%2FBaseModule.php;h=c04b835c52ff4bb324c388dae1ebc940ffbc5a88;hb=40a126306621fe9eadb58101bd19a0be32e4c163;hp=c03a77e29e2e3cc935e7b43e2907d280efc89a23;hpb=720a43461d67ab229de0aecfc5008f22cc4c1c54;p=friendica.git diff --git a/src/BaseModule.php b/src/BaseModule.php index c03a77e29e..c04b835c52 100644 --- a/src/BaseModule.php +++ b/src/BaseModule.php @@ -1,6 +1,6 @@ l10n->tt($singular, $plurarl, $count); + return $this->l10n->tt($singular, $plural, $count); } /** @@ -102,11 +103,11 @@ abstract class BaseModule implements ICanHandleRequests * e.g. from protocol implementations. * * @param string[] $request The $_REQUEST content + * @return void */ protected function rawContent(array $request = []) { - // echo ''; - // exit; + // $this->httpExit(...); } /** @@ -117,6 +118,7 @@ abstract class BaseModule implements ICanHandleRequests * XML feed or a JSON output. * * @param string[] $request The $_REQUEST content + * @return string */ protected function content(array $request = []): string { @@ -130,6 +132,7 @@ abstract class BaseModule implements ICanHandleRequests * Doesn't display any content * * @param string[] $request The $_REQUEST content + * @return void */ protected function delete(array $request = []) { @@ -142,6 +145,7 @@ abstract class BaseModule implements ICanHandleRequests * Doesn't display any content * * @param string[] $request The $_REQUEST content + * @return void */ protected function patch(array $request = []) { @@ -154,7 +158,7 @@ abstract class BaseModule implements ICanHandleRequests * Doesn't display any content * * @param string[] $request The $_REQUEST content - * + * @return void */ protected function post(array $request = []) { @@ -168,6 +172,7 @@ abstract class BaseModule implements ICanHandleRequests * Doesn't display any content * * @param string[] $request The $_REQUEST content + * @return void */ protected function put(array $request = []) { @@ -176,7 +181,7 @@ abstract class BaseModule implements ICanHandleRequests /** * {@inheritDoc} */ - public function run(array $request = []): ResponseInterface + 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/') { @@ -184,6 +189,11 @@ abstract class BaseModule implements ICanHandleRequests $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'); @@ -229,7 +239,8 @@ abstract class BaseModule implements ICanHandleRequests $timestamp = microtime(true); // "rawContent" is especially meant for technical endpoints. - // This endpoint doesn't need any theme initialization or other comparable stuff. + // 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 { @@ -238,7 +249,16 @@ abstract class BaseModule implements ICanHandleRequests $this->response->addContent($arr['content']); $this->response->addContent($this->content($request)); } catch (HTTPException $e) { - $this->response->addContent((new ModuleHTTPException())->content($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'); } @@ -279,12 +299,12 @@ abstract class BaseModule implements ICanHandleRequests /** * Fetch a request value and apply default values and check against minimal and maximal values * - * @param array $input - * @param string $parameter - * @param mixed $default - * @param mixed $minimal_value - * @param mixed $maximum_value - * @return mixed + * @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) { @@ -320,7 +340,7 @@ abstract class BaseModule implements ICanHandleRequests 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; @@ -330,8 +350,11 @@ 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']); $timestamp = time(); @@ -340,7 +363,14 @@ abstract class BaseModule implements ICanHandleRequests 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; @@ -372,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); @@ -397,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 = [ [ @@ -432,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); + } }