vendor/sulu/sulu/src/Sulu/Bundle/WebsiteBundle/Routing/ContentRouteProvider.php line 104

  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\WebsiteBundle\Routing;
  14. use PHPCR\RepositoryException;
  15. use Sulu\Bundle\DocumentManagerBundle\Bridge\DocumentInspector;
  16. use Sulu\Bundle\PageBundle\Document\PageDocument;
  17. use Sulu\Component\Content\Compat\Structure\PageBridge;
  18. use Sulu\Component\Content\Compat\StructureManagerInterface;
  19. use Sulu\Component\Content\Document\Behavior\ExtensionBehavior;
  20. use Sulu\Component\Content\Document\Behavior\ResourceSegmentBehavior;
  21. use Sulu\Component\Content\Document\Behavior\WebspaceBehavior;
  22. use Sulu\Component\Content\Document\RedirectType;
  23. use Sulu\Component\Content\Exception\ResourceLocatorMovedException;
  24. use Sulu\Component\Content\Exception\ResourceLocatorNotFoundException;
  25. use Sulu\Component\Content\Types\ResourceLocator\Strategy\ResourceLocatorStrategyPoolInterface;
  26. use Sulu\Component\DocumentManager\DocumentManagerInterface;
  27. use Sulu\Component\Security\Authorization\SecurityCheckerInterface;
  28. use Sulu\Component\Webspace\Analyzer\Attributes\RequestAttributes;
  29. use Sulu\Component\Webspace\Analyzer\RequestAnalyzerInterface;
  30. use Sulu\Component\Webspace\Manager\WebspaceManagerInterface;
  31. use Symfony\Cmf\Component\Routing\RouteProviderInterface;
  32. use Symfony\Component\HttpFoundation\Request;
  33. use Symfony\Component\Routing\Exception\RouteNotFoundException;
  34. use Symfony\Component\Routing\Route;
  35. use Symfony\Component\Routing\RouteCollection;
  36. use Webmozart\Assert\Assert;
  38. /**
  39.  * The PortalRouteProvider should load the dynamic routes created by Sulu.
  40.  */
  41. class ContentRouteProvider implements RouteProviderInterface
  42. {
  43.     /**
  44.      * @var DocumentManagerInterface
  45.      */
  46.     private $documentManager;
  48.     /**
  49.      * @var DocumentInspector
  50.      */
  51.     private $documentInspector;
  53.     /**
  54.      * @var ResourceLocatorStrategyPoolInterface
  55.      */
  56.     private $resourceLocatorStrategyPool;
  58.     /**
  59.      * @var StructureManagerInterface
  60.      */
  61.     private $structureManager;
  63.     /**
  64.      * @var WebspaceManagerInterface
  65.      */
  66.     private $webspaceManager;
  68.     /**
  69.      * @var RequestAnalyzerInterface
  70.      */
  71.     private $requestAnalyzer;
  73.     /**
  74.      * @var SecurityCheckerInterface|null
  75.      */
  76.     private $securityChecker;
  78.     /**
  79.      * @var array
  80.      */
  81.     private $defaultOptions;
  83.     public function __construct(
  84.         DocumentManagerInterface $documentManager,
  85.         DocumentInspector $documentInspector,
  86.         ResourceLocatorStrategyPoolInterface $resourceLocatorStrategyPool,
  87.         StructureManagerInterface $structureManager,
  88.         WebspaceManagerInterface $webspaceManager,
  89.         RequestAnalyzerInterface $requestAnalyzer,
  90.         ?SecurityCheckerInterface $securityChecker = null,
  91.         array $defaultOptions = []
  92.     ) {
  93.         $this->documentManager = $documentManager;
  94.         $this->documentInspector = $documentInspector;
  95.         $this->resourceLocatorStrategyPool = $resourceLocatorStrategyPool;
  96.         $this->structureManager = $structureManager;
  97.         $this->webspaceManager = $webspaceManager;
  98.         $this->requestAnalyzer = $requestAnalyzer;
  99.         $this->securityChecker = $securityChecker;
  100.         Assert::null($securityChecker, 'The security checker should be called by the SecurityListener not the ContentRouteProvider.'); // people who overwrite the ContentRouteProvider should make aware of that they also need to refactor this
  101.         $this->defaultOptions = $defaultOptions;
  102.     }
  104.     public function getRouteCollectionForRequest(Request $request): RouteCollection
  105.     {
  106.         $collection = new RouteCollection();
  108.         if ('' === $request->getRequestFormat()) {
  109.             return $collection;
  110.         }
  112.         /** @var RequestAttributes $attributes */
  113.         $attributes = $request->attributes->get('_sulu');
  114.         if (!$attributes) {
  115.             return $collection;
  116.         }
  118.         $matchType = $attributes->getAttribute('matchType');
  120.         // no portal information without localization supported
  121.         if (null === $attributes->getAttribute('localization')
  122.             && RequestAnalyzerInterface::MATCH_TYPE_PARTIAL !== $matchType
  123.             && RequestAnalyzerInterface::MATCH_TYPE_REDIRECT !== $matchType
  124.         ) {
  125.             return $collection;
  126.         }
  128.         $resourceLocator = $this->decodePathInfo($attributes->getAttribute('resourceLocator'));
  129.         $prefix = $attributes->getAttribute('resourceLocatorPrefix');
  131.         $pathInfo = $this->decodePathInfo($request->getPathInfo());
  132.         $htmlRedirect = $pathInfo !== $prefix . $resourceLocator
  133.                         && \in_array($request->getRequestFormat(), ['htm', 'html']);
  135.         if ($htmlRedirect
  136.             || RequestAnalyzerInterface::MATCH_TYPE_REDIRECT == $matchType
  137.             || RequestAnalyzerInterface::MATCH_TYPE_PARTIAL == $matchType
  138.         ) {
  139.             return $collection;
  140.         }
  142.         // just show the page
  143.         $portal = $attributes->getAttribute('portal');
  144.         $locale = $attributes->getAttribute('localization')->getLocale();
  145.         $resourceLocatorStrategy = $this->resourceLocatorStrategyPool->getStrategyByWebspaceKey(
  146.             $portal->getWebspace()->getKey()
  147.         );
  149.         try {
  150.             // load content by url ignore ending trailing slash
  151.             /** @var PageDocument $document */
  152.             $document = $this->documentManager->find(
  153.                 $resourceLocatorStrategy->loadByResourceLocator(
  154.                     \rtrim($resourceLocator, '/'),
  155.                     $portal->getWebspace()->getKey(),
  156.                     $locale
  157.                 ),
  158.                 $locale,
  159.                 [
  160.                     'load_ghost_content' => false,
  161.                 ]
  162.             );
  164.             if (!$document->getTitle()) {
  165.                 // If the title is empty the document does not exist in this locale
  166.                 // Necessary because of https://github.com/sulu/sulu/issues/2724, otherwise locale could be checked
  167.                 return $collection;
  168.             }
  170.             if (\preg_match('/\/$/', $resourceLocator) && ('/' !== $resourceLocator || $prefix)) {
  171.                 // redirect page to page without slash at the end
  172.                 $url = $prefix . \rtrim($resourceLocator, '/');
  173.                 if ($request->getQueryString()) {
  174.                     $url .= '?' . $request->getQueryString();
  175.                 }
  176.                 $collection->add('redirect_' . \uniqid(), $this->getRedirectRoute($request, $url));
  177.             } elseif (RedirectType::INTERNAL === $document->getRedirectType()) {
  178.                 $redirectTarget = $document->getRedirectTarget();
  180.                 if (!$redirectTarget instanceof ResourceSegmentBehavior || !$redirectTarget instanceof WebspaceBehavior) {
  181.                     return $collection;
  182.                 }
  184.                 $redirectUrl = $this->webspaceManager->findUrlByResourceLocator(
  185.                     $redirectTarget->getResourceSegment(),
  186.                     null,
  187.                     $document->getLocale(),
  188.                     $redirectTarget->getWebspaceName()
  189.                 );
  191.                 if ($request->getQueryString()) {
  192.                     $redirectUrl .= '?' . $request->getQueryString();
  193.                 }
  195.                 $collection->add(
  196.                     $document->getStructureType() . '_' . $document->getUuid(),
  197.                     $this->getRedirectRoute($request, $redirectUrl)
  198.                 );
  199.             } elseif (RedirectType::EXTERNAL === $document->getRedirectType()) {
  200.                 $collection->add(
  201.                     $document->getStructureType() . '_' . $document->getUuid(),
  202.                     $this->getRedirectRoute($request, $document->getRedirectExternal())
  203.                 );
  204.             } elseif (!$this->checkResourceLocator($resourceLocator, $prefix)) {
  205.                 return $collection;
  206.             } else {
  207.                 if ($document instanceof ExtensionBehavior) {
  208.                     $documentSegments = $document->getExtensionsData()['excerpt']['segments'] ?? [];
  209.                     $documentSegmentKey = $documentSegments[$portal->getWebspace()->getKey()] ?? null;
  210.                     $segment = $this->requestAnalyzer->getSegment();
  212.                     if ($segment && $documentSegmentKey && $segment->getKey() !== $documentSegmentKey) {
  213.                         $this->requestAnalyzer->changeSegment($documentSegmentKey);
  214.                     }
  215.                 }
  217.                 // convert the page to a StructureBridge because of BC
  218.                 $metadata = $this->documentInspector->getStructureMetadata($document);
  219.                 if (!$metadata) {
  220.                     return $collection;
  221.                 }
  223.                 /** @var PageBridge $structure */
  224.                 $structure = $this->structureManager->wrapStructure(
  225.                     $this->documentInspector->getMetadata($document)->getAlias(),
  226.                     $metadata
  227.                 );
  228.                 $structure->setDocument($document);
  230.                 // show the page
  231.                 $collection->add(
  232.                     $document->getStructureType() . '_' . $document->getUuid(),
  233.                     $this->getStructureRoute($request, $structure)
  234.                 );
  235.             }
  236.         } catch (ResourceLocatorNotFoundException $exc) {
  237.             // just do not add any routes to the collection
  238.         } catch (ResourceLocatorMovedException $exc) {
  239.             $url = $prefix . $exc->getNewResourceLocator();
  240.             if ($request->getQueryString()) {
  241.                 $url .= '?' . $request->getQueryString();
  242.             }
  244.             // old url resource was moved
  245.             $collection->add(
  246.                 $exc->getNewResourceLocatorUuid() . '_' . \uniqid(),
  247.                 $this->getRedirectRoute($request, $url)
  248.             );
  249.         } catch (RepositoryException $exc) {
  250.             // just do not add any routes to the collection
  251.         }
  253.         return $collection;
  254.     }
  256.     /**
  257.      * @param string $name
  258.      */
  259.     public function getRouteByName($name): Route
  260.     {
  261.         throw new RouteNotFoundException();
  262.     }
  264.     public function getRoutesByNames($names = null): iterable
  265.     {
  266.         return [];
  267.     }
  269.     /**
  270.      * Checks if the resource locator is valid.
  271.      * A resource locator with a slash only is not allowed, the only exception is when it is a single language
  272.      * website, where the browser automatically adds the slash.
  273.      *
  274.      * @param string $resourceLocator
  275.      * @param string $resourceLocatorPrefix
  276.      *
  277.      * @return bool
  278.      */
  279.     private function checkResourceLocator($resourceLocator, $resourceLocatorPrefix)
  280.     {
  281.         return !('/' === $resourceLocator && $resourceLocatorPrefix);
  282.     }
  284.     /**
  285.      * @param string $url
  286.      *
  287.      * @return Route
  288.      */
  289.     protected function getRedirectRoute(Request $request, $url)
  290.     {
  291.         $requestFormat = $request->getRequestFormat(null);
  292.         $formatSuffix = $requestFormat ? '.' . $requestFormat : '';
  293.         $urlParts = \explode('?', $url, 2);
  294.         $url = $urlParts[0] . $formatSuffix;
  295.         if ($urlParts[1] ?? null) {
  296.             $url .= '?' . $urlParts[1];
  297.         }
  299.         // redirect to linked page
  300.         return new Route(
  301.             $this->decodePathInfo($request->getPathInfo()),
  302.             [
  303.                 '_controller' => 'sulu_website.redirect_controller::redirectAction',
  304.                 'url' => $url,
  305.             ],
  306.             [],
  307.             $this->defaultOptions
  308.         );
  309.     }
  311.     /**
  312.      * @return Route
  313.      */
  314.     protected function getStructureRoute(Request $request, PageBridge $content)
  315.     {
  316.         return new Route(
  317.             $this->decodePathInfo($request->getPathInfo()),
  318.             [
  319.                 '_controller' => $content->getController(),
  320.                 'structure' => $content,
  321.                 'partial' => 'true' === $request->get('partial', 'false'),
  322.             ],
  323.             [],
  324.             $this->defaultOptions
  325.         );
  326.     }
  328.     /**
  329.      * Server encodes the url and symfony does not encode it
  330.      * Symfony decodes this data here https://github.com/symfony/symfony/blob/3.3/src/Symfony/Component/Routing/Matcher/UrlMatcher.php#L91.
  331.      *
  332.      * @param string $pathInfo
  333.      *
  334.      * @return string
  335.      */
  336.     private function decodePathInfo($pathInfo)
  337.     {
  338.         if (null === $pathInfo || '' === $pathInfo) {
  339.             return '';
  340.         }
  342.         return '/' . \ltrim(\rawurldecode($pathInfo), '/');
  343.     }
  344. }