custom/plugins/ScopPlatformRedirecter/src/Subscriber/RequestSubscriber.php line 70

Open in your IDE?
  1. <?php
  2. /**
  3.  * Implemented by scope01 GmbH team https://scope01.com
  4.  *
  5.  * @copyright scope01 GmbH https://scope01.com
  6.  * @license MIT License
  7.  * @link https://scope01.com
  8.  */
  9. declare(strict_types=1);
  10. /**
  11.  * Implemented by scope01 GmbH team https://scope01.com
  12.  *
  13.  * @copyright scope01 GmbH https://scope01.com
  14.  * @license MIT
  15.  * @link https://scope01.com
  16.  */
  18. namespace Scop\PlatformRedirecter\Subscriber;
  20. use Shopware\Core\Framework\Context;
  21. use Shopware\Core\Framework\DataAbstractionLayer\EntityRepositoryInterface;
  22. use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
  23. use Shopware\Core\Framework\DataAbstractionLayer\Search\Filter\EqualsAnyFilter;
  24. use Shopware\Core\Framework\DataAbstractionLayer\Search\Filter\EqualsFilter;
  25. use Shopware\Core\Framework\Event\BeforeSendRedirectResponseEvent;
  26. use Shopware\Core\Framework\Event\BeforeSendResponseEvent;
  27. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  28. use Symfony\Component\HttpFoundation\RedirectResponse;
  30. class RequestSubscriber implements EventSubscriberInterface
  31. {
  32.     /**
  33.      * @var EntityRepositoryInterface
  34.      */
  35.     private $repository;
  36.     /**
  37.      * @var EntityRepositoryInterface
  38.      */
  39.     private $seoUrlRepository;
  41.     /**
  42.      * @param EntityRepositoryInterface $redirectRepository
  43.      */
  44.     public function __construct(EntityRepositoryInterface $redirectRepository, EntityRepositoryInterface $seoUrlRepository)
  45.     {
  46.         /** @var EntityRepositoryInterface $repository */
  47.         $this->repository = $redirectRepository;
  48.         $this->seoUrlRepository = $seoUrlRepository;
  49.     }
  51.     /**
  52.      *
  53.      * @return array
  54.      */
  55.     public static function getSubscribedEvents(): array
  56.     {
  57.         return [
  58.             BeforeSendResponseEvent::class => 'redirectBeforeSendResponse',
  59.             BeforeSendRedirectResponseEvent::class => 'redirectBeforeSendResponse'
  60.         ];
  61.     }
  63.     /**
  64.      * Redirect to the new url if found in redirects
  65.      * Otherwise do nothing
  66.      * Modules like admin, api or widgets are excluded from redirects
  67.      *
  68.      * @param BeforeSendResponseEvent $event
  69.      */
  70.     public function redirectBeforeSendResponse(BeforeSendResponseEvent $event): void
  71.     {
  72.         $requestUri = (string)$event->getRequest()->get("sw-original-request-uri");
  74.         // "sw-original-request-uri" is not present in shopware versions below 6.4.0.0.
  75.         // In this case, an older method must be used for redirecting, which doesn't redirects correctly in some edge cases.
  76.         if ($requestUri === "") {
  77.             $this->oldRedirectBeforeSendResponse($event);
  78.             return;
  79.         }
  81.         $storefrontUri = $event->getRequest()->get('sw-sales-channel-absolute-base-url');
  82.         $requestBase = $event->getRequest()->getPathInfo();
  83.         $requestBaseUrl = $event->getRequest()->getBaseUrl();
  85.         // Block overriding /admin and /api and widgets, so you can't lock out of the administration.
  86.         if (\strpos($requestBase, "/admin") === 0) {
  87.             return;
  88.         }
  89.         if (\strpos($requestBase, "/api") === 0) {
  90.             return;
  91.         }
  92.         if (\strpos($requestBase, "/widgets") === 0) {
  93.             return;
  94.         }
  95.         if (\strpos($requestBase, "/store-api") === 0) {
  96.             return;
  97.         }
  98.         if (\strpos($requestBase, "/_profiler") === 0) {
  99.             return;
  100.         }
  102.         $context = Context::createDefaultContext();
  104.         $umlaute = [
  105.             '%C3%9C' => 'Ü',
  106.             '%C3%BC' => 'ü',
  107.             '%C3%96' => 'Ö',
  108.             '%C3%B6' => 'ö',
  109.             '%C3%84' => 'Ä',
  110.             '%C3%A4' => 'ä',
  111.             '%C3%9F' => 'ß'
  112.         ];
  114.         foreach ($umlaute as $key => $value) {
  115.             $requestUri = str_replace($key, $value, $requestUri);
  116.         }
  118.         $search = [
  119.             $requestBaseUrl . '/' . $requestUri, // relative url with shopware 6 in sub folder: /public/Ergonomic-Concrete-Cough-Machine/48314803f1244f609a2ce907bfb48f53
  120.             $requestBaseUrl . $requestUri, // relative url with shopware 6 in sub folder url is not shopware seo url: /public/test
  121.             $storefrontUri . $requestUri, // absolute url with shopware 6 in sub folder, full url with host: http://shopware-platform.local/public/test1
  122.             $storefrontUri . '/' . $requestUri, // absolute url with shopware 6 in sub folder, full url with host and slash at the end: http://shopware-platform.local/public/Freizeit-Elektro/Telefone/
  123.             $requestUri, // relative url domain configured in public folder: /Ergonomic-Concrete-Cough-Machine/48314803f1244f609a2ce907bfb48f53 or /test4
  124.             '/' . $requestUri, // absolute url domain configured in public folder: http://shopware-platform.local/Shoes-Baby/
  125.             \substr($requestUri, 1), // e.g. "test"
  126.         ];
  128.         // search for the redirect in the database
  129.         $redirects = $this->repository->search((new Criteria())->addFilter(new EqualsAnyFilter('sourceURL', $search))->addFilter(new EqualsFilter('enabled', true))
  130.             ->setLimit(1), $context);
  132.         if ($redirects->count() === 0) {
  133.             // Checks if the requested URL contains Query parameters, and if so, checks if a redirect can be found with the ignoreQueryParams option
  134.             if (str_contains($requestUri, '?')) {
  135.                 $searchWithoutQuery = [];
  136.                 foreach ($search as $string)
  137.                     $searchWithoutQuery[] = explode('?', $string)[0];
  139.                 $redirects = $this->repository->search((new Criteria())->addFilter(new EqualsAnyFilter('sourceURL', $searchWithoutQuery))->addFilter(new EqualsFilter('enabled', true))->addFilter(new EqualsFilter('ignoreQueryParams', true))
  140.                     ->setLimit(1), $context);
  142.                 // No Redirect found for this URL, do nothing
  143.                 if ($redirects->count() === 0) {
  144.                     return;
  145.                 }
  146.             } else {
  147.                 // No Redirect found for this URL, do nothing
  148.                 return;
  149.             }
  150.         }
  152.         $redirect = $redirects->first();
  153.         $targetURL = $redirect->getTargetURL();
  154.         $code = $redirect->getHttpCode();
  156.         // Prevent endless redirecting when target url and source url have only different capitalisation
  157.         if (in_array($targetURL, $search, true)) {
  158.             return;
  159.         }
  161.         /*
  162.          *  checks if $targetURL is a full url or path and redirects accordingly
  163.          */
  164.         if (!(\strpos($targetURL, "http:") === 0 || \strpos($targetURL, "https:") === 0)) {
  165.             if (\strpos($targetURL, "www.") === 0) {
  166.                 $targetURL = "http://" . $targetURL;
  167.             } else {
  168.                 if (\strpos($targetURL, "/") !== 0) {
  169.                     $targetURL = "/" . $targetURL;
  170.                 }
  171.             }
  172.         }
  173.         $event->setResponse(new RedirectResponse($targetURL, $code));
  174.     }
  176.     /**
  177.      * Method for shopware versions below 6.4.0.0
  178.      *
  179.      * Redirect to the new url if found in redirects
  180.      * Otherwise do nothing
  181.      * Modules like admin, api or widgets are excluded from redirects
  182.      *
  183.      * @param BeforeSendResponseEvent $event
  184.      */
  185.     private function oldRedirectBeforeSendResponse(BeforeSendResponseEvent $event): void
  186.     {
  187.         $requestUri = (string)$event->getRequest()->get('resolved-uri');
  188.         $storefrontUri = $event->getRequest()->get('sw-storefront-url');
  189.         $requestBase = $event->getRequest()->getPathInfo();
  190.         $requestBaseUrl = $event->getRequest()->getBaseUrl();
  191.         $queryString = (string)$event->getRequest()->getQueryString();
  192.         $search = [];
  193.         // Block overriding /admin and /api and widgets, so you can't lock out of the administration.
  194.         if (\strpos($requestBase, "/admin") === 0) {
  195.             return;
  196.         }
  197.         if (\strpos($requestBase, "/api") === 0) {
  198.             return;
  199.         }
  200.         if (\strpos($requestBase, "/widgets") === 0) {
  201.             return;
  202.         }
  203.         if (\strpos($requestBase, "/store-api") === 0) {
  204.             return;
  205.         }
  206.         if (\strpos($requestBase, "/_profiler") === 0) {
  207.             return;
  208.         }
  210.         if ($queryString !== '') {
  211.             $queryString = urldecode($queryString);
  212.             $requestUri .= '?' . $queryString;
  213.         }
  215.         // try to load the seo route
  216.         $context = Context::createDefaultContext();
  217.         $redirects = $this->seoUrlRepository->search((new Criteria())
  218.             ->addFilter(new EqualsAnyFilter('pathInfo', [$requestUri])), $context);
  220.         // if found overwrite search term with the seo route
  221.         if ($redirects->count() !== 0) {
  222.             foreach ($redirects as $redirect) {
  223.                 $requestBase = $redirect->getSeoPathInfo();
  224.                 // Search for Redirect
  225.                 $search[] = [
  226.                     $requestBaseUrl . '/' . $requestBase, // relative url with shopware 6 in sub folder: /public/Ergonomic-Concrete-Cough-Machine/48314803f1244f609a2ce907bfb48f53
  227.                     $requestBaseUrl . $requestBase, // relative url with shopware 6 in sub folder url is not shopware seo url: /public/test
  228.                     $storefrontUri . $requestBase, // absolute url with shopware 6 in sub folder, full url with host: http://shopware-platform.local/public/test1
  229.                     $storefrontUri . '/' . $requestBase, // absolute url with shopware 6 in sub folder, full url with host and slash at the end: http://shopware-platform.local/public/Freizeit-Elektro/Telefone/
  230.                     $requestBase, // relative url domain configured in public folder: /Ergonomic-Concrete-Cough-Machine/48314803f1244f609a2ce907bfb48f53 or /test4
  231.                     '/' . $requestBase, // absolute url domain configured in public folder: http://shopware-platform.local/Shoes-Baby/
  232.                     \substr($requestBase, 1), // e.g. "test"
  233.                 ];
  234.             }
  235.         }
  236.         if (!empty($search)) {
  237.             $search = array_merge(...$search);
  238.         } else {
  239.             $search = [
  240.                 $requestBaseUrl . '/' . $requestUri, // relative url with shopware 6 in sub folder: /public/Ergonomic-Concrete-Cough-Machine/48314803f1244f609a2ce907bfb48f53
  241.                 $requestBaseUrl . $requestUri, // relative url with shopware 6 in sub folder url is not shopware seo url: /public/test
  242.                 $storefrontUri . $requestUri, // absolute url with shopware 6 in sub folder, full url with host: http://shopware-platform.local/public/test1
  243.                 $storefrontUri . '/' . $requestUri, // absolute url with shopware 6 in sub folder, full url with host and slash at the end: http://shopware-platform.local/public/Freizeit-Elektro/Telefone/
  244.                 $requestUri, // relative url domain configured in public folder: /Ergonomic-Concrete-Cough-Machine/48314803f1244f609a2ce907bfb48f53 or /test4
  245.                 '/' . $requestUri, // absolute url domain configured in public folder: http://shopware-platform.local/Shoes-Baby/
  246.                 \substr($requestUri, 1), // e.g. "test"
  247.             ];
  248.         }
  250.         // search for the redirect in the database
  251.         $redirects = $this->repository->search((new Criteria())->addFilter(new EqualsAnyFilter('sourceURL', $search))->addFilter(new EqualsFilter('enabled', true))
  252.             ->setLimit(1), $context);
  254.         if ($redirects->count() === 0) {
  255.             // Checks if the requested URL contains Query parameters, and if so, checks if a redirect can be found with the ignoreQueryParams option
  256.             if (str_contains($requestUri, '?')) {
  257.                 $searchWithoutQuery = [];
  258.                 foreach ($search as $string)
  259.                     $searchWithoutQuery[] = explode('?', $string)[0];
  261.                 $redirects = $this->repository->search((new Criteria())->addFilter(new EqualsAnyFilter('sourceURL', $searchWithoutQuery))->addFilter(new EqualsFilter('enabled', true))->addFilter(new EqualsFilter('ignoreQueryParams', true))
  262.                     ->setLimit(1), $context);
  264.                 // No Redirect found for this URL, do nothing
  265.                 if ($redirects->count() === 0) {
  266.                     return;
  267.                 }
  268.             } else {
  269.                 // No Redirect found for this URL, do nothing
  270.                 return;
  271.             }
  272.         }
  274.         $redirect = $redirects->first();
  275.         $targetURL = $redirect->getTargetURL();
  276.         $code = $redirect->getHttpCode();
  278.         // Prevent endless redirecting when target url belongs to the same seo url like the source url or when target url and source url have only different capitalisation
  279.         if (in_array($targetURL, $search, true)) {
  280.             return;
  281.         }
  283.         /*
  284.          *  checks if $targetURL is a full url or path and redirects accordingly
  285.          */
  286.         if (!(\strpos($targetURL, "http:") === 0 || \strpos($targetURL, "https:") === 0)) {
  287.             if (\strpos($targetURL, "www.") === 0) {
  288.                 $targetURL = "http://" . $targetURL;
  289.             } else {
  290.                 if (\strpos($targetURL, "/") !== 0) {
  291.                     $targetURL = "/" . $targetURL;
  292.                 }
  293.             }
  294.         }
  295.         $event->setResponse(new RedirectResponse($targetURL, $code));
  296.     }
  297. }