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