Changeset 7787

Timestamp:

03/09/08 17:38:15 (6 months ago)

Author:

francois

Message:

Changed the way sfViewCacheManager deals with internal cache keys:

• Allows sfViewCacheManager::remove() to accept URIs with wildcards for any type of cache (bye, bye, sfToolkit::clearGlob())
  
• It is now possible to empty partial cache selectively
  
• It is now possible to empty contextual partial cache selectively
  
• It is possible to empty cache for all hosts and vary headers
  
• And the remove() method is totally cache engine agnostic (works with sfFileCache, sfSQLiteCache, sfMemcacheCache, etc.)
  
• Not to mention the fact that it is now much easier to explain how to remove something from the cache...
  

Files:

• branches/1.1/lib/view/sfViewCacheManager.class.php (modified) (5 diffs)
• branches/1.1/test/unit/view/sfViewCacheManagerTest.php (modified) (7 diffs)

branches/1.1/lib/view/sfViewCacheManager.class.php

@@ -59 +59 @@
-    // cache instance
-    $this->cache = $cache;
-
-egister a named route for our partial cache (at the end)
+
+outing instance
-    $this->routing = $context->getRouting();
-    if (!$this->routing->hasRouteName('sf_cache_partial'))
-    {
-      $this->routing->connect('sf_cache_partial', '/sf_cache_partial/:module/:action/:sf_cache_key.', array(), array());
-    }
-  }
-
@@ -90 +86 @@
-  /**
-   * Generates a unique cache key for an internal URI.
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-   *
-   * @return string The cache key
-
-
+
+
+
-  {
-    if ($callable = sfConfig::get('sf_cache_namespace_callable'))
@@ -104 +116 @@
-      }
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
-    if ($this->isContextual($internalUri))
-    {
+      // Contextual partial
+      if(!$contextualPrefix)
+      {
+        list($route_name, $params) = $this->controller->convertUrlStringToParameters($this->routing->getCurrentInternalUri());
+        $cacheKey = $this->convertParametersToKey($params);
+      }
+      else
+      {
+        $cacheKey = $contextualPrefix;
+      }
-      list($route_name, $params) = $this->controller->convertUrlStringToParameters($internalUri);
-uri = $this->controller->genUrl($this->routing->getCurrentInternalUri()).
+cacheKey .= 
-    }
-    else
-    {
-
-
-
-
+
+
+
+
+
+
+
+
+
-    // prefix with vary headers
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-      $request = $this->context->getRequest();
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
-
-    // replace multiple /
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-  /**
-   * Adds a cache to the manager.
@@ -407 +470 @@
-   *
-   * @param string Internal uniform resource identifier
-
-
-
-
+
+
+
+
+
+
+
-  {
-    if (sfConfig::get('sf_logging_enabled'))
@@ -416 +482 @@
-      $this->dispatcher->notify(new sfEvent($this, 'application.log', array(sprintf('Remove cache for "%s"', $internalUri))));
-    }
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
-    }
-  }

branches/1.1/test/unit/view/sfViewCacheManagerTest.php

@@ -12 +12 @@
-require_once($_test_dir.'/unit/sfContextMock.class.php');
-
-11
+33
-
-class myController extends sfWebController
@@ -61 +61 @@
-  public function removePattern($pattern, $delimiter = ':')
-  {
+    $pattern = '#^' . str_replace('*', '.*', $pattern) . '$#';
+    foreach(self::$cache as $key => $value)
+    {
+      if(preg_match($pattern, $key))
+      {
+        unset(self::$cache[$key]);
+      }
+    }
+  }
+
+  public function clean($mode = sfCache::ALL)
+  {
-    self::$cache = array();
-  }
-
-
+
+
+
+
+
+
+
+
+
+
+
-  {
-    self::$cache = array();
-  }
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
-
-$r = $context->routing;
@@ -95 +110 @@
-$t->is($m->getCache(), $cache, '->initialize() takes a sfCache object as its second argument');
-
+// ->generateCacheKey()
+$t->diag('->generateCacheKey');
+$t->is($m->generateCacheKey('mymodule/myaction'), '/localhost/all/mymodule/myaction', '->generateCacheKey() creates a simple cache key from an internal URI');
+$t->is($m->generateCacheKey('mymodule/myaction', 'foo'), '/foo/all/mymodule/myaction', '->generateCacheKey() can take a hostName as second parameter');
+$t->is($m->generateCacheKey('mymodule/myaction', null, 'bar'), '/localhost/bar/mymodule/myaction', '->generateCacheKey() can take a serialized set of vary headers as third parameter');
+
+$t->is($m->generateCacheKey('mymodule/myaction?key1=value1&key2=value2'), '/localhost/all/mymodule/myaction/key1/value1/key2/value2', '->generateCacheKey() includes request parameters as key/value pairs');
+$t->is($m->generateCacheKey('mymodule/myaction?akey=value1&ckey=value2&bkey=value3'), '/localhost/all/mymodule/myaction/akey/value1/bkey/value3/ckey/value2', '->generateCacheKey() reorders request parameters alphabetically');
+
+try
+{
+  $m->generateCacheKey('@rule?key=value');
+  $t->fail('->generateCacheKey() throws an sfException when passed an internal URI with a rule');
+}
+catch(sfException $e)
+{
+  $t->pass('->generateCacheKey() throws an sfException when passed an internal URI with a rule');
+}
+try
+{
+  $m->generateCacheKey('@sf_cache_partial?module=mymodule&action=myaction');
+  $t->pass('->generateCacheKey() does not throw an sfException when passed an internal URI with a @sf_cache_partial rule');
+}
+catch(sfException $e)
+{
+  $t->fail('->generateCacheKey() does not throw an sfException when passed an internal URI with a @sf_cache_partial rule');
+}
+try
+{
+  $m->generateCacheKey('@sf_cache_partial?key=value');
+  $t->fail('->generateCacheKey() throws an sfException when passed an internal URI with a @sf_cache_partial rule with no module or action param');
+}
+catch(sfException $e)
+{
+  $t->pass('->generateCacheKey() throws an sfException when passed an internal URI with a @sf_cache_partial rule with no module or action param');
+}
+
+$t->is($m->generateCacheKey('@sf_cache_partial?module=foo&action=bar&sf_cache_key=value'), '/localhost/all/sf_cache_partial/foo/bar/sf_cache_key/value', '->generateCacheKey() can deal with internal URIs to partials');
+
+$m = get_cache_manager($context);
+$m->addCache('foo', 'bar', get_cache_config(true));
+$t->is($m->generateCacheKey('@sf_cache_partial?module=foo&action=bar&sf_cache_key=value'), '/localhost/all/currentModule/currentAction/currentKey/currentValue/foo/bar/value', '->generateCacheKey() can deal with internal URIs to contextual partials');
+
+$t->is($m->generateCacheKey('@sf_cache_partial?module=foo&action=bar&sf_cache_key=value', null, null, 'baz'), '/localhost/all/baz/foo/bar/value', '->generateCacheKey() can take a prefix for contextual partials as fourth parameter');
+
+
-// ->generateNamespace()
-$t->diag('->generateNamespace()');
@@ -116 +177 @@
-$t->is($m->set('test', 'module/action'), true, '->set() returns true if the action is cacheable');
-
+$m = get_cache_manager($context);
+$m->addCache('module', 'action', get_cache_config());
+$m->set('test', 'module/action');
+$t->is($m->get('module/action'), 'test', '->set() stores the first parameter in a key computed from the second parameter');
+
+$m = get_cache_manager($context);
+$m->addCache('module', 'action', get_cache_config());
+$m->set('test', 'module/action?key1=value1');
+$t->is($m->get('module/action?key1=value1'), 'test', '->set() works with URIs with parameters');
+$t->is($m->get('module/action?key2=value2'), null, '->set() stores a different version for each set of parameters');
+$t->is($m->get('module/action'), null, '->set() stores a different version for each set of parameters');
+
+$m = get_cache_manager($context);
+$m->addCache('module', 'action', get_cache_config());
+$m->set('test', '@sf_cache_partial?module=module&action=action');
+$t->is($m->get('@sf_cache_partial?module=module&action=action'), 'test', '->set() accepts keys to partials');
+
+$m = get_cache_manager($context);
+$m->addCache('module', 'action', get_cache_config(true));
+$m->set('test', '@sf_cache_partial?module=module&action=action');
+$t->is($m->get('@sf_cache_partial?module=module&action=action'), 'test', '->set() accepts keys to contextual partials');
+
-// ->get()
-$t->diag('->get()');
@@ -141 +224 @@
-$t->is($m->has('module/action'), false, '->remove() removes cache content for an action');
-
+$m->set('test', 'module/action?key1=value1');
+$m->set('test', 'module/action?key2=value2');
+$m->remove('module/action?key1=value1');
+$t->is($m->has('module/action?key1=value1'), false, '->remove() removes accepts an internal URI as first parameter');
+$t->is($m->has('module/action?key2=value2'), true, '->remove() does not remove cache content for keys not matching the internal URI');
+
+$m = get_cache_manager($context);
+$m->addCache('module', 'action', get_cache_config());
+$m->set('test', 'module/action?key1=value1');
+$m->set('test', 'module/action?key1=value2');
+$m->set('test', 'module/action?key2=value1');
+$m->remove('module/action?key1=*');
+$t->is($m->has('module/action?key1=value1'), false, '->remove() accepts wildcards in URIs and then removes all keys matching the pattern');
+$t->is($m->has('module/action?key1=value2'), false, '->remove() accepts wildcards in URIs and then removes all keys matching the pattern');
+$t->is($m->has('module/action?key2=value1'), true, '->remove() accepts wildcards in URIs and lets keys not matching the pattern unchanged');
+
-function get_cache_manager($context)
-{
@@ -149 +248 @@
-}
-
-
+$contextual = false
-{
-  return array(
@@ -155 +254 @@
-    'lifeTime'       => 86400,
-    'clientLifeTime' => 86400,
-false
+$contextual
-    'vary'           => array(),
-  );