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.         $search = [
  105.             $requestBaseUrl . '/' . $requestUri, // relative url with shopware 6 in sub folder: /public/Ergonomic-Concrete-Cough-Machine/48314803f1244f609a2ce907bfb48f53
  106.             $requestBaseUrl . $requestUri, // relative url with shopware 6 in sub folder url is not shopware seo url: /public/test
  107.             $storefrontUri . $requestUri, // absolute url with shopware 6 in sub folder, full url with host: http://shopware-platform.local/public/test1
  108.             $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/
  109.             $requestUri, // relative url domain configured in public folder: /Ergonomic-Concrete-Cough-Machine/48314803f1244f609a2ce907bfb48f53 or /test4
  110.             '/' . $requestUri, // absolute url domain configured in public folder: http://shopware-platform.local/Shoes-Baby/
  111.             \substr($requestUri, 1), // e.g. "test"
  112.         ];
  114.         // search for the redirect in the database
  115.         $redirects = $this->repository->search((new Criteria())->addFilter(new EqualsAnyFilter('sourceURL', $search))->addFilter(new EqualsFilter('enabled', true))
  116.             ->setLimit(1), $context);
  118.         if ($redirects->count() === 0) {
  119.             // Checks if the requested URL contains Query parameters, and if so, checks if a redirect can be found with the ignoreQueryParams option
  120.             if(str_contains($requestUri, '?')) {
  121.                 $searchWithoutQuery = [];
  122.                 foreach ($search as $string)
  123.                     $searchWithoutQuery[] = explode('?', $string)[0];
  125.                 $redirects = $this->repository->search((new Criteria())->addFilter(new EqualsAnyFilter('sourceURL', $searchWithoutQuery))->addFilter(new EqualsFilter('enabled', true))->addFilter(new EqualsFilter('ignoreQueryParams', true))
  126.                     ->setLimit(1), $context);
  128.                 // No Redirect found for this URL, do nothing
  129.                 if ($redirects->count() === 0) {
  130.                     return;
  131.                 }
  132.             } else {
  133.                 // No Redirect found for this URL, do nothing
  134.                 return;
  135.             }
  136.         }
  138.         $redirect = $redirects->first();
  139.         $targetURL = $redirect->getTargetURL();
  140.         $code = $redirect->getHttpCode();
  142.         // Prevent endless redirecting when target url and source url have only different capitalisation
  143.         if (in_array($targetURL, $search, true)) {
  144.             return;
  145.         }
  147.         /*
  148.          *  checks if $targetURL is a full url or path and redirects accordingly
  149.          */
  150.         if (!(\strpos($targetURL, "http:") === 0 || \strpos($targetURL, "https:") === 0)) {
  151.             if (\strpos($targetURL, "www.") === 0) {
  152.                 $targetURL = "http://" . $targetURL;
  153.             } else {
  154.                 if (\strpos($targetURL, "/") !== 0) {
  155.                     $targetURL = "/" . $targetURL;
  156.                 }
  157.             }
  158.         }
  159.         $event->setResponse(new RedirectResponse($targetURL, $code));
  160.     }
  162.     /**
  163.      * Method for shopware versions below 6.4.0.0
  164.      *
  165.      * Redirect to the new url if found in redirects
  166.      * Otherwise do nothing
  167.      * Modules like admin, api or widgets are excluded from redirects
  168.      *
  169.      * @param BeforeSendResponseEvent $event
  170.      */
  171.     private function oldRedirectBeforeSendResponse(BeforeSendResponseEvent $event): void
  172.     {
  173.         $requestUri = (string)$event->getRequest()->get('resolved-uri');
  174.         $storefrontUri = $event->getRequest()->get('sw-storefront-url');
  175.         $requestBase = $event->getRequest()->getPathInfo();
  176.         $requestBaseUrl = $event->getRequest()->getBaseUrl();
  177.         $queryString = (string)$event->getRequest()->getQueryString();
  178.         $search = [];
  179.         // Block overriding /admin and /api and widgets, so you can't lock out of the administration.
  180.         if (\strpos($requestBase, "/admin") === 0) {
  181.             return;
  182.         }
  183.         if (\strpos($requestBase, "/api") === 0) {
  184.             return;
  185.         }
  186.         if (\strpos($requestBase, "/widgets") === 0) {
  187.             return;
  188.         }
  189.         if (\strpos($requestBase, "/store-api") === 0) {
  190.             return;
  191.         }
  192.         if (\strpos($requestBase, "/_profiler") === 0) {
  193.             return;
  194.         }
  196.         if ($queryString !== '') {
  197.             $queryString = urldecode($queryString);
  198.             $requestUri .= '?' . $queryString;
  199.         }
  201.         // try to load the seo route
  202.         $context = Context::createDefaultContext();
  203.         $redirects = $this->seoUrlRepository->search((new Criteria())
  204.             ->addFilter(new EqualsAnyFilter('pathInfo', [$requestUri])), $context);
  206.         // if found overwrite search term with the seo route
  207.         if ($redirects->count() !== 0) {
  208.             foreach ($redirects as $redirect) {
  209.                 $requestBase = $redirect->getSeoPathInfo();
  210.                 // Search for Redirect
  211.                 $search[] = [
  212.                     $requestBaseUrl . '/' . $requestBase, // relative url with shopware 6 in sub folder: /public/Ergonomic-Concrete-Cough-Machine/48314803f1244f609a2ce907bfb48f53
  213.                     $requestBaseUrl . $requestBase, // relative url with shopware 6 in sub folder url is not shopware seo url: /public/test
  214.                     $storefrontUri . $requestBase, // absolute url with shopware 6 in sub folder, full url with host: http://shopware-platform.local/public/test1
  215.                     $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/
  216.                     $requestBase, // relative url domain configured in public folder: /Ergonomic-Concrete-Cough-Machine/48314803f1244f609a2ce907bfb48f53 or /test4
  217.                     '/' . $requestBase, // absolute url domain configured in public folder: http://shopware-platform.local/Shoes-Baby/
  218.                     \substr($requestBase, 1), // e.g. "test"
  219.                 ];
  220.             }
  221.         }
  222.         if (!empty($search)) {
  223.             $search = array_merge(...$search);
  224.         } else {
  225.             $search = [
  226.                 $requestBaseUrl . '/' . $requestUri, // relative url with shopware 6 in sub folder: /public/Ergonomic-Concrete-Cough-Machine/48314803f1244f609a2ce907bfb48f53
  227.                 $requestBaseUrl . $requestUri, // relative url with shopware 6 in sub folder url is not shopware seo url: /public/test
  228.                 $storefrontUri . $requestUri, // absolute url with shopware 6 in sub folder, full url with host: http://shopware-platform.local/public/test1
  229.                 $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/
  230.                 $requestUri, // relative url domain configured in public folder: /Ergonomic-Concrete-Cough-Machine/48314803f1244f609a2ce907bfb48f53 or /test4
  231.                 '/' . $requestUri, // absolute url domain configured in public folder: http://shopware-platform.local/Shoes-Baby/
  232.                 \substr($requestUri, 1), // e.g. "test"
  233.             ];
  234.         }
  236.         // search for the redirect in the database
  237.         $redirects = $this->repository->search((new Criteria())->addFilter(new EqualsAnyFilter('sourceURL', $search))->addFilter(new EqualsFilter('enabled', true))
  238.             ->setLimit(1), $context);
  240.         if ($redirects->count() === 0) {
  241.             // Checks if the requested URL contains Query parameters, and if so, checks if a redirect can be found with the ignoreQueryParams option
  242.             if(str_contains($requestUri, '?')) {
  243.                 $searchWithoutQuery = [];
  244.                 foreach ($search as $string)
  245.                     $searchWithoutQuery[] = explode('?', $string)[0];
  247.                 $redirects = $this->repository->search((new Criteria())->addFilter(new EqualsAnyFilter('sourceURL', $searchWithoutQuery))->addFilter(new EqualsFilter('enabled', true))->addFilter(new EqualsFilter('ignoreQueryParams', true))
  248.                     ->setLimit(1), $context);
  250.                 // No Redirect found for this URL, do nothing
  251.                 if ($redirects->count() === 0) {
  252.                     return;
  253.                 }
  254.             } else {
  255.                 // No Redirect found for this URL, do nothing
  256.                 return;
  257.             }
  258.         }
  260.         $redirect = $redirects->first();
  261.         $targetURL = $redirect->getTargetURL();
  262.         $code = $redirect->getHttpCode();
  264.         // 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
  265.         if (in_array($targetURL, $search, true)) {
  266.             return;
  267.         }
  269.         /*
  270.          *  checks if $targetURL is a full url or path and redirects accordingly
  271.          */
  272.         if (!(\strpos($targetURL, "http:") === 0 || \strpos($targetURL, "https:") === 0)) {
  273.             if (\strpos($targetURL, "www.") === 0) {
  274.                 $targetURL = "http://" . $targetURL;
  275.             } else {
  276.                 if (\strpos($targetURL, "/") !== 0) {
  277.                     $targetURL = "/" . $targetURL;
  278.                 }
  279.             }
  280.         }
  281.         $event->setResponse(new RedirectResponse($targetURL, $code));
  282.     }
  283. }