Ticket #10944: 10944_v3.diff

new file django/contrib/sites/templatetags/__init__.py

@@ +1 @@
+

new file django/contrib/sites/templatetags/sites.py

@@ +1 @@
+from django import template
+from django.contrib.sites.models import Site
+from django.conf import settings
+from django.template.base import Node, Token
+from django.template.defaulttags import url
+
+
+register = template.Library()
+
+
+@register.tag
+def site_url(parser, token):
+    #import ipdb; ipdb.set_trace()
+    bits = token.split_contents()
+    if len(bits) < 2:
+        raise TemplateSyntaxError("'%s' needs an argument describing "
+                                  "path to a view." % bits[0])
+    site = parser.compile_filter(bits[1])
+
+    # handle "site_url site using https"
+    protocol = 'http'
+    if len(bits) > 2 and bits[2] == 'using':
+        if len(bits) < 4:
+            raise TemplateSyntaxError("'%s' needs a protocol after "
+                                      "'using' word." % bits[0])
+        protocol = bits[3]
+        del bits[2:4] # delete "using <protocol>"
+    del bits[1] # delete site argument
+
+    content = " ".join(bits)
+    new_token = Token(token.token_type, content)
+    url_node = url(parser, new_token)
+    return SiteURLNode(protocol, site, url_node)
+
+
+class SiteURLNode(Node):
+    def __init__(self, protocol, site, url_node):
+        self._protocol = protocol
+        self._url_node = url_node
+        self._site = site
+
+    def render(self, context):
+        relative_path = self._url_node.render(context) # "/view"
+        domain = self._site.resolve(context, True).domain # "example.com"
+        return self._protocol + "://" + domain + relative_path
+

docs/ref/contrib/sites.txt

@@ -174 +174 @@
 .. 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.
 
@@ -240 +240 @@
 It's a good idea to exploit the :class:`~django.contrib.sites.models.Site`
 objects as much as possible, to remove unneeded complexity and redundancy.
 
-Getting the current domain for full URLs
-----------------------------------------
+``site_url`` tag for building full URLs
+---------------------------------------
+
+Django's ``get_absolute_url()`` convention is nice for getting your
+objects' URL without the domain name, but in some cases you might want
+to display the full URL -- with ``http://`` and the domain and
+everything -- for an object.  To do this, you can use ``site_url`` tag
+which behave in similar way to ``url`` tag except there must be site
+specified as first argument::
+
+    {% site_url site 'myapp.views.viewname' %}
 
-Django's ``get_absolute_url()`` convention is nice for getting your objects'
-URL without the domain name, but in some cases you might want to display the
-full URL -- with ``http://`` and the domain and everything -- for an object.
-To do this, you can use the sites framework. A simple example::
+The result of rendering that template is
+``http://example.com/path/to/view``.
+
+If you want you can also specify another protocol (the default is
+``http``). To do this add ``using`` and protocol after site argument,
+see example::
+
+    {% site_url site using https 'myapp.views.viewname' %}
 
-    >>> from django.contrib.sites.models import Site
-    >>> obj = MyModel.objects.get(id=3)
-    >>> obj.get_absolute_url()
-    '/mymodel/objects/3/'
-    >>> Site.objects.get_current().domain
-    'example.com'
-    >>> 'http://%s%s' % (Site.objects.get_current().domain, obj.get_absolute_url())
-    'http://example.com/mymodel/objects/3/'
 
 Caching the current ``Site`` object
 ===================================
@@ -437 +442 @@
 
         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

tests/regressiontests/sites_framework/tests.py

@@ -2 +2 @@
 
 from django.conf import settings
 from django.contrib.sites.models import Site
+from django.template import Context, Template
 from django.test import TestCase
 
 from .models import (SyndicatedArticle, ExclusiveArticle, CustomArticle,
@@ -9 +10 @@
 
 
 class SitesFrameworkTestCase(TestCase):
+    urls = 'regressiontests.sites_framework.urls'
+
     def setUp(self):
         Site.objects.get_or_create(id=settings.SITE_ID, domain="example.com", name="example.com")
         Site.objects.create(id=settings.SITE_ID+1, domain="example2.com", name="example2.com")
@@ -36 +39 @@
     def test_invalid_field_type(self):
         article = ConfusedArticle.objects.create(title="More Bad News!", site=settings.SITE_ID)
         self.assertRaises(TypeError, ConfusedArticle.on_site.all)
+
+    def test_site_url_tag(self):
+        site = Site.objects.get(domain='example2.com')
+        template = Template(
+            "{% load sites %}"
+            "{% site_url site 'regressiontests.sites_framework.views.view' %}")
+        rendered = template.render(Context({'site':site}))
+        self.assertEquals(rendered, "http://example2.com/lala")
+
+    def test_site_url_tag_without_sites_framework_installed(self):
+        Site._meta.installed = False
+        self.test_site_url_tag()
+
+    def test_site_url_tag_with_https(self):
+        site = Site.objects.get(domain='example2.com')
+        template = Template(
+            "{% load sites %}"
+            "{% site_url site using https "
+            "'regressiontests.sites_framework.views.view' %}")
+        rendered = template.render(Context({'site':site}))
+        self.assertEquals(rendered, "https://example2.com/lala")
+
+    def test_site_url_tag_with_https_without_sites_framework_installed(self):
+        Site._meta.installed = False
+        self.test_site_url_tag_with_https()

new file tests/regressiontests/sites_framework/urls.py

@@ +1 @@
+# coding: utf-8
+from __future__ import absolute_import, unicode_literals
+from django.conf.urls import patterns
+
+from . import views
+
+
+urlpatterns = patterns('',
+    # Test urls for testing reverse lookups
+    (r'^lala$', views.view),
+)
+

new file tests/regressiontests/sites_framework/views.py

@@ +1 @@
+def view(request):
+    pass