123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195 |
- <?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;
- /**
- * Ssi implements the SSI capabilities to Request and Response instances.
- *
- * @author Sebastian Krebs <krebs.seb@gmail.com>
- */
- class Ssi implements SurrogateInterface
- {
- private $contentTypes;
- private $phpEscapeMap = array(
- array('<?', '<%', '<s', '<S'),
- array('<?php echo "<?"; ?>', '<?php echo "<%"; ?>', '<?php echo "<s"; ?>', '<?php echo "<S"; ?>'),
- );
- /**
- * Constructor.
- *
- * @param array $contentTypes An array of content-type that should be parsed for SSI 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;
- }
- /**
- * {@inheritdoc}
- */
- public function getName()
- {
- return 'ssi';
- }
- /**
- * {@inheritdoc}
- */
- 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($value, 'SSI/1.0');
- }
- /**
- * {@inheritdoc}
- */
- public function addSurrogateCapability(Request $request)
- {
- $current = $request->headers->get('Surrogate-Capability');
- $new = 'symfony2="SSI/1.0"';
- $request->headers->set('Surrogate-Capability', $current ? $current.', '.$new : $new);
- }
- /**
- * {@inheritdoc}
- */
- public function addSurrogateControl(Response $response)
- {
- if (false !== strpos($response->getContent(), '<!--#include')) {
- $response->headers->set('Surrogate-Control', 'content="SSI/1.0"');
- }
- }
- /**
- * {@inheritdoc}
- */
- public function needsParsing(Response $response)
- {
- if (!$control = $response->headers->get('Surrogate-Control')) {
- return false;
- }
- return (bool) preg_match('#content="[^"]*SSI/1.0[^"]*"#', $control);
- }
- /**
- * {@inheritdoc}
- */
- public function renderIncludeTag($uri, $alt = null, $ignoreErrors = true, $comment = '')
- {
- return sprintf('<!--#include virtual="%s" -->', $uri);
- }
- /**
- * {@inheritdoc}
- */
- public function process(Request $request, Response $response)
- {
- $type = $response->headers->get('Content-Type');
- if (empty($type)) {
- $type = 'text/html';
- }
- $parts = explode(';', $type);
- if (!in_array($parts[0], $this->contentTypes)) {
- return $response;
- }
- // we don't use a proper XML parser here as we can have SSI tags in a plain text response
- $content = $response->getContent();
- $chunks = preg_split('#<!--\#include\s+(.*?)\s*-->#', $content, -1, PREG_SPLIT_DELIM_CAPTURE);
- $chunks[0] = str_replace($this->phpEscapeMap[0], $this->phpEscapeMap[1], $chunks[0]);
- $i = 1;
- while (isset($chunks[$i])) {
- $options = array();
- preg_match_all('/(virtual)="([^"]*?)"/', $chunks[$i], $matches, PREG_SET_ORDER);
- foreach ($matches as $set) {
- $options[$set[1]] = $set[2];
- }
- if (!isset($options['virtual'])) {
- throw new \RuntimeException('Unable to process an SSI tag without a "virtual" attribute.');
- }
- $chunks[$i] = sprintf('<?php echo $this->surrogate->handle($this, %s, \'\', false) ?>'."\n",
- var_export($options['virtual'], true)
- );
- ++$i;
- $chunks[$i] = str_replace($this->phpEscapeMap[0], $this->phpEscapeMap[1], $chunks[$i]);
- ++$i;
- }
- $content = implode('', $chunks);
- $response->setContent($content);
- $response->headers->set('X-Body-Eval', 'SSI');
- // remove SSI/1.0 from the Surrogate-Control header
- if ($response->headers->has('Surrogate-Control')) {
- $value = $response->headers->get('Surrogate-Control');
- if ('content="SSI/1.0"' == $value) {
- $response->headers->remove('Surrogate-Control');
- } elseif (preg_match('#,\s*content="SSI/1.0"#', $value)) {
- $response->headers->set('Surrogate-Control', preg_replace('#,\s*content="SSI/1.0"#', '', $value));
- } elseif (preg_match('#content="SSI/1.0",\s*#', $value)) {
- $response->headers->set('Surrogate-Control', preg_replace('#content="SSI/1.0",\s*#', '', $value));
- }
- }
- }
- /**
- * {@inheritdoc}
- */
- public function handle(HttpCache $cache, $uri, $alt, $ignoreErrors)
- {
- $subRequest = Request::create($uri, 'get', array(), $cache->getRequest()->cookies->all(), array(), $cache->getRequest()->server->all());
- try {
- $response = $cache->handle($subRequest, HttpKernelInterface::SUB_REQUEST, true);
- 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;
- }
- }
- }
- }
|