Ticket #10909: sitemaps_custom_domain_docs_tests.diff

django/contrib/sitemaps/__init__.py

@@ -27 +27 @@
     if sitemap_url is None:
         raise SitemapNotFound("You didn't provide a sitemap_url, and the sitemap URL couldn't be auto-detected.")
 
-    from django.contrib.sites.models import Site
-    current_site = Site.objects.get_current()
-    url = "http://%s%s" % (current_site.domain, sitemap_url)
-    params = urllib.urlencode({'sitemap':url})
+    if '://' not in sitemap_url:
+        from django.contrib.sites.models import Site
+        current_site = Site.objects.get_current()
+        sitemap_url = "http://%s%s" % (current_site.domain, sitemap_url)
+    params = urllib.urlencode({'sitemap': sitemap_url})
     urllib.urlopen("%s?%s" % (ping_url, params))
 
 class Sitemap(object):
@@ -60 +61 @@
     paginator = property(_get_paginator)
 
     def get_urls(self, page=1):
-        from django.contrib.sites.models import Site
-        current_site = Site.objects.get_current()
         urls = []
         for item in self.paginator.page(page).object_list:
-            loc = "http://%s%s" % (current_site.domain, self.__get('location', item))
+            loc = "http://%s%s" % (self.get_domain(),
+                                   self.__get('location', item))
             url_info = {
                 'location':   loc,
                 'lastmod':    self.__get('lastmod', item, None),
@@ -74 +74 @@
             urls.append(url_info)
         return urls
 
+    def get_domain(self):
+        """
+        This method can be overridden to avoid the requirement of the ``sites``
+        contrib application.
+        """
+        from django.contrib.sites.models import Site
+        return Site.objects.get_current().domain
+
 class FlatPageSitemap(Sitemap):
     def items(self):
         from django.contrib.sites.models import Site

docs/ref/contrib/sitemaps.txt

@@ -208 +208 @@
         page is ``0.5``. See the `sitemaps.org documentation`_ for more.
 
         .. _sitemaps.org documentation: http://www.sitemaps.org/protocol.html#prioritydef
+    
+    .. method:: Sitemap.get_domain
+
+        **Optional.** A method.
+
+        It should return the applicable domain, as a string, to be applied to
+        all URLs within the sitemap.
+
+        By default, this uses the ``sites`` framework and returns the domain
+        from the current :class:`django.contrib.sites.models.Site`.
+        
+        If you don't want use the ``sites`` framework, you can override this
+        method and return the domain of your choosing. This should not include
+        the protocol or path. Examples:
+
+            * Good: :file:`'example.com'`
+            * Bad: :file:`'example/'`
+            * Bad: :file:`'http://example.com'`
 
 Shortcuts
 =========

new file tests/regressiontests/sitemaps/fixtures/sitemapdata.json

@@ +1 @@
+[
+  {
+    "model": "sitemaps.entry",
+    "pk": 1,
+    "fields": {
+      "title": "My first entry",
+      "date": "2008-01-01 12:30:00"
+    }
+  },
+  {
+    "model": "sitemaps.entry",
+    "pk": 2,
+    "fields": {
+      "title": "My second entry",
+      "date": "2008-01-02 12:30:00"
+    }
+  },
+  {
+    "model": "sitemaps.entry",
+    "pk": 3,
+    "fields": {
+      "title": "My third entry",
+      "date": "2008-01-02 13:30:00"
+    }
+  },
+  {
+    "model": "sitemaps.entry",
+    "pk": 4,
+    "fields": {
+      "title": "A & B < C > D",
+      "date": "2008-01-03 13:30:00"
+    }
+  }
+]

new file tests/regressiontests/sitemaps/models.py

@@ +1 @@
+from django.db import models
+
+class Entry(models.Model):
+    title = models.CharField(max_length=200)
+    date = models.DateTimeField()
+
+    class Meta:
+        ordering = ('date',)
+
+    def __unicode__(self):
+        return self.title
+
+    def get_absolute_url(self):
+        return "/blog/%s/" % self.pk

new file tests/regressiontests/sitemaps/tests.py

@@ +1 @@
+from xml.dom import minidom
+from django.test import TestCase
+
+
+class SitemapsTestCase(TestCase):
+    fixtures = ['sitemapdata.json']
+    urls = 'regressiontests.sitemaps.urls'
+    
+    def test_standard_and_custom(self):
+        resp = self.client.get('/sitemap.xml')
+        self.assertEqual(resp.status_code, 200)
+        sitemap_xml = resp.content
+        
+        doc = minidom.parseString(sitemap_xml)
+        urls = doc.getElementsByTagName('url')
+        self.assertEqual(8, len(urls))
+        
+        found_urls = []
+        
+        for url in urls:
+            loc = url.firstChild.firstChild
+            found_urls.append(loc.wholeText)
+        
+        self.assertEqual([
+            u'http://djangoproject.com/blog/1/',
+            u'http://djangoproject.com/blog/2/',
+            u'http://djangoproject.com/blog/3/',
+            u'http://djangoproject.com/blog/4/',
+            u'http://example.com/blog/1/',
+            u'http://example.com/blog/2/',
+            u'http://example.com/blog/3/',
+            u'http://example.com/blog/4/'
+        ], sorted(found_urls))

new file tests/regressiontests/sitemaps/urls.py

@@ +1 @@
+from django.conf.urls.defaults import *
+from django.contrib.sitemaps import Sitemap
+from regressiontests.sitemaps.models import Entry
+
+class EntrySitemap(Sitemap):
+    def items(self):
+        return Entry.objects.all().order_by('-date')
+
+class CustomDomainSite(EntrySitemap):
+    def get_domain(self):
+        return 'djangoproject.com'
+
+sitemaps = {
+    'standard': EntrySitemap,
+    'custom': CustomDomainSite,
+}
+
+urlpatterns = patterns('',
+    (r'^sitemap.xml$', 'django.contrib.sitemaps.views.sitemap', {'sitemaps': sitemaps})
+)

tests/runtests.py

@@ -25 +25 @@
     'django.contrib.contenttypes',
     'django.contrib.auth',
     'django.contrib.sites',
+    'django.contrib.sitemaps',
     'django.contrib.flatpages',
     'django.contrib.redirects',
     'django.contrib.sessions',

tests/urls.py

@@ -29 +29 @@
     (r'widget_admin/', include('regressiontests.admin_widgets.urls')),
 
     (r'^utils/', include('regressiontests.utils.urls')),
-
+    
     # test urlconf for syndication tests
     (r'^syndication/', include('regressiontests.syndication.urls')),