contrib/penfield/utils.py

   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
   5 from philo.utils import paginate
   6
   7
   8 class FeedMultiViewMixin(object):
   9         """
  10         This mixin provides common methods for adding feeds to multiviews. In order to use this mixin,
  11         the multiview must define feed_title (probably as properties that return values
  12         on related objects.) feed_description may also be defined; it defaults to an empty string.
  13         """
  14         feed_suffix = 'feed'
  15         feeds_enabled = True
  16         atom_feed = Atom1Feed
  17         rss_feed = Rss201rev2Feed
  18         feed_description = ''
  19         list_var = 'objects'
  20
  21         def page_view(self, func, page):
  22                 """
  23                 Wraps an object-fetching function and renders the results as a page.
  24                 """
  25                 def inner(request, node=None, extra_context=None, **kwargs):
  26                         objects, extra_context = func(request=request, node=node, extra_context=extra_context, **kwargs)
  27
  28                         context = self.get_context()
  29                         context.update(extra_context or {})
  30
  31                         if 'page' in kwargs or 'page' in request.GET or (hasattr(self, 'per_page') and self.per_page):
  32                                 page_num = kwargs.get('page', request.GET.get('page', 1))
  33                                 paginator, paginated_page, objects = paginate(objects, self.per_page, page_num)
  34                                 context.update({'paginator': paginator, 'paginated_page': paginated_page, self.list_var: objects})
  35                         else:
  36                                 context.update({self.list_var: objects})
  37
  38                         return page.render_to_response(node, request, extra_context=context)
  39
  40                 return inner
  41
  42         def feed_view(self, func, reverse_name):
  43                 """
  44                 Wraps an object-fetching function and renders the results as a rss or atom feed.
  45                 """
  46                 def inner(request, node=None, extra_context=None, **kwargs):
  47                         objects, extra_context = func(request=request, node=node, extra_context=extra_context, **kwargs)
  48
  49                         if 'HTTP_ACCEPT' in request.META and 'rss' in request.META['HTTP_ACCEPT'] and 'atom' not in request.META['HTTP_ACCEPT']:
  50                                 feed_type = 'rss'
  51                         else:
  52                                 feed_type = 'atom'
  53
  54                         feed = self.get_feed(feed_type, request, node, kwargs, reverse_name)
  55
  56                         for obj in objects:
  57                                 feed.add_item(obj.title, '/%s/%s/' % (node.get_absolute_url().strip('/'), self.get_subpath(obj).strip('/')), description=self.get_obj_description(obj))
  58
  59                         response = HttpResponse(mimetype=feed.mime_type)
  60                         feed.write(response, 'utf-8')
  61                         return response
  62
  63                 return inner
  64
  65         def get_feed(self, feed_type, request, node, kwargs, reverse_name):
  66                 title = self.feed_title
  67                 link = '/%s/%s/' % (node.get_absolute_url().strip('/'), reverse(reverse_name, urlconf=self, kwargs=kwargs).strip('/'))
  68                 description = self.feed_description
  69                 if feed_type == 'rss':
  70                         return self.rss_feed(title, link, description)
  71
  72                 return self.atom_feed(title, link, description, subtitle=description)
  73
  74         def feed_patterns(self, object_fetcher, page, base_name):
  75                 feed_name = '%s_feed' % base_name
  76                 urlpatterns = patterns('',
  77                         url(r'^%s/$' % self.feed_suffix, self.feed_view(object_fetcher, feed_name), name=feed_name),
  78                         url(r'^$', self.page_view(object_fetcher, page), name=base_name)
  79                 )
  80                 return urlpatterns
  81
  82         def get_obj_description(self, obj):
  83                 raise NotImplementedError