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