<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Middleware — Django v1.1 documentation</title>
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '1.1',
COLLAPSE_MODINDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="top" title="Django v1.1 documentation" href="../index.html" />
<link rel="up" title="API Reference" href="index.html" />
<link rel="next" title="Models" href="models/index.html" />
<link rel="prev" title="Generic views" href="generic-views.html" />
<script type="text/javascript" src="../templatebuiltins.js"></script>
<script type="text/javascript">
(function($) {
if (!django_template_builtins) {
// templatebuiltins.js missing, do nothing.
return;
}
$(document).ready(function() {
// Hyperlink Django template tags and filters
var base = "templates/builtins.html";
if (base == "#") {
// Special case for builtins.html itself
base = "";
}
// Tags are keywords, class '.k'
$("div.highlight\\-html\\+django span.k").each(function(i, elem) {
var tagname = $(elem).text();
if ($.inArray(tagname, django_template_builtins.ttags) != -1) {
var fragment = tagname.replace(/_/, '-');
$(elem).html("<a href='" + base + "#" + fragment + "'>" + tagname + "</a>");
}
});
// Filters are functions, class '.nf'
$("div.highlight\\-html\\+django span.nf").each(function(i, elem) {
var filtername = $(elem).text();
if ($.inArray(filtername, django_template_builtins.tfilters) != -1) {
var fragment = filtername.replace(/_/, '-');
$(elem).html("<a href='" + base + "#" + fragment + "'>" + filtername + "</a>");
}
});
});
})(jQuery);
</script>
</head>
<body>
<div class="document">
<div id="custom-doc" class="yui-t6">
<div id="hd">
<h1><a href="../index.html">Django v1.1 documentation</a></h1>
<div id="global-nav">
<a title="Home page" href="../index.html">Home</a> |
<a title="Table of contents" href="../contents.html">Table of contents</a> |
<a title="Global index" href="../genindex.html">Index</a> |
<a title="Module index" href="../modindex.html">Modules</a>
</div>
<div class="nav">
« <a href="generic-views.html" title="Generic views">previous</a>
|
<a href="index.html" title="API Reference" accesskey="U">up</a>
|
<a href="models/index.html" title="Models">next</a> »</div>
</div>
<div id="bd">
<div id="yui-main">
<div class="yui-b">
<div class="yui-g" id="ref-middleware">
<div class="section" id="s-module-django.middleware">
<span id="s-ref-middleware"></span><span id="module-django.middleware"></span><span id="ref-middleware"></span><h1>Middleware<a class="headerlink" href="#module-django.middleware" title="Permalink to this headline">¶</a></h1>
<p>This document explains all middleware components that come with Django. For
information on how how to use them and how to write your own middleware, see
the <a class="reference external" href="../topics/http/middleware.html#topics-http-middleware"><em>middleware usage guide</em></a>.</p>
<div class="section" id="s-available-middleware">
<span id="available-middleware"></span><h2>Available middleware<a class="headerlink" href="#available-middleware" title="Permalink to this headline">¶</a></h2>
<div class="section" id="s-module-django.middleware.cache">
<span id="module-django.middleware.cache"></span><h3>Cache middleware<a class="headerlink" href="#module-django.middleware.cache" title="Permalink to this headline">¶</a></h3>
<dl class="class">
<dt id="django.middleware.cache.django.middleware.cache.UpdateCacheMiddleware">
<em class="property">class </em><tt class="descclassname">django.middleware.cache.</tt><tt class="descname">UpdateCacheMiddleware</tt><a class="headerlink" href="#django.middleware.cache.django.middleware.cache.UpdateCacheMiddleware" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="class">
<dt id="django.middleware.cache.django.middleware.cache.FetchFromCacheMiddleware">
<em class="property">class </em><tt class="descclassname">django.middleware.cache.</tt><tt class="descname">FetchFromCacheMiddleware</tt><a class="headerlink" href="#django.middleware.cache.django.middleware.cache.FetchFromCacheMiddleware" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<p>Enable the site-wide cache. If these are enabled, each Django-powered page will
be cached for as long as the <a class="reference external" href="settings.html#setting-CACHE_MIDDLEWARE_SECONDS"><tt class="xref docutils literal"><span class="pre">CACHE_MIDDLEWARE_SECONDS</span></tt></a> setting
defines. See the <a class="reference external" href="../topics/cache.html#topics-cache"><em>cache documentation</em></a>.</p>
</div>
<div class="section" id="s-module-django.middleware.common">
<span id="module-django.middleware.common"></span><h3>“Common” middleware<a class="headerlink" href="#module-django.middleware.common" title="Permalink to this headline">¶</a></h3>
<dl class="class">
<dt id="django.middleware.common.django.middleware.common.CommonMiddleware">
<em class="property">class </em><tt class="descclassname">django.middleware.common.</tt><tt class="descname">CommonMiddleware</tt><a class="headerlink" href="#django.middleware.common.django.middleware.common.CommonMiddleware" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<p>Adds a few conveniences for perfectionists:</p>
<ul>
<li><p class="first">Forbids access to user agents in the <a class="reference external" href="settings.html#setting-DISALLOWED_USER_AGENTS"><tt class="xref docutils literal"><span class="pre">DISALLOWED_USER_AGENTS</span></tt></a>
setting, which should be a list of strings.</p>
</li>
<li><p class="first">Performs URL rewriting based on the <a class="reference external" href="settings.html#setting-APPEND_SLASH"><tt class="xref docutils literal"><span class="pre">APPEND_SLASH</span></tt></a> and
<a class="reference external" href="settings.html#setting-PREPEND_WWW"><tt class="xref docutils literal"><span class="pre">PREPEND_WWW</span></tt></a> settings.</p>
<p>If <a class="reference external" href="settings.html#setting-APPEND_SLASH"><tt class="xref docutils literal"><span class="pre">APPEND_SLASH</span></tt></a> is <tt class="xref docutils literal"><span class="pre">True</span></tt> and the initial URL doesn’t end
with a slash, and it is not found in the URLconf, then a new URL is
formed by appending a slash at the end. If this new URL is found in the
URLconf, then Django redirects the request to this new URL. Otherwise,
the initial URL is processed as usual.</p>
<p>For example, <tt class="docutils literal"><span class="pre">foo.com/bar</span></tt> will be redirected to <tt class="docutils literal"><span class="pre">foo.com/bar/</span></tt> if
you don’t have a valid URL pattern for <tt class="docutils literal"><span class="pre">foo.com/bar</span></tt> but <em>do</em> have a
valid pattern for <tt class="docutils literal"><span class="pre">foo.com/bar/</span></tt>.</p>
<div class="versionchanged">
<span class="title">Changed in Django 1.0:</span> The behavior of <a class="reference external" href="settings.html#setting-APPEND_SLASH"><tt class="xref docutils literal"><span class="pre">APPEND_SLASH</span></tt></a> has changed slightly in this
version. It didn’t used to check whether the pattern was matched in
the URLconf.</div>
<p>If <a class="reference external" href="settings.html#setting-PREPEND_WWW"><tt class="xref docutils literal"><span class="pre">PREPEND_WWW</span></tt></a> is <tt class="xref docutils literal"><span class="pre">True</span></tt>, URLs that lack a leading “www.”
will be redirected to the same URL with a leading “www.”</p>
<p>Both of these options are meant to normalize URLs. The philosophy is that
each URL should exist in one, and only one, place. Technically a URL
<tt class="docutils literal"><span class="pre">foo.com/bar</span></tt> is distinct from <tt class="docutils literal"><span class="pre">foo.com/bar/</span></tt> – a search-engine
indexer would treat them as separate URLs – so it’s best practice to
normalize URLs.</p>
</li>
<li><p class="first">Handles ETags based on the <a class="reference external" href="settings.html#setting-USE_ETAGS"><tt class="xref docutils literal"><span class="pre">USE_ETAGS</span></tt></a> setting. If
<a class="reference external" href="settings.html#setting-USE_ETAGS"><tt class="xref docutils literal"><span class="pre">USE_ETAGS</span></tt></a> is set to <tt class="xref docutils literal"><span class="pre">True</span></tt>, Django will calculate an ETag
for each request by MD5-hashing the page content, and it’ll take care of
sending <tt class="docutils literal"><span class="pre">Not</span> <span class="pre">Modified</span></tt> responses, if appropriate.</p>
</li>
</ul>
</div>
<div class="section" id="s-module-django.middleware.doc">
<span id="module-django.middleware.doc"></span><h3>View metadata middleware<a class="headerlink" href="#module-django.middleware.doc" title="Permalink to this headline">¶</a></h3>
<dl class="class">
<dt id="django.middleware.doc.django.middleware.doc.XViewMiddleware">
<em class="property">class </em><tt class="descclassname">django.middleware.doc.</tt><tt class="descname">XViewMiddleware</tt><a class="headerlink" href="#django.middleware.doc.django.middleware.doc.XViewMiddleware" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<p>Sends custom <tt class="docutils literal"><span class="pre">X-View</span></tt> HTTP headers to HEAD requests that come from IP
addresses defined in the <a class="reference external" href="settings.html#setting-INTERNAL_IPS"><tt class="xref docutils literal"><span class="pre">INTERNAL_IPS</span></tt></a> setting. This is used by
Django’s automatic documentation system.</p>
</div>
<div class="section" id="s-module-django.middleware.gzip">
<span id="module-django.middleware.gzip"></span><h3>GZIP middleware<a class="headerlink" href="#module-django.middleware.gzip" title="Permalink to this headline">¶</a></h3>
<dl class="class">
<dt id="django.middleware.gzip.django.middleware.gzip.GZipMiddleware">
<em class="property">class </em><tt class="descclassname">django.middleware.gzip.</tt><tt class="descname">GZipMiddleware</tt><a class="headerlink" href="#django.middleware.gzip.django.middleware.gzip.GZipMiddleware" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<p>Compresses content for browsers that understand gzip compression (all modern
browsers).</p>
<p>It is suggested to place this first in the middleware list, so that the
compression of the response content is the last thing that happens. Will not
compress content bodies less than 200 bytes long, when the response code is
something other than 200, JavaScript files (for IE compatibility), or
responses that have the <tt class="docutils literal"><span class="pre">Content-Encoding</span></tt> header already specified.</p>
</div>
<div class="section" id="s-module-django.middleware.http">
<span id="module-django.middleware.http"></span><h3>Conditional GET middleware<a class="headerlink" href="#module-django.middleware.http" title="Permalink to this headline">¶</a></h3>
<dl class="class">
<dt id="django.middleware.http.django.middleware.http.ConditionalGetMiddleware">
<em class="property">class </em><tt class="descclassname">django.middleware.http.</tt><tt class="descname">ConditionalGetMiddleware</tt><a class="headerlink" href="#django.middleware.http.django.middleware.http.ConditionalGetMiddleware" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<p>Handles conditional GET operations. If the response has a <tt class="docutils literal"><span class="pre">ETag</span></tt> or
<tt class="docutils literal"><span class="pre">Last-Modified</span></tt> header, and the request has <tt class="docutils literal"><span class="pre">If-None-Match</span></tt> or
<tt class="docutils literal"><span class="pre">If-Modified-Since</span></tt>, the response is replaced by an
<tt class="xref docutils literal"><span class="pre">HttpNotModified</span></tt>.</p>
<p>Also sets the <tt class="docutils literal"><span class="pre">Date</span></tt> and <tt class="docutils literal"><span class="pre">Content-Length</span></tt> response-headers.</p>
</div>
<div class="section" id="s-reverse-proxy-middleware">
<span id="reverse-proxy-middleware"></span><h3>Reverse proxy middleware<a class="headerlink" href="#reverse-proxy-middleware" title="Permalink to this headline">¶</a></h3>
<dl class="class">
<dt id="django.middleware.http.django.middleware.http.SetRemoteAddrFromForwardedFor">
<em class="property">class </em><tt class="descclassname">django.middleware.http.</tt><tt class="descname">SetRemoteAddrFromForwardedFor</tt><a class="headerlink" href="#django.middleware.http.django.middleware.http.SetRemoteAddrFromForwardedFor" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<div class="versionchanged">
<span class="title">Changed in Django 1.1:</span> <a class="reference external" href="../releases/1.1.html#releases-1-1"><em>Please, see the release notes</em></a></div>
<p>This middleware was removed in Django 1.1. See <a class="reference external" href="../releases/1.1.html#removed-setremoteaddrfromforwardedfor-middleware"><em>the release notes</em></a> for details.</p>
</div>
<div class="section" id="s-module-django.middleware.locale">
<span id="module-django.middleware.locale"></span><h3>Locale middleware<a class="headerlink" href="#module-django.middleware.locale" title="Permalink to this headline">¶</a></h3>
<dl class="class">
<dt id="django.middleware.locale.django.middleware.locale.LocaleMiddleware">
<em class="property">class </em><tt class="descclassname">django.middleware.locale.</tt><tt class="descname">LocaleMiddleware</tt><a class="headerlink" href="#django.middleware.locale.django.middleware.locale.LocaleMiddleware" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<p>Enables language selection based on data from the request. It customizes
content for each user. See the <a class="reference external" href="../topics/i18n/index.html#topics-i18n"><em>internationalization documentation</em></a>.</p>
</div>
<div class="section" id="s-module-django.contrib.sessions.middleware">
<span id="module-django.contrib.sessions.middleware"></span><h3>Session middleware<a class="headerlink" href="#module-django.contrib.sessions.middleware" title="Permalink to this headline">¶</a></h3>
<dl class="class">
<dt id="django.contrib.sessions.middleware.django.contrib.sessions.middleware.SessionMiddleware">
<em class="property">class </em><tt class="descclassname">django.contrib.sessions.middleware.</tt><tt class="descname">SessionMiddleware</tt><a class="headerlink" href="#django.contrib.sessions.middleware.django.contrib.sessions.middleware.SessionMiddleware" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<p>Enables session support. See the <a class="reference external" href="../topics/http/sessions.html#topics-http-sessions"><em>session documentation</em></a>.</p>
</div>
<div class="section" id="s-module-django.contrib.auth.middleware">
<span id="module-django.contrib.auth.middleware"></span><h3>Authentication middleware<a class="headerlink" href="#module-django.contrib.auth.middleware" title="Permalink to this headline">¶</a></h3>
<dl class="class">
<dt id="django.contrib.auth.middleware.django.contrib.auth.middleware.AuthenticationMiddleware">
<em class="property">class </em><tt class="descclassname">django.contrib.auth.middleware.</tt><tt class="descname">AuthenticationMiddleware</tt><a class="headerlink" href="#django.contrib.auth.middleware.django.contrib.auth.middleware.AuthenticationMiddleware" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<p>Adds the <tt class="docutils literal"><span class="pre">user</span></tt> attribute, representing the currently-logged-in user, to
every incoming <tt class="docutils literal"><span class="pre">HttpRequest</span></tt> object. See <a class="reference external" href="../topics/auth.html#topics-auth"><em>Authentication in Web requests</em></a>.</p>
</div>
<div class="section" id="s-module-django.contrib.csrf.middleware">
<span id="module-django.contrib.csrf.middleware"></span><h3>CSRF protection middleware<a class="headerlink" href="#module-django.contrib.csrf.middleware" title="Permalink to this headline">¶</a></h3>
<dl class="class">
<dt id="django.contrib.csrf.middleware.django.contrib.csrf.middleware.CsrfMiddleware">
<em class="property">class </em><tt class="descclassname">django.contrib.csrf.middleware.</tt><tt class="descname">CsrfMiddleware</tt><a class="headerlink" href="#django.contrib.csrf.middleware.django.contrib.csrf.middleware.CsrfMiddleware" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<div class="versionadded">
<span class="title">New in Django 1.0:</span> <a class="reference external" href="../releases/1.0.html#releases-1-0"><em>Please, see the release notes</em></a></div>
<p>Adds protection against Cross Site Request Forgeries by adding hidden form
fields to POST forms and checking requests for the correct value. See the
<a class="reference external" href="contrib/csrf.html#ref-contrib-csrf"><em>Cross Site Request Forgery protection documentation</em></a>.</p>
</div>
<div class="section" id="s-module-django.middleware.transaction">
<span id="module-django.middleware.transaction"></span><h3>Transaction middleware<a class="headerlink" href="#module-django.middleware.transaction" title="Permalink to this headline">¶</a></h3>
<dl class="class">
<dt id="django.middleware.transaction.django.middleware.transaction.TransactionMiddleware">
<em class="property">class </em><tt class="descclassname">django.middleware.transaction.</tt><tt class="descname">TransactionMiddleware</tt><a class="headerlink" href="#django.middleware.transaction.django.middleware.transaction.TransactionMiddleware" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<p>Binds commit and rollback to the request/response phase. If a view function
runs successfully, a commit is done. If it fails with an exception, a rollback
is done.</p>
<p>The order of this middleware in the stack is important: middleware modules
running outside of it run with commit-on-save - the default Django behavior.
Middleware modules running inside it (coming later in the stack) will be under
the same transaction control as the view functions.</p>
<p>See the <a class="reference external" href="../topics/db/transactions.html#topics-db-transactions"><em>transaction management documentation</em></a>.</p>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="yui-b" id="sidebar">
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="../contents.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference external" href="#">Middleware</a><ul>
<li><a class="reference external" href="#available-middleware">Available middleware</a><ul>
<li><a class="reference external" href="#module-django.middleware.cache">Cache middleware</a></li>
<li><a class="reference external" href="#module-django.middleware.common">“Common” middleware</a></li>
<li><a class="reference external" href="#module-django.middleware.doc">View metadata middleware</a></li>
<li><a class="reference external" href="#module-django.middleware.gzip">GZIP middleware</a></li>
<li><a class="reference external" href="#module-django.middleware.http">Conditional GET middleware</a></li>
<li><a class="reference external" href="#reverse-proxy-middleware">Reverse proxy middleware</a></li>
<li><a class="reference external" href="#module-django.middleware.locale">Locale middleware</a></li>
<li><a class="reference external" href="#module-django.contrib.sessions.middleware">Session middleware</a></li>
<li><a class="reference external" href="#module-django.contrib.auth.middleware">Authentication middleware</a></li>
<li><a class="reference external" href="#module-django.contrib.csrf.middleware">CSRF protection middleware</a></li>
<li><a class="reference external" href="#module-django.middleware.transaction">Transaction middleware</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<h3>Browse</h3>
<ul>
<li>Prev: <a href="generic-views.html">Generic views</a></li>
<li>Next: <a href="models/index.html">Models</a></li>
</ul>
<h3>You are here:</h3>
<ul>
<li>
<a href="../index.html">Django v1.1 documentation</a>
<ul><li><a href="index.html">API Reference</a>
<ul><li>Middleware</li></ul>
</li></ul>
</li>
</ul>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/ref/middleware.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<h3>Last update:</h3>
<p class="topless">Feb 18, 2011</p>
</div>
</div>
<div id="ft">
<div class="nav">
« <a href="generic-views.html" title="Generic views">previous</a>
|
<a href="index.html" title="API Reference" accesskey="U">up</a>
|
<a href="models/index.html" title="Models">next</a> »</div>
</div>
</div>
<div class="clearer"></div>
</div>
</body>
</html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
57efe471f3561e70a829edf1b0e9f507
>
files
>
2326
