X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=src%2FBaseModule.php;h=c04b835c52ff4bb324c388dae1ebc940ffbc5a88;hb=40a126306621fe9eadb58101bd19a0be32e4c163;hp=619095dfb6fbaf019c669c309cc07c6fece29ec9;hpb=1359b171af33d5cca480d3b3c5e0e6d54454dcb7;p=friendica.git diff --git a/src/BaseModule.php b/src/BaseModule.php index 619095dfb6..c04b835c52 100644 --- a/src/BaseModule.php +++ b/src/BaseModule.php @@ -27,6 +27,7 @@ use Friendica\Capabilities\ICanCreateResponses; use Friendica\Core\Hook; use Friendica\Core\L10n; use Friendica\Core\Logger; +use Friendica\Core\System; use Friendica\Model\User; use Friendica\Module\Response; use Friendica\Module\Special\HTTPException as ModuleHTTPException; @@ -106,8 +107,7 @@ abstract class BaseModule implements ICanHandleRequests */ protected function rawContent(array $request = []) { - // echo ''; - // exit; + // $this->httpExit(...); } /** @@ -189,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'); @@ -234,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 { @@ -456,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); + } }