vendor/shopware/storefront/Framework/Routing/RequestTransformer.php line 109

  1. <?php declare(strict_types=1);
  3. namespace Shopware\Storefront\Framework\Routing;
  5. use Shopware\Core\Content\Seo\AbstractSeoResolver;
  6. use Shopware\Core\Framework\Log\Package;
  7. use Shopware\Core\Framework\Routing\RequestTransformerInterface;
  8. use Shopware\Core\PlatformRequest;
  9. use Shopware\Core\SalesChannelRequest;
  10. use Shopware\Storefront\Framework\Routing\Exception\SalesChannelMappingException;
  11. use Symfony\Component\HttpFoundation\Request;
  13. /**
  14.  * @phpstan-import-type Domain from AbstractDomainLoader
  15.  * @phpstan-import-type ResolvedSeoUrl from AbstractSeoResolver
  16.  */
  17. #[Package('storefront')]
  18. class RequestTransformer implements RequestTransformerInterface
  19. {
  20.     final public const REQUEST_TRANSFORMER_CACHE_KEY = CachedDomainLoader::CACHE_KEY;
  22.     /**
  23.      * Virtual path of the "domain"
  24.      *
  25.      * @example
  26.      * - `/de`
  27.      * - `/en`
  28.      * - {empty} - the virtual path is optional
  29.      */
  30.     final public const SALES_CHANNEL_BASE_URL = 'sw-sales-channel-base-url';
  32.     /**
  33.      * Scheme + Host + port + subdir in web root
  34.      *
  35.      * @example
  36.      * - `https://shop.example` - no subdir
  37.      * - `http://localhost:8000/subdir` - with sub dir `/subdir`
  38.      */
  39.     final public const SALES_CHANNEL_ABSOLUTE_BASE_URL = 'sw-sales-channel-absolute-base-url';
  41.     /**
  42.      * Scheme + Host + port + subdir in web root + virtual path
  43.      *
  44.      * @example
  45.      * - `https://shop.example` - no sub dir and no virtual path
  46.      * - `https://shop.example/en` - no sub dir and virtual path `/en`
  47.      * - `http://localhost:8000/subdir` - with sub directory `/subdir`
  48.      * - `http://localhost:8000/subdir/de` - with sub directory `/subdir` and virtual path `/de`
  49.      */
  50.     final public const STOREFRONT_URL = 'sw-storefront-url';
  52.     final public const SALES_CHANNEL_RESOLVED_URI = 'resolved-uri';
  54.     final public const ORIGINAL_REQUEST_URI = 'sw-original-request-uri';
  56.     private const INHERITABLE_ATTRIBUTE_NAMES = [
  57.         self::SALES_CHANNEL_BASE_URL,
  58.         self::SALES_CHANNEL_ABSOLUTE_BASE_URL,
  59.         self::STOREFRONT_URL,
  60.         self::SALES_CHANNEL_RESOLVED_URI,
  62.         PlatformRequest::ATTRIBUTE_SALES_CHANNEL_ID,
  63.         SalesChannelRequest::ATTRIBUTE_IS_SALES_CHANNEL_REQUEST,
  65.         SalesChannelRequest::ATTRIBUTE_DOMAIN_LOCALE,
  66.         SalesChannelRequest::ATTRIBUTE_DOMAIN_SNIPPET_SET_ID,
  67.         SalesChannelRequest::ATTRIBUTE_DOMAIN_CURRENCY_ID,
  68.         SalesChannelRequest::ATTRIBUTE_DOMAIN_ID,
  70.         SalesChannelRequest::ATTRIBUTE_THEME_ID,
  71.         SalesChannelRequest::ATTRIBUTE_THEME_NAME,
  72.         SalesChannelRequest::ATTRIBUTE_THEME_BASE_NAME,
  74.         SalesChannelRequest::ATTRIBUTE_CANONICAL_LINK,
  75.     ];
  77.     /**
  78.      * @var array<string>
  79.      */
  80.     private array $whitelist = [
  81.         '/_wdt/',
  82.         '/_profiler/',
  83.         '/_error/',
  84.         '/payment/finalize-transaction',
  85.         '/installer',
  86.     ];
  88.     /**
  89.      * @internal
  90.      *
  91.      * @param list<string> $registeredApiPrefixes
  92.      */
  93.     public function __construct(
  94.         private readonly RequestTransformerInterface $decorated,
  95.         private readonly AbstractSeoResolver $resolver,
  96.         private readonly array $registeredApiPrefixes,
  97.         private readonly AbstractDomainLoader $domainLoader
  98.     ) {
  99.     }
  101.     public function transform(Request $request): Request
  102.     {
  103.         $request = $this->decorated->transform($request);
  105.         if (!$this->isSalesChannelRequired($request->getPathInfo())) {
  106.             return $this->decorated->transform($request);
  107.         }
  109.         $salesChannel = $this->findSalesChannel($request);
  110.         if ($salesChannel === null) {
  111.             // this class and therefore the "isSalesChannelRequired" method is currently not extendable
  112.             // which can cause problems when adding custom paths
  113.             throw new SalesChannelMappingException($request->getUri());
  114.         }
  116.         $absoluteBaseUrl = $this->getSchemeAndHttpHost($request) . $request->getBaseUrl();
  117.         $baseUrl = str_replace($absoluteBaseUrl, '', $salesChannel['url']);
  119.         $resolved = $this->resolveSeoUrl(
  120.             $request,
  121.             $baseUrl,
  122.             $salesChannel['languageId'],
  123.             $salesChannel['salesChannelId']
  124.         );
  126.         $currentRequestUri = $request->getRequestUri();
  128.         /**
  129.          * - Remove "virtual" suffix of domain mapping shopware.de/de
  130.          * - To get only the host shopware.de as real request uri shopware.de/
  131.          * - Resolve remaining seo url and get the real path info shopware.de/outdoor => shopware.de/navigation/{id}
  132.          *
  133.          * Possible domains
  134.          *
  135.          * same host, different "virtual" suffix
  136.          * http://shopware.de/de
  137.          * http://shopware.de/en
  138.          * http://shopware.de/fr
  139.          *
  140.          * same host, different location
  141.          * http://shopware.fr
  142.          * http://shopware.com
  143.          * http://shopware.de
  144.          *
  145.          * complete different host and location
  146.          * http://color.com
  147.          * http://farben.de
  148.          * http://couleurs.fr
  149.          *
  150.          * installation in sub directory
  151.          * http://localhost/development/public/de
  152.          * http://localhost/development/public/en
  153.          * http://localhost/development/public/fr
  154.          *
  155.          * installation with port
  156.          * http://localhost:8080
  157.          * http://localhost:8080/en
  158.          * http://localhost:8080/fr
  159.          */
  160.         $transformedServerVars = array_merge(
  161.             $request->server->all(),
  162.             ['REQUEST_URI' => rtrim($request->getBaseUrl(), '/') . $resolved['pathInfo']]
  163.         );
  165.         $transformedRequest = $request->duplicate(null, null, null, null, null, $transformedServerVars);
  166.         $transformedRequest->attributes->set(self::SALES_CHANNEL_BASE_URL, $baseUrl);
  167.         $transformedRequest->attributes->set(self::SALES_CHANNEL_ABSOLUTE_BASE_URL, rtrim($absoluteBaseUrl, '/'));
  168.         $transformedRequest->attributes->set(
  169.             self::STOREFRONT_URL,
  170.             $transformedRequest->attributes->get(self::SALES_CHANNEL_ABSOLUTE_BASE_URL)
  171.             . $transformedRequest->attributes->get(self::SALES_CHANNEL_BASE_URL)
  172.         );
  173.         $transformedRequest->attributes->set(self::SALES_CHANNEL_RESOLVED_URI, $resolved['pathInfo']);
  175.         $transformedRequest->attributes->set(PlatformRequest::ATTRIBUTE_SALES_CHANNEL_ID, $salesChannel['salesChannelId']);
  176.         $transformedRequest->attributes->set(SalesChannelRequest::ATTRIBUTE_IS_SALES_CHANNEL_REQUEST, true);
  177.         $transformedRequest->attributes->set(SalesChannelRequest::ATTRIBUTE_DOMAIN_LOCALE, $salesChannel['locale']);
  178.         $transformedRequest->attributes->set(SalesChannelRequest::ATTRIBUTE_DOMAIN_SNIPPET_SET_ID, $salesChannel['snippetSetId']);
  179.         $transformedRequest->attributes->set(SalesChannelRequest::ATTRIBUTE_DOMAIN_CURRENCY_ID, $salesChannel['currencyId']);
  180.         $transformedRequest->attributes->set(SalesChannelRequest::ATTRIBUTE_DOMAIN_ID, $salesChannel['id']);
  181.         $transformedRequest->attributes->set(SalesChannelRequest::ATTRIBUTE_THEME_ID, $salesChannel['themeId']);
  182.         $transformedRequest->attributes->set(SalesChannelRequest::ATTRIBUTE_THEME_NAME, $salesChannel['themeName']);
  183.         $transformedRequest->attributes->set(SalesChannelRequest::ATTRIBUTE_THEME_BASE_NAME, $salesChannel['parentThemeName']);
  185.         $transformedRequest->attributes->set(
  186.             SalesChannelRequest::ATTRIBUTE_SALES_CHANNEL_MAINTENANCE,
  187.             (bool) $salesChannel['maintenance']
  188.         );
  190.         $transformedRequest->attributes->set(
  191.             SalesChannelRequest::ATTRIBUTE_SALES_CHANNEL_MAINTENANCE_IP_WHITLELIST,
  192.             $salesChannel['maintenanceIpWhitelist']
  193.         );
  195.         if (isset($resolved['canonicalPathInfo'])) {
  196.             $urlPath = parse_url($salesChannel['url'], \PHP_URL_PATH);
  197.             if ($urlPath === false || $urlPath === null) {
  198.                 $urlPath = '';
  199.             }
  201.             $baseUrlPath = trim($urlPath, '/');
  202.             if (\strlen($baseUrlPath) > 1 && !str_starts_with($baseUrlPath, '/')) {
  203.                 $baseUrlPath = '/' . $baseUrlPath;
  204.             }
  206.             $transformedRequest->attributes->set(
  207.                 SalesChannelRequest::ATTRIBUTE_CANONICAL_LINK,
  208.                 $this->getSchemeAndHttpHost($request) . $baseUrlPath . $resolved['canonicalPathInfo']
  209.             );
  210.         }
  212.         $transformedRequest->headers->add($request->headers->all());
  213.         $transformedRequest->headers->set(PlatformRequest::HEADER_LANGUAGE_ID, $salesChannel['languageId']);
  214.         $transformedRequest->attributes->set(self::ORIGINAL_REQUEST_URI, $currentRequestUri);
  216.         return $transformedRequest;
  217.     }
  219.     /**
  220.      * @return array<string, mixed>
  221.      */
  222.     public function extractInheritableAttributes(Request $sourceRequest): array
  223.     {
  224.         $inheritableAttributes = $this->decorated
  225.             ->extractInheritableAttributes($sourceRequest);
  227.         foreach (self::INHERITABLE_ATTRIBUTE_NAMES as $attributeName) {
  228.             if (!$sourceRequest->attributes->has($attributeName)) {
  229.                 continue;
  230.             }
  232.             $inheritableAttributes[$attributeName] = $sourceRequest->attributes->get($attributeName);
  233.         }
  235.         return $inheritableAttributes;
  236.     }
  238.     private function isSalesChannelRequired(string $pathInfo): bool
  239.     {
  240.         $pathInfo = rtrim($pathInfo, '/') . '/';
  242.         foreach ($this->registeredApiPrefixes as $apiPrefix) {
  243.             if (mb_strpos($pathInfo, '/' . $apiPrefix . '/') === 0) {
  244.                 return false;
  245.             }
  246.         }
  248.         foreach ($this->whitelist as $prefix) {
  249.             if (mb_strpos($pathInfo, $prefix) === 0) {
  250.                 return false;
  251.             }
  252.         }
  254.         return true;
  255.     }
  257.     /**
  258.      * @return Domain|null
  259.      */
  260.     private function findSalesChannel(Request $request): ?array
  261.     {
  262.         $domains = $this->domainLoader->load();
  264.         if (empty($domains)) {
  265.             return null;
  266.         }
  268.         // domain urls and request uri should be in same format, all with trailing slash
  269.         $requestUrl = rtrim($this->getSchemeAndHttpHost($request) . $request->getBasePath() . $request->getPathInfo(), '/') . '/';
  271.         // direct hit
  272.         if (\array_key_exists($requestUrl, $domains)) {
  273.             $domain = $domains[$requestUrl];
  274.             $domain['url'] = rtrim($domain['url'], '/');
  276.             return $domain;
  277.         }
  279.         // reduce shops to which base url is the beginning of the request
  280.         $domains = array_filter($domains, fn ($baseUrl) => mb_strpos($requestUrl, (string) $baseUrl) === 0, \ARRAY_FILTER_USE_KEY);
  282.         if (empty($domains)) {
  283.             return null;
  284.         }
  286.         // determine most matching shop base url
  287.         $lastBaseUrl = '';
  288.         $bestMatch = current($domains);
  289.         /** @var string $baseUrl */
  290.         foreach ($domains as $baseUrl => $urlConfig) {
  291.             if (mb_strlen($baseUrl) > mb_strlen($lastBaseUrl)) {
  292.                 $bestMatch = $urlConfig;
  293.             }
  295.             $lastBaseUrl = $baseUrl;
  296.         }
  298.         $bestMatch['url'] = rtrim($bestMatch['url'], '/');
  300.         return $bestMatch;
  301.     }
  303.     /**
  304.      * @return ResolvedSeoUrl
  305.      */
  306.     private function resolveSeoUrl(Request $request, string $baseUrl, string $languageId, string $salesChannelId): array
  307.     {
  308.         $seoPathInfo = $request->getPathInfo();
  310.         // only remove full base url not part
  311.         // registered domain: 'shop-dev.de/de'
  312.         // incoming request:  'shop-dev.de/detail'
  313.         // without leading slash, detail would be stripped
  314.         $baseUrl = rtrim($baseUrl, '/') . '/';
  316.         if ($this->equalsBaseUrl($seoPathInfo, $baseUrl)) {
  317.             $seoPathInfo = '';
  318.         } elseif ($this->containsBaseUrl($seoPathInfo, $baseUrl)) {
  319.             $seoPathInfo = mb_substr($seoPathInfo, mb_strlen($baseUrl));
  320.         }
  322.         $resolved = $this->resolver->resolve($languageId, $salesChannelId, $seoPathInfo);
  324.         $resolved['pathInfo'] = '/' . ltrim($resolved['pathInfo'], '/');
  326.         return $resolved;
  327.     }
  329.     private function getSchemeAndHttpHost(Request $request): string
  330.     {
  331.         return $request->getScheme() . '://' . idn_to_utf8($request->getHttpHost());
  332.     }
  334.     /**
  335.      * We add the trailing slash to the base url
  336.      * so we have to add it to the path info too, to check if they are equal
  337.      */
  338.     private function equalsBaseUrl(string $seoPathInfo, string $baseUrl): bool
  339.     {
  340.         return $baseUrl === rtrim($seoPathInfo, '/') . '/';
  341.     }
  343.     /**
  344.      * We don't have to add the trailing slash when we check if the pathInfo contains teh base url
  345.      */
  346.     private function containsBaseUrl(string $seoPathInfo, string $baseUrl): bool
  347.     {
  348.         return !empty($baseUrl) && mb_strpos($seoPathInfo, $baseUrl) === 0;
  349.     }
  350. }