class Ssi in Zircon Profile 8

Ssi implements the SSI capabilities to Request and Response instances.

@author Sebastian Krebs <[e-mail]>

Hierarchy

• class \Symfony\Component\HttpKernel\HttpCache\Ssi implements SurrogateInterface

1 file declares its use of Ssi

SsiTest.php in vendor/symfony/http-kernel/Tests/HttpCache/SsiTest.php

1 string reference to 'Ssi'

xa4.php in core/lib/Drupal/Component/Transliteration/data/xa4.php

File

vendor/symfony/http-kernel/HttpCache/Ssi.php, line 23

Namespace

Symfony\Component\HttpKernel\HttpCache

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;
      }
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Ssi::$contentTypes	private	property
Ssi::$phpEscapeMap	private	property
Ssi::addSurrogateCapability	public	function	Adds Surrogate-capability to the given Request. Overrides SurrogateInterface::addSurrogateCapability
Ssi::addSurrogateControl	public	function	Adds HTTP headers to specify that the Response needs to be parsed for Surrogate. Overrides SurrogateInterface::addSurrogateControl
Ssi::createCacheStrategy	public	function	Returns a new cache strategy instance. Overrides SurrogateInterface::createCacheStrategy
Ssi::getName	public	function	Returns surrogate name. Overrides SurrogateInterface::getName
Ssi::handle	public	function	Handles a Surrogate from the cache. Overrides SurrogateInterface::handle
Ssi::hasSurrogateCapability	public	function	Checks that at least one surrogate has Surrogate capability. Overrides SurrogateInterface::hasSurrogateCapability
Ssi::needsParsing	public	function	Checks that the Response needs to be parsed for Surrogate tags. Overrides SurrogateInterface::needsParsing
Ssi::process	public	function	Replaces a Response Surrogate tags with the included resource content. Overrides SurrogateInterface::process
Ssi::renderIncludeTag	public	function	Renders a Surrogate tag. Overrides SurrogateInterface::renderIncludeTag
Ssi::__construct	public	function	Constructor.