bug #385 update to smarty-3.1.28-dev (from Github)

1 files changed, 175 insertions, 125 deletions

diff --git a/include/smarty/libs/sysplugins/smarty_cacheresource_keyvaluestore.php b/include/smarty/libs/sysplugins/smarty_cacheresource_keyvaluestore.php
index dff9b65aa..ee4021a19 100644
--- a/include/smarty/libs/sysplugins/smarty_cacheresource_keyvaluestore.php
+++ b/include/smarty/libs/sysplugins/smarty_cacheresource_keyvaluestore.php
@@ -2,44 +2,44 @@
 /**
  * Smarty Internal Plugin
  *
- * @package Smarty
+ * @package    Smarty
  * @subpackage Cacher
  */
 
 /**
  * Smarty Cache Handler Base for Key/Value Storage Implementations
- *
  * This class implements the functionality required to use simple key/value stores
  * for hierarchical cache groups. key/value stores like memcache or APC do not support
  * wildcards in keys, therefore a cache group cannot be cleared like "a|*" - which
  * is no problem to filesystem and RDBMS implementations.
- *
  * This implementation is based on the concept of invalidation. While one specific cache
  * can be identified and cleared, any range of caches cannot be identified. For this reason
  * each level of the cache group hierarchy can have its own value in the store. These values
  * are nothing but microtimes, telling us when a particular cache group was cleared for the
  * last time. These keys are evaluated for every cache read to determine if the cache has
  * been invalidated since it was created and should hence be treated as inexistent.
- *
  * Although deep hierarchies are possible, they are not recommended. Try to keep your
  * cache groups as shallow as possible. Anything up 3-5 parents should be ok. So
  * »a|b|c« is a good depth where »a|b|c|d|e|f|g|h|i|j|k« isn't. Try to join correlating
  * cache groups: if your cache groups look somewhat like »a|b|$page|$items|$whatever«
  * consider using »a|b|c|$page-$items-$whatever« instead.
  *
- * @package Smarty
+ * @package    Smarty
  * @subpackage Cacher
- * @author Rodney Rehm
+ * @author     Rodney Rehm
  */
-abstract class Smarty_CacheResource_KeyValueStore extends Smarty_CacheResource {
-
+abstract class Smarty_CacheResource_KeyValueStore extends Smarty_CacheResource
+{
     /**
      * cache for contents
+     *
      * @var array
      */
     protected $contents = array();
+
     /**
      * cache for timestamps
+     *
      * @var array
      */
     protected $timestamps = array();
@@ -47,16 +47,15 @@ abstract class Smarty_CacheResource_KeyValueStore extends Smarty_CacheResource {
     /**
      * populate Cached Object with meta data from Resource
      *
-     * @param Smarty_Template_Cached   $cached    cached object
-     * @param Smarty_Internal_Template $_template template object
+     * @param  Smarty_Template_Cached   $cached    cached object
+     * @param  Smarty_Internal_Template $_template template object
+     *
      * @return void
      */
     public function populate(Smarty_Template_Cached $cached, Smarty_Internal_Template $_template)
     {
-        $cached->filepath = $_template->source->uid
-                . '#' . $this->sanitize($cached->source->name)
-                . '#' . $this->sanitize($cached->cache_id)
-                . '#' . $this->sanitize($cached->compile_id);
+        $cached->filepath = $_template->source->uid . '#' . $this->sanitize($cached->source->resource) . '#' .
+            $this->sanitize($cached->cache_id) . '#' . $this->sanitize($cached->compile_id);
 
         $this->populateTimestamp($cached);
     }
@@ -64,7 +63,8 @@ abstract class Smarty_CacheResource_KeyValueStore extends Smarty_CacheResource {
     /**
      * populate Cached Object with timestamp and exists from Resource
      *
-     * @param Smarty_Template_Cached $cached cached object
+     * @param  Smarty_Template_Cached $cached cached object
+     *
      * @return void
      */
     public function populateTimestamp(Smarty_Template_Cached $cached)
@@ -80,11 +80,13 @@ abstract class Smarty_CacheResource_KeyValueStore extends Smarty_CacheResource {
     /**
      * Read the cached template and process the 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
+     * @param  Smarty_Internal_Template $_template template object
+     * @param  Smarty_Template_Cached   $cached    cached object
+     * @param bool                      $update    flag if called because cache update
+     *
+     * @return boolean                 true or false if the cached content does not exist
      */
-    public function process(Smarty_Internal_Template $_template, Smarty_Template_Cached $cached=null)
+    public function process(Smarty_Internal_Template $_template, Smarty_Template_Cached $cached = null, $update = false)
     {
         if (!$cached) {
             $cached = $_template->cached;
@@ -97,55 +99,92 @@ abstract class Smarty_CacheResource_KeyValueStore extends Smarty_CacheResource {
             }
         }
         if (isset($content)) {
+            /** @var Smarty_Internal_Template $_smarty_tpl
+             * used in evaluated code
+             */
             $_smarty_tpl = $_template;
             eval("?>" . $content);
+
             return true;
         }
+
         return false;
     }
 
     /**
      * Write the rendered template output to cache
      *
-     * @param Smarty_Internal_Template $_template template object
-     * @param string $content content to cache
-     * @return boolean success
+     * @param  Smarty_Internal_Template $_template template object
+     * @param  string                   $content   content to cache
+     *
+     * @return boolean                  success
      */
     public function writeCachedContent(Smarty_Internal_Template $_template, $content)
     {
         $this->addMetaTimestamp($content);
-        return $this->write(array($_template->cached->filepath => $content), $_template->properties['cache_lifetime']);
+
+        return $this->write(array($_template->cached->filepath => $content), $_template->cache_lifetime);
     }
 
     /**
-     * Empty cache
+     * Read cached template from cache
      *
+     * @param  Smarty_Internal_Template $_template template object
+     *
+     * @return string  content
+     */
+    public function readCachedContent(Smarty_Internal_Template $_template)
+    {
+        $content = $_template->cached->content ? $_template->cached->content : null;
+        $timestamp = null;
+        if ($content === null) {
+            if (!$this->fetch($_template->cached->filepath, $_template->source->name, $_template->cache_id, $_template->compile_id, $content, $timestamp, $_template->source->uid)) {
+                return false;
+            }
+        }
+        if (isset($content)) {
+            return $content;
+        }
+        return false;
+    }
+
+    /**
+     * Empty cache
      * {@internal the $exp_time argument is ignored altogether }}
      *
-     * @param Smarty  $smarty   Smarty object
-     * @param integer $exp_time expiration time [being ignored]
+     * @param  Smarty  $smarty   Smarty object
+     * @param  integer $exp_time expiration time [being ignored]
+     *
      * @return integer number of cache files deleted [always -1]
      * @uses purge() to clear the whole store
      * @uses invalidate() to mark everything outdated if purge() is inapplicable
      */
-    public function clearAll(Smarty $smarty, $exp_time=null)
+    public function clearAll(Smarty $smarty, $exp_time = null)
     {
         if (!$this->purge()) {
             $this->invalidate(null);
         }
-        return -1;
+        // remove from template cache
+        if (isset($smarty->_cache['template_objects'])) {
+            foreach ($smarty->_cache['template_objects'] as $key => $tpl) {
+                if (isset($tpl->cached)) {
+                    unset($smarty->_cache['template_objects'][$key]);
+                }
+            }
+        }
+        return - 1;
     }
 
     /**
      * Empty cache for a specific template
-     *
      * {@internal the $exp_time argument is ignored altogether}}
      *
-     * @param Smarty  $smarty        Smarty 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 [being ignored]
+     * @param  Smarty  $smarty        Smarty 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 [being ignored]
+     *
      * @return integer number of cache files deleted [always -1]
      * @uses buildCachedFilepath() to generate the CacheID
      * @uses invalidate() to mark CacheIDs parent chain as outdated
@@ -153,53 +192,54 @@ abstract class Smarty_CacheResource_KeyValueStore extends Smarty_CacheResource {
      */
     public function clear(Smarty $smarty, $resource_name, $cache_id, $compile_id, $exp_time)
     {
-        $uid = $this->getTemplateUid($smarty, $resource_name, $cache_id, $compile_id);
-        $cid = $uid . '#' . $this->sanitize($resource_name) . '#' . $this->sanitize($cache_id) . '#' . $this->sanitize($compile_id);
+        $uid = $this->getTemplateUid($smarty, $resource_name);
+        $cid = $uid . '#' . $this->sanitize($resource_name) . '#' . $this->sanitize($cache_id) . '#' .
+            $this->sanitize($compile_id);
         $this->delete(array($cid));
         $this->invalidate($cid, $resource_name, $cache_id, $compile_id, $uid);
-        return -1;
+        // remove from template cache
+        if (isset($resource_name) && isset($smarty->_cache['template_objects'])) {
+            if (isset($smarty->_cache['template_objects'])) {
+                foreach ($smarty->_cache['template_objects'] as $key => $tpl) {
+                    if ($tpl->source->uid == $uid && isset($tpl->cached)) {
+                        unset($smarty->_cache['template_objects'][$key]);
+                    }
+                }
+            }
+        }
+        return - 1;
     }
+
     /**
      * Get template's unique ID
      *
-     * @param Smarty $smarty        Smarty object
-     * @param string $resource_name template name
-     * @param string $cache_id      cache id
-     * @param string $compile_id    compile id
+     * @param  Smarty $smarty        Smarty object
+     * @param  string $resource_name template name
+     *
      * @return string filepath of cache file
+     * @throws \SmartyException
+     *
      */
-    protected function getTemplateUid(Smarty $smarty, $resource_name, $cache_id, $compile_id)
+    protected function getTemplateUid(Smarty $smarty, $resource_name)
     {
-        $uid = '';
         if (isset($resource_name)) {
-            $tpl = new $smarty->template_class($resource_name, $smarty);
-            if ($tpl->source->exists) {
-                $uid = $tpl->source->uid;
-            }
-            
-            // remove from template cache
-            if ($smarty->allow_ambiguous_resources) {
-                $_templateId = $tpl->source->unique_resource . $tpl->cache_id . $tpl->compile_id;
-            } else {
-                $_templateId = $smarty->joined_template_dir . '#' . $resource_name . $tpl->cache_id . $tpl->compile_id;
-            }
-            if (isset($_templateId[150])) {
-                $_templateId = sha1($_templateId);
+            $source = Smarty_Template_Source::load(null, $smarty, $resource_name);
+            if ($source->exists) {
+                return $source->uid;
             }
-            unset($smarty->template_objects[$_templateId]);
         }
-        return $uid;
+        return '';
     }
 
     /**
      * Sanitize CacheID components
      *
-     * @param string $string CacheID component to sanitize
+     * @param  string $string CacheID component to sanitize
+     *
      * @return string sanitized CacheID component
      */
     protected function sanitize($string)
     {
-        // some poeple smoke bad weed
         $string = trim($string, '|');
         if (!$string) {
             return null;
@@ -210,13 +250,14 @@ abstract class Smarty_CacheResource_KeyValueStore extends Smarty_CacheResource {
     /**
      * Fetch and prepare a cache object.
      *
-     * @param string  $cid           CacheID to fetch
-     * @param string  $resource_name template name
-     * @param string  $cache_id      cache id
-     * @param string  $compile_id    compile id
-     * @param string  $content       cached content
-     * @param integer &$timestamp    cached timestamp (epoch)
-     * @param string  $resource_uid  resource's uid
+     * @param  string  $cid           CacheID to fetch
+     * @param  string  $resource_name template name
+     * @param  string  $cache_id      cache id
+     * @param  string  $compile_id    compile id
+     * @param  string  $content       cached content
+     * @param  integer &$timestamp    cached timestamp (epoch)
+     * @param  string  $resource_uid  resource's uid
+     *
      * @return boolean success
      */
     protected function fetch($cid, $resource_name = null, $cache_id = null, $compile_id = null, &$content = null, &$timestamp = null, $resource_uid = null)
@@ -238,7 +279,6 @@ abstract class Smarty_CacheResource_KeyValueStore extends Smarty_CacheResource {
 
     /**
      * Add current microtime to the beginning of $cache_content
-     *
      * {@internal the header uses 8 Bytes, the first 4 Bytes are the seconds, the second 4 Bytes are the microseconds}}
      *
      * @param string &$content the content to be cached
@@ -253,25 +293,25 @@ abstract class Smarty_CacheResource_KeyValueStore extends Smarty_CacheResource {
     /**
      * Extract the timestamp the $content was cached
      *
-     * @param string &$content the cached content
-     * @return float the microtime the content was cached
+     * @param  string &$content the cached content
+     *
+     * @return float  the microtime the content was cached
      */
     protected function getMetaTimestamp(&$content)
     {
-        $s = unpack("N", substr($content, 0, 4));
-        $m = unpack("N", substr($content, 4, 4));
-        $content = substr($content, 8);
-        return $s[1] + ($m[1] / 100000000);
+        extract(unpack('N1s/N1m/a*content', $content));
+        return $s + ($m / 100000000);
     }
 
     /**
      * Invalidate CacheID
      *
-     * @param string $cid           CacheID
-     * @param string $resource_name template name
-     * @param string $cache_id      cache id
-     * @param string $compile_id    compile id
-     * @param string $resource_uid  source's uid
+     * @param  string $cid           CacheID
+     * @param  string $resource_name template name
+     * @param  string $cache_id      cache id
+     * @param  string $compile_id    compile id
+     * @param  string $resource_uid  source's uid
+     *
      * @return void
      */
     protected function invalidate($cid = null, $resource_name = null, $cache_id = null, $compile_id = null, $resource_uid = null)
@@ -281,22 +321,24 @@ abstract class Smarty_CacheResource_KeyValueStore extends Smarty_CacheResource {
         // invalidate everything
         if (!$resource_name && !$cache_id && !$compile_id) {
             $key = 'IVK#ALL';
-        }
-        // invalidate all caches by template
-        else if ($resource_name && !$cache_id && !$compile_id) {
-            $key = 'IVK#TEMPLATE#' . $resource_uid . '#' . $this->sanitize($resource_name);
-        }
-        // invalidate all caches by cache group
-        else if (!$resource_name && $cache_id && !$compile_id) {
-            $key = 'IVK#CACHE#' . $this->sanitize($cache_id);
-        }
-        // invalidate all caches by compile id
-        else if (!$resource_name && !$cache_id && $compile_id) {
-            $key = 'IVK#COMPILE#' . $this->sanitize($compile_id);
-        }
-        // invalidate by combination
+        } // invalidate all caches by template
         else {
-            $key = 'IVK#CID#' . $cid;
+            if ($resource_name && !$cache_id && !$compile_id) {
+                $key = 'IVK#TEMPLATE#' . $resource_uid . '#' . $this->sanitize($resource_name);
+            } // invalidate all caches by cache group
+            else {
+                if (!$resource_name && $cache_id && !$compile_id) {
+                    $key = 'IVK#CACHE#' . $this->sanitize($cache_id);
+                } // invalidate all caches by compile id
+                else {
+                    if (!$resource_name && !$cache_id && $compile_id) {
+                        $key = 'IVK#COMPILE#' . $this->sanitize($compile_id);
+                    } // invalidate by combination
+                    else {
+                        $key = 'IVK#CID#' . $cid;
+                    }
+                }
+            }
         }
         $this->write(array($key => $now));
     }
@@ -304,12 +346,13 @@ abstract class Smarty_CacheResource_KeyValueStore extends Smarty_CacheResource {
     /**
      * Determine the latest timestamp known to the invalidation chain
      *
-     * @param string $cid           CacheID to determine latest invalidation timestamp of
-     * @param string $resource_name template name
-     * @param string $cache_id      cache id
-     * @param string $compile_id    compile id
-     * @param string $resource_uid  source's filepath
-     * @return float the microtime the CacheID was invalidated
+     * @param  string $cid           CacheID to determine latest invalidation timestamp of
+     * @param  string $resource_name template name
+     * @param  string $cache_id      cache id
+     * @param  string $compile_id    compile id
+     * @param  string $resource_uid  source's filepath
+     *
+     * @return float  the microtime the CacheID was invalidated
      */
     protected function getLatestInvalidationTimestamp($cid, $resource_name = null, $cache_id = null, $compile_id = null, $resource_uid = null)
     {
@@ -321,27 +364,28 @@ abstract class Smarty_CacheResource_KeyValueStore extends Smarty_CacheResource {
         if (!($_cid = $this->listInvalidationKeys($cid, $resource_name, $cache_id, $compile_id, $resource_uid))) {
             return 0;
         }
-        
+
         // there are no InValidationKeys
         if (!($values = $this->read($_cid))) {
             return 0;
         }
         // make sure we're dealing with floats
         $values = array_map('floatval', $values);
+
         return max($values);
     }
 
     /**
      * Translate a CacheID into the list of applicable InvalidationKeys.
-     *
      * Splits "some|chain|into|an|array" into array( '#clearAll#', 'some', 'some|chain', 'some|chain|into', ... )
      *
-     * @param string $cid           CacheID to translate
-     * @param string $resource_name template name
-     * @param string $cache_id      cache id
-     * @param string $compile_id    compile id
-     * @param string $resource_uid  source's filepath
-     * @return array list of InvalidationKeys
+     * @param  string $cid           CacheID to translate
+     * @param  string $resource_name template name
+     * @param  string $cache_id      cache id
+     * @param  string $compile_id    compile id
+     * @param  string $resource_uid  source's filepath
+     *
+     * @return array  list of InvalidationKeys
      * @uses $invalidationKeyPrefix to prepend to each InvalidationKey
      */
     protected function listInvalidationKeys($cid, $resource_name = null, $cache_id = null, $compile_id = null, $resource_uid = null)
@@ -357,7 +401,6 @@ abstract class Smarty_CacheResource_KeyValueStore extends Smarty_CacheResource {
             $t[] = 'IVK#COMPILE' . $_compile;
         }
         $_name .= '#';
-        // some poeple smoke bad weed
         $cid = trim($cache_id, '|');
         if (!$cid) {
             return $t;
@@ -378,30 +421,35 @@ abstract class Smarty_CacheResource_KeyValueStore extends Smarty_CacheResource {
             $t[] = 'IVK#CACHE#' . $part;
             $t[] = 'IVK#CID' . $_name . $part . $_compile;
             // skip past delimiter position
-            $i++;
+            $i ++;
         }
+
         return $t;
     }
 
     /**
      * 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
+     * @param  Smarty                 $smarty Smarty object
+     * @param  Smarty_Template_Cached $cached cached object
+     *
+     * @return boolean               true or false if cache is locked
      */
     public function hasLock(Smarty $smarty, Smarty_Template_Cached $cached)
     {
         $key = 'LOCK#' . $cached->filepath;
         $data = $this->read(array($key));
+
         return $data && time() - $data[$key] < $smarty->locking_timeout;
     }
 
     /**
      * Lock cache for this template
      *
-     * @param Smarty $smarty Smarty object
+     * @param Smarty                 $smarty Smarty object
      * @param Smarty_Template_Cached $cached cached object
+     *
+     * @return bool|void
      */
     public function acquireLock(Smarty $smarty, Smarty_Template_Cached $cached)
     {
@@ -413,8 +461,10 @@ abstract class Smarty_CacheResource_KeyValueStore extends Smarty_CacheResource {
     /**
      * Unlock cache for this template
      *
-     * @param Smarty $smarty Smarty object
+     * @param Smarty                 $smarty Smarty object
      * @param Smarty_Template_Cached $cached cached object
+     *
+     * @return bool|void
      */
     public function releaseLock(Smarty $smarty, Smarty_Template_Cached $cached)
     {
@@ -426,27 +476,30 @@ abstract class Smarty_CacheResource_KeyValueStore extends Smarty_CacheResource {
     /**
      * Read values for a set of keys from cache
      *
-     * @param array $keys list of keys to fetch
+     * @param  array $keys list of keys to fetch
+     *
      * @return array list of values with the given keys used as indexes
      */
-    protected abstract function read(array $keys);
+    abstract protected function read(array $keys);
 
     /**
      * Save values for a set of keys to cache
      *
-     * @param array $keys   list of values to save
-     * @param int   $expire expiration time
+     * @param  array $keys   list of values to save
+     * @param  int   $expire expiration time
+     *
      * @return boolean true on success, false on failure
      */
-    protected abstract function write(array $keys, $expire=null);
+    abstract protected function write(array $keys, $expire = null);
 
     /**
      * Remove values from cache
      *
-     * @param array $keys list of keys to delete
+     * @param  array $keys list of keys to delete
+     *
      * @return boolean true on success, false on failure
      */
-    protected abstract function delete(array $keys);
+    abstract protected function delete(array $keys);
 
     /**
      * Remove *all* values from cache
@@ -457,7 +510,4 @@ abstract class Smarty_CacheResource_KeyValueStore extends Smarty_CacheResource {
     {
         return false;
     }
-
 }
-
-?>
\ No newline at end of file