app/django/middleware/doc.py
author Todd Larsen <tlarsen@google.com>
Wed, 19 Nov 2008 21:05:31 +0000
changeset 506 deaf548efde3
parent 54 03e267d67478
permissions -rw-r--r--
Fix bug where script fails when it encounters a socket (which is not a regular file). Fix bug where exception is raised if error occurred before parser object was returned from _buildParser(). Add a --notext option, so that just the file paths will be output on matches (both find and find/replace); useful with xargs. Patch by: Todd Larsen

from django.conf import settings
from django import http

class XViewMiddleware(object):
    """
    Adds an X-View header to internal HEAD requests -- used by the documentation system.
    """
    def process_view(self, request, view_func, view_args, view_kwargs):
        """
        If the request method is HEAD and either the IP is internal or the
        user is a logged-in staff member, quickly return with an x-header
        indicating the view function.  This is used by the documentation module
        to lookup the view function for an arbitrary page.
        """
        if request.method == 'HEAD' and (request.META.get('REMOTE_ADDR') in settings.INTERNAL_IPS or (request.user.is_authenticated() and request.user.is_staff)):
            response = http.HttpResponse()
            response['X-View'] = "%s.%s" % (view_func.__module__, view_func.__name__)
            return response