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