X-Git-Url: http://git.ithinksw.org/philo.git/blobdiff_plain/4b094dbc60c3853814c2523d5772e4cf2884a073..ef0184bd6446c6b2d7fcd59a477d052a7f19fe89:/contrib/penfield/utils.py?ds=sidebyside diff --git a/contrib/penfield/utils.py b/contrib/penfield/utils.py index 5df800c..bfa08d0 100644 --- a/contrib/penfield/utils.py +++ b/contrib/penfield/utils.py @@ -1,20 +1,98 @@ -from django.core.paginator import Paginator, InvalidPage, EmptyPage +from django.utils.feedgenerator import Atom1Feed, Rss201rev2Feed +from django.conf.urls.defaults import url, patterns +from django.http import HttpResponse +from philo.utils import paginate -def paginate(request, entries, entries_per_page): - paginator = Paginator(entries, entries_per_page) - try: - page_number = int(request.GET.get('page', '1')) - entries = paginator.page(page_number).object_list - page = paginator.page(page_number) - except ValueError: - page_number = 1 - entries = paginator.page(page_number).object_list - page = paginator.page(page_number) - try: - entries = paginator.page(page_number).object_list - page = paginator.page(page_number) - except (EmptyPage, InvalidPage): - entries = paginator.page(paginator.num_pages).object_list - page = paginator.page(page_number) - return page \ No newline at end of file +class FeedMultiViewMixin(object): + """ + This mixin provides common methods for adding feeds to multiviews. In order to use this mixin, + the multiview must define feed_title (probably as properties that return values + on related objects.) feed_description may also be defined; it defaults to an empty string. + """ + feed_suffix = 'feed' + feeds_enabled = True + atom_feed = Atom1Feed + rss_feed = Rss201rev2Feed + feed_title = None + feed_description = None + list_var = 'objects' + + def page_view(self, func, page): + """ + Wraps an object-fetching function and renders the results as a page. + """ + def inner(request, extra_context=None, **kwargs): + objects, extra_context = func(request=request, extra_context=extra_context, **kwargs) + + context = self.get_context() + context.update(extra_context or {}) + + if 'page' in kwargs or 'page' in request.GET or (hasattr(self, 'per_page') and self.per_page): + page_num = kwargs.get('page', request.GET.get('page', 1)) + paginator, paginated_page, objects = paginate(objects, self.per_page, page_num) + context.update({'paginator': paginator, 'paginated_page': paginated_page, self.list_var: objects}) + else: + context.update({self.list_var: objects}) + + return page.render_to_response(request, extra_context=context) + + return inner + + def feed_view(self, func, reverse_name): + """ + Wraps an object-fetching function and renders the results as a rss or atom feed. + """ + def inner(request, extra_context=None, **kwargs): + objects, extra_context = func(request=request, extra_context=extra_context, **kwargs) + + if 'HTTP_ACCEPT' in request.META and 'rss' in request.META['HTTP_ACCEPT'] and 'atom' not in request.META['HTTP_ACCEPT']: + feed_type = 'rss' + else: + feed_type = 'atom' + + feed_kwargs = { + 'link': request.node.construct_url(subpath=self.reverse(reverse_name, kwargs=kwargs), request=request, with_domain=True) + } + feed = self.get_feed(feed_type, extra_context, feed_kwargs) + + for obj in objects: + kwargs = { + 'link': request.node.construct_url(subpath=self.reverse(obj=obj), request=request, with_domain=True) + } + self.add_item(feed, obj, kwargs=kwargs) + + response = HttpResponse(mimetype=feed.mime_type) + feed.write(response, 'utf-8') + return response + + return inner + + def get_feed(self, feed_type, extra_context, kwargs=None): + defaults = { + 'description': '' + } + defaults.update(kwargs or {}) + + if feed_type == 'rss': + return self.rss_feed(**defaults) + + if 'description' in defaults and defaults['description'] and 'subtitle' not in defaults: + defaults['subtitle'] = defaults['description'] + + return self.atom_feed(**defaults) + + def feed_patterns(self, object_fetcher, page, base_name): + urlpatterns = patterns('', + url(r'^$', self.page_view(object_fetcher, page), name=base_name) + ) + if self.feeds_enabled: + feed_name = '%s_feed' % base_name + urlpatterns = patterns('', + url(r'^%s$' % self.feed_suffix, self.feed_view(object_fetcher, feed_name), name=feed_name), + ) + urlpatterns + return urlpatterns + + def add_item(self, feed, obj, kwargs=None): + defaults = kwargs or {} + feed.add_item(**defaults) \ No newline at end of file