contrib/penfield/models.py

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