Changeset 2538

Timestamp:

02/24/10 10:00:22 (5 months ago)

Author:

JensDiemer

Message:

• New: Blog plugin can send feeds
• New: Blog tag filter can be combinied
• Update Journal feeds used the "count" GET parameter

Location:

branches/0.9/pylucid_project

Files:

• pylucid_plugins/blog/preference_forms.py (modified) (1 diff)
• pylucid_plugins/blog/templates/blog/detail_view.html (modified) (1 diff)
• pylucid_plugins/blog/templates/blog/feed_description.html (added)
• pylucid_plugins/blog/templates/blog/includes/add_tag_filter.html (added)
• pylucid_plugins/blog/templates/blog/includes/tagcloud.html (modified) (1 diff)
• pylucid_plugins/blog/templates/blog/includes/taglist.html (modified) (1 diff)
• pylucid_plugins/blog/templates/blog/select_feed.html (added)
• pylucid_plugins/blog/templates/blog/summary.html (modified) (2 diffs)
• pylucid_plugins/blog/urls.py (modified) (1 diff)
• pylucid_plugins/blog/views.py (modified) (9 diffs)
• pylucid_plugins/update_journal/preference_forms.py (added)
• pylucid_plugins/update_journal/views.py (modified) (3 diffs)
• utils/safe_obtain.py (added)

branches/0.9/pylucid_project/pylucid_plugins/blog/preference_forms.py

@@ -24 +24 @@
         ),
     )
+    
+    initial_feed_count = forms.IntegerField(
+        initial=5, min_value=1,
+        help_text=_("Default numbers of blog articles in RSS/Atom feed."),
+    )
+    max_feed_count = forms.IntegerField(
+        initial=30, min_value=1,
+        help_text=_("The maximal numbers of blog articles in RSS/Atom feed."),
+    )
     class Meta:
         app_label = 'blog'

branches/0.9/pylucid_project/pylucid_plugins/blog/templates/blog/detail_view.html

@@ -21 +21 @@
     <div class="content">{{ entry.get_html }}</div>
     
+    {% if entry.lastupdateby %}
     <small><p class="date_info">
-        {% if entry.lastupdateby %}(Last update: {{ entry.lastupdatetime|date:_("DATETIME_FORMAT") }} by {{ entry.lastupdateby }}.){% endif %}
+        (Last update: {{ entry.lastupdatetime|date:_("DATETIME_FORMAT") }} by {{ entry.lastupdateby }}.)
     </p></small>
+    {% endif %}
     
     {% include "blog/includes/taglist.html" %}

branches/0.9/pylucid_project/pylucid_plugins/blog/templates/blog/includes/tagcloud.html

@@ -2 +2 @@
 {% for tag in tag_cloud %}
     {% if not forloop.first %}|{% endif %}
-    <a href="{% url Blog-tag_view tag=tag.name %}" style="font-size:{{ tag.font_size }}em;">{{ tag.name }}</a>
+    
+    {% if tag.name in used_tags %}
+        <strong style="font-size:{{ tag.font_size }}em;">{{ tag.name }}</strong>
+    {% else %}
+        <a href="{% url Blog-tag_view tags=tag.name %}" style="font-size:{{ tag.font_size }}em;">{{ tag.name }}</a>
+    {% endif %}
+    
+    {% if add_tag_filter_link %}
+        {% include "blog/includes/add_tag_filter.html" %}
+    {% endif %}
 {% endfor %}
 </fieldset>

branches/0.9/pylucid_project/pylucid_plugins/blog/templates/blog/includes/taglist.html

@@ -5 +5 @@
 {% for tag in tags %}
     {% if not forloop.first %}|{% endif %}
-    <a href="{% url Blog-tag_view tag=tag.name %}">{{ tag.name }}</a>
+    {% if tag.name in used_tags %}
+        <strong>{{ tag.name }}</strong>
+    {% else %}
+        <a href="{% url Blog-tag_view tags=tag.name %}">{{ tag.name }}</a>
+    {% endif %}
+    {% if add_tag_filter_link %}
+        {% include "blog/includes/add_tag_filter.html" %}
+    {% endif %}
 {% endfor %}
 </fieldset>

branches/0.9/pylucid_project/pylucid_plugins/blog/templates/blog/summary.html

@@ -22 +22 @@
     <div class="content">{{ entry.get_html }}</div>
 
+    {% if entry.lastupdateby %}
     <small><p class="date_info">
-        {% if entry.lastupdateby %}(Last update: {{ entry.lastupdatetime|date:_("DATETIME_FORMAT") }} by {{ entry.lastupdateby }}.){% endif %}
+        (Last update: {{ entry.lastupdatetime|date:_("DATETIME_FORMAT") }} by {{ entry.lastupdateby }}.)
     </p></small>
+    {% endif %}
 
    {% include "blog/includes/taglist.html" %}
@@ -34 +36 @@
 {% endfor %}
 </div>
+
+<fieldset class="feed_selection"><legend>{% trans "Syndication feed format:" %}</legend>
+<ul>
+{% for feed in feeds %}
+    <li>
+        {% if tags %}
+            <a href="{% url Blog-tag_feed tags feed.filename %}">{% url Blog-tag_feed tags feed.filename %}</a>
+        {% else %}      
+            <a href="{% url Blog-feed feed.filename %}">{% url Blog-feed feed.filename %}</a>
+        {% endif %}
+        <small>(
+        {% if feed.filename == "feed.rss" %}
+            <a href="{% trans "http://en.wikipedia.org/wiki/RSS" %}">Really Simple Syndication</a> v2.01rev2
+        {% endif %}
+        {% if feed.filename == "feed.atom" %}   
+            <a href="{% trans "http://en.wikipedia.org/wiki/Atom_(standard)" %}">Atom Syndication Format</a> v1.0
+        {% endif %}
+        )
+        </small>
+    </li>    
+{% endfor %}
+</lu>
+</fieldset>
 
 <div class="pagination">

branches/0.9/pylucid_project/pylucid_plugins/blog/urls.py

@@ -3 +3 @@
 from django.conf.urls.defaults import patterns, url
 
-from blog.views import summary, tag_view, detail_view
+from blog.views import summary, tag_view, detail_view, feed, select_feed
 
 urlpatterns = patterns('',
-    url(r'^/tags/(?P<tag>.*?)/$', tag_view, name='Blog-tag_view'),
+    url(r'^/tags/(?P<tags>.+?)/$', tag_view, name='Blog-tag_view'),
     url(r'^/(?P<id>\d+?)/(?P<title>.*)/$', detail_view, name='Blog-detail_view'),
+
+    url(r'^/feed/(?P<tags>.+)/(?P<filename>.+?)$', feed, name='Blog-tag_feed'),
+    url(r'^/feed/(?P<filename>.+?)$', feed, name='Blog-feed'),
+    url(r'^/feed/', select_feed, name='Blog-select_feed'),
+
     url(r'^', summary, name='Blog-summary'),
 )

branches/0.9/pylucid_project/pylucid_plugins/blog/views.py

@@ -27 +27 @@
 
 from django.conf import settings
+from django.contrib.syndication.views import Feed
 from django.utils.translation import ugettext as _
 from django.views.decorators.csrf import csrf_protect
 from django.contrib.comments.views.comments import post_comment
+from django.utils.feedgenerator import Rss201rev2Feed, Atom1Feed
 
 from pylucid_project.apps.pylucid.decorators import render_to
+from pylucid_project.utils.safe_obtain import safe_pref_get_integer
 
 from pylucid_project.pylucid_plugins.blog.models import BlogEntry
+from pylucid_project.pylucid_plugins.blog.preference_forms import BlogPrefForm
 
 # from django-tagging
@@ -48 +52 @@
 
 
+def _get_queryset(request, tags=None):
+    # Get all blog entries, that the current user can see
+    queryset = BlogEntry.objects.all_accessible(request)
+
+    if tags is not None:
+        # filter by tags 
+        queryset = TaggedItem.objects.get_by_model(queryset, tags)
+
+    return queryset
+
+
+def _split_tags(raw_tags):
+    "simple split tags from url"
+    tags = raw_tags.strip("/").split("/")
+    return tags
+
+
+class RssFeed(Feed):
+    feed_type = Rss201rev2Feed
+    filename = "feed.rss"
+    title = _("Blog - RSS feed")
+    link = "/"
+    description_template = "blog/feed_description.html"
+
+    def __init__(self, request, tags=None):
+        self.request = request
+
+        if tags is not None:
+            tags = _split_tags(tags)
+        self.tags = tags
+
+        # Get max number of feed entries from request.GET["count"]
+        # Validate/Limit it with information from DBPreferences 
+        self.count, error = safe_pref_get_integer(
+            request, "count", BlogPrefForm,
+            default_key="initial_feed_count", default_fallback=5,
+            min_key="initial_feed_count", min_fallback=5,
+            max_key="max_feed_count", max_fallback=30
+        )
+
+    def description(self):
+        if self.tags is None:
+            return _("Last %s blog articles") % self.count
+        else:
+            return _(
+                 "Last %(count)s blog articles tagged with: %(tags)s"
+            ) % {"count":self.count, "tags": ",".join(self.tags)}
+
+    def items(self):
+        queryset = _get_queryset(self.request, self.tags)
+        return queryset[:self.count]
+
+    def item_title(self, item):
+        return item.headline
+
+    def item_author_name(self, item):
+        return item.createby
+
+    def item_link(self, item):
+        return item.get_absolute_url()
+
+
+class AtomFeed(RssFeed):
+    """
+    http://docs.djangoproject.com/en/dev/ref/contrib/syndication/#publishing-atom-and-rss-feeds-in-tandem
+    """
+    feed_type = Atom1Feed
+    filename = "feed.atom"
+    title = _("Blog - Atom feed")
+    subtitle = RssFeed.description
+
+
+# The last class is the fallback class, if filename doesn't match
+FEEDS = [AtomFeed, RssFeed]
+
+
+
 @render_to("blog/summary.html")
 def summary(request):
@@ -54 +135 @@
     """
     # Get all blog entries, that the current user can see
-    queryset = BlogEntry.objects.all_accessible(request)
+    queryset = _get_queryset(request)
 
     # Limit the queryset with django Paginator
@@ -65 +146 @@
         "tag_cloud": tag_cloud,
         "CSS_PLUGIN_CLASS_NAME": settings.PYLUCID.CSS_PLUGIN_CLASS_NAME,
+        "feeds": FEEDS,
     }
     return context
@@ -70 +152 @@
 
 @render_to("blog/summary.html")
-def tag_view(request, tag):
-    """
-    Display summary list with blog entries filtered by the giben tag.
-    """
-    tags = tag.strip("/").split("/")
-
-    # Get all blog entries, that the current user can see
-    queryset = BlogEntry.objects.all_accessible(request)
-
-    queryset = TaggedItem.objects.get_by_model(queryset, tags)
+def tag_view(request, tags):
+    """
+    Display summary list with blog entries filtered by the given tags.
+    """
+    tags = _split_tags(tags)
+
+    # Get all blog entries, that the current user can see
+    queryset = _get_queryset(request, tags)
 
     # Limit the queryset with django Paginator
@@ -85 +165 @@
 
     # Add link to the breadcrumbs ;)
-    _add_breadcrumb(request, title=_("All '%s' tagged items" % ",".join(tags)), url=request.path)
+    _add_breadcrumb(request, title=_("All items tagged with: %s" % ", ".join(tags)), url=request.path)
 
     tag_cloud = BlogEntry.objects.get_tag_cloud(request)
@@ -92 +172 @@
         "entries": paginator,
         "tag_cloud": tag_cloud,
+        "add_tag_filter_link": True, # Add + tag filter link
         "CSS_PLUGIN_CLASS_NAME": settings.PYLUCID.CSS_PLUGIN_CLASS_NAME,
+        "used_tags": tags,
+        "tags": "/".join(tags),
+        "feeds": FEEDS,
     }
     return context
@@ -104 +188 @@
     """
     # Get all blog entries, that the current user can see
-    queryset = BlogEntry.objects.all_accessible(request)
+    queryset = _get_queryset(request)
 
     try:
@@ -133 +217 @@
     return context
 
+#------------------------------------------------------------------------------
+
+
+@render_to("blog/select_feed.html")
+def select_feed(request):
+    """ Display a list with existing feed filenames. """
+    context = {"feeds": FEEDS}
+    return context
+
+
+def feed(request, filename, tags=None):
+    """
+    return RSS/Atom feed for all blog entries and filtered by tags. 
+    Feed format is selected by filename.
+    """
+    for feed_class in FEEDS:
+        if filename == feed_class.filename:
+            break
+
+    feed = feed_class(request, tags)
+    response = feed(request)
+    return response
+

branches/0.9/pylucid_project/pylucid_plugins/update_journal/views.py

@@ -27 +27 @@
 from django.core.urlresolvers import NoReverseMatch
 
-from pylucid_project.apps.pylucid.models import Language
 from pylucid_project.apps.pylucid.decorators import render_to
+from pylucid_project.utils.safe_obtain import safe_pref_get_integer
+from pylucid_project.apps.pylucid.models import Language, PluginPage
 
 from pylucid_project.pylucid_plugins.update_journal.models import UpdateJournal
-from pylucid_project.apps.pylucid.models import PluginPage
+from pylucid_project.pylucid_plugins.update_journal.preference_forms import UpdateJournalPrefForm
+
 
 def _get_queryset(request, count):
@@ -76 +78 @@
     filename = "feed.rss"
 
-    title = "Update Journal"
+    title = _("Update Journal - RSS feed")
     link = "/"
-    description = "Updates and changes"
     description_template = "update_journal/feed_description.html"
 
     def __init__(self, request):
-        self.count = 10 # FIXME: use GET parameter?
         self.request = request
+
+        # Get max number of feed entries from request.GET["count"]
+        # Validate/Limit it with information from DBPreferences 
+        self.count, error = safe_pref_get_integer(
+            request, "count", UpdateJournalPrefForm,
+            default_key="initial_feed_count", default_fallback=5,
+            min_key="initial_feed_count", min_fallback=5,
+            max_key="max_feed_count", max_fallback=30
+        )
+
+    def description(self):
+        return _("Last %s updates and changes") % self.count
 
     def items(self):
@@ -101 +113 @@
     feed_type = Atom1Feed
     filename = "feed.atom"
+    title = _("Update Journal - Atom feed")
     subtitle = RssFeed.description