Context Navigation

Ticket #17005: 17005.diff

File 17005.diff, 3.7 KB (added by Christopher Medrela, 12 years ago)

diff --git a/django/contrib/sites/middleware.py b/django/contrib/sites/middleware.py
new file mode 100644
index 0000000..74ce561

-              -
+from django.conf import settings
+from django.contrib.sites.models import Site
+class SiteMiddleware(object):
+    """
+    Middleware that sets `site` attribute to request object.
+    """
+    def process_request(self, request):
+        request.site = Site.objects.get_current()

diff --git a/django/contrib/sites/tests.py b/django/contrib/sites/tests.py
index 17ab1f2..3a80ffc 100644

-              a
 from django.conf import settings
 from django.contrib.sites.models import Site, RequestSite, get_current_site
+from django.contrib.sites.middleware import SiteMiddleware
 from django.core.exceptions import ObjectDoesNotExist
 from django.http import HttpRequest
 from django.test import TestCase
-…
+               class SitesFrameworkTests(TestCase):
         site = get_current_site(request)
         self.assertTrue(isinstance(site, RequestSite))
         self.assertEqual(site.name, u"example.com")
+class MiddlewareTest(TestCase):
+    def test_request(self):
+        """
+        Makes sure that the request has correct `site` attribute.
+        """
+        middleware = SiteMiddleware()
+        request = HttpRequest()
+        middleware.process_request(request)
+        self.assertEqual(request.site.id, settings.SITE_ID)

diff --git a/docs/ref/contrib/sites.txt b/docs/ref/contrib/sites.txt
index 8fc434b..7a9f340 100644

                fallback for cases where it is not installed.
 .. function:: get_current_site(request)
     Checks if contrib.sites is installed and returns either the current
     :class:`~django.contrib.sites.models.Site` object or a
+    :class:`~django.contrib.sites.models.Site` object or a
     :class:`~django.contrib.sites.models.RequestSite` object based on
     the request.
-…
+               fallback when the database-backed sites framework is not available.
         Sets the ``name`` and ``domain`` attributes to the value of
         :meth:`~django.http.HttpRequest.get_host`.
 A :class:`~django.contrib.sites.models.RequestSite` object has a similar
 interface to a normal :class:`~django.contrib.sites.models.Site` object, except
-…
+               its :meth:`~django.contrib.sites.models.RequestSite.__init__()` method takes an
 and ``delete()`` methods to match the interface of
 :class:`~django.contrib.sites.models.Site`, but the methods raise
 ``NotImplementedError``.
+``SiteMiddleware``
+==================
+If you often use this pattern::
+    from django.contrib.sites.models import Site
+    def my_view(request):
+        site = Site.objects.get_current()
+        ...
+there is simple way to avoid repetitions. Add
+:mod:`django.contrib.site.middleware.SiteMiddleware`
+to :setting:`MIDDLEWARE_CLASSES`. The middleware sets ``site`` attribute
+to every incoming request object.

diff --git a/docs/ref/middleware.txt b/docs/ref/middleware.txt
index 737e0b2..570a33a 100644

                Message middleware
 Enables cookie- and session-based message support. See the
 :doc:`messages documentation </ref/contrib/messages>`.
+Site middleware
+----------------
+.. module:: django.contrib.site.middleware
+  :synopsis: Site middleware.
+.. class:: SiteMiddleware
+.. versionadded:: 1.4
+Adds the ``site`` attribute, representing the current site, to every incoming
+``HttpRequest`` object. See the :doc:`sites documentation </ref/contrib/sites>`.
 Session middleware
 ------------------