app/django/views/decorators/cache.py
author Todd Larsen <tlarsen@google.com>
Thu, 28 Aug 2008 23:54:35 +0000
changeset 119 50d8d58dcd7c
parent 54 03e267d67478
permissions -rw-r--r--
Add soc.views.simple containing (initially) two simple template views. templateWithLinkName() is a view that can replace most public() read-only views. errorResponse() is a view that renders an error page for out_of_band.ErrorResponse exceptions. Also, change response_helpers.respond() to accept keyword arguments to pass to http.HttpResponse(). (errorResponse() makes use of this new respond() feature.) Patch by: Todd Larsen Review by: to-be-reviewed

"""
Decorator for views that tries getting the page from the cache and
populates the cache if the page isn't in the cache yet.

The cache is keyed by the URL and some data from the headers. Additionally
there is the key prefix that is used to distinguish different cache areas
in a multi-site setup. You could use the sites.get_current().domain, for
example, as that is unique across a Django project.

Additionally, all headers from the response's Vary header will be taken into
account on caching -- just like the middleware does.
"""

try:
    from functools import wraps
except ImportError:
    from django.utils.functional import wraps  # Python 2.3, 2.4 fallback.

from django.utils.decorators import decorator_from_middleware
from django.utils.cache import patch_cache_control, add_never_cache_headers
from django.middleware.cache import CacheMiddleware

cache_page = decorator_from_middleware(CacheMiddleware)

def cache_control(**kwargs):

    def _cache_controller(viewfunc):

        def _cache_controlled(request, *args, **kw):
            response = viewfunc(request, *args, **kw)
            patch_cache_control(response, **kwargs)
            return response

        return wraps(viewfunc)(_cache_controlled)

    return _cache_controller

def never_cache(view_func):
    """
    Decorator that adds headers to a response so that it will
    never be cached.
    """
    def _wrapped_view_func(request, *args, **kwargs):
        response = view_func(request, *args, **kwargs)
        add_never_cache_headers(response)
        return response
    return wraps(view_func)(_wrapped_view_func)