contrib/penfield/models.py

   1 from django.db import models
   2 from django.conf import settings
   3 from philo.models import Tag, Titled, Entity, MultiView, Page, register_value_model
   4 from philo.exceptions import ViewCanNotProvideSubpath
   5 from django.conf.urls.defaults import url, patterns, include
   6 from django.core.urlresolvers import reverse
   7 from django.http import Http404, HttpResponse
   8 from datetime import datetime
   9 from philo.utils import paginate
  10 from philo.contrib.penfield.validators import validate_pagination_count
  11 from django.utils.feedgenerator import Atom1Feed, Rss201rev2Feed
  12
  13
  14 class Blog(Entity, Titled):
  15         @property
  16         def entry_tags(self):
  17                 """ Returns a QuerySet of Tags that are used on any entries in this blog. """
  18                 return Tag.objects.filter(blogentries__blog=self).distinct()
  19
  20         @property
  21         def entry_dates(self):
  22                 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')}
  23                 return dates
  24
  25
  26 register_value_model(Blog)
  27
  28
  29 class BlogEntry(Entity, Titled):
  30         blog = models.ForeignKey(Blog, related_name='entries', blank=True, null=True)
  31         author = models.ForeignKey(getattr(settings, 'PHILO_PERSON_MODULE', 'auth.User'), related_name='blogentries')
  32         date = models.DateTimeField(default=datetime.now)
  33         content = models.TextField()
  34         excerpt = models.TextField(blank=True, null=True)
  35         tags = models.ManyToManyField(Tag, related_name='blogentries', blank=True, null=True)
  36
  37         class Meta:
  38                 ordering = ['-date']
  39                 verbose_name_plural = "blog entries"
  40
  41
  42 register_value_model(BlogEntry)
  43
  44
  45 class BlogView(MultiView):
  46         ENTRY_PERMALINK_STYLE_CHOICES = (
  47                 ('D', 'Year, month, and day'),
  48                 ('M', 'Year and month'),
  49                 ('Y', 'Year'),
  50                 ('B', 'Custom base'),
  51                 ('N', 'No base')
  52         )
  53
  54         blog = models.ForeignKey(Blog, related_name='blogviews')
  55
  56         index_page = models.ForeignKey(Page, related_name='blog_index_related')
  57         entry_page = models.ForeignKey(Page, related_name='blog_entry_related')
  58         entry_archive_page = models.ForeignKey(Page, related_name='blog_entry_archive_related', null=True, blank=True)
  59         tag_page = models.ForeignKey(Page, related_name='blog_tag_related')
  60         tag_archive_page = models.ForeignKey(Page, related_name='blog_tag_archive_related', null=True, blank=True)
  61         entries_per_page = models.IntegerField(blank=True, validators=[validate_pagination_count], null=True)
  62
  63         entry_permalink_style = models.CharField(max_length=1, choices=ENTRY_PERMALINK_STYLE_CHOICES)
  64         entry_permalink_base = models.CharField(max_length=255, blank=False, default='entries')
  65         tag_permalink_base = models.CharField(max_length=255, blank=False, default='tags')
  66         feed_suffix = models.CharField(max_length=255, blank=False, default='feed')
  67         feeds_enabled = models.BooleanField()
  68
  69         def __unicode__(self):
  70                 return u'BlogView for %s' % self.blog.title
  71
  72         @property
  73         def _feeds_enabled(self):
  74                 return self.feeds_enabled
  75
  76         @property
  77         def per_page(self):
  78                 return self.entries_per_page
  79
  80         def get_subpath(self, obj):
  81                 if isinstance(obj, BlogEntry):
  82                         if obj.blog == self.blog:
  83                                 entry_view_args = {'slug': obj.slug}
  84                                 if self.entry_permalink_style in 'DMY':
  85                                         entry_view_args.update({'year': str(obj.date.year).zfill(4)})
  86                                         if self.entry_permalink_style in 'DM':
  87                                                 entry_view_args.update({'month': str(obj.date.month).zfill(2)})
  88                                                 if self.entry_permalink_style == 'D':
  89                                                         entry_view_args.update({'day': str(obj.date.day).zfill(2)})
  90                                 return reverse(self.entry_view, urlconf=self, kwargs=entry_view_args)
  91                 elif isinstance(obj, Tag):
  92                         if obj in self.blog.entry_tags:
  93                                 return reverse(self.tag_view, urlconf=self, kwargs={'tag_slugs': obj.slug})
  94                 elif isinstance(obj, (str, unicode)):
  95                         split_obj = obj.split(':')
  96                         if len(split_obj) > 1:
  97                                 entry_archive_view_args = {}
  98                                 if split_obj[0].lower() == 'archives':
  99                                         entry_archive_view_args.update({'year': str(int(split_obj[1])).zfill(4)})
 100                                         if len(split_obj) > 2:
 101                                                 entry_archive_view_args.update({'month': str(int(split_obj[2])).zfill(2)})
 102                                                 if len(split_obj) > 3:
 103                                                         entry_archive_view_args.update({'day': str(int(split_obj[3])).zfill(2)})
 104                                         return reverse(self.entry_archive_view, urlconf=self, kwargs=entry_archive_view_args)
 105                 raise ViewCanNotProvideSubpath
 106
 107         def page_view(self, func, page, list_var='entries'):
 108                 """
 109                 Wraps an object-fetching function and renders the results as a page.
 110                 """
 111                 def inner(request, node=None, extra_context=None, **kwargs):
 112                         objects, extra_context = func(request, node, extra_context, **kwargs)
 113
 114                         context = self.get_context()
 115                         context.update(extra_context or {})
 116
 117                         if 'page' in kwargs or 'page' in request.GET:
 118                                 page_num = kwargs.get('page', request.GET.get('page', 1))
 119                                 paginator, paginated_page, objects = paginate(objects, self.per_page, page_num)
 120                                 context.update({'paginator': paginator, 'paginated_page': paginated_page, list_var: objects})
 121                         else:
 122                                 context.update({list_var: objects})
 123
 124                         return page.render_to_response(node, request, extra_context=context)
 125
 126                 return inner
 127
 128         def get_atom_feed(self):
 129                 return Atom1Feed(self.blog.title, '/%s/%s/' % (node.get_absolute_url().strip('/'), reverse(reverse_name, urlconf=self, kwargs=kwargs).strip('/')), '', subtitle='')
 130
 131         def get_rss_feed(self):
 132                 return Rss201rev2Feed(self.blog.title, '/%s/%s/' % (node.get_absolute_url().strip('/'), reverse(reverse_name, urlconf=self, kwargs=kwargs).strip('/')), '')
 133
 134         def feed_view(self, func, reverse_name):
 135                 """
 136                 Wraps an object-fetching function and renders the results as a rss or atom feed.
 137                 """
 138                 def inner(request, node=None, extra_context=None, **kwargs):
 139                         objects, extra_context = func(request, node, extra_context, **kwargs)
 140
 141                         if 'HTTP_ACCEPT' in request.META and 'rss' in request.META['HTTP_ACCEPT'] and 'atom' not in request.META['HTTP_ACCEPT']:
 142                                 feed = self.get_rss_feed()
 143                         else:
 144                                 feed = self.get_atom_feed()
 145
 146                         for obj in objects:
 147                                 feed.add_item(obj.title, '/%s/%s/' % (node.get_absolute_url().strip('/'), self.get_subpath(obj).strip('/')), description=obj.excerpt)
 148
 149                         response = HttpResponse(mimetype=feed.mime_type)
 150                         feed.write(response, 'utf-8')
 151                         return response
 152
 153                 return inner
 154
 155         def get_context(self):
 156                 return {'blog': self.blog}
 157
 158         def feed_patterns(self, object_fetcher, page, base_name):
 159                 feed_name = '%s_feed' % base_name
 160                 urlpatterns = patterns('',
 161                         url(r'^%s/$' % self.feed_suffix, self.feed_view(object_fetcher, feed_name), name=feed_name),
 162                         url(r'^$', self.page_view(object_fetcher, page), name=base_name)
 163                 )
 164                 return urlpatterns
 165
 166         @property
 167         def urlpatterns(self):
 168                 base_patterns = patterns('',
 169                         url(r'^', include(self.feed_patterns(self.get_all_entries, self.index_page, 'index'))),
 170                         url((r'^(?:%s)/?$' % self.tag_permalink_base), self.tag_archive_view),
 171                         url((r'^(?:%s)/(?P<tag_slugs>[-\w]+[-+/\w]*)/' % self.tag_permalink_base), include(self.feed_patterns(self.get_entries_by_tag, self.tag_page, 'entries_by_tag')))
 172                 )
 173                 if self.entry_permalink_style == 'D':
 174                         entry_patterns = patterns('',
 175                                 url(r'^(?P<year>\d{4})/', include(self.feed_patterns(self.get_entries_by_ymd, self.entry_archive_page, 'entries_by_year'))),
 176                                 url(r'^(?P<year>\d{4})/(?P<month>\d{2})/?$', include(self.feed_patterns(self.get_entries_by_ymd, self.entry_archive_page, 'entries_by_month'))),
 177                                 url(r'^(?P<year>\d{4})/(?P<month>\d{2})/(?P<day>\d{2})/?$', include(self.feed_patterns(self.get_entries_by_ymd, self.entry_archive_page, 'entries_by_day'))),
 178                                 url(r'^(?P<year>\d{4})/(?P<month>\d{2})/(?P<day>\d{2})/(?P<slug>[-\w]+)/?$', self.entry_view)
 179                         )
 180                 elif self.entry_permalink_style == 'M':
 181                         entry_patterns = patterns('',
 182                                 url(r'^(?P<year>\d{4})/', include(self.feed_patterns(self.get_entries_by_ymd, self.entry_archive_page, 'entries_by_year'))),
 183                                 url(r'^(?P<year>\d{4})/(?P<month>\d{2})/?$', include(self.feed_patterns(self.get_entries_by_ymd, self.entry_archive_page, 'entries_by_month'))),
 184                                 url(r'^(?P<year>\d{4})/(?P<month>\d{2})/(?P<slug>[-\w]+)/?$', self.entry_view)
 185                         )
 186                 elif self.entry_permalink_style == 'Y':
 187                         entry_patterns = patterns('',
 188                                 url(r'^(?P<year>\d{4})/', include(self.feed_patterns(self.get_entries_by_ymd, self.entry_archive_page, 'entries_by_year'))),
 189                                 url(r'^(?P<year>\d{4})/(?P<slug>[-\w]+)/?$', self.entry_view)
 190                         )
 191                 elif self.entry_permalink_style == 'B':
 192                         entry_patterns = patterns('',
 193                                 url((r'^(?:%s)/?$' % self.entry_permalink_base),
 194                                         url(r'^(?P<year>\d{4})/', include(self.feed_patterns(self.get_all_entries, self.entry_archive_page, 'entries_by_year'))),),
 195                                 url((r'^(?:%s)/(?P<slug>[-\w]+)/?$' % self.entry_permalink_base), self.entry_view)
 196                         )
 197                 else:
 198                         entry_patterns = patterns('',
 199                                 url(r'^(?P<slug>[-\w]+)/?$', self.entry_view)
 200                         )
 201                 return base_patterns + entry_patterns
 202
 203         def get_all_entries(self, request, node=None, extra_context=None):
 204                 return self.blog.entries.all(), extra_context
 205
 206         def get_entries_by_ymd(self, request, year=None, month=None, day=None, node=None, extra_context=None):
 207                 if not self.entry_archive_page:
 208                         raise Http404
 209                 entries = self.blog.entries.all()
 210                 if year:
 211                         entries = entries.filter(date__year=year)
 212                 if month:
 213                         entries = entries.filter(date__month=month)
 214                 if day:
 215                         entries = entries.filter(date__day=day)
 216
 217                 context = extra_context or {}
 218                 context.update({'year': year, 'month': month, 'day': day})
 219                 return entries, context
 220
 221         def get_entries_by_tag(self, request, node=None, extra_context=None):
 222                 tags = []
 223                 for tag_slug in tag_slugs.replace('+', '/').split('/'):
 224                         if tag_slug: # ignore blank slugs, handles for multiple consecutive separators (+ or /)
 225                                 try:
 226                                         tag = self.blog.entry_tags.get(slug=tag_slug)
 227                                 except:
 228                                         raise Http404
 229                                 tags.append(tag)
 230                 if len(tags) <= 0:
 231                         raise Http404
 232
 233                 entries = self.blog.entries.all()
 234                 for tag in tags:
 235                         entries = entries.filter(tags=tag)
 236                 if entries.count() <= 0:
 237                         raise Http404
 238
 239                 return entries, extra_context
 240
 241         def entry_view(self, request, slug, year=None, month=None, day=None, node=None, extra_context=None):
 242                 entries = self.blog.entries.all()
 243                 if year:
 244                         entries = entries.filter(date__year=year)
 245                 if month:
 246                         entries = entries.filter(date__month=month)
 247                 if day:
 248                         entries = entries.filter(date__day=day)
 249                 try:
 250                         entry = entries.get(slug=slug)
 251                 except:
 252                         raise Http404
 253                 context = self.get_context()
 254                 context.update(extra_context or {})
 255                 context.update({'entry': entry})
 256                 return self.entry_page.render_to_response(node, request, extra_context=context)
 257
 258         def tag_archive_view(self, request, node=None, extra_context=None):
 259                 if not self.tag_archive_page:
 260                         raise Http404
 261                 context = {}
 262                 context.update(extra_context or {})
 263                 context.update({'blog': self.blog})
 264                 return self.tag_archive_page.render_to_response(node, request, extra_context=context)
 265
 266
 267 class Newsletter(Entity, Titled):
 268         pass
 269
 270
 271 register_value_model(Newsletter)
 272
 273
 274 class NewsletterArticle(Entity, Titled):
 275         newsletter = models.ForeignKey(Newsletter, related_name='articles')
 276         authors = models.ManyToManyField(getattr(settings, 'PHILO_PERSON_MODULE', 'auth.User'), related_name='newsletterarticles')
 277         date = models.DateTimeField(default=datetime.now)
 278         lede = models.TextField(null=True, blank=True)
 279         full_text = models.TextField()
 280
 281         class Meta:
 282                 get_latest_by = 'date'
 283                 ordering = ['-date']
 284                 unique_together = (('newsletter', 'slug'),)
 285
 286
 287 register_value_model(NewsletterArticle)
 288
 289
 290 class NewsletterIssue(Entity, Titled):
 291         newsletter = models.ForeignKey(Newsletter, related_name='issues')
 292         number = models.PositiveIntegerField()
 293         articles = models.ManyToManyField(NewsletterArticle, related_name='issues')
 294
 295         class Meta:
 296                 ordering = ['-number']
 297                 unique_together = (('newsletter', 'number'),)
 298
 299
 300 register_value_model(NewsletterIssue)
 301
 302
 303 class NewsletterView(MultiView):
 304         ARTICLE_PERMALINK_STYLE_CHOICES = (
 305                 ('D', 'Year, month, and day'),
 306                 ('M', 'Year and month'),
 307                 ('Y', 'Year'),
 308                 ('S', 'Slug only')
 309         )
 310
 311         newsletter = models.ForeignKey(Newsletter, related_name='newsletterviews')
 312
 313         index_page = models.ForeignKey(Page, related_name='newsletter_index_related')
 314         article_page = models.ForeignKey(Page, related_name='newsletter_article_related')
 315         article_archive_page = models.ForeignKey(Page, related_name='newsletter_article_archive_related', null=True, blank=True)
 316         issue_page = models.ForeignKey(Page, related_name='newsletter_issue_related')
 317         issue_archive_page = models.ForeignKey(Page, related_name='newsletter_issue_archive_related', null=True, blank=True)
 318
 319         article_permalink_style = models.CharField(max_length=1, choices=ARTICLE_PERMALINK_STYLE_CHOICES)
 320         article_permalink_base = models.CharField(max_length=255, blank=False, default='articles')
 321         issue_permalink_base = models.CharField(max_length=255, blank=False, default='issues')
 322
 323         def get_subpath(self, obj):
 324                 if isinstance(obj, NewsletterArticle):
 325                         if obj.newsletter == self.newsletter:
 326                                 article_view_args = {'slug': obj.slug}
 327                                 if self.article_permalink_style in 'DMY':
 328                                         article_view_args.update({'year': str(obj.date.year).zfill(4)})
 329                                         if self.article_permalink_style in 'DM':
 330                                                 article_view_args.update({'month': str(obj.date.month).zfill(2)})
 331                                                 if self.article_permalink_style == 'D':
 332                                                         article_view_args.update({'day': str(obj.date.day).zfill(2)})
 333                                 return reverse(self.article_view, urlconf=self, kwargs=article_view_args)
 334                 elif isinstance(obj, NewsletterIssue):
 335                         if obj.newsletter == self.newsletter:
 336                                 return reverse(self.issue_view, urlconf=self, kwargs={'number': str(obj.number)})
 337                 raise ViewCanNotProvideSubpath
 338
 339         @property
 340         def urlpatterns(self):
 341                 base_patterns = patterns('',
 342                         url(r'^$', self.index_view),
 343                         url((r'^(?:%s)/?$' % self.issue_permalink_base), self.issue_archive_view),
 344                         url((r'^(?:%s)/(?P<number>\d+)/?$' % self.issue_permalink_base), self.issue_view)
 345                 )
 346                 article_patterns = patterns('',
 347                         url((r'^(?:%s)/?$' % self.article_permalink_base), self.article_archive_view)
 348                 )
 349                 if self.article_permalink_style in 'DMY':
 350                         article_patterns += patterns('',
 351                                 url((r'^(?:%s)/(?P<year>\d{4})/?$' % self.article_permalink_base), self.article_archive_view)
 352                         )
 353                         if self.article_permalink_style in 'DM':
 354                                 article_patterns += patterns('',
 355                                         url((r'^(?:%s)/(?P<year>\d{4})/(?P<month>\d{2})/?$' % self.article_permalink_base), self.article_archive_view)
 356                                 )
 357                                 if self.article_permalink_style == 'D':
 358                                         article_patterns += patterns('',
 359                                                 url((r'^(?:%s)/(?P<year>\d{4})/(?P<month>\d{2})/(?P<day>\d{2})/?$' % self.article_permalink_base), self.article_archive_view),
 360                                                 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)
 361                                         )
 362                                 else:
 363                                         article_patterns += patterns('',
 364                                                 url((r'^(?:%s)/(?P<year>\d{4})/(?P<month>\d{2})/(?P<slug>[-\w]+)/?$' % self.article_permalink_base), self.article_view)
 365                                         )
 366                         else:
 367                                 article_patterns += patterns('',
 368                                         url((r'^(?:%s)/(?P<year>\d{4})/(?P<slug>[-\w]+)/?$' % self.article_permalink_base), self.article_view)
 369                                 )
 370                 else:
 371                         article_patterns += patterns('',
 372                                 url((r'^(?:%s)/(?P<slug>[-\w]+)/?$' % self.article_permalink_base), self.article_view)
 373                         )
 374                 return base_patterns + article_patterns
 375
 376         def index_view(self, request, node=None, extra_context=None):
 377                 context = {}
 378                 context.update(extra_context or {})
 379                 context.update({'newsletter': self.newsletter})
 380                 return self.index_page.render_to_response(node, request, extra_context=context)
 381
 382         def article_view(self, request, slug, year=None, month=None, day=None, node=None, extra_context=None):
 383                 articles = self.newsletter.articles.all()
 384                 if year:
 385                         articles = articles.filter(date__year=year)
 386                 if month:
 387                         articles = articles.filter(date__month=month)
 388                 if day:
 389                         articles = articles.filter(date__day=day)
 390                 try:
 391                         article = articles.get(slug=slug)
 392                 except:
 393                         raise Http404
 394                 context = {}
 395                 context.update(extra_context or {})
 396                 context.update({'newsletter': self.newsletter, 'article': article})
 397                 return self.article_page.render_to_response(node, request, extra_context=context)
 398
 399         def article_archive_view(self, request, year=None, month=None, day=None, node=None, extra_context=None):
 400                 if not self.article_archive_page:
 401                         raise Http404
 402                 articles = self.newsletter.articles.all()
 403                 if year:
 404                         articles = articles.filter(date__year=year)
 405                 if month:
 406                         articles = articles.filter(date__month=month)
 407                 if day:
 408                         articles = articles.filter(date__day=day)
 409                 context = {}
 410                 context.update(extra_context or {})
 411                 context.update({'newsletter': self.newsletter, 'year': year, 'month': month, 'day': day, 'articles': articles})
 412                 return self.article_archive_page.render_to_response(node, request, extra_context=context)
 413
 414         def issue_view(self, request, number, node=None, extra_context=None):
 415                 try:
 416                         issue = self.newsletter.issues.get(number=number)
 417                 except:
 418                         raise Http404
 419                 context = {}
 420                 context.update(extra_context or {})
 421                 context.update({'newsletter': self.newsletter, 'issue': issue})
 422                 return self.issue_page.render_to_response(node, request, extra_context=context)
 423
 424         def issue_archive_view(self, request, node=None, extra_context=None):
 425                 if not self.issue_archive_page:
 426                         raise Http404
 427                 context = {}
 428                 context.update(extra_context or {})
 429                 context.update({'newsletter': self.newsletter})
 430                 return self.issue_archive_page.render_to_response(node, request, extra_context=context)