4 * This file is part of the Symfony package.
6 * (c) Fabien Potencier <fabien@symfony.com>
8 * For the full copyright and license information, please view the LICENSE
9 * file that was distributed with this source code.
12 namespace Symfony\Component\HttpKernel\HttpCache;
14 use Symfony\Component\HttpFoundation\Request;
15 use Symfony\Component\HttpFoundation\Response;
16 use Symfony\Component\HttpKernel\HttpKernelInterface;
19 * Abstract class implementing Surrogate capabilities to Request and Response instances.
21 * @author Fabien Potencier <fabien@symfony.com>
22 * @author Robin Chalas <robin.chalas@gmail.com>
24 abstract class AbstractSurrogate implements SurrogateInterface
26 protected $contentTypes;
27 protected $phpEscapeMap = array(
28 array('<?', '<%', '<s', '<S'),
29 array('<?php echo "<?"; ?>', '<?php echo "<%"; ?>', '<?php echo "<s"; ?>', '<?php echo "<S"; ?>'),
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)
36 public function __construct(array $contentTypes = array('text/html', 'text/xml', 'application/xhtml+xml', 'application/xml'))
38 $this->contentTypes = $contentTypes;
42 * Returns a new cache strategy instance.
44 * @return ResponseCacheStrategyInterface A ResponseCacheStrategyInterface instance
46 public function createCacheStrategy()
48 return new ResponseCacheStrategy();
54 public function hasSurrogateCapability(Request $request)
56 if (null === $value = $request->headers->get('Surrogate-Capability')) {
60 return false !== strpos($value, sprintf('%s/1.0', strtoupper($this->getName())));
66 public function addSurrogateCapability(Request $request)
68 $current = $request->headers->get('Surrogate-Capability');
69 $new = sprintf('symfony="%s/1.0"', strtoupper($this->getName()));
71 $request->headers->set('Surrogate-Capability', $current ? $current.', '.$new : $new);
77 public function needsParsing(Response $response)
79 if (!$control = $response->headers->get('Surrogate-Control')) {
83 $pattern = sprintf('#content="[^"]*%s/1.0[^"]*"#', strtoupper($this->getName()));
85 return (bool) preg_match($pattern, $control);
91 public function handle(HttpCache $cache, $uri, $alt, $ignoreErrors)
93 $subRequest = Request::create($uri, Request::METHOD_GET, array(), $cache->getRequest()->cookies->all(), array(), $cache->getRequest()->server->all());
96 $response = $cache->handle($subRequest, HttpKernelInterface::SUB_REQUEST, true);
98 if (!$response->isSuccessful()) {
99 throw new \RuntimeException(sprintf('Error when rendering "%s" (Status code is %s).', $subRequest->getUri(), $response->getStatusCode()));
102 return $response->getContent();
103 } catch (\Exception $e) {
105 return $this->handle($cache, $alt, '', $ignoreErrors);
108 if (!$ignoreErrors) {
115 * Remove the Surrogate from the Surrogate-Control header.
117 protected function removeFromControl(Response $response)
119 if (!$response->headers->has('Surrogate-Control')) {
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));