Ticket #10944: site_url.2.diff

django/contrib/sites/tests.py

@@ -3 +3 @@
 from django.core.exceptions import ObjectDoesNotExist
 from django.http import HttpRequest
 from django.test import TestCase
+from django.template import Template, Context
 
 
 class SitesFrameworkTests(TestCase):
@@ -54 +55 @@
         site = get_current_site(request)
         self.assert_(isinstance(site, RequestSite))
         self.assertEqual(site.name, u"example.com")
+    
+    def test_site_get_url(self):
+        # Test absolute URLs builder using relative path for Site
+        site = Site.objects.get_current()
+        self.assertEqual(u"http://example.com/test", site.get_url("/test"))
+        self.assertEqual(u"https://example.com/test", site.get_url("/test", protocol="https"))
+
+    def test_request_site_get_url(self):
+        # Test absolute URLs builder using relative path for RequestSite
+        Site._meta.installed = False
+        site = Site.objects.get_current()
+        self.assertEqual(u"http://example.com/test", site.get_url("/test"))
+        self.assertEqual(u"https://example.com/test", site.get_url("/test", protocol="https"))
+
+    def test_get_site_url_tag(self):
+        out = Template(
+                "{% load sites %}"
+                "{% site_url '/test' %}"
+            ).render(Context())
+        self.assertEquals(out, "http://example.com/test")
+        out = Template(
+                "{% load sites %}"
+                "{% site_url '/test' 'https' %}"
+            ).render(Context())
+        self.assertEquals(out, "https://example.com/test")
+
+    def test_get_request_site_url_tag(self):
+        Site._meta.installed = False
+        out = Template(
+                "{% load sites %}"
+                "{% site_url '/test' %}"
+            ).render(Context())
+        self.assertEquals(out, "http://example.com/test")
+        out = Template(
+                "{% load sites %}"
+                "{% site_url '/test' 'https' %}"
+            ).render(Context())
+        self.assertEquals(out, "https://example.com/test")
+

django/contrib/sites/models.py

@@ -61 +61 @@
         except KeyError:
             pass
 
+    def get_url(self, path, protocol='http'):
+        """Returns absolute URLs based on a protocol and given relative path"""
+        return protocol + '://' + self.domain + path
 
 class RequestSite(object):
     """
@@ -81 +84 @@
 
     def delete(self):
         raise NotImplementedError('RequestSite cannot be deleted.')
+    
+    def get_url(self, path, protocol='http'):
+        """Returns absolute URLs based on a protocol and given relative path"""
+        return protocol + '://' + self.domain + path
 
-
 def get_current_site(request):
     """
     Checks if contrib.sites is installed and returns either the current

django/contrib/sites/templatetags/sites.py

@@ +1 @@
+from django import template
+from django.contrib.sites.models import Site
+from django.conf import settings
+
+register = template.Library()
+
+def site_url(path, scheme='http'):
+    site = Site.objects.get_current()
+    return site.get_url(path, scheme)
+
+register.simple_tag(site_url)

docs/ref/contrib/sites.txt

@@ -237 +237 @@
     >>> 'http://%s%s' % (Site.objects.get_current().domain, obj.get_absolute_url())
     'http://example.com/mymodel/objects/3/'
 
+.. versionadded:: 1.3
+
+A :class:`~django.contrib.sites.models.Site` object has the method 
+:meth:`~django.contrib.sites.Site.get_url()` to help you build absolute 
+URLs based on a protocol, a domain and a relative path.
+
+    >>> Site.objects.get_current().get_url(obj.get_absolute_url())
+    'http://example.com/mymodel/objects/3/'
+    >>> Site.objects.get_current().get_url(obj.get_absolute_url(), protocol='https')
+    'https://example.com/mymodel/objects/3/'
+
+The template tag ``site_url`` allows you to build absolute URLs inside a 
+template by specifying a relative path and a protocol.
+
+Sample usages::
+
+    {% site_url '/test' %}
+    {% site_url '/test' 'https' %}
+
 Caching the current ``Site`` object
 ===================================