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