djangofloor.middleware

HttpRequest and WindowInfo middlewares

Two kinds of middlewares are provided:

• standard Django middleware,
• middlewares for populating djangofloor.wsgi.window_info.WindowInfo

The DjangoFloorMiddleware provides several things:

• authenticates users with the settings.DF_REMOTE_USER_HEADER HTTP header,
• generates a unique ID and add it to the django.http.request.HttpRequest,
• add the ‘X-UA-Compatible’ header to the response,
• if settings.DF_FAKE_AUTHENTICATION_USERNAME and the settings.DEBUG are set, a username is set, for simplifying debug sessions,
• overrides the ‘REMOTE_ADDR’ META attribute since your project is assumed to be run behind a reverse proxy,
• if the HTTP_AUTHORIZATION header is set, use it for authenticating users (HTTP basic auth)

The class WindowInfoMiddleware allows to:

• populate a new djangofloor.wsgi.window_info.WindowInfo from a django.http.request.HttpRequest,
• serialize a djangofloor.wsgi.window_info.WindowInfo to a dict,
• populate a new djangofloor.wsgi.window_info.WindowInfo from a dict,,
• populate a template context from a djangofloor.wsgi.window_info.WindowInfo object,
• build an empty djangofloor.wsgi.window_info.WindowInfo,
• install new methods to the djangofloor.wsgi.window_info.WindowInfo class.

class djangofloor.middleware.BasicAuthMiddleware(get_response=None)

Deprecated class, replaced by djangofloor.middleware.DjangoFloorMiddleware

process_request(request)

class djangofloor.middleware.BrowserMiddleware

add attributes related to the browser (currently only the HTTP_USER_AGENT header)

from_dict(window_info, values)

from_request(request, window_info)

get_context(window_info)

new_window_info(window_info)

to_dict(window_info)

class djangofloor.middleware.DjangoAuthMiddleware

handle attributes related to the django.contrib.auth framework

from_dict(window_info, values)

from_request(request, window_info)

get_context(window_info)

provide the same context data as the django.contrib.auth.context_processors:

• user: a user or django.contrib.auth.models.AnonymousUser
• perms, with the same meaning

install_methods(window_info_cls)

new_window_info(window_info)

to_dict(window_info)

class djangofloor.middleware.DjangoFloorMiddleware(get_response=None)

Like django.contrib.auth.middleware.RemoteUserMiddleware but:

• can use any header defined by the setting DF_REMOTE_USER_HEADER,
• handle the HTTP_X_FORWARDED_FOR HTTP header (set the right client IP)
• handle HTTP basic authentication
• set response header for Internet Explorer (to use its most recent render engine)

ajax_header = 'HTTP_WINDOW_KEY'

format_remote_username(remote_username)

header = None

process_request(request: django.http.request.HttpRequest)

process_response(request, response)

remote_user_authentication(request, username)

class djangofloor.middleware.Djangoi18nMiddleware

Add attributes required for using i18n-related functions.

from_dict(window_info, values)

from_request(request, window_info)

get_context(window_info)

new_window_info(window_info)

to_dict(window_info)

class djangofloor.middleware.FakeAuthenticationMiddleware(get_response=None)

Deprecated class, replaced by djangofloor.middleware.DjangoFloorMiddleware

group_cache = {}

process_request(request)

class djangofloor.middleware.IEMiddleware(get_response=None)

Deprecated since version 1.0: replaced by djangofloor.middleware.DjangoFloorMiddleware

process_request(request)

process_template_response(request, response)

class djangofloor.middleware.RemoteUserMiddleware(get_response=None)

Deprecated class, replaced by djangofloor.middleware.DjangoFloorMiddleware

header = None

original_process_request(request)

process_request(request)

class djangofloor.middleware.WindowInfoMiddleware

Base class for the WindowInfo middlewares.

from_dict(window_info, values)

from_request(request, window_info)

get_context(window_info)

install_methods(window_info_cls)

new_window_info(window_info)

to_dict(window_info)

class djangofloor.middleware.WindowKeyMiddleware

handle the unique ID generated for each django.http.request.HttpRequest and copy it to the WindowInfo object

from_dict(window_info, values)

from_request(request, window_info)

get_context(window_info)

new_window_info(window_info)

to_dict(window_info)