Merge pull request #4 from Micro-PHP/v1.0.2-release

v1.0.3-release

Author: Asisyas

.gitignore

@@ -1,3 +1,4 @@
+.idea
 vendor
 composer.lock
 .phpunit.result.cache

composer.json

@@ -28,7 +28,7 @@
     },
     "autoload-dev": {
         "psr-4": {
-            "Micro\\Plugin\\Http\\Test\\": "tests/"
+            "Micro\\Plugin\\Http\\Test\\Unit\\": "tests/Unit"
         }
     },
     "config": {

src/Business/Executor/HttpExecutorLoggerAwareDecorator.php

@@ -14,6 +14,7 @@
 namespace Micro\Plugin\Http\Business\Executor;
 
 use Micro\Plugin\Http\Business\Logger\Formatter\LogFormatterInterface;
+use Micro\Plugin\Http\Exception\HttpException;
 use Psr\Log\LoggerInterface;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
@@ -40,12 +41,35 @@ public function execute(Request $request, bool $flush = true): Response
         $response = null;
         try {
             $response = $this->decorated->execute($request, $flush);
-        } catch (\Throwable $throwable) {
+        } catch (HttpException $exception) {
+            if ($exception->getCode() >= 500) {
+                $this->loggerError->critical(
+                    $this->logErrorFormatter->format($request, $response, $exception),
+                    [
+                        'exception' => $exception,
+                    ]
+                );
+
+                throw $exception;
+            }
+
+            $this->loggerError->info(
+                $this->logErrorFormatter->format($request, $response, $exception),
+                [
+                    'exception' => $exception,
+                ]
+            );
+
+            throw $exception;
+        } catch (\Throwable $exception) {
             $this->loggerError->critical(
-                $this->logErrorFormatter->format($request, $response, $throwable)
+                $this->logErrorFormatter->format($request, $response, $exception),
+                [
+                    'exception' => $exception,
+                ]
             );
 
-            throw $throwable;
+            throw $exception;
         } finally {
             $this->loggerAccess->info(
                 $this->logAccessFormatter->format($request, $response, null)

src/Business/Logger/Formatter/Format/AbstractHeaderFormatter.php

@@ -0,0 +1,57 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ *  This file is part of the Micro framework package.
+ *
+ *  (c) Stanislau Komar <kost@micro-php.net>
+ *
+ *  For the full copyright and license information, please view the LICENSE
+ *  file that was distributed with this source code.
+ */
+
+namespace Micro\Plugin\Http\Business\Logger\Formatter\Format;
+
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+
+/**
+ * @author Stanislau Komar <head.trackingsoft@gmail.com>
+ *
+ * @codeCoverageIgnore
+ */
+abstract class AbstractHeaderFormatter implements LogFormatterConcreteInterface
+{
+    public function format(Request $request, ?Response $response, ?\Throwable $exception, ?string $message = null): string
+    {
+        if (!$message) {
+            return '';
+        }
+
+        $matchPattern = sprintf('/{{%s_header\.(.*?)}}/', $this->getPrefix());
+        $matched = preg_match_all($matchPattern, $message, $matches);
+        if (!$matched || 2 !== \count($matches)) {
+            return $message;
+        }
+
+        $matchesPattern = $matches[0];
+        $matchesVars = $matches[1];
+
+        $countMatches = \count($matchesVars);
+
+        for ($i = 0; $i < $countMatches; ++$i) {
+            $message = str_ireplace(
+                $matchesPattern[$i],
+                $this->getValue($request, $response, $matchesVars[$i]),
+                $message
+            );
+        }
+
+        return $message;
+    }
+
+    abstract protected function getValue(Request $request, ?Response $response, string $matchedVar): string;
+
+    abstract protected function getPrefix(): string;
+}

src/Business/Logger/Formatter/Format/HeadersRequestFormatter.php

@@ -0,0 +1,81 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ *  This file is part of the Micro framework package.
+ *
+ *  (c) Stanislau Komar <kost@micro-php.net>
+ *
+ *  For the full copyright and license information, please view the LICENSE
+ *  file that was distributed with this source code.
+ */
+
+namespace Micro\Plugin\Http\Business\Logger\Formatter\Format;
+
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+
+/**
+ * @author Stanislau Komar <head.trackingsoft@gmail.com>
+ */
+class HeadersRequestFormatter extends AbstractHeaderFormatter
+{
+    /**
+     * @var string[]
+     */
+    private readonly array $securedHeadersList;
+
+    /**
+     * @param string[] $securedHeadersList
+     */
+    public function __construct(
+        array $securedHeadersList
+    ) {
+        $this->securedHeadersList = array_map('mb_strtolower', $securedHeadersList);
+    }
+
+    protected function getPrefix(): string
+    {
+        return 'request';
+    }
+
+    protected function getValue(Request $request, ?Response $response, string $matchedVar): string
+    {
+        if (!$matchedVar) {
+            return '';
+        }
+        $isSingleVar = true;
+        if ('*' === $matchedVar) {
+            $headersArray = $request->headers->all();
+            $isSingleVar = false;
+        } else {
+            $tmpHeaderValue = $request->headers->get($matchedVar);
+
+            $headersArray = [$matchedVar => $tmpHeaderValue];
+        }
+
+        $headersArray = array_change_key_case($headersArray);
+        foreach ($this->securedHeadersList as $securedHeader) {
+            if (!\array_key_exists($securedHeader, $headersArray)) {
+                continue;
+            }
+            /** @var string[] $securedHeaderValue */
+            $securedHeaderValue = $headersArray[$securedHeader];
+
+            $headersArray[$securedHeader] = array_map(fn (mixed $value) => '** Secured **', $securedHeaderValue);
+        }
+
+        if ($isSingleVar) {
+            $headersArray = array_values($headersArray);
+            if (1 === \count($headersArray)) {
+                $tmpValue = $headersArray[0];
+                if (!\is_array($tmpValue)) {
+                    return (string) $tmpValue;
+                }
+            }
+        }
+
+        return (string) json_encode($headersArray);
+    }
+}

src/Business/Logger/Formatter/Format/HttpRefererFormat.php

@@ -13,33 +13,25 @@
 
 namespace Micro\Plugin\Http\Business\Logger\Formatter;
 
-use Micro\Plugin\Http\Business\Logger\Formatter\Format\HttpRefererFormat;
-use Micro\Plugin\Http\Business\Logger\Formatter\Format\IpFormat;
-use Micro\Plugin\Http\Business\Logger\Formatter\Format\MethodFormat;
-use Micro\Plugin\Http\Business\Logger\Formatter\Format\RequestBodyFormat;
-use Micro\Plugin\Http\Business\Logger\Formatter\Format\RequestFormat;
-use Micro\Plugin\Http\Business\Logger\Formatter\Format\StatusFormat;
-use Micro\Plugin\Http\Business\Logger\Formatter\Format\TimeFormat;
-use Micro\Plugin\Http\Business\Logger\Formatter\Format\UsernameFormat;
+use Micro\Plugin\Http\Business\Logger\Formatter\Format\LogFormatterConcreteInterface;
 
 /**
  * @author Stanislau Komar <kost@micro-php.net>
  */
-class LogFormatterFactory implements LogFormatterFactoryInterface
+readonly class LogFormatterFactory implements LogFormatterFactoryInterface
 {
+    /**
+     * @param iterable<LogFormatterConcreteInterface> $logFormatterCollection
+     */
+    public function __construct(
+        private iterable $logFormatterCollection,
+    ) {
+    }
+
     public function create(string $format): LogFormatterInterface
     {
         return new LogFormatter(
-            [
-                new HttpRefererFormat(),
-                new IpFormat(),
-                new MethodFormat(),
-                new RequestBodyFormat(),
-                new RequestFormat(),
-                new StatusFormat(),
-                new TimeFormat(),
-                new UsernameFormat(),
-            ],
+            $this->logFormatterCollection,
             $format
         );
     }

src/Business/Logger/Formatter/LogFormatterFactory.php

@@ -20,6 +20,14 @@
 use Micro\Framework\Kernel\Plugin\PluginDependedInterface;
 use Micro\Plugin\Http\Business\Executor\HttpExecutorLoggerAwareDecoratorFactory;
 use Micro\Plugin\Http\Business\Executor\RouteExecutorFactoryInterface;
+use Micro\Plugin\Http\Business\Logger\Formatter\Format\HeadersRequestFormatter;
+use Micro\Plugin\Http\Business\Logger\Formatter\Format\IpFormat;
+use Micro\Plugin\Http\Business\Logger\Formatter\Format\MethodFormat;
+use Micro\Plugin\Http\Business\Logger\Formatter\Format\RequestBodyFormat;
+use Micro\Plugin\Http\Business\Logger\Formatter\Format\RequestFormat;
+use Micro\Plugin\Http\Business\Logger\Formatter\Format\StatusFormat;
+use Micro\Plugin\Http\Business\Logger\Formatter\Format\TimeFormat;
+use Micro\Plugin\Http\Business\Logger\Formatter\Format\UsernameFormat;
 use Micro\Plugin\Http\Business\Logger\Formatter\LogFormatterFactory;
 use Micro\Plugin\Http\Business\Logger\Formatter\LogFormatterFactoryInterface;
 use Micro\Plugin\Http\Decorator\HttpFacadeLoggerDecorator;
@@ -73,7 +81,18 @@ protected function createHttpExecutorFactory(): RouteExecutorFactoryInterface
 
     protected function createLogFormatterFactory(): LogFormatterFactoryInterface
     {
-        return new LogFormatterFactory();
+        return new LogFormatterFactory(
+            [
+                new HeadersRequestFormatter($this->configuration()->getRequestHeadersSecuredList()),
+                new IpFormat(),
+                new MethodFormat(),
+                new RequestBodyFormat(),
+                new RequestFormat(),
+                new StatusFormat(),
+                new TimeFormat(),
+                new UsernameFormat(),
+            ]
+        );
     }
 
     public function getDependedPlugins(): iterable

src/HttpLoggerPlugin.php

@@ -23,13 +23,13 @@ class HttpLoggerPluginConfiguration extends PluginConfiguration implements HttpL
 {
     public const CFG_LOGGER_ACCESS = 'MICRO_HTTP_LOGGER_ACCESS';
     public const CFG_LOGGER_ERROR = 'MICRO_HTTP_LOGGER_ERROR';
+    public const CFG_LOGGER_HEADERS_SECURED = 'MICRO_HTTP_LOGGER_HEADERS_SECURED';
+    public const CFG_LOGGER_HEADERS_SECURED_DEFAULT = 'Authorization';
     public const CFG_DECORATION_WEIGHT = 'MICRO_HTTP_LOGGER_DECORATION_WEIGHT';
-
     public const CFG_HTTP_LOGGER_ACCESS_FORMAT = 'MICRO_HTTP_LOGGER_ACCESS_FORMAT';
     public const CFG_HTTP_LOGGER_ERROR_FORMAT = 'MICRO_HTTP_LOGGER_ERROR_FORMAT';
-    public const LOGGER_ERROR_FORMAT_DEFAULT = '{{remote_addr}} - {{remote_user}} [{{time}}] "{{request}}" {{status}}';
-    public const LOGGER_ACCESS_FORMAT_DEFAULT = '{{remote_addr}} - {{remote_user}} [{{time}}] "{{request}}" {{status}} {{http_referer}} {{http_user_agent}}';
-
+    public const LOGGER_ERROR_FORMAT_DEFAULT = '{{remote_addr}} - {{remote_user}} [{{status}}] "{{request}}"';
+    public const LOGGER_ACCESS_FORMAT_DEFAULT = '{{remote_addr}} - {{remote_user}} [{{status}}] "{{request}}" {{request_header.http-referer}} {{request_header.user-agent}}';
     public const DECORATION_DEFAULT = 10;
 
     public function getAccessLoggerName(): string
@@ -56,4 +56,14 @@ public function getAccessLogFormat(): string
     {
         return $this->configuration->get(self::CFG_HTTP_LOGGER_ACCESS_FORMAT, self::LOGGER_ACCESS_FORMAT_DEFAULT, false);
     }
+
+    public function getRequestHeadersSecuredList(): array
+    {
+        return $this->explodeStringToArray(
+            $this->configuration->get(
+                self::CFG_LOGGER_HEADERS_SECURED,
+                self::CFG_LOGGER_HEADERS_SECURED_DEFAULT
+            )
+        );
+    }
 }

src/HttpLoggerPluginConfiguration.php

@@ -26,5 +26,10 @@ public function getErrorLogFormat(): string;
 
     public function getAccessLogFormat(): string;
 
+    /**
+     * @return string[]
+     */
+    public function getRequestHeadersSecuredList(): array;
+
     public function getWeight(): int;
 }