Revised penfield's pagination helper to work more generically.
[philo.git] / contrib / penfield / models.py
index 371ea57..94ad5c3 100644 (file)
@@ -1,16 +1,29 @@
 from django.db import models
 from django.conf import settings
 from philo.models import Tag, Titled, Entity, MultiView, Page, register_value_model
+from philo.exceptions import ViewCanNotProvideSubpath
 from django.conf.urls.defaults import url, patterns
+from django.core.paginator import EmptyPage
+from django.core.urlresolvers import reverse
 from django.http import Http404, HttpResponse
 from datetime import datetime
+from philo.contrib.penfield.utils import paginate
+from philo.contrib.penfield.validators import validate_pagination_count
 
 
 class Blog(Entity, Titled):
        @property
        def entry_tags(self):
                """ Returns a QuerySet of Tags that are used on any entries in this blog. """
-               return Tag.objects.filter(blogentries__blog=self)
+               return Tag.objects.filter(blogentries__blog=self).distinct()
+       
+       @property
+       def entry_dates(self):
+               dates = {'year': self.entries.dates('date', 'year', order='DESC'), 'month': self.entries.dates('date', 'month', order='DESC'), 'day': self.entries.dates('date', 'day', order='DESC')}
+               return dates
+
+
+register_value_model(Blog)
 
 
 class BlogEntry(Entity, Titled):
@@ -18,8 +31,8 @@ class BlogEntry(Entity, Titled):
        author = models.ForeignKey(getattr(settings, 'PHILO_PERSON_MODULE', 'auth.User'), related_name='blogentries')
        date = models.DateTimeField(default=datetime.now)
        content = models.TextField()
-       excerpt = models.TextField()
-       tags = models.ManyToManyField(Tag, related_name='blogentries')
+       excerpt = models.TextField(blank=True, null=True)
+       tags = models.ManyToManyField(Tag, related_name='blogentries', blank=True, null=True)
        
        class Meta:
                ordering = ['-date']
@@ -45,17 +58,48 @@ class BlogView(MultiView):
        entry_archive_page = models.ForeignKey(Page, related_name='blog_entry_archive_related', null=True, blank=True)
        tag_page = models.ForeignKey(Page, related_name='blog_tag_related')
        tag_archive_page = models.ForeignKey(Page, related_name='blog_tag_archive_related', null=True, blank=True)
+       entries_per_page = models.IntegerField(blank=True, validators=[validate_pagination_count], null=True)
        
        entry_permalink_style = models.CharField(max_length=1, choices=ENTRY_PERMALINK_STYLE_CHOICES)
        entry_permalink_base = models.CharField(max_length=255, blank=False, default='entries')
        tag_permalink_base = models.CharField(max_length=255, blank=False, default='tags')
        
+       def __unicode__(self):
+               return u'BlogView for %s' % self.blog.title
+       
+       def get_subpath(self, obj):
+               if isinstance(obj, BlogEntry):
+                       if obj.blog == self.blog:
+                               entry_view_args = {'slug': obj.slug}
+                               if self.entry_permalink_style in 'DMY':
+                                       entry_view_args.update({'year': str(obj.date.year).zfill(4)})
+                                       if self.entry_permalink_style in 'DM':
+                                               entry_view_args.update({'month': str(obj.date.month).zfill(2)})
+                                               if self.entry_permalink_style == 'D':
+                                                       entry_view_args.update({'day': str(obj.date.day).zfill(2)})
+                               return reverse(self.entry_view, urlconf=self, kwargs=entry_view_args)
+               elif isinstance(obj, Tag):
+                       if obj in self.blog.entry_tags:
+                               return reverse(self.tag_view, urlconf=self, kwargs={'tag_slugs': obj.slug})
+               elif isinstance(obj, (str, unicode)):
+                       split_obj = obj.split(':')
+                       if len(split_obj) > 1:
+                               entry_archive_view_args = {}
+                               if split_obj[0].lower() == 'archives':
+                                       entry_archive_view_args.update({'year': str(int(split_obj[1])).zfill(4)})
+                                       if len(split_obj) > 2:
+                                               entry_archive_view_args.update({'month': str(int(split_obj[2])).zfill(2)})
+                                               if len(split_obj) > 3:
+                                                       entry_archive_view_args.update({'day': str(int(split_obj[3])).zfill(2)})
+                                       return reverse(self.entry_archive_view, urlconf=self, kwargs=entry_archive_view_args)
+               raise ViewCanNotProvideSubpath
+       
        @property
        def urlpatterns(self):
                base_patterns = patterns('',
                        url(r'^$', self.index_view),
                        url((r'^(?:%s)/?$' % self.tag_permalink_base), self.tag_archive_view),
-                       url((r'^(?:%s)/(?P<tag>[-\w]+)/?$' % self.tag_permalink_base), self.tag_view)
+                       url((r'^(?:%s)/(?P<tag_slugs>[-\w]+[-+/\w]*)/?$' % self.tag_permalink_base), self.tag_view)
                )
                if self.entry_permalink_style == 'D':
                        entry_patterns = patterns('',
@@ -86,10 +130,17 @@ class BlogView(MultiView):
                        )
                return base_patterns + entry_patterns
        
+       def paginate(self, objects, page_number):
+               try:
+                       return paginate(objects, self.entries_per_page, page_number)
+               except EmptyPage:
+                       raise Http404
+       
        def index_view(self, request, node=None, extra_context=None):
+               paginated_page, entries = self.paginate(self.blog.entries.all(), request.GET.get('page', 1))
                context = {}
                context.update(extra_context or {})
-               context.update({'blog': self.blog})
+               context.update({'blog': self.blog, 'entries': entries, 'paginated_page': paginated_page})
                return self.index_page.render_to_response(node, request, extra_context=context)
        
        def entry_view(self, request, slug, year=None, month=None, day=None, node=None, extra_context=None):
@@ -119,20 +170,35 @@ class BlogView(MultiView):
                        entries = entries.filter(date__month=month)
                if day:
                        entries = entries.filter(date__day=day)
+               
+               paginated_page, entries = self.paginate(entries, request.GET.get('page', 1))
                context = {}
                context.update(extra_context or {})
-               context.update({'blog': self.blog, 'year': year, 'month': month, 'day': day, 'entries': entries})
+               context.update({'blog': self.blog, 'year': year, 'month': month, 'day': day, 'entries': entries, 'paginated_page': paginated_page})
                return self.entry_archive_page.render_to_response(node, request, extra_context=context)
        
-       def tag_view(self, request, tag, node=None, extra_context=None):
-               try:
-                       tag = self.blog.entry_tags.filter(slug=tag)
-               except:
+       def tag_view(self, request, tag_slugs, node=None, extra_context=None):
+               tags = []
+               for tag_slug in tag_slugs.replace('+', '/').split('/'):
+                       if tag_slug: # ignore blank slugs, handles for multiple consecutive separators (+ or /)
+                               try:
+                                       tag = self.blog.entry_tags.get(slug=tag_slug)
+                               except:
+                                       raise Http404
+                               tags.append(tag)
+               if len(tags) <= 0:
                        raise Http404
-               entries = self.blog.entries.filter(tags=tag)
+               
+               entries = self.blog.entries.all()
+               for tag in tags:
+                       entries = entries.filter(tags=tag)
+               if entries.count() <= 0:
+                       raise Http404
+               
+               paginated_page, entries = self.paginate(entries, request.GET.get('page', 1))
                context = {}
                context.update(extra_context or {})
-               context.update({'blog': self.blog, 'tag': tag, 'entries': entries})
+               context.update({'blog': self.blog, 'tags': tags, 'entries': entries, 'paginated_page': paginated_page})
                return self.tag_page.render_to_response(node, request, extra_context=context)
        
        def tag_archive_view(self, request, node=None, extra_context=None):
@@ -148,6 +214,9 @@ class Newsletter(Entity, Titled):
        pass
 
 
+register_value_model(Newsletter)
+
+
 class NewsletterArticle(Entity, Titled):
        newsletter = models.ForeignKey(Newsletter, related_name='articles')
        authors = models.ManyToManyField(getattr(settings, 'PHILO_PERSON_MODULE', 'auth.User'), related_name='newsletterarticles')
@@ -156,6 +225,7 @@ class NewsletterArticle(Entity, Titled):
        full_text = models.TextField()
        
        class Meta:
+               get_latest_by = 'date'
                ordering = ['-date']
                unique_together = (('newsletter', 'slug'),)
 
@@ -166,13 +236,16 @@ register_value_model(NewsletterArticle)
 class NewsletterIssue(Entity, Titled):
        newsletter = models.ForeignKey(Newsletter, related_name='issues')
        number = models.PositiveIntegerField()
-       articles = models.ManyToManyField(NewsletterArticle)
+       articles = models.ManyToManyField(NewsletterArticle, related_name='issues')
        
        class Meta:
                ordering = ['-number']
                unique_together = (('newsletter', 'number'),)
 
 
+register_value_model(NewsletterIssue)
+
+
 class NewsletterView(MultiView):
        ARTICLE_PERMALINK_STYLE_CHOICES = (
                ('D', 'Year, month, and day'),
@@ -193,6 +266,22 @@ class NewsletterView(MultiView):
        article_permalink_base = models.CharField(max_length=255, blank=False, default='articles')
        issue_permalink_base = models.CharField(max_length=255, blank=False, default='issues')
        
+       def get_subpath(self, obj):
+               if isinstance(obj, NewsletterArticle):
+                       if obj.newsletter == self.newsletter:
+                               article_view_args = {'slug': obj.slug}
+                               if self.article_permalink_style in 'DMY':
+                                       article_view_args.update({'year': str(obj.date.year).zfill(4)})
+                                       if self.article_permalink_style in 'DM':
+                                               article_view_args.update({'month': str(obj.date.month).zfill(2)})
+                                               if self.article_permalink_style == 'D':
+                                                       article_view_args.update({'day': str(obj.date.day).zfill(2)})
+                               return reverse(self.article_view, urlconf=self, kwargs=article_view_args)
+               elif isinstance(obj, NewsletterIssue):
+                       if obj.newsletter == self.newsletter:
+                               return reverse(self.issue_view, urlconf=self, kwargs={'number': str(obj.number)})
+               raise ViewCanNotProvideSubpath
+       
        @property
        def urlpatterns(self):
                base_patterns = patterns('',