www.aleph1.co.uk Git - yaffs-website/blob - vendor/symfony/http-kernel/HttpCache/AbstractSurrogate.php

   1 <?php
   2
   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  */
  11
  12 namespace Symfony\Component\HttpKernel\HttpCache;
  13
  14 use Symfony\Component\HttpFoundation\Request;
  15 use Symfony\Component\HttpFoundation\Response;
  16 use Symfony\Component\HttpKernel\HttpKernelInterface;
  17
  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 = array(
  28         array('<?', '<%', '<s', '<S'),
  29         array('<?php echo "<?"; ?>', '<?php echo "<%"; ?>', '<?php echo "<s"; ?>', '<?php echo "<S"; ?>'),
  30     );
  31
  32     /**
  33      * Constructor.
  34      *
  35      * @param array $contentTypes An array of content-type that should be parsed for Surrogate information
  36      *                            (default: text/html, text/xml, application/xhtml+xml, and application/xml)
  37      */
  38     public function __construct(array $contentTypes = array('text/html', 'text/xml', 'application/xhtml+xml', 'application/xml'))
  39     {
  40         $this->contentTypes = $contentTypes;
  41     }
  42
  43     /**
  44      * Returns a new cache strategy instance.
  45      *
  46      * @return ResponseCacheStrategyInterface A ResponseCacheStrategyInterface instance
  47      */
  48     public function createCacheStrategy()
  49     {
  50         return new ResponseCacheStrategy();
  51     }
  52
  53     /**
  54      * {@inheritdoc}
  55      */
  56     public function hasSurrogateCapability(Request $request)
  57     {
  58         if (null === $value = $request->headers->get('Surrogate-Capability')) {
  59             return false;
  60         }
  61
  62         return false !== strpos($value, sprintf('%s/1.0', strtoupper($this->getName())));
  63     }
  64
  65     /**
  66      * {@inheritdoc}
  67      */
  68     public function addSurrogateCapability(Request $request)
  69     {
  70         $current = $request->headers->get('Surrogate-Capability');
  71         $new = sprintf('symfony="%s/1.0"', strtoupper($this->getName()));
  72
  73         $request->headers->set('Surrogate-Capability', $current ? $current.', '.$new : $new);
  74     }
  75
  76     /**
  77      * {@inheritdoc}
  78      */
  79     public function needsParsing(Response $response)
  80     {
  81         if (!$control = $response->headers->get('Surrogate-Control')) {
  82             return false;
  83         }
  84
  85         $pattern = sprintf('#content="[^"]*%s/1.0[^"]*"#', strtoupper($this->getName()));
  86
  87         return (bool) preg_match($pattern, $control);
  88     }
  89
  90     /**
  91      * {@inheritdoc}
  92      */
  93     public function handle(HttpCache $cache, $uri, $alt, $ignoreErrors)
  94     {
  95         $subRequest = Request::create($uri, Request::METHOD_GET, array(), $cache->getRequest()->cookies->all(), array(), $cache->getRequest()->server->all());
  96
  97         try {
  98             $response = $cache->handle($subRequest, HttpKernelInterface::SUB_REQUEST, true);
  99
 100             if (!$response->isSuccessful()) {
 101                 throw new \RuntimeException(sprintf('Error when rendering "%s" (Status code is %s).', $subRequest->getUri(), $response->getStatusCode()));
 102             }
 103
 104             return $response->getContent();
 105         } catch (\Exception $e) {
 106             if ($alt) {
 107                 return $this->handle($cache, $alt, '', $ignoreErrors);
 108             }
 109
 110             if (!$ignoreErrors) {
 111                 throw $e;
 112             }
 113         }
 114     }
 115
 116     /**
 117      * Remove the Surrogate from the Surrogate-Control header.
 118      *
 119      * @param Response $response
 120      */
 121     protected function removeFromControl(Response $response)
 122     {
 123         if (!$response->headers->has('Surrogate-Control')) {
 124             return;
 125         }
 126
 127         $value = $response->headers->get('Surrogate-Control');
 128         $upperName = strtoupper($this->getName());
 129
 130         if (sprintf('content="%s/1.0"', $upperName) == $value) {
 131             $response->headers->remove('Surrogate-Control');
 132         } elseif (preg_match(sprintf('#,\s*content="%s/1.0"#', $upperName), $value)) {
 133             $response->headers->set('Surrogate-Control', preg_replace(sprintf('#,\s*content="%s/1.0"#', $upperName), '', $value));
 134         } elseif (preg_match(sprintf('#content="%s/1.0",\s*#', $upperName), $value)) {
 135             $response->headers->set('Surrogate-Control', preg_replace(sprintf('#content="%s/1.0",\s*#', $upperName), '', $value));
 136         }
 137     }
 138 }