custom/plugins/PickwareDhl/vendor/pickware/debug-bundle/src/ResponseExceptionListener/ResponseExceptionListenerDecorator.php line 55

Open in your IDE?
  1. <?php
  2. /*
  3.  * Copyright (c) Pickware GmbH. All rights reserved.
  4.  * This file is part of software that is released under a proprietary license.
  5.  * You must not copy, modify, distribute, make publicly available, or execute
  6.  * its contents or parts thereof without express permission by the copyright
  7.  * holder, unless otherwise permitted by law.
  8.  */
  10. declare(strict_types=1);
  12. namespace Pickware\DebugBundle\ResponseExceptionListener;
  14. use League\OAuth2\Server\Exception\OAuthServerException;
  15. use Psr\Log\LoggerInterface;
  16. use Shopware\Core\Framework\Api\EventListener\ResponseExceptionListener;
  17. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  18. use Symfony\Component\HttpFoundation\JsonResponse;
  19. use Symfony\Component\HttpFoundation\Request;
  20. use Symfony\Component\HttpFoundation\Response;
  21. use Symfony\Component\HttpKernel\Event\ExceptionEvent;
  22. use Throwable;
  24. class ResponseExceptionListenerDecorator implements EventSubscriberInterface
  25. {
  26.     private ResponseExceptionListener $decoratedService;
  28.     private LoggerInterface $errorLogger;
  29.     private JwtValidator $jwtValidator;
  31.     /**
  32.      * We can't use a php type hint for the ResponseExceptionListener here since it does not implement an interface that
  33.      * contains the non-static methods, and it could be decorated by a different plugin as well.
  34.      *
  35.      * @param ResponseExceptionListener $decoratedService
  36.      */
  37.     public function __construct($decoratedService, LoggerInterface $errorLogger, JwtValidator $jwtValidator)
  38.     {
  39.         $this->decoratedService = $decoratedService;
  40.         $this->errorLogger = $errorLogger;
  41.         $this->jwtValidator = $jwtValidator;
  42.     }
  44.     /**
  45.      * Unfortunately, static methods can not be decorated, so we need to call the original method directly and hope that
  46.      * no other plugin wraps this method and changes its return value.
  47.      *
  48.      * @return array
  49.      */
  50.     public static function getSubscribedEvents()
  51.     {
  52.         return ResponseExceptionListener::getSubscribedEvents();
  53.     }
  55.     public function onKernelException(ExceptionEvent $originalEvent)
  56.     {
  57.         $event = $this->decoratedService->onKernelException($originalEvent);
  58.         $exception = $event->getThrowable();
  60.         if ($exception instanceof OAuthServerException) {
  61.             return $event;
  62.         }
  64.         if ($this->shouldAddTraceToResponse($event->getRequest(), $event->getResponse())) {
  65.             $event->setResponse($this->addTraceToResponse($event->getResponse(), $event->getThrowable()));
  66.         }
  68.         if ($this->shouldLogTrace($event->getRequest())) {
  69.             $this->errorLogger->error($exception->getMessage(), [
  70.                 'exception' => $this->getTrace($exception),
  71.             ]);
  72.         }
  74.         return $event;
  75.     }
  77.     private function shouldAddTraceToResponse(Request $request, ?Response $response): bool
  78.     {
  79.         if (!$this->containsValidDebugHeader($request)) {
  80.             return false;
  81.         }
  83.         if (!$response) {
  84.             return false;
  85.         }
  87.         if (!($response instanceof JsonResponse)) {
  88.             return false;
  89.         }
  91.         if ($response->getStatusCode() === 401) {
  92.             return false;
  93.         }
  95.         return true;
  96.     }
  98.     private function containsValidDebugHeader(Request $request): bool
  99.     {
  100.         $debugHeader = $request->headers->get('X-Pickware-Show-Trace');
  102.         return $debugHeader && $this->jwtValidator->isJwtTokenValid($debugHeader);
  103.     }
  105.     private function addTraceToResponse(JsonResponse $response, Throwable $throwable): Response
  106.     {
  107.         $content = json_decode($response->getContent(), true);
  108.         $content['trace'] = $this->getTrace($throwable);
  110.         $response->setData($content);
  112.         return $response;
  113.     }
  115.     private function shouldLogTrace(Request $request): bool
  116.     {
  117.         if ($this->containsValidDebugHeader($request)) {
  118.             return true;
  119.         }
  121.         if (mb_strpos($request->headers->get('User-Agent') ?? '', 'com.viison.pickware.POS') !== false) {
  122.             return true;
  123.         }
  125.         return false;
  126.     }
  128.     private function getTrace(Throwable $throwable): array
  129.     {
  130.         // Remove args so that no credentials are logged.
  131.         return array_map(function ($element) {
  132.             unset($element['args']);
  134.             return $element;
  135.         }, $throwable->getTrace());
  136.     }
  137. }