212 lines
4.4 KiB
PHP
212 lines
4.4 KiB
PHP
<?php
|
|
/**
|
|
* @package Joomla.Platform
|
|
* @subpackage Cache
|
|
*
|
|
* @copyright Copyright (C) 2005 - 2013 Open Source Matters, Inc. All rights reserved.
|
|
* @license GNU General Public License version 2 or later; see LICENSE
|
|
*/
|
|
|
|
defined('JPATH_PLATFORM') or die;
|
|
|
|
/**
|
|
* Joomla! Cache page type object
|
|
*
|
|
* @package Joomla.Platform
|
|
* @subpackage Cache
|
|
* @since 11.1
|
|
*/
|
|
class JCacheControllerPage extends JCacheController
|
|
{
|
|
/**
|
|
* @var integer ID property for the cache page object.
|
|
* @since 11.1
|
|
*/
|
|
protected $_id;
|
|
|
|
/**
|
|
* @var string Cache group
|
|
* @since 11.1
|
|
*/
|
|
protected $_group;
|
|
|
|
/**
|
|
* @var object Cache lock test
|
|
* @since 11.1
|
|
*/
|
|
protected $_locktest = null;
|
|
|
|
/**
|
|
* Get the cached page data
|
|
*
|
|
* @param string $id The cache data id
|
|
* @param string $group The cache data group
|
|
*
|
|
* @return boolean True if the cache is hit (false else)
|
|
*
|
|
* @since 11.1
|
|
*/
|
|
public function get($id = false, $group = 'page')
|
|
{
|
|
// If an id is not given, generate it from the request
|
|
if ($id == false)
|
|
{
|
|
$id = $this->_makeId();
|
|
}
|
|
|
|
// If the etag matches the page id ... set a no change header and exit : utilize browser cache
|
|
if (!headers_sent() && isset($_SERVER['HTTP_IF_NONE_MATCH']))
|
|
{
|
|
$etag = stripslashes($_SERVER['HTTP_IF_NONE_MATCH']);
|
|
if ($etag == $id)
|
|
{
|
|
$browserCache = isset($this->options['browsercache']) ? $this->options['browsercache'] : false;
|
|
if ($browserCache)
|
|
{
|
|
$this->_noChange();
|
|
}
|
|
}
|
|
}
|
|
|
|
// We got a cache hit... set the etag header and echo the page data
|
|
$data = $this->cache->get($id, $group);
|
|
|
|
$this->_locktest = new stdClass;
|
|
$this->_locktest->locked = null;
|
|
$this->_locktest->locklooped = null;
|
|
|
|
if ($data === false)
|
|
{
|
|
$this->_locktest = $this->cache->lock($id, $group);
|
|
if ($this->_locktest->locked == true && $this->_locktest->locklooped == true)
|
|
{
|
|
$data = $this->cache->get($id, $group);
|
|
}
|
|
}
|
|
|
|
if ($data !== false)
|
|
{
|
|
$data = unserialize(trim($data));
|
|
|
|
$data = JCache::getWorkarounds($data);
|
|
|
|
$this->_setEtag($id);
|
|
if ($this->_locktest->locked == true)
|
|
{
|
|
$this->cache->unlock($id, $group);
|
|
}
|
|
return $data;
|
|
}
|
|
|
|
// Set id and group placeholders
|
|
$this->_id = $id;
|
|
$this->_group = $group;
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Stop the cache buffer and store the cached data
|
|
*
|
|
* @param mixed $data The data to store
|
|
* @param string $id The cache data id
|
|
* @param string $group The cache data group
|
|
* @param boolean $wrkarounds True to use wrkarounds
|
|
*
|
|
* @return boolean True if cache stored
|
|
*
|
|
* @since 11.1
|
|
*/
|
|
public function store($data, $id, $group = null, $wrkarounds = true)
|
|
{
|
|
// Get page data from JResponse
|
|
if (empty($data))
|
|
{
|
|
$data = JResponse::getBody();
|
|
}
|
|
|
|
// Get id and group and reset the placeholders
|
|
if (empty($id))
|
|
{
|
|
$id = $this->_id;
|
|
}
|
|
if (empty($group))
|
|
{
|
|
$group = $this->_group;
|
|
}
|
|
|
|
// Only attempt to store if page data exists
|
|
if ($data)
|
|
{
|
|
if ($wrkarounds) {
|
|
$data = JCache::setWorkarounds($data, array(
|
|
'nopathway' => 1,
|
|
'nohead' => 1,
|
|
'nomodules' => 1,
|
|
'headers' => true
|
|
));
|
|
}
|
|
|
|
if ($this->_locktest->locked == false)
|
|
{
|
|
$this->_locktest = $this->cache->lock($id, $group);
|
|
}
|
|
|
|
$sucess = $this->cache->store(serialize($data), $id, $group);
|
|
|
|
if ($this->_locktest->locked == true)
|
|
{
|
|
$this->cache->unlock($id, $group);
|
|
}
|
|
|
|
return $sucess;
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Generate a page cache id
|
|
*
|
|
* @return string MD5 Hash : page cache id
|
|
*
|
|
* @since 11.1
|
|
* @todo Discuss whether this should be coupled to a data hash or a request
|
|
* hash ... perhaps hashed with a serialized request
|
|
*/
|
|
protected function _makeId()
|
|
{
|
|
return JCache::makeId();
|
|
}
|
|
|
|
/**
|
|
* There is no change in page data so send an
|
|
* unmodified header and die gracefully
|
|
*
|
|
* @return void
|
|
*
|
|
* @since 11.1
|
|
*/
|
|
protected function _noChange()
|
|
{
|
|
$app = JFactory::getApplication();
|
|
|
|
// Send not modified header and exit gracefully
|
|
header('HTTP/1.x 304 Not Modified', true);
|
|
$app->close();
|
|
}
|
|
|
|
/**
|
|
* Set the ETag header in the response
|
|
*
|
|
* @param string $etag The entity tag (etag) to set
|
|
*
|
|
* @return void
|
|
*
|
|
* @since 11.1
|
|
*/
|
|
protected function _setEtag($etag)
|
|
{
|
|
JResponse::setHeader('ETag', $etag, true);
|
|
}
|
|
}
|