vendor/symfony/http-kernel/HttpCache/AbstractSurrogate.php line 97

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Component\HttpKernel\HttpCache;
  14. use Symfony\Component\HttpFoundation\Request;
  15. use Symfony\Component\HttpFoundation\Response;
  16. use Symfony\Component\HttpKernel\HttpKernelInterface;
  18. /**
  19.  * Abstract class implementing Surrogate capabilities to Request and Response instances.
  20.  *
  21.  * @author Fabien Potencier <fabien@symfony.com>
  22.  * @author Robin Chalas <robin.chalas@gmail.com>
  23.  */
  24. abstract class AbstractSurrogate implements SurrogateInterface
  25. {
  26.     protected $contentTypes;
  27.     protected $phpEscapeMap = [
  28.         ['<?', '<%', '<s', '<S'],
  29.         ['<?php echo "<?"; ?>', '<?php echo "<%"; ?>', '<?php echo "<s"; ?>', '<?php echo "<S"; ?>'],
  30.     ];
  32.     /**
  33.      * @param array $contentTypes An array of content-type that should be parsed for Surrogate information
  34.      *                            (default: text/html, text/xml, application/xhtml+xml, and application/xml)
  35.      */
  36.     public function __construct(array $contentTypes = ['text/html', 'text/xml', 'application/xhtml+xml', 'application/xml'])
  37.     {
  38.         $this->contentTypes = $contentTypes;
  39.     }
  41.     /**
  42.      * Returns a new cache strategy instance.
  43.      */
  44.     public function createCacheStrategy(): ResponseCacheStrategyInterface
  45.     {
  46.         return new ResponseCacheStrategy();
  47.     }
  49.     /**
  50.      * {@inheritdoc}
  51.      */
  52.     public function hasSurrogateCapability(Request $request): bool
  53.     {
  54.         if (null === $value = $request->headers->get('Surrogate-Capability')) {
  55.             return false;
  56.         }
  58.         return str_contains($value, sprintf('%s/1.0', strtoupper($this->getName())));
  59.     }
  61.     /**
  62.      * {@inheritdoc}
  63.      */
  64.     public function addSurrogateCapability(Request $request)
  65.     {
  66.         $current = $request->headers->get('Surrogate-Capability');
  67.         $new = sprintf('symfony="%s/1.0"', strtoupper($this->getName()));
  69.         $request->headers->set('Surrogate-Capability', $current ? $current.', '.$new : $new);
  70.     }
  72.     /**
  73.      * {@inheritdoc}
  74.      */
  75.     public function needsParsing(Response $response): bool
  76.     {
  77.         if (!$control = $response->headers->get('Surrogate-Control')) {
  78.             return false;
  79.         }
  81.         $pattern = sprintf('#content="[^"]*%s/1.0[^"]*"#', strtoupper($this->getName()));
  83.         return (bool) preg_match($pattern, $control);
  84.     }
  86.     /**
  87.      * {@inheritdoc}
  88.      */
  89.     public function handle(HttpCache $cache, string $uri, string $alt, bool $ignoreErrors): string
  90.     {
  91.         $subRequest = Request::create($uri, Request::METHOD_GET, [], $cache->getRequest()->cookies->all(), [], $cache->getRequest()->server->all());
  93.         try {
  94.             $response = $cache->handle($subRequest, HttpKernelInterface::SUB_REQUEST, true);
  96.             if (!$response->isSuccessful() && Response::HTTP_NOT_MODIFIED !== $response->getStatusCode()) {
  97.                 throw new \RuntimeException(sprintf('Error when rendering "%s" (Status code is %d).', $subRequest->getUri(), $response->getStatusCode()));
  98.             }
  100.             return $response->getContent();
  101.         } catch (\Exception $e) {
  102.             if ($alt) {
  103.                 return $this->handle($cache, $alt, '', $ignoreErrors);
  104.             }
  106.             if (!$ignoreErrors) {
  107.                 throw $e;
  108.             }
  109.         }
  111.         return '';
  112.     }
  114.     /**
  115.      * Remove the Surrogate from the Surrogate-Control header.
  116.      */
  117.     protected function removeFromControl(Response $response)
  118.     {
  119.         if (!$response->headers->has('Surrogate-Control')) {
  120.             return;
  121.         }
  123.         $value = $response->headers->get('Surrogate-Control');
  124.         $upperName = strtoupper($this->getName());
  126.         if (sprintf('content="%s/1.0"', $upperName) == $value) {
  127.             $response->headers->remove('Surrogate-Control');
  128.         } elseif (preg_match(sprintf('#,\s*content="%s/1.0"#', $upperName), $value)) {
  129.             $response->headers->set('Surrogate-Control', preg_replace(sprintf('#,\s*content="%s/1.0"#', $upperName), '', $value));
  130.         } elseif (preg_match(sprintf('#content="%s/1.0",\s*#', $upperName), $value)) {
  131.             $response->headers->set('Surrogate-Control', preg_replace(sprintf('#content="%s/1.0",\s*#', $upperName), '', $value));
  132.         }
  133.     }
  134. }