require XMLHttpRequest view decorator

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from django.http import Http404
def require_xhr():
    """
    Decorator to make a view only accept requests from AJAX calls. Usage::

        @require_xhr()
        def my_view(request):
            # Returns data
            # ...
    """
    def decorator(func):
        def inner(request, *args, **kwargs):
            if request.META.get('HTTP_X_REQUESTED_WITH') != 'XMLHttpRequest':
                raise Http404
            return func(request, *args, **kwargs)
        return inner
    return decorator

Comments

daevaorn (on January 29, 2008):

May be better solution: 

def require_xhr( func ):
    """
    Usage:
       @require_xhr
       def my_view(request):
           pass
    """
    def _decorator(request, *args, **kwargs):
        if request.META.get('HTTP_X_REQUESTED_WITH', "") != 'XMLHttpRequest':
            return HttpResponseNotAllowed()
        return func(request, *args, **kwargs)
    _decorator.__name__ = func.__name__
    _decorator.__doc___ = func.__doc___
    _decorator.__module___ = func.__module__
    return _decorator

#

derelm (on January 29, 2008):

@daevaorn:

HttpResponseNotAllowed requires a 2nd argument specifying the allowed methods, so it's not of use here

#

skam (on January 30, 2008):

Changed HttpResponseNotAllowed to Http404 exception

#

skam (on April 11, 2008):

is_ajax method was added to request objects:

http://code.djangoproject.com/ticket/6616

#

(Forgotten your password?)

You may use Markdown syntax here, but raw HTML will be removed.