Initial commit

application/Espo/Core/Api/ErrorOutput.php

@@ -0,0 +1,278 @@
+<?php
+/************************************************************************
+ * This file is part of EspoCRM.
+ *
+ * EspoCRM – Open Source CRM application.
+ * Copyright (C) 2014-2025 EspoCRM, Inc.
+ * Website: https://www.espocrm.com
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ *
+ * The interactive user interfaces in modified source and object code versions
+ * of this program must display Appropriate Legal Notices, as required under
+ * Section 5 of the GNU Affero General Public License version 3.
+ *
+ * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
+ * these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
+ ************************************************************************/
+
+namespace Espo\Core\Api;
+
+use Espo\Core\Exceptions\BadRequest;
+use Espo\Core\Exceptions\Conflict;
+use Espo\Core\Exceptions\Error;
+use Espo\Core\Exceptions\Forbidden;
+use Espo\Core\Exceptions\HasBody;
+use Espo\Core\Exceptions\HasLogLevel;
+use Espo\Core\Exceptions\HasLogMessage;
+use Espo\Core\Exceptions\NotFound;
+use Espo\Core\Utils\Log;
+
+use LogicException;
+use Psr\Log\LogLevel;
+use RuntimeException;
+use Throwable;
+
+/**
+ * Processes an error output. If an exception occurred, it will be passed to here.
+ */
+class ErrorOutput
+{
+    /** @var array<int, string> */
+    private $errorDescriptions = [
+        400 => 'Bad Request',
+        401 => 'Unauthorized',
+        403 => 'Forbidden',
+        404 => 'Page Not Found',
+        409 => 'Conflict',
+        500 => 'Internal Server Error',
+        503 => 'Service Unavailable',
+    ];
+
+    /** @var int[] */
+    private $allowedStatusCodeList = [
+        200,
+        201,
+        400,
+        401,
+        403,
+        404,
+        409,
+        500,
+        503,
+    ];
+
+    /** @var class-string<Throwable>[] */
+    private array $printStatusReasonExceptionClassNameList = [
+        Error::class,
+        Forbidden::class,
+        Conflict::class,
+        BadRequest::class,
+        NotFound::class,
+    ];
+
+    public function __construct(private Log $log)
+    {}
+
+    public function process(
+        Request $request,
+        Response $response,
+        Throwable $exception,
+        ?string $route = null
+    ): void {
+
+        $this->processInternal($request, $response, $exception, $route);
+    }
+
+    public function processWithBodyPrinting(
+        Request $request,
+        Response $response,
+        Throwable $exception,
+        ?string $route = null
+    ): void {
+
+        $this->processInternal($request, $response, $exception, $route, true);
+    }
+
+    private function processInternal(
+        Request $request,
+        Response $response,
+        Throwable $exception,
+        ?string $route = null,
+        bool $toPrintBody = false
+    ): void {
+
+        $message = $exception->getMessage();
+
+        if ($exception->getPrevious() && $exception->getPrevious()->getMessage()) {
+            $message .= " " . $exception->getPrevious()->getMessage();
+        }
+
+        $statusCode = $exception->getCode();
+
+        if ($exception instanceof HasLogMessage) {
+            $message = $exception->getLogMessage();
+        }
+
+        if ($route) {
+            $this->processRoute($route, $request, $exception);
+        }
+
+        $level = $this->getLevel($exception);
+
+        $this->log->log($level, $message, [
+            'exception' => $exception,
+            'request' => $request,
+        ]);
+
+        if (!in_array($statusCode, $this->allowedStatusCodeList)) {
+            $statusCode = 500;
+        }
+
+        $response->setStatus($statusCode);
+
+        if ($this->toPrintExceptionStatusReason($exception)) {
+            $response->setHeader('X-Status-Reason', $this->stripInvalidCharactersFromHeaderValue($message));
+        }
+
+        if ($exception instanceof HasBody && $this->exceptionHasBody($exception)) {
+            $response->writeBody($exception->getBody() ?? '');
+
+            $toPrintBody = false;
+        }
+
+        if ($toPrintBody) {
+            $codeDescription = $this->getCodeDescription($statusCode);
+
+            $statusText = isset($codeDescription) ?
+                $statusCode . ' '. $codeDescription :
+                'HTTP ' . $statusCode;
+
+            if ($message) {
+                $message = htmlspecialchars($message);
+            }
+
+            $response->writeBody(self::generateErrorBody($statusText, $message));
+        }
+    }
+
+    private function exceptionHasBody(Throwable $exception): bool
+    {
+        if (!$exception instanceof HasBody) {
+            return false;
+        }
+
+        $exceptionBody = $exception->getBody();
+
+        return $exceptionBody !== null;
+    }
+
+    private function getCodeDescription(int $statusCode): ?string
+    {
+        if (isset($this->errorDescriptions[$statusCode])) {
+            return $this->errorDescriptions[$statusCode];
+        }
+
+        return null;
+    }
+
+    private function clearPasswords(string $string): string
+    {
+        return preg_replace('/"(.*password.*)":".*"/i', '"$1":"*****"', $string) ?? $string;
+    }
+
+    private static function generateErrorBody(string $header, string $text): string
+    {
+        $body = "<h1>" . $header . "</h1>";
+        $body .= $text;
+
+        return $body;
+    }
+
+    private function stripInvalidCharactersFromHeaderValue(string $value): string
+    {
+        $pattern = "/[^ \t\x21-\x7E\x80-\xFF]/";
+
+        /** @var string */
+        return preg_replace($pattern, ' ', $value);
+    }
+
+    private function processRoute(string $route, Request $request, Throwable $exception): void
+    {
+        $requestBodyString = $this->clearPasswords($request->getBodyContents() ?? '');
+
+        $message = $exception->getMessage();
+
+        if ($exception->getPrevious() && $exception->getPrevious()->getMessage()) {
+            $message .= " " . $exception->getPrevious()->getMessage();
+        }
+
+        $statusCode = $exception->getCode();
+
+        $routeParams = $request->getRouteParams();
+
+        $logMessage = "API ($statusCode) ";
+
+        $logMessageItemList = [];
+
+        if ($message) {
+            $logMessageItemList[] = $message;
+        }
+
+        $logMessageItemList[] = $request->getMethod() . ' ' . $request->getResourcePath();
+
+        if ($requestBodyString) {
+            $logMessageItemList[] = "Input data: " . $requestBodyString;
+        }
+
+        $logMessageItemList[] = "Route pattern: " . $route;
+
+        if (!empty($routeParams)) {
+            $logMessageItemList[] = "Route params: " . print_r($routeParams, true);
+        }
+
+        $logMessage .= implode("; ", $logMessageItemList);
+
+        $this->log->debug($logMessage);
+    }
+
+    private function toPrintExceptionStatusReason(Throwable $exception): bool
+    {
+        foreach ($this->printStatusReasonExceptionClassNameList as $clasName) {
+
+            if ($exception instanceof ($clasName)) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
+    private function getLevel(Throwable $exception): string
+    {
+        if ($exception instanceof HasLogLevel) {
+            return $exception->getLogLevel();
+        }
+
+        if ($exception instanceof LogicException) {
+            return LogLevel::ALERT;
+        }
+
+        if ($exception instanceof RuntimeException) {
+            return LogLevel::CRITICAL;
+        }
+
+        return LogLevel::ERROR;
+    }
+}