root/branches/1.0/lib/filter/sfCacheFilter.class.php

<?php

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

/**
 * sfCacheFilter deals with page caching and action caching.
 *
 * @package    symfony
 * @subpackage filter
 * @author     Fabien Potencier <fabien.potencier@symfony-project.com>
 * @version    SVN: $Id$
 */
class sfCacheFilter extends sfFilter
{
  protected
    $cacheManager = null,
    $request      = null,
    $response     = null,
    $cache        = array();

  /**
   * Initializes this Filter.
   *
   * @param sfContext The current application context
   * @param array   An associative array of initialization parameters
   *
   * @return bool true, if initialization completes successfully, otherwise false
   *
   * @throws <b>sfInitializationException</b> If an error occurs while initializing this Filter
   */
  public function initialize($context, $parameters = array())
  {
    parent::initialize($context, $parameters);

    $this->cacheManager = $context->getViewCacheManager();
    $this->request      = $context->getRequest();
    $this->response     = $context->getResponse();
  }

  /**
   * Executes this filter.
   *
   * @param sfFilterChain A sfFilterChain instance
   */
  public function execute($filterChain)
  {
    // execute this filter only once, if cache is set and no GET or POST parameters
    if (!sfConfig::get('sf_cache') || count($_GET) || count($_POST))
    {
      $filterChain->execute();

      return;
    }

    if ($this->executeBeforeExecution())
    {
      $filterChain->execute();
    }

    $this->executeBeforeRendering();
  }

  public function executeBeforeExecution()
  {
    // register our cache configuration
    $this->cacheManager->registerConfiguration($this->getContext()->getModuleName());

    $uri = sfRouting::getInstance()->getCurrentInternalUri();

    // page cache
    $this->cache[$uri] = array('page' => false, 'action' => false);
    $cacheable = $this->cacheManager->isCacheable($uri);
    if ($cacheable)
    {
      if ($this->cacheManager->withLayout($uri))
      {
        $inCache = $this->getPageCache($uri);
        $this->cache[$uri]['page'] = !$inCache;

        if ($inCache)
        {
          // page is in cache, so no need to run execution filter
          return false;
        }
      }
      else
      {
        $inCache = $this->getActionCache($uri);
        $this->cache[$uri]['action'] = !$inCache;
      }
    }

    return true;
  }

  /**
   * Executes this filter.
   *
   * @param sfFilterChain A sfFilterChain instance.
   */
  public function executeBeforeRendering()
  {
    // cache only 200 HTTP status
    if (200 != $this->response->getStatusCode())
    {
      return;
    }

    $uri = sfRouting::getInstance()->getCurrentInternalUri();

    // save page in cache
    if (isset($this->cache[$uri]) && $this->cache[$uri]['page'])
    {
      // set some headers that deals with cache
      if ($lifetime = $this->cacheManager->getClientLifeTime($uri, 'page'))
      {
        $this->response->setHttpHeader('Last-Modified', $this->response->getDate(time()), false);
        $this->response->setHttpHeader('Expires', $this->response->getDate(time() + $lifetime), false);
        $this->response->addCacheControlHttpHeader('max-age', $lifetime);
      }

      // set Vary headers
      foreach ($this->cacheManager->getVary($uri, 'page') as $vary)
      {
        $this->response->addVaryHttpHeader($vary);
      }

      $this->setPageCache($uri);
    }
    else if (isset($this->cache[$uri]) && $this->cache[$uri]['action'])
    {
      // save action in cache
      $this->setActionCache($uri);
    }

    // remove PHP automatic Cache-Control and Expires headers if not overwritten by application or cache
    if ($this->response->hasHttpHeader('Last-Modified') || sfConfig::get('sf_etag'))
    {
      // FIXME: these headers are set by PHP sessions (see session_cache_limiter())
      $this->response->setHttpHeader('Cache-Control', null, false);
      $this->response->setHttpHeader('Expires', null, false);
      $this->response->setHttpHeader('Pragma', null, false);
    }

    // Etag support
    if (sfConfig::get('sf_etag'))
    {
      $etag = '"'.md5($this->response->getContent()).'"';
      $this->response->setHttpHeader('ETag', $etag);

      if ($this->request->getHttpHeader('IF_NONE_MATCH') == $etag)
      {
        $this->response->setStatusCode(304);
        $this->response->setHeaderOnly(true);

        if (sfConfig::get('sf_logging_enabled'))
        {
          $this->getContext()->getLogger()->info('{sfFilter} ETag matches If-None-Match (send 304)');
        }
      }
    }

    // conditional GET support
    // never in debug mode
    if ($this->response->hasHttpHeader('Last-Modified') && !sfConfig::get('sf_debug'))
    {
      $last_modified = $this->response->getHttpHeader('Last-Modified');
      if ($this->request->getHttpHeader('IF_MODIFIED_SINCE') == $last_modified)
      {
        $this->response->setStatusCode(304);
        $this->response->setHeaderOnly(true);

        if (sfConfig::get('sf_logging_enabled'))
        {
          $this->getContext()->getLogger()->info('{sfFilter} Last-Modified matches If-Modified-Since (send 304)');
        }
      }
    }
  }

  /**
   * Sets a page template in the cache.
   *
   * @param string The internal URI
   */
  protected function setPageCache($uri)
  {
    if ($this->getContext()->getController()->getRenderMode() != sfView::RENDER_CLIENT)
    {
      return;
    }

    // save content in cache
    $this->cacheManager->set(serialize($this->response), $uri);

    if (sfConfig::get('sf_web_debug'))
    {
      $content = sfWebDebug::getInstance()->decorateContentWithDebug($uri, $this->response->getContent(), true);
      $this->response->setContent($content);
    }
  }

  /**
   * Gets a page template from the cache.
   *
   * @param string The internal URI
   */
  protected function getPageCache($uri)
  {
    $context = $this->getContext();

    // get the current action information
    $moduleName = $context->getModuleName();
    $actionName = $context->getActionName();

    $retval = $this->cacheManager->get($uri);

    if ($retval === null)
    {
      return false;
    }

    $cachedResponse = unserialize($retval);
    $cachedResponse->setContext($context);

    $controller = $context->getController();
    if ($controller->getRenderMode() == sfView::RENDER_VAR)
    {
      $controller->getActionStack()->getLastEntry()->setPresentation($cachedResponse->getContent());
      $this->response->setContent('');
    }
    else
    {
      $context->setResponse($cachedResponse);
      $this->response = $this->getContext()->getResponse();

      if (sfConfig::get('sf_web_debug'))
      {
        $content = sfWebDebug::getInstance()->decorateContentWithDebug($uri, $this->response->getContent(), false);
        $this->response->setContent($content);
      }
    }

    return true;
  }

  /**
   * Sets an action template in the cache.
   *
   * @param string The internal URI
   */
  protected function setActionCache($uri)
  {
    $content = $this->response->getParameter($uri.'_action', null, 'symfony/cache');

    if ($content !== null)
    {
      $this->cacheManager->set($content, $uri);
    }
  }

  /**
   * Gets an action template from the cache.
   *
   * @param string The internal URI
   */
  protected function getActionCache($uri)
  {
    // retrieve content from cache
    $retval = $this->cacheManager->get($uri);

    if ($retval && sfConfig::get('sf_web_debug'))
    {
      $cache = unserialize($retval);
      $this->response->mergeProperties($cache['response']);
      $cache['content'] = sfWebDebug::getInstance()->decorateContentWithDebug($uri, $cache['content'], false);
      $retval = serialize($cache);
    }

    $this->response->setParameter('current_key', $uri.'_action', 'symfony/cache/current');
    $this->response->setParameter($uri.'_action', $retval, 'symfony/cache');

    return $retval ? true : false;
  }
}