1. sfCacheFilter.class.php
  2. /**
 * sfCacheFilter deals with page caching and action caching.
 *
 * @package    symfony
 * @subpackage filter
 * @author     Fabien Potencier 
 * @version    SVN: $Id: sfCacheFilter.class.php 24619 2009-11-30 23:14:18Z FabianLange $
 */
  3. class sfCacheFilter extends sfFilter
  4. {
  5.   protected
  6.     $cacheManager = null,
  7.     $request      = null,
  8.     $response     = null,
  9.     $routing      = null,
  10.     $cache        = array();
  12.   /**
  13.    * Initializes this Filter.
  14.    *
  15.    * @param sfContext $context    The current application context
  16.    * @param array     $parameters An associative array of initialization parameters
  17.    *
  18.    * @return bool true, if initialization completes successfully, otherwise false
  19.    *
  20.    * @throws <b>sfInitializationException</b> If an error occurs while initializing this Filter
  21.    */
  22.   public function initialize($context, $parameters = array())
  23.   {
  24.     parent::initialize($context, $parameters);
  26.     $this->cacheManager = $context->getViewCacheManager();
  27.     $this->request      = $context->getRequest();
  28.     $this->response     = $context->getResponse();
  29.     $this->routing      = $context->getRouting();
  30.   }
  32.   /**
  33.    * Executes this filter.
  34.    *
  35.    * @param sfFilterChain $filterChain A sfFilterChain instance
  36.    */
  37.   public function execute($filterChain)
  38.   {
  39.     // execute this filter only once, if cache is set and no GET or POST parameters
  40.     if (!sfConfig::get('sf_cache'))
  41.     {
  42.       $filterChain->execute();
  44.       return;
  45.     }
  47.     if ($this->executeBeforeExecution())
  48.     {
  49.       $filterChain->execute();
  50.     }
  52.     $this->executeBeforeRendering();
  53.   }
  55.   public function executeBeforeExecution()
  56.   {
  57.     $uri = $this->cacheManager->getCurrentCacheKey();
  59.     if (null === $uri)
  60.     {
  61.       return true;
  62.     }
  64.     // page cache
  65.     $cacheable = $this->cacheManager->isCacheable($uri);
  66.     if ($cacheable && $this->cacheManager->withLayout($uri))
  67.     {
  68.       $inCache = $this->cacheManager->getPageCache($uri);
  69.       $this->cache[$uri] = $inCache;
  71.       if ($inCache)
  72.       {
  73.         // page is in cache, so no need to run execution filter
  74.         return false;
  75.       }
  76.     }
  78.     return true;
  79.   }
  81.   /**
  82.    * Executes this filter.
  83.    */
  84.   public function executeBeforeRendering()
  85.   {
  86.     // cache only 200 HTTP status
  87.     if (200 != $this->response->getStatusCode())
  88.     {
  89.       return;
  90.     }
  92.     $uri = $this->cacheManager->getCurrentCacheKey();
  94.     // save page in cache
  95.     if (isset($this->cache[$uri]) && false === $this->cache[$uri])
  96.     {
  97.       $this->setCacheExpiration($uri);
  98.       $this->setCacheValidation($uri);
  100.       // set Vary headers
  101.       foreach ($this->cacheManager->getVary($uri, 'page') as $vary)
  102.       {
  103.         $this->response->addVaryHttpHeader($vary);
  104.       }
  106.       $this->cacheManager->setPageCache($uri);
  107.     }
  109.     // cache validation
  110.     $this->checkCacheValidation();
  111.   }
  113.   /**
  114.    * Sets cache expiration headers.
  115.    *
  116.    * @param string $uri An internal URI
  117.    */
  118.   protected function setCacheExpiration($uri)
  119.   {
  120.     // don't add cache expiration (Expires) if
  121.     //   * the client lifetime is not set
  122.     //   * the response already has a cache validation (Last-Modified header)
  123.     //   * the Expires header has already been set
  124.     if (!$lifetime = $this->cacheManager->getClientLifeTime($uri, 'page'))
  125.     {
  126.       return;
  127.     }
  129.     if ($this->response->hasHttpHeader('Last-Modified'))
  130.     {
  131.       return;
  132.     }
  134.     if (!$this->response->hasHttpHeader('Expires'))
  135.     {
  136.       $this->response->setHttpHeader('Expires', $this->response->getDate(time() + $lifetime), false);
  137.       $this->response->addCacheControlHttpHeader('max-age', $lifetime);
  138.     }
  139.   }
  141.   /**
  142.    * Sets cache validation headers.
  143.    *
  144.    * @param string $uri An internal URI
  145.    */
  147.   protected function setCacheValidation($uri)
  148.   {
  149.     // don't add cache validation (Last-Modified) if
  150.     //   * the client lifetime is set (cache.yml)
  151.     //   * the response already has a Last-Modified header
  152.     if ($this->cacheManager->getClientLifeTime($uri, 'page'))
  153.     {
  154.       return;
  155.     }
  157.     if (!$this->response->hasHttpHeader('Last-Modified'))
  158.     {
  159.       $this->response->setHttpHeader('Last-Modified', $this->response->getDate(time()), false);
  160.     }
  162.     if (sfConfig::get('sf_etag'))
  163.     {
  164.       $etag = '"'.md5($this->response->getContent()).'"';
  165.       $this->response->setHttpHeader('ETag', $etag);
  166.     }
  167.   }
  169.   /**
  170.    * Checks cache validation headers.
  171.    */
  172.   protected function checkCacheValidation()
  173.   {
  174.     // Etag support
  175.     if (sfConfig::get('sf_etag'))
  176.     {
  177.       $etag = '"'.md5($this->response->getContent()).'"';
  179.       if ($this->request->getHttpHeader('IF_NONE_MATCH') == $etag)
  180.       {
  181.         $this->response->setStatusCode(304);
  182.         $this->response->setHeaderOnly(true);
  184.         if (sfConfig::get('sf_logging_enabled'))
  185.         {
  186.           $this->context->getEventDispatcher()->notify(new sfEvent($this, 'application.log', array('ETag matches If-None-Match (send 304)')));
  187.         }
  188.       }
  189.     }
  191.     // conditional GET support
  192.     // never in debug mode
  193.     if ($this->response->hasHttpHeader('Last-Modified') && !sfConfig::get('sf_debug'))
  194.     {
  195.       $lastModified = $this->response->getHttpHeader('Last-Modified');
  196.       if ($this->request->getHttpHeader('IF_MODIFIED_SINCE') == $lastModified)
  197.       {
  198.         $this->response->setStatusCode(304);
  199.         $this->response->setHeaderOnly(true);
  201.         if (sfConfig::get('sf_logging_enabled'))
  202.         {
  203.           $this->context->getEventDispatcher()->notify(new sfEvent($this, 'application.log', array('Last-Modified matches If-Modified-Since (send 304)')));
  204.         }
  205.       }
  206.     }
  207.   }
  208. }
Debug toolbar