Ticket #5691: 5691.2.patch

django/utils/cache.py

@@ -29 +29 @@
 from django.utils.encoding import smart_str, iri_to_uri
 from django.utils.http import http_date
 from django.utils.hashcompat import md5_constructor
+from django.utils import translation 
 from django.http import HttpRequest
 
 cc_delim_re = re.compile(r'\s*,\s*')
@@ -145 +146 @@
         if value is not None:
             ctx.update(value)
     path = md5_constructor(iri_to_uri(request.path))
-    return 'views.decorators.cache.cache_page.%s.%s.%s' % (
-               key_prefix, path.hexdigest(), ctx.hexdigest())
+    cache_key = 'views.decorators.cache.cache_page.%s.%s.%s' % (
+        key_prefix, path.hexdigest(), ctx.hexdigest()) 
+    if settings.USE_I18N: 
+        cache_key += ".%s" % translation.get_language() 
+    return cache_key 
 
 def _generate_cache_header_key(key_prefix, request):
     """Returns a cache key for the header cache."""
@@ -166 +170 @@
     if key_prefix is None:
         key_prefix = settings.CACHE_MIDDLEWARE_KEY_PREFIX
     cache_key = _generate_cache_header_key(key_prefix, request)
+    if settings.USE_I18N: 
+        cache_key += ".%s" % translation.get_language() 
     headerlist = cache.get(cache_key, None)
     if headerlist is not None:
         return _generate_cache_key(request, headerlist, key_prefix)
@@ -190 +196 @@
     if cache_timeout is None:
         cache_timeout = settings.CACHE_MIDDLEWARE_SECONDS
     cache_key = _generate_cache_header_key(key_prefix, request)
+    if settings.USE_I18N: 
+        cache_key += ".%s" % translation.get_language() 
     if response.has_header('Vary'):
         headerlist = ['HTTP_'+header.upper().replace('-', '_')
                       for header in cc_delim_re.split(response['Vary'])]

tests/regressiontests/cache/tests.py

@@ -14 +14 @@
 from django.core.cache import get_cache
 from django.core.cache.backends.base import InvalidCacheBackendError
 from django.http import HttpResponse, HttpRequest
+from django.middleware.cache import FetchFromCacheMiddleware, UpdateCacheMiddleware 
+from django.utils import translation 
 from django.utils.cache import patch_vary_headers, get_cache_key, learn_cache_key
 from django.utils.hashcompat import md5_constructor
 from regressiontests.cache.models import Poll, expensive_calculation
@@ -458 +460 @@
         learn_cache_key(request, response)
         self.assertEqual(get_cache_key(request), 'views.decorators.cache.cache_page.settingsprefix.a8c87a3d8c44853d7f79474f7ffe4ad5.d41d8cd98f00b204e9800998ecf8427e')
 
+class CacheI18nTest(unittest.TestCase): 
+    def setUp(self):  
+        self.orig_cache_middleware_seconds = settings.CACHE_MIDDLEWARE_SECONDS 
+        self.orig_cache_middleware_key_prefix = settings.CACHE_MIDDLEWARE_KEY_PREFIX 
+        self.orig_cache_backend = settings.CACHE_BACKEND 
+        self.orig_use_i18n = settings.USE_I18N 
+        self.orig_languages =  settings.LANGUAGES
+ 
+        settings.LANGUAGES = ( 
+                ('en', 'English'), 
+                ('es', 'Spanish'), 
+        )
+        self.path = '/cache/test/'
+        settings.CACHE_MIDDLEWARE_KEY_PREFIX = 'settingsprefix'
+        settings.CACHE_MIDDLEWARE_SECONDS
+        self.path = '/cache/test/'
+        
+ 
+    def tearDown(self): 
+        settings.CACHE_MIDDLEWARE_SECONDS = self.orig_cache_middleware_seconds 
+        settings.CACHE_MIDDLEWARE_KEY_PREFIX = self.orig_cache_middleware_key_prefix 
+        settings.CACHE_BACKEND = self.orig_cache_backend 
+        settings.USE_I18N = self.orig_use_i18n 
+        settings.LANGUAGES = self.orig_languages 
+        translation.deactivate() 
+ 
+    def _get_request(self): 
+        request = HttpRequest() 
+        request.META = { 
+            'SERVER_NAME': 'testserver', 
+            'SERVER_PORT': 80, 
+        } 
+        request.path = request.path_info = self.path
+        return request 
+ 
+    def _get_request_cache(self): 
+        request = HttpRequest() 
+        request.META = { 
+            'SERVER_NAME': 'testserver', 
+            'SERVER_PORT': 80, 
+        } 
+        request.path = request.path_info = self.path
+        request._cache_update_cache = True 
+        request.method = 'GET' 
+        request.session = {} 
+        return request 
+ 
+    def test_cache_key_i18n(self): 
+        settings.USE_I18N = True 
+        request = self._get_request() 
+        lang = translation.get_language() 
+        response = HttpResponse() 
+        key = learn_cache_key(request, response) 
+        self.assertTrue(key.endswith(lang), "Cache keys should include the language name when i18n is active") 
+        key2 = get_cache_key(request) 
+        self.assertEqual(key, key2) 
+ 
+    def test_cache_key_no_i18n (self): 
+        settings.USE_I18N = False 
+        request = self._get_request() 
+        lang = translation.get_language() 
+        response = HttpResponse() 
+        key = learn_cache_key(request, response) 
+        self.assertFalse(key.endswith(lang), "Cache keys shouldn't include the language name when i18n is inactive") 
+ 
+    def test_middleware(self): 
+ 
+        def set_cache(request, lang, msg): 
+            translation.activate(lang) 
+            response = HttpResponse() 
+            response.content= msg 
+            return UpdateCacheMiddleware().process_response(request, response) 
+ 
+        settings.CACHE_MIDDLEWARE_SECONDS = 60 
+        settings.CACHE_MIDDLEWARE_KEY_PREFIX="test" 
+        settings.CACHE_BACKEND='locmem:///' 
+        settings.USE_I18N = True 
+        en_message ="Hello world!" 
+        es_message ="Hola mundo!" 
+ 
+        request = self._get_request_cache() 
+        set_cache(request, 'en', en_message) 
+        get_cache_data = FetchFromCacheMiddleware().process_request(request) 
+        # Check that we can recover the cache 
+        self.assertNotEqual(get_cache_data.content, None) 
+        self.assertEqual(en_message, get_cache_data.content) 
+        # change the session language and set content 
+        request = self._get_request_cache() 
+        set_cache(request, 'es', es_message) 
+        # change again the language 
+        translation.activate('en') 
+        # retrieve the content from cache 
+        get_cache_data = FetchFromCacheMiddleware().process_request(request) 
+        self.assertEqual(get_cache_data.content, en_message) 
+        # change again the language 
+        translation.activate('es') 
+        get_cache_data = FetchFromCacheMiddleware().process_request(request) 
+        self.assertEqual(get_cache_data.content, es_message) 
+
 if __name__ == '__main__':
     unittest.main()

docs/topics/cache.txt

@@ -320 +320 @@
 the ``never_cache`` decorator). See the `using other headers`__ section for
 more on these decorators.
 
+.. versionadded:: 1.2
+
+If USE_I18N is set to True the generated cache key would include the language name.
+
 __ `Controlling cache: Using other headers`_
 
 The per-view cache