Changeset 1194

Timestamp:

11/11/05 21:44:53 (3 years ago)

Author:

adrian

Message:

Completely refactored legacy RSS framework to the new django.contrib.syndication package. Also added Atom support, changed the way feeds are registered and added documentation for the whole lot. This is backwards-incompatible, but the RSS framework had not yet been documented, so this should only affect tinkerers and WorldOnline. Fixes #329, #498, #502 and #554. Thanks for various patches/ideas to alastair, ismael, hugo, eric moritz and garthk

Files:

• django/trunk/django/conf/urls/rss.py (deleted)
• django/trunk/django/contrib/syndication (added)
• django/trunk/django/contrib/syndication/feeds.py (added)
• django/trunk/django/contrib/syndication/__init__.py (added)
• django/trunk/django/contrib/syndication/views.py (moved) (moved from django/trunk/django/views/rss/rss.py) (1 diff)
• django/trunk/django/core/rss.py (deleted)
• django/trunk/django/utils/feedgenerator.py (modified) (5 diffs)
• django/trunk/docs/syndication_feeds.txt (added)

django/trunk/django/contrib/syndication/views.py

@@ -1 @@
-re import rs
+ntrib.syndication import feed
-from django.core.exceptions import Http404
-from django.utils.httpwrappers import HttpResponse
-
-
+
+
+
+
-    try:
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    response = HttpResponse(mimetype='application/xml')
-
+eedgen
-    return response

django/trunk/django/utils/feedgenerator.py

@@ -20 +20 @@
-
-from django.utils.xmlutils import SimplerXMLGenerator
+import datetime, re, time
+import email.Utils
+from xml.dom import minidom
+from xml.parsers.expat import ExpatError
+
+def rfc2822_date(date):
+    return email.Utils.formatdate(time.mktime(date.timetuple()))
+
+def get_tag_uri(url, date):
+    "Creates a TagURI. See http://diveintomark.org/archives/2004/05/28/howto-atom-id"
+    tag = re.sub('^http://', '', url)
+    if date is not None:
+        tag = re.sub('/', ',%s:/' % date.strftime('%Y-%m-%d'), tag, 1)
+    tag = re.sub('#', '/', tag)
+    return 'tag:' + tag
-
-class SyndicationFeed:
-    "Base class for all syndication feeds. Subclasses should provide write()"
-
-
+
+
+
-            'title': title,
-            'link': link,
-            'description': description,
-            'language': language,
+            'author_email': author_email,
+            'author_name': author_name,
+            'author_link': author_link,
+            'subtitle': subtitle,
+            'categories': categories or (),
-        }
-        self.items = []
-
-    def add_item(self, title, link, description, author_email=None,
- unique_id=None,
-enclosure=None, categories=None
+
+unique_id=None, enclosure=None, categories=()
-        """
-        Adds an item to the feed. All args are expected to be Python Unicode
@@ -50 +71 @@
-            'unique_id': unique_id,
-            'enclosure': enclosure,
-[]
+()
-        })
-
@@ -71 +92 @@
-        self.write(s, encoding)
-        return s.getvalue()
+
+    def latest_post_date(self):
+        """
+        Returns the latest item's pubdate. If none of them have a pubdate,
+        this returns the current date/time.
+        """
+        updates = [i['pubdate'] for i in self.items if i['pubdate'] is not None]
+        if len(updates) > 0:
+            updates.sort()
+            return updates[-1]
+        else:
+            return datetime.datetime.now()
-
-class Enclosure:
@@ -82 +115 @@
-        handler = SimplerXMLGenerator(outfile, encoding)
-        handler.startDocument()
-
-
-
-
+
+
+
+
+
+
+
+
-        self.endChannelElement(handler)
-        self.endRssElement(handler)
-
-    def writeRssElement(self, handler):
-        "Adds the <rss> element to handler, taking care of versioning, etc."
-        raise NotImplementedError
-
-    def endRssElement(self, handler):
-        "Ends the <rss> element."
-        handler.endElement(u"rss")
-
-    def writeChannelElement(self, handler):
-        handler.startElement(u"channel", {})
-        handler.addQuickElement(u"title", self.feed_info['title'], {})
-        handler.addQuickElement(u"link", self.feed_info['link'], {})
-        handler.addQuickElement(u"description", self.feed_info['description'], {})
-        if self.feed_info['language'] is not None:
-            handler.addQuickElement(u"language", self.feed_info['language'], {})
-
-    def endChannelElement(self, handler):
@@ -109 +130 @@
-
-class RssUserland091Feed(RssFeed):
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
-
-class Rss201rev2Feed(RssFeed):
-    # Spec: http://blogs.law.harvard.edu/tech/rss
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-# This isolates the decision of what the system default is, so calling code can
-Rss
-Rss
+
+