summaryrefslogtreecommitdiff
path: root/libs/sysplugins/smarty_internal_cacheresource_file.php
diff options
context:
space:
mode:
Diffstat (limited to 'libs/sysplugins/smarty_internal_cacheresource_file.php')
-rw-r--r--libs/sysplugins/smarty_internal_cacheresource_file.php280
1 files changed, 164 insertions, 116 deletions
diff --git a/libs/sysplugins/smarty_internal_cacheresource_file.php b/libs/sysplugins/smarty_internal_cacheresource_file.php
index 512f6fbf..35b1be3a 100644
--- a/libs/sysplugins/smarty_internal_cacheresource_file.php
+++ b/libs/sysplugins/smarty_internal_cacheresource_file.php
@@ -1,207 +1,255 @@
<?php
-
/**
* Smarty Internal Plugin CacheResource File
- *
- * Implements the file system as resource for the HTML cache
- * Version ussing nocache inserts
- *
+ *
* @package Smarty
* @subpackage Cacher
- * @author Uwe Tews
+ * @author Uwe Tews
+ * @author Rodney Rehm
*/
/**
* This class does contain all necessary methods for the HTML cache on file system
+ *
+ * Implements the file system as resource for the HTML cache Version ussing nocache inserts.
+ *
+ * @package Smarty
+ * @subpackage Cacher
*/
-class Smarty_Internal_CacheResource_File {
- function __construct($smarty)
- {
- $this->smarty = $smarty;
- }
+class Smarty_Internal_CacheResource_File extends Smarty_CacheResource {
+
/**
- * Returns the filepath of the cached template output
- *
- * @param object $_template current template
- * @return string the cache filepath
+ * populate Cached Object with meta data from Resource
+ *
+ * @param Smarty_Template_Cached $cached cached object
+ * @param Smarty_Internal_Template $_template template object
+ * @return void
*/
- public function getCachedFilepath($_template)
+ public function populate(Smarty_Template_Cached $cached, Smarty_Internal_Template $_template)
{
- $_source_file_path = str_replace(':', '.', $_template->getTemplateFilepath());
+ $_source_file_path = str_replace(':', '.', $_template->source->filepath);
$_cache_id = isset($_template->cache_id) ? preg_replace('![^\w\|]+!', '_', $_template->cache_id) : null;
$_compile_id = isset($_template->compile_id) ? preg_replace('![^\w\|]+!', '_', $_template->compile_id) : null;
- $_filepath = $_template->templateUid;
+ $_filepath = $_template->source->uid;
// if use_sub_dirs, break file into directories
- if ($this->smarty->use_sub_dirs) {
+ if ($_template->smarty->use_sub_dirs) {
$_filepath = substr($_filepath, 0, 2) . DS
- . substr($_filepath, 2, 2) . DS
- . substr($_filepath, 4, 2) . DS
- . $_filepath;
- }
- $_compile_dir_sep = $this->smarty->use_sub_dirs ? DS : '^';
+ . substr($_filepath, 2, 2) . DS
+ . substr($_filepath, 4, 2) . DS
+ . $_filepath;
+ }
+ $_compile_dir_sep = $_template->smarty->use_sub_dirs ? DS : '^';
if (isset($_cache_id)) {
$_cache_id = str_replace('|', $_compile_dir_sep, $_cache_id) . $_compile_dir_sep;
} else {
$_cache_id = '';
- }
+ }
if (isset($_compile_id)) {
$_compile_id = $_compile_id . $_compile_dir_sep;
} else {
$_compile_id = '';
- }
- $_cache_dir = $this->smarty->cache_dir;
- if (strpos('/\\', substr($_cache_dir, -1)) === false) {
- $_cache_dir .= DS;
- }
- return $_cache_dir . $_cache_id . $_compile_id . $_filepath . '.' . basename($_source_file_path) . '.php';
- }
+ }
+ $_cache_dir = $_template->smarty->getCacheDir();
+ if ($_template->smarty->cache_locking) {
+ // create locking file name
+ // relative file name?
+ if (!preg_match('/^([\/\\\\]|[a-zA-Z]:[\/\\\\])/', $_cache_dir)) {
+ $_lock_dir = getcwd().$_cache_dir;
+ } else {
+ $_lock_dir = $_cache_dir;
+ }
+ $cached->lock_id = $_lock_dir.sha1($_cache_id.$_compile_id.$_template->source->uid).'.lock';
+ }
+ $cached->filepath = $_cache_dir . $_cache_id . $_compile_id . $_filepath . '.' . basename($_source_file_path) . '.php';
+ $cached->timestamp = @filemtime($cached->filepath);
+ $cached->exists = !!$cached->timestamp;
+ }
/**
- * Returns the timpestamp of the cached template output
- *
- * @param object $_template current template
- * @return integer |booelan the template timestamp or false if the file does not exist
+ * populate Cached Object with timestamp and exists from Resource
+ *
+ * @param Smarty_Template_Cached $cached cached object
+ * @return void
*/
- public function getCachedTimestamp($_template)
- {
- // return @filemtime ($_template->getCachedFilepath());
- return ($_template->getCachedFilepath() && file_exists($_template->getCachedFilepath())) ? filemtime($_template->getCachedFilepath()) : false ;
- }
+ public function populateTimestamp(Smarty_Template_Cached $cached)
+ {
+ $cached->timestamp = @filemtime($cached->filepath);
+ $cached->exists = !!$cached->timestamp;
+ }
/**
- * Returns the cached template output
- *
- * @param object $_template current template
- * @return string |booelan the template content or false if the file does not exist
+ * Read the cached template and process its header
+ *
+ * @param Smarty_Internal_Template $_template template object
+ * @param Smarty_Template_Cached $cached cached object
+ * @return booelan true or false if the cached content does not exist
*/
- public function getCachedContents($_template, $no_render = false)
+ public function process(Smarty_Internal_Template $_template, Smarty_Template_Cached $cached=null)
{
- if (!$no_render) {
- ob_start();
- }
$_smarty_tpl = $_template;
- include $_template->getCachedFilepath();
- if ($no_render) {
- return null;
- } else {
- return ob_get_clean();
- }
- }
+ return @include $_template->cached->filepath;
+ }
/**
- * Writes the rendered template output to cache file
- *
- * @param object $_template current template
- * @return boolean status
+ * Write the rendered template output to cache
+ *
+ * @param Smarty_Internal_Template $_template template object
+ * @param string $content content to cache
+ * @return boolean success
*/
- public function writeCachedContent($_template, $content)
+ public function writeCachedContent(Smarty_Internal_Template $_template, $content)
{
- if (!$_template->resource_object->isEvaluated) {
- if (Smarty_Internal_Write_File::writeFile($_template->getCachedFilepath(), $content, $this->smarty) === true) {
- $_template->cached_timestamp = filemtime($_template->getCachedFilepath());
- return true;
- }
- }
+ if (Smarty_Internal_Write_File::writeFile($_template->cached->filepath, $content, $_template->smarty) === true) {
+ $_template->cached->timestamp = filemtime($_template->cached->filepath);
+ $_template->cached->exists = !!$_template->cached->timestamp;
+ return true;
+ }
return false;
- }
+ }
/**
- * Empty cache folder
- *
- * @param integer $exp_time expiration time
+ * Empty cache
+ *
+ * @param Smarty_Internal_Template $_template template object
+ * @param integer $exp_time expiration time (number of seconds, not timestamp)
* @return integer number of cache files deleted
*/
- public function clearAll($exp_time = null)
+ public function clearAll(Smarty $smarty, $exp_time = null)
{
- return $this->clear(null, null, null, $exp_time);
- }
+ return $this->clear($smarty, null, null, null, $exp_time);
+ }
+
/**
* Empty cache for a specific template
- *
- * @param string $resource_name template name
- * @param string $cache_id cache id
- * @param string $compile_id compile id
- * @param integer $exp_time expiration time
+ *
+ * @param Smarty $_template template object
+ * @param string $resource_name template name
+ * @param string $cache_id cache id
+ * @param string $compile_id compile id
+ * @param integer $exp_time expiration time (number of seconds, not timestamp)
* @return integer number of cache files deleted
- */
- public function clear($resource_name, $cache_id, $compile_id, $exp_time)
+ */
+ public function clear(Smarty $smarty, $resource_name, $cache_id, $compile_id, $exp_time)
{
$_cache_id = isset($cache_id) ? preg_replace('![^\w\|]+!', '_', $cache_id) : null;
$_compile_id = isset($compile_id) ? preg_replace('![^\w\|]+!', '_', $compile_id) : null;
- $_dir_sep = $this->smarty->use_sub_dirs ? '/' : '^';
- $_compile_id_offset = $this->smarty->use_sub_dirs ? 3 : 0;
- $_dir = rtrim($this->smarty->cache_dir, '/\\') . DS;
+ $_dir_sep = $smarty->use_sub_dirs ? '/' : '^';
+ $_compile_id_offset = $smarty->use_sub_dirs ? 3 : 0;
+ $_dir = $smarty->getCacheDir();
$_dir_length = strlen($_dir);
if (isset($_cache_id)) {
$_cache_id_parts = explode('|', $_cache_id);
$_cache_id_parts_count = count($_cache_id_parts);
- if ($this->smarty->use_sub_dirs) {
+ if ($smarty->use_sub_dirs) {
foreach ($_cache_id_parts as $id_part) {
$_dir .= $id_part . DS;
- }
- }
- }
+ }
+ }
+ }
if (isset($resource_name)) {
- $_save_stat = $this->smarty->caching;
- $this->smarty->caching = true;
- $tpl = new $this->smarty->template_class($resource_name, $this->smarty);
- $this->smarty->caching = $_save_stat;
- if ($tpl->isExisting()) {
- $_resourcename_parts = basename(str_replace('^', '/', $tpl->getCachedFilepath()));
- // remove from template cache
- unset($this->smarty->template_objects[sha1($tpl->template_resource . $tpl->cache_id . $tpl->compile_id)]);
+ $_save_stat = $smarty->caching;
+ $smarty->caching = true;
+ $tpl = new $smarty->template_class($resource_name, $smarty);
+ $smarty->caching = $_save_stat;
+ if ($tpl->source->exists) {
+ $_resourcename_parts = basename(str_replace('^', '/', $tpl->cached->filepath));
+ // remove from template cache
+ unset($smarty->template_objects[sha1($tpl->template_resource . $tpl->cache_id . $tpl->compile_id)]);
} else {
- // remove from template cache
- unset($this->smarty->template_objects[sha1($tpl->template_resource . $tpl->cache_id . $tpl->compile_id)]);
+ // remove from template cache
+ unset($smarty->template_objects[sha1($tpl->template_resource . $tpl->cache_id . $tpl->compile_id)]);
return 0;
- }
- }
+ }
+ }
$_count = 0;
+ $_time = time();
if (file_exists($_dir)) {
$_cacheDirs = new RecursiveDirectoryIterator($_dir);
$_cache = new RecursiveIteratorIterator($_cacheDirs, RecursiveIteratorIterator::CHILD_FIRST);
foreach ($_cache as $_file) {
- if (substr($_file->getBasename(),0,1) == '.') continue;
+ if (substr($_file->getBasename(),0,1) == '.' || strpos($_file, '.svn') !== false) continue;
// directory ?
if ($_file->isDir()) {
if (!$_cache->isDot()) {
// delete folder if empty
@rmdir($_file->getPathname());
- }
+ }
} else {
$_parts = explode($_dir_sep, str_replace('\\', '/', substr((string)$_file, $_dir_length)));
- $_parts_count = count($_parts);
+ $_parts_count = count($_parts);
// check name
if (isset($resource_name)) {
if ($_parts[$_parts_count-1] != $_resourcename_parts) {
continue;
- }
- }
+ }
+ }
// check compile id
if (isset($_compile_id) && (!isset($_parts[$_parts_count-2 - $_compile_id_offset]) || $_parts[$_parts_count-2 - $_compile_id_offset] != $_compile_id)) {
continue;
- }
+ }
// check cache id
if (isset($_cache_id)) {
// count of cache id parts
$_parts_count = (isset($_compile_id)) ? $_parts_count - 2 - $_compile_id_offset : $_parts_count - 1 - $_compile_id_offset;
if ($_parts_count < $_cache_id_parts_count) {
continue;
- }
+ }
for ($i = 0; $i < $_cache_id_parts_count; $i++) {
if ($_parts[$i] != $_cache_id_parts[$i]) continue 2;
- }
- }
+ }
+ }
// expired ?
- if (isset($exp_time) && time() - @filemtime($_file) < $exp_time) {
+ if (isset($exp_time) && $_time - @filemtime($_file) < $exp_time) {
continue;
- }
+ }
$_count += @unlink((string) $_file) ? 1 : 0;
- }
- }
- }
+ }
+ }
+ }
return $_count;
- }
-}
+ }
+
+ /**
+ * Check is cache is locked for this template
+ *
+ * @param Smarty $smarty Smarty object
+ * @param Smarty_Template_Cached $cached cached object
+ * @return booelan true or false if cache is locked
+ */
+ public function hasLock(Smarty $smarty, Smarty_Template_Cached $cached)
+ {
+ if (version_compare(PHP_VERSION, '5.3.0', '>=')) {
+ clearstatcache(true, $cached->lock_id);
+ } else {
+ clearstatcache();
+ }
+ $t = @filemtime($cached->lock_id);
+ return $t && (time() - $t < $smarty->locking_timeout);
+ }
+
+ /**
+ * Lock cache for this template
+ *
+ * @param Smarty $smarty Smarty object
+ * @param Smarty_Template_Cached $cached cached object
+ */
+ public function acquireLock(Smarty $smarty, Smarty_Template_Cached $cached)
+ {
+ $cached->is_locked = true;
+ touch($cached->lock_id);
+ }
+
+ /**
+ * Unlock cache for this template
+ *
+ * @param Smarty $smarty Smarty object
+ * @param Smarty_Template_Cached $cached cached object
+ */
+ public function releaseLock(Smarty $smarty, Smarty_Template_Cached $cached)
+ {
+ $cached->is_locked = false;
+ @unlink($cached->lock_id);
+ }
+}
?> \ No newline at end of file