Classes List

Symfony\Component\HttpKernel\HttpCache\AbstractSurrogate

 1 
 2 
 3 
 4 
 5 
 6 
 7 
 8 
 9 
 10 
 11 
 12 
 13 
 14 
 15 
 16 
 17 
 18 
 19 
 20 
 21 
 22 
 23 
 24 
 25 
 26 
 27 
 28 
 29 
 30 
 31 
 32 
 33 
 34 
 35 
 36 
 37 
 38 
 39 
 40 
 41 
 42 
 43 
 44 
 45 
 46 
 47 
 48 
 49 
 50 
 51 
 52 
 53 
 54 
 55 
 56 
 57 
 58 
 59 
 60 
 61 
 62 
 63 
 64 
 65 
 66 
 67 
 68 
 69 
 70 
 71 
 72 
 73 
 74 
 75 
 76 
 77 
 78 
 79 
 80 
 81 
 82 
 83 
 84 
 85 
 86 
 87 
 88 
 89 
 90 
 91 
 92 
 93 
 94 
 95 
 96 
 97 
 98 
 99 
 100 
 101 
 102 
 103 
 104 
 105 
 106 
 107 
 108 
 109 
 110 
 111 
 112 
 113 
 114 
 115 
 116 
 117 
 118 
 119 
 120 
 121 
 122 
 123 
 124 
 125 
 126 
 127 
 128 
 129 
 130 
 131 
 132 
 133 
 134 
 135 
<?php

/* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */


namespace Symfony\Component\HttpKernel\HttpCache;

use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpKernel\HttpKernelInterface;

/** * Abstract class implementing Surrogate capabilities to Request and Response instances. * * @author Fabien Potencier <fabien@symfony.com> * @author Robin Chalas <robin.chalas@gmail.com> */
abstract class AbstractSurrogate implements SurrogateInterface
{
    protected $contentTypes;
    protected $phpEscapeMap = array(
        array('<?''<%''<s''<S'),
        array('<?php echo "<?"; ?>''<?php echo "<%"; ?>''<?php echo "<s"; ?>''<?php echo "<S"; ?>'),
    );

    /** * @param array $contentTypes An array of content-type that should be parsed for Surrogate information * (default: text/html, text/xml, application/xhtml+xml, and application/xml) */
    public function __construct(array $contentTypes = array('text/html''text/xml''application/xhtml+xml''application/xml'))
    {
        $this->contentTypes = $contentTypes;
    }

    /** * Returns a new cache strategy instance. * * @return ResponseCacheStrategyInterface A ResponseCacheStrategyInterface instance */
    public function createCacheStrategy()
    {
        return new ResponseCacheStrategy();
    }

    /** * {@inheritdoc} */
    public function hasSurrogateCapability(Request $request)
    {
        if (null === $value = $request->headers->get('Surrogate-Capability')) {
            return false;
        }

        return false !== strpos($valuesprintf('%s/1.0'strtoupper($this->getName())));
    }

    /** * {@inheritdoc} */
    public function addSurrogateCapability(Request $request)
    {
        $current = $request->headers->get('Surrogate-Capability');
        $new = sprintf('symfony="%s/1.0"'strtoupper($this->getName()));

        $request->headers->set('Surrogate-Capability'$current ? $current.', '.$new : $new);
    }

    /** * {@inheritdoc} */
    public function needsParsing(Response $response)
    {
        if (!$control = $response->headers->get('Surrogate-Control')) {
            return false;
        }

        $pattern = sprintf('#content="[^"]*%s/1.0[^"]*"#'strtoupper($this->getName()));

        return (bool) preg_match($pattern$control);
    }

    /** * {@inheritdoc} */
    public function handle(HttpCache $cache$uri$alt$ignoreErrors)
    {
        $subRequest = Request::create($uriRequest::METHOD_GETarray(), $cache->getRequest()->cookies->all(), array(), $cache->getRequest()->server->all());

        try {
            $response = $cache->handle($subRequestHttpKernelInterface::SUB_REQUESTtrue);

            if (!$response->isSuccessful()) {
                throw new \RuntimeException(sprintf('Error when rendering "%s" (Status code is %s).'$subRequest->getUri(), $response->getStatusCode()));
            }

            return $response->getContent();
        } catch (\Exception $e) {
            if ($alt) {
                return $this->handle($cache$alt''$ignoreErrors);
            }

            if (!$ignoreErrors) {
                throw $e;
            }
        }
    }

    /** * Remove the Surrogate from the Surrogate-Control header. */
    protected function removeFromControl(Response $response)
    {
        if (!$response->headers->has('Surrogate-Control')) {
            return;
        }

        $value = $response->headers->get('Surrogate-Control');
        $upperName = strtoupper($this->getName());

        if (sprintf('content="%s/1.0"'$upperName== $value) {
            $response->headers->remove('Surrogate-Control');
        } elseif (preg_match(sprintf('#,\s*content="%s/1.0"#'$upperName), $value)) {
            $response->headers->set('Surrogate-Control'preg_replace(sprintf('#,\s*content="%s/1.0"#'$upperName), ''$value));
        } elseif (preg_match(sprintf('#content="%s/1.0",\s*#'$upperName), $value)) {
            $response->headers->set('Surrogate-Control'preg_replace(sprintf('#content="%s/1.0",\s*#'$upperName), ''$value));
        }
    }
}