Slight changes to penfield NewsletterIssueAdmin & added newsletter value models

[philo.git] / contrib / penfield / models.py

diff --git a/contrib/penfield/models.py b/contrib/penfield/models.py
index 42aca6c..eede5a4 100644 (file)
--- a/contrib/penfield/models.py
+++ b/contrib/penfield/models.py
@@ -1,14 +1,23 @@
 from django.db import models
 from django.conf import settings
 from django.db import models
 from django.conf import settings

-from philo.models import Tag, Titled, Entity, MultiView, Template, register_value_model
+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.conf.urls.defaults import url, patterns

+from django.core.urlresolvers import reverse

 from django.http import Http404, HttpResponse
 from django.http import Http404, HttpResponse

-from django.template import RequestContext

 from datetime import datetime
 from datetime import datetime

+from philo.contrib.penfield.utils import paginate
+from philo.contrib.penfield.validators import validate_pagination_count

 
 
 class Blog(Entity, Titled):
 
 
 class Blog(Entity, Titled):

-       pass
+       @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).distinct()
+
+
+register_value_model(Blog)

 
 
 class BlogEntry(Entity, Titled):
 
 
 class BlogEntry(Entity, Titled):


@@ -16,19 +25,19 @@ 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()
        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)
+       excerpt = models.TextField(blank=True, null=True)
+       tags = models.ManyToManyField(Tag, related_name='blogentries', blank=True, null=True)

        
        class Meta:
                ordering = ['-date']
        
        class Meta:
                ordering = ['-date']

-               verbose_name_plural = "Blog Entries"
+               verbose_name_plural = "blog entries"

 
 
 register_value_model(BlogEntry)
 
 
 class BlogView(MultiView):
 
 
 register_value_model(BlogEntry)
 
 
 class BlogView(MultiView):

-       PERMALINK_STYLE_CHOICES = (
+       ENTRY_PERMALINK_STYLE_CHOICES = (

                ('D', 'Year, month, and day'),
                ('M', 'Year and month'),
                ('Y', 'Year'),
                ('D', 'Year, month, and day'),
                ('M', 'Year and month'),
                ('Y', 'Year'),


@@ -38,56 +47,85 @@ class BlogView(MultiView):
        
        blog = models.ForeignKey(Blog, related_name='blogviews')
        
        
        blog = models.ForeignKey(Blog, related_name='blogviews')
        

-       index_template = models.ForeignKey(Template, related_name='blog_index_related')
-       archive_template = models.ForeignKey(Template, related_name='blog_archive_related')
-       tag_template = models.ForeignKey(Template, related_name='blog_tag_related')
-       entry_template = models.ForeignKey(Template, related_name='blog_entry_related')
+       index_page = models.ForeignKey(Page, related_name='blog_index_related')
+       entry_page = models.ForeignKey(Page, related_name='blog_entry_related')
+       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=PERMALINK_STYLE_CHOICES)
+       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')
        
        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})
+               raise ViewCanNotProvideSubpath
+       

        @property
        def urlpatterns(self):
                base_patterns = patterns('',
                        url(r'^$', self.index_view),
        @property
        def urlpatterns(self):
                base_patterns = patterns('',
                        url(r'^$', self.index_view),

-                       url((r'^(?:%s)/?' % self.tag_permalink_base), self.tag_view),
-                       url((r'^(?:%s)/(?P<tag>>[-\w]+)/?' % self.tag_permalink_base), self.tag_view)
+                       url((r'^(?:%s)/?$' % self.tag_permalink_base), self.tag_archive_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('',
                )
                if self.entry_permalink_style == 'D':
                        entry_patterns = patterns('',

-                               url(r'^(?P<year>\d{4})/?$', self.archive_view),
-                               url(r'^(?P<year>\d{4})/(?P<month>\d{2})/?$', self.archive_view),
-                               url(r'^(?P<year>\d{4})/(?P<month>\d{2})/(?P<day>\d+)/?$', self.archive_view),
-                               url(r'^(?P<year>\d{4})/(?P<month>\d{2})/(?P<day>\d+)/(?P<slug>[-\w]+)/?', self.entry_view)
+                               url(r'^(?P<year>\d{4})/?$', self.entry_archive_view),
+                               url(r'^(?P<year>\d{4})/(?P<month>\d{2})/?$', self.entry_archive_view),
+                               url(r'^(?P<year>\d{4})/(?P<month>\d{2})/(?P<day>\d{2})/?$', self.entry_archive_view),
+                               url(r'^(?P<year>\d{4})/(?P<month>\d{2})/(?P<day>\d{2})/(?P<slug>[-\w]+)/?$', self.entry_view)

                        )
                elif self.entry_permalink_style == 'M':
                        entry_patterns = patterns('',
                        )
                elif self.entry_permalink_style == 'M':
                        entry_patterns = patterns('',

-                               url(r'^(?P<year>\d{4})/?$', self.archive_view),
-                               url(r'^(?P<year>\d{4})/(?P<month>\d{2})/?$', self.archive_view),
-                               url(r'^(?P<year>\d{4})/(?P<month>\d{2})/(?P<slug>>[-\w]+)/?', self.entry_view)
+                               url(r'^(?P<year>\d{4})/?$', self.entry_archive_view),
+                               url(r'^(?P<year>\d{4})/(?P<month>\d{2})/?$', self.entry_archive_view),
+                               url(r'^(?P<year>\d{4})/(?P<month>\d{2})/(?P<slug>[-\w]+)/?$', self.entry_view)

                        )
                elif self.entry_permalink_style == 'Y':
                        entry_patterns = patterns('',
                        )
                elif self.entry_permalink_style == 'Y':
                        entry_patterns = patterns('',

-                               url(r'^(?P<year>\d{4})/?$', self.archive_view),
-                               url(r'^(?P<year>\d{4})/(?P<slug>>[-\w]+)/?', self.entry_view)
+                               url(r'^(?P<year>\d{4})/?$', self.entry_archive_view),
+                               url(r'^(?P<year>\d{4})/(?P<slug>[-\w]+)/?$', self.entry_view)

                        )
                elif self.entry_permalink_style == 'B':
                        entry_patterns = patterns('',
                        )
                elif self.entry_permalink_style == 'B':
                        entry_patterns = patterns('',

-                               url((r'^(?:%s)/?' % self.entry_permalink_base), self.archive_view),
-                               url((r'^(?:%s)/(?P<slug>>[-\w]+)/?' % self.entry_permalink_base), self.entry_view)
+                               url((r'^(?:%s)/?$' % self.entry_permalink_base), self.entry_archive_view),
+                               url((r'^(?:%s)/(?P<slug>[-\w]+)/?$' % self.entry_permalink_base), self.entry_view)

                        )
                else:
                        entry_patterns = patterns('',
                        )
                else:
                        entry_patterns = patterns('',

-                               url(r'^(?P<slug>>[-\w]+)/?', self.entry_view)
+                               url(r'^(?P<slug>[-\w]+)/?$', self.entry_view)

                        )
                return base_patterns + entry_patterns
        
                        )
                return base_patterns + entry_patterns
        

-       def index_view(self, request):
-               entries = self.blog.entries.order_by('-date')
-               return HttpResponse(self.index_template.django_template.render(RequestContext(request, {'blog': self.blog, 'entries': entries})), mimetype=self.index_template.mimetype)
+       def index_view(self, request, node=None, extra_context=None):
+               entries = self.blog.entries.all()
+               if self.entries_per_page:
+                       paginated_page = paginate(request, entries, self.entries_per_page)
+                       entries = paginated_page.object_list
+               else:
+                       paginated_page = None
+               context = {}
+               context.update(extra_context or {})
+               context.update({'blog': self.blog, 'entries': entries, 'paginated_page': paginated_page})
+               return self.index_page.render_to_response(node, request, extra_context=context)

        
        

-       def archive_view(self, request, year=None, month=None, day=None):
+       def entry_view(self, request, slug, year=None, month=None, day=None, node=None, extra_context=None):

                entries = self.blog.entries.all()
                if year:
                        entries = entries.filter(date__year=year)
                entries = self.blog.entries.all()
                if year:
                        entries = entries.filter(date__year=year)


@@ -95,13 +133,18 @@ class BlogView(MultiView):
                        entries = entries.filter(date__month=month)
                if day:
                        entries = entries.filter(date__day=day)
                        entries = entries.filter(date__month=month)
                if day:
                        entries = entries.filter(date__day=day)

-               return HttpResponse(self.archive_template.django_template.render(RequestContext(request, {'blog': self.blog, 'year': year, 'month': month, 'day': day, 'entries': entries})), mimetype=self.archive_template.mimetype)
-       
-       def tag_view(self, request, tag=None):
-               # return HttpResponse(self.tag_template.django_template.render(RequestContext(request, {'blog': self.blog, 'tag': tag, 'entries': None})), mimetype=self.tag_template.mimetype)
-               raise Http404
+               try:
+                       entry = entries.get(slug=slug)
+               except:
+                       raise Http404
+               context = {}
+               context.update(extra_context or {})
+               context.update({'blog': self.blog, 'entry': entry})
+               return self.entry_page.render_to_response(node, request, extra_context=context)

        
        

-       def entry_view(self, request, slug, year=None, month=None, day=None):
+       def entry_archive_view(self, request, year=None, month=None, day=None, node=None, extra_context=None):
+               if not self.entry_archive_page:
+                       raise Http404

                entries = self.blog.entries.all()
                if year:
                        entries = entries.filter(date__year=year)
                entries = self.blog.entries.all()
                if year:
                        entries = entries.filter(date__year=year)


@@ -109,23 +152,70 @@ class BlogView(MultiView):
                        entries = entries.filter(date__month=month)
                if day:
                        entries = entries.filter(date__day=day)
                        entries = entries.filter(date__month=month)
                if day:
                        entries = entries.filter(date__day=day)

-               try:
-                       entry = entries.get(slug=slug)
-               except:
+               if self.entries_per_page:
+                       paginated_page = paginate(request, entries, self.entries_per_page)
+                       entries = paginated_page.object_list
+               else:
+                       paginated_page = None
+               context = {}
+               context.update(extra_context or {})
+               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_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.all()
+               for tag in tags:
+                       entries = entries.filter(tags=tag)
+               if entries.count() <= 0:

                        raise Http404
                        raise Http404

-               return HttpResponse(self.entry_template.django_template.render(RequestContext(request, {'blog': self.blog, 'entry': entry})), mimetype=self.entry_template.mimetype)
+               
+               if self.entries_per_page:
+                       paginated_page = paginate(request, entries, self.entries_per_page)
+                       entries = paginated_page.object_list
+               else:
+                       paginated_page = None
+               context = {}
+               context.update(extra_context or {})
+               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):
+               if not self.tag_archive_page:
+                       raise Http404
+               context = {}
+               context.update(extra_context or {})
+               context.update({'blog': self.blog})
+               return self.tag_archive_page.render_to_response(node, request, extra_context=context)

 
 
 class Newsletter(Entity, Titled):
        pass
 
 
 
 
 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')
        date = models.DateTimeField(default=datetime.now)
        lede = models.TextField(null=True, blank=True)
        full_text = models.TextField()
 class NewsletterArticle(Entity, Titled):
        newsletter = models.ForeignKey(Newsletter, related_name='articles')
        authors = models.ManyToManyField(getattr(settings, 'PHILO_PERSON_MODULE', 'auth.User'), related_name='newsletterarticles')
        date = models.DateTimeField(default=datetime.now)
        lede = models.TextField(null=True, blank=True)
        full_text = models.TextField()

+       
+       class Meta:
+               ordering = ['-date']
+               unique_together = (('newsletter', 'slug'),)

 
 
 register_value_model(NewsletterArticle)
 
 
 register_value_model(NewsletterArticle)


@@ -135,28 +225,95 @@ class NewsletterIssue(Entity, Titled):
        newsletter = models.ForeignKey(Newsletter, related_name='issues')
        number = models.PositiveIntegerField()
        articles = models.ManyToManyField(NewsletterArticle)
        newsletter = models.ForeignKey(Newsletter, related_name='issues')
        number = models.PositiveIntegerField()
        articles = models.ManyToManyField(NewsletterArticle)

+       
+       class Meta:
+               ordering = ['-number']
+               unique_together = (('newsletter', 'number'),)
+
+
+register_value_model(NewsletterIssue)

 
 
 class NewsletterView(MultiView):
 
 
 class NewsletterView(MultiView):

+       ARTICLE_PERMALINK_STYLE_CHOICES = (
+               ('D', 'Year, month, and day'),
+               ('M', 'Year and month'),
+               ('Y', 'Year'),
+               ('S', 'Slug only')
+       )
+       

        newsletter = models.ForeignKey(Newsletter, related_name='newsletterviews')
        
        newsletter = models.ForeignKey(Newsletter, related_name='newsletterviews')
        

-       index_template = models.ForeignKey(Template, related_name='newsletter_index_related')
-       article_template = models.ForeignKey(Template, related_name='newsletter_article_related')
-       issue_template = models.ForeignKey(Template, related_name='newsletter_issue_related')
+       index_page = models.ForeignKey(Page, related_name='newsletter_index_related')
+       article_page = models.ForeignKey(Page, related_name='newsletter_article_related')
+       article_archive_page = models.ForeignKey(Page, related_name='newsletter_article_archive_related', null=True, blank=True)
+       issue_page = models.ForeignKey(Page, related_name='newsletter_issue_related')
+       issue_archive_page = models.ForeignKey(Page, related_name='newsletter_issue_archive_related', null=True, blank=True)
+       
+       article_permalink_style = models.CharField(max_length=1, choices=ARTICLE_PERMALINK_STYLE_CHOICES)
+       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('',
                        url(r'^$', self.index_view),
        
        @property
        def urlpatterns(self):
                base_patterns = patterns('',
                        url(r'^$', self.index_view),

-                       url(r'^articles/(?P<year>\d{4})/(?P<month>\d{2})/(?P<day>\d+)/(?P<slug>[-\w]+)/?', self.article_view),
-                       url(r'^issues/(?P<number>\d+)/?', self.issue_view),
+                       url((r'^(?:%s)/?$' % self.issue_permalink_base), self.issue_archive_view),
+                       url((r'^(?:%s)/(?P<number>\d+)/?$' % self.issue_permalink_base), self.issue_view)
+               )
+               article_patterns = patterns('',
+                       url((r'^(?:%s)/?$' % self.article_permalink_base), self.article_archive_view)

                )
                )

-               return base_patterns
+               if self.article_permalink_style in 'DMY':
+                       article_patterns += patterns('',
+                               url((r'^(?:%s)/(?P<year>\d{4})/?$' % self.article_permalink_base), self.article_archive_view)
+                       )
+                       if self.article_permalink_style in 'DM':
+                               article_patterns += patterns('',
+                                       url((r'^(?:%s)/(?P<year>\d{4})/(?P<month>\d{2})/?$' % self.article_permalink_base), self.article_archive_view)
+                               )
+                               if self.article_permalink_style == 'D':
+                                       article_patterns += patterns('',
+                                               url((r'^(?:%s)/(?P<year>\d{4})/(?P<month>\d{2})/(?P<day>\d{2})/?$' % self.article_permalink_base), self.article_archive_view),
+                                               url((r'^(?:%s)/(?P<year>\d{4})/(?P<month>\d{2})/(?P<day>\d{2})/(?P<slug>[-\w]+)/?$' % self.article_permalink_base), self.article_view)
+                                       )
+                               else:
+                                       article_patterns += patterns('',
+                                               url((r'^(?:%s)/(?P<year>\d{4})/(?P<month>\d{2})/(?P<slug>[-\w]+)/?$' % self.article_permalink_base), self.article_view)
+                                       )
+                       else:
+                               article_patterns += patterns('',
+                                       url((r'^(?:%s)/(?P<year>\d{4})/(?P<slug>[-\w]+)/?$' % self.article_permalink_base), self.article_view)
+                               )
+               else:
+                       article_patterns += patterns('',
+                               url((r'^(?:%s)/(?P<slug>[-\w]+)/?$' % self.article_permalink_base), self.article_view)
+                       )
+               return base_patterns + article_patterns

        
        

-       def index_view(self, request):
-               return HttpResponse(self.index_template.django_template.render(RequestContext(request, {'newsletter': self.newsletter})), mimetype=self.index_template.mimetype)
+       def index_view(self, request, node=None, extra_context=None):
+               context = {}
+               context.update(extra_context or {})
+               context.update({'newsletter': self.newsletter})
+               return self.index_page.render_to_response(node, request, extra_context=context)

        
        

-       def article_view(self, request, slug, year=None, month=None, day=None):
+       def article_view(self, request, slug, year=None, month=None, day=None, node=None, extra_context=None):

                articles = self.newsletter.articles.all()
                if year:
                        articles = articles.filter(date__year=year)
                articles = self.newsletter.articles.all()
                if year:
                        articles = articles.filter(date__year=year)


@@ -168,11 +325,40 @@ class NewsletterView(MultiView):
                        article = articles.get(slug=slug)
                except:
                        raise Http404
                        article = articles.get(slug=slug)
                except:
                        raise Http404

-               return HttpResponse(self.article_template.django_template.render(RequestContext(request, {'newsletter': self.newsletter, 'article': article})), mimetype=self.article_template.mimetype)
+               context = {}
+               context.update(extra_context or {})
+               context.update({'newsletter': self.newsletter, 'article': article})
+               return self.article_page.render_to_response(node, request, extra_context=context)

        
        

-       def issue_view(self, request, number):
+       def article_archive_view(self, request, year=None, month=None, day=None, node=None, extra_context=None):
+               if not self.article_archive_page:
+                       raise Http404
+               articles = self.newsletter.articles.all()
+               if year:
+                       articles = articles.filter(date__year=year)
+               if month:
+                       articles = articles.filter(date__month=month)
+               if day:
+                       articles = articles.filter(date__day=day)
+               context = {}
+               context.update(extra_context or {})
+               context.update({'newsletter': self.newsletter, 'year': year, 'month': month, 'day': day, 'articles': articles})
+               return self.article_archive_page.render_to_response(node, request, extra_context=context)
+       
+       def issue_view(self, request, number, node=None, extra_context=None):

                try:
                        issue = self.newsletter.issues.get(number=number)
                except:
                        raise Http404
                try:
                        issue = self.newsletter.issues.get(number=number)
                except:
                        raise Http404

-               return HttpResponse(self.issue_template.django_template.render(RequestContext(request, {'newsletter': self.newsletter, 'issue': issue})), mimetype=self.issue_template.mimetype)
\ No newline at end of file
+               context = {}
+               context.update(extra_context or {})
+               context.update({'newsletter': self.newsletter, 'issue': issue})
+               return self.issue_page.render_to_response(node, request, extra_context=context)
+       
+       def issue_archive_view(self, request, node=None, extra_context=None):
+               if not self.issue_archive_page:
+                       raise Http404
+               context = {}
+               context.update(extra_context or {})
+               context.update({'newsletter': self.newsletter})
+               return self.issue_archive_page.render_to_response(node, request, extra_context=context)
\ No newline at end of file