1 from django.utils.feedgenerator import Atom1Feed, Rss201rev2Feed
2 from django.conf.urls.defaults import url, patterns
3 from django.core.urlresolvers import reverse
4 from django.http import HttpResponse
7 class FeedMultiViewMixin(object):
9 This mixin provides common methods for adding feeds to multiviews. In order to use this mixin,
10 the multiview must define feed_title (probably as properties that return values
11 on related objects.) feed_description may also be defined; it defaults to an empty string.
16 rss_feed = Rss201rev2Feed
20 def page_view(self, func, page):
22 Wraps an object-fetching function and renders the results as a page.
24 def inner(request, node=None, extra_context=None, **kwargs):
25 objects, extra_context = func(request=request, node=node, extra_context=extra_context, **kwargs)
27 context = self.get_context()
28 context.update(extra_context or {})
30 if 'page' in kwargs or 'page' in request.GET:
31 page_num = kwargs.get('page', request.GET.get('page', 1))
32 paginator, paginated_page, objects = paginate(objects, self.per_page, page_num)
33 context.update({'paginator': paginator, 'paginated_page': paginated_page, self.list_var: objects})
35 context.update({self.list_var: objects})
37 return page.render_to_response(node, request, extra_context=context)
41 def feed_view(self, func, reverse_name):
43 Wraps an object-fetching function and renders the results as a rss or atom feed.
45 def inner(request, node=None, extra_context=None, **kwargs):
46 objects, extra_context = func(request=request, node=node, extra_context=extra_context, **kwargs)
48 if 'HTTP_ACCEPT' in request.META and 'rss' in request.META['HTTP_ACCEPT'] and 'atom' not in request.META['HTTP_ACCEPT']:
53 feed = self.get_feed(feed_type, request, node, kwargs, reverse_name)
56 feed.add_item(obj.title, '/%s/%s/' % (node.get_absolute_url().strip('/'), self.get_subpath(obj).strip('/')), description=self.get_obj_description(obj))
58 response = HttpResponse(mimetype=feed.mime_type)
59 feed.write(response, 'utf-8')
64 def get_feed(self, feed_type, request, node, kwargs, reverse_name):
65 title = self.feed_title
66 link = '/%s/%s/' % (node.get_absolute_url().strip('/'), reverse(reverse_name, urlconf=self, kwargs=kwargs).strip('/'))
67 description = self.feed_description
68 if feed_type == 'rss':
69 return self.rss_feed(title, link, description)
71 return self.atom_feed(title, link, description, subtitle=description)
73 def feed_patterns(self, object_fetcher, page, base_name):
74 feed_name = '%s_feed' % base_name
75 urlpatterns = patterns('',
76 url(r'^%s/$' % self.feed_suffix, self.feed_view(object_fetcher, feed_name), name=feed_name),
77 url(r'^$', self.page_view(object_fetcher, page), name=base_name)
81 def get_obj_description(self, obj):
82 raise NotImplementedError