vendor/sulu/sulu/src/Sulu/Bundle/CustomUrlBundle/Request/CustomUrlRequestProcessor.php line 76

Open in your IDE?
  1. <?php
  3. /*
  4. * This file is part of Sulu.
  5. *
  6. * (c) Sulu GmbH
  7. *
  8. * This source file is subject to the MIT license that is bundled
  9. * with this source code in the file LICENSE.
  10. */
  12. namespace Sulu\Bundle\CustomUrlBundle\Request;
  14. use Sulu\Component\Content\Document\WorkflowStage;
  15. use Sulu\Component\CustomUrl\Generator\GeneratorInterface;
  16. use Sulu\Component\CustomUrl\Manager\CustomUrlManagerInterface;
  17. use Sulu\Component\Localization\Localization;
  18. use Sulu\Component\Webspace\Analyzer\Attributes\RequestAttributes;
  19. use Sulu\Component\Webspace\Analyzer\Attributes\RequestProcessorInterface;
  20. use Sulu\Component\Webspace\Analyzer\RequestAnalyzer;
  21. use Sulu\Component\Webspace\Manager\WebspaceManagerInterface;
  22. use Sulu\Component\Webspace\PortalInformation;
  23. use Symfony\Component\HttpFoundation\Request;
  25. /**
  26. * Set localization in case of custom-url route.
  27. */
  28. class CustomUrlRequestProcessor implements RequestProcessorInterface
  29. {
  30. /**
  31. * @var CustomUrlManagerInterface
  32. */
  33. private $customUrlManager;
  35. /**
  36. * @var GeneratorInterface
  37. */
  38. private $generator;
  40. /**
  41. * @var WebspaceManagerInterface
  42. */
  43. private $webspaceManager;
  45. /**
  46. * @var string
  47. */
  48. private $environment;
  50. public function __construct(
  51. CustomUrlManagerInterface $customUrlManager,
  52. GeneratorInterface $generator,
  53. WebspaceManagerInterface $webspaceManager,
  54. $environment
  55. ) {
  56. $this->customUrlManager = $customUrlManager;
  57. $this->generator = $generator;
  58. $this->webspaceManager = $webspaceManager;
  59. $this->environment = $environment;
  60. }
  62. public function process(Request $request, RequestAttributes $requestAttributes)
  63. {
  64. $pathInfo = $request->getPathInfo();
  65. $position = \strrpos($pathInfo, '.');
  66. if ($position) {
  67. $pathInfo = \substr($pathInfo, 0, $position);
  68. }
  70. $queryString = $request->getQueryString();
  71. if (!empty($queryString)) {
  72. $queryString = '?' . $queryString;
  73. }
  75. $url = $this->decodeUrl(\rtrim(\sprintf('%s%s%s', $request->getHost(), $pathInfo, $queryString), '/'));
  76. $portalInformations = $this->webspaceManager->findPortalInformationsByUrl($url, $this->environment);
  78. if (0 === \count($portalInformations)) {
  79. return new RequestAttributes();
  80. }
  82. /** @var PortalInformation[] $portalInformations */
  83. $portalInformations = \array_filter(
  84. $portalInformations,
  85. function(PortalInformation $portalInformation) {
  86. return RequestAnalyzer::MATCH_TYPE_WILDCARD === $portalInformation->getType();
  87. }
  88. );
  90. foreach ($portalInformations as $portalInformation) {
  91. if (!$portalInformation->getWebspace()) {
  92. continue;
  93. }
  95. if (null !== $attributes = $this->matchCustomUrl($url, $portalInformation, $request)) {
  96. return new RequestAttributes($attributes);
  97. }
  98. }
  100. return new RequestAttributes();
  101. }
  103. public function validate(RequestAttributes $attributes)
  104. {
  105. return true;
  106. }
  108. /**
  109. * Matches given url to portal-information.
  110. */
  111. private function matchCustomUrl(string $url, PortalInformation $portalInformation, Request $request): array
  112. {
  113. $webspace = $portalInformation->getWebspace();
  114. $routeDocument = $this->customUrlManager->findRouteByUrl(
  115. \rawurldecode($url),
  116. $webspace->getKey()
  117. );
  119. if (!$routeDocument) {
  120. return [];
  121. } elseif ($routeDocument->isHistory()) {
  122. // redirect happen => no portal is needed
  123. return ['customUrlRoute' => $routeDocument];
  124. }
  126. $customUrlDocument = $this->customUrlManager->findByUrl(
  127. \rawurldecode($url),
  128. $webspace->getKey(),
  129. $routeDocument->getTargetDocument()->getTargetLocale()
  130. );
  132. if (null === $customUrlDocument
  133. || false === $customUrlDocument->isPublished()
  134. || null === $customUrlDocument->getTargetDocument()
  135. || WorkflowStage::PUBLISHED !== $customUrlDocument->getTargetDocument()->getWorkflowStage()
  136. ) {
  137. // error happen because this custom-url is not published => no portal is needed
  138. return ['customUrlRoute' => $routeDocument, 'customUrl' => $customUrlDocument];
  139. }
  141. $localization = Localization::createFromString($customUrlDocument->getTargetLocale());
  143. $portalInformations = $this->webspaceManager->findPortalInformationsByWebspaceKeyAndLocale(
  144. $portalInformation->getWebspace()->getKey(),
  145. $localization->getLocale(),
  146. $this->environment
  147. );
  149. if (0 === \count($portalInformations)) {
  150. return ['customUrlRoute' => $routeDocument, 'customUrl' => $customUrlDocument];
  151. }
  153. return [
  154. 'portalInformation' => $portalInformation,
  155. 'localization' => $localization,
  156. 'locale' => $localization->getLocale(),
  157. 'customUrlRoute' => $routeDocument,
  158. 'customUrl' => $customUrlDocument,
  159. 'urlExpression' => $this->generator->generate(
  160. $customUrlDocument->getBaseDomain(),
  161. $customUrlDocument->getDomainParts()
  162. ),
  163. ];
  164. }
  166. /**
  167. * Server encodes the url and symfony does not encode it
  168. * Symfony decodes this data here https://github.com/symfony/symfony/blob/3.3/src/Symfony/Component/Routing/Matcher/UrlMatcher.php#L91.
  169. */
  170. private function decodeUrl(string $pathInfo): string
  171. {
  172. return \rawurldecode($pathInfo);
  173. }
  174. }