Changeset 21918

Timestamp:

09/11/09 16:07:35 (4 years ago)

Author:

hartym

Message:

[1.3] fixed #4245. View cache manager now accepts params in factories.yml, added two params to enable or disable use of vary headers and host name in cache key generation, default to use all (as in symfony 1.0 1.1 and 1.2).

Files:

• branches/1.3/WHATS_NEW (modified) (1 diff)
• branches/1.3/lib/config/config/factories.yml (modified) (1 diff)
• branches/1.3/lib/config/sfFactoryConfigHandler.class.php (modified) (2 diffs)
• branches/1.3/lib/task/generator/skeleton/app/app/config/factories.yml (modified) (1 diff)
• branches/1.3/lib/view/sfViewCacheManager.class.php (modified) (5 diffs)
• branches/1.3/test/unit/view/sfViewCacheManagerTest.php (modified) (3 diffs)

branches/1.3/WHATS_NEW

@@ -886 +886 @@
-      <p>No results.</p>
-    <?php endif; ?>
+
+View cache
+----------
+
+The view cache manager nows accept params in factories.yml. Generating the
+cache key for a view has been refactored in different methods to ease extending the class.
+
+Two params are available in factories.yml:
+  * `cache_key_use_vary_headers` (default: true): specify if the cache keys
+    should include the vary headers part. In practice, it says if the page
+    cache should be http header dependent, as specified in `vary` cache
+    parameter.
+  * `cache_key_use_host_name` (default: true): specify if the cache keys should
+    include the host name part. In practice, it says if page cache should be
+    hostname dependant.
+

branches/1.3/lib/config/config/factories.yml

@@ -41 +41 @@
-  view_cache_manager:
-    class: sfViewCacheManager
+    param:
+      cache_key_use_vary_headers: true
+      cache_key_use_host_name:    true
-
-  view_cache:

branches/1.3/lib/config/sfFactoryConfigHandler.class.php

@@ -121 +121 @@
-                             "    \$class = sfConfig::get('sf_factory_view_cache', '%s');\n".
-                             "    \$cache = new \$class(sfConfig::get('sf_factory_view_cache_parameters', %s));\n".
-
+, %s
-                             "  }\n".
-                             "  else\n".
@@ -127 +127 @@
-                             "    \$this->factories['viewCacheManager'] = null;\n".
-                             "  }\n",
-
+, var_export($config['view_cache_manager']['param'], true)
-          break;
-

branches/1.3/lib/task/generator/skeleton/app/app/config/factories.yml

@@ -40 +40 @@
-      generate_shortest_url:            true
-      extra_parameters_as_query_string: true
+
+  view_cache_manager:
+    class: sfViewCacheManager
+    param:
+      cache_key_use_vary_headers: true
+      cache_key_use_host_name:    true

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

@@ -37 +37 @@
-   * @see initialize()
-   */
-
-
-
+, $options = array()
+
+, $options
-  }
-
@@ -48 +48 @@
-   * @param sfCache   $cache    An sfCache instance
-   */
-
+, $options = array()
-  {
-    $this->context    = $context;
-    $this->dispatcher = $context->getEventDispatcher();
-    $this->controller = $context->getController();
+    $this->options    = array_merge(array(
+        'cache_key_use_vary_headers' => true,
+        'cache_key_use_host_name'    => true,
+      ), $options);
-
-    if (sfConfig::get('sf_web_debug'))
@@ -158 +162 @@
-    }
-
+    $cacheKey = sprintf('/%s/%s/%s', $this->getCacheKeyHostNamePart($hostName), $this->getCacheKeyVaryHeaderPart($internalUri, $vary), $cacheKey);
+
+    // replace multiple /
+    $cacheKey = preg_replace('#/+#', '/', $cacheKey);
+
+    return $cacheKey;
+  }
+
+  /**
+   * Gets the vary header part of view cache key.
+   *
+   * @param  string $vary
+   * @return string
+   */
+  protected function getCacheKeyVaryHeaderPart($internalUri, $vary = '')
+  {
+    if (!$this->options['cache_key_use_vary_headers'])
+    {
+      return '';
+    }
+
-    // prefix with vary headers
-    if (!$vary)
-    {
-      $varyHeaders = $this->getVary($internalUri);
-
+
+
-      {
-
-
-
-
-
-
-
-
-
-
+
-      }
-
+
+
+
+
+
+
-      {
-= 'all
+.= $request->getHttpHeader($header).'|
-      }
-    }
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    if (!$hostName)
-    {
-request = $this->context->getReque
-  $hostName = $request->getHost();
-
+hostName = $this->context->getRequest()->getHo
+}
+
-    $hostName = preg_replace('/[^a-z0-9\*]/i', '_', $hostName);
-
-
-
-
-
-
-
-
+
+
+
-  }
-
@@ -397 +429 @@
-  /**
-   * Returns true if the action is cacheable.
- 
+
-   * @param  string $moduleName A module name
-   * @param  string $actionName An action or partial template name
- 
+
-   * @return boolean True if the action is cacheable
- 
+
-   * @see isCacheable()
-   */
@@ -668 +700 @@
-  /**
-   * Checks that the supplied parameters include a cache key.
- 
+
-   * If no 'sf_cache_key' parameter is present one is added to the array as
-   * it is passed by reference.
- 
+
-   * @param  array  $parameters An array of parameters
- 
+
-   * @return string The cache key
-   */

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

@@ -4 +4 @@
- * 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.
@@ -12 +12 @@
-require_once($_test_dir.'/unit/sfContextMock.class.php');
-
-3
+6
-
-class myViewCacheManager extends sfViewCacheManager
@@ -265 +265 @@
-  );
-}
+
+// ->initialize()
+$t->diag('Cache key generation options');
+$m = new myViewCacheManager($context, $cache = new myCache(), array('cache_key_use_vary_headers' => false));
+$t->is($m->generateCacheKey('mymodule/myaction'), '/localhost/mymodule/myaction', '->generateCacheKey() uses "cache_key_use_vary_headers" option to know if vary headers changes cache key.');
+
+$m = new myViewCacheManager($context, $cache = new myCache(), array('cache_key_use_host_name' => false));
+$t->is($m->generateCacheKey('mymodule/myaction'), '/all/mymodule/myaction', '->generateCacheKey() uses "cache_key_use_host_name" option to know if vary headers changes cache key.');
+
+$m = new myViewCacheManager($context, $cache = new myCache(), array('cache_key_use_host_name' => false, 'cache_key_use_vary_headers' => false));
+$t->is($m->generateCacheKey('mymodule/myaction'), '/mymodule/myaction', '->generateCacheKey() allows the use of both "cache_key_use_host_name" and "cache_key_use_vary_headers" options.');
+