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 index_view(self, request, node=None, extra_context=None):
 134                 pagination = paginate(self.blog.entries.all(), self.entries_per_page, request.GET.get('page', 1))
 135                 context = {}
 136                 context.update(extra_context or {})
 137                 context.update({'blog': self.blog, 'pagination': pagination})
 138                 return self.index_page.render_to_response(node, request, extra_context=context)
 139
 140         def entry_view(self, request, slug, year=None, month=None, day=None, node=None, extra_context=None):
 141                 entries = self.blog.entries.all()
 142                 if year:
 143                         entries = entries.filter(date__year=year)
 144                 if month:
 145                         entries = entries.filter(date__month=month)
 146                 if day:
 147                         entries = entries.filter(date__day=day)
 148                 try:
 149                         entry = entries.get(slug=slug)
 150                 except:
 151                         raise Http404
 152                 context = {}
 153                 context.update(extra_context or {})
 154                 context.update({'blog': self.blog, 'entry': entry})
 155                 return self.entry_page.render_to_response(node, request, extra_context=context)
 156
 157         def entry_archive_view(self, request, year=None, month=None, day=None, node=None, extra_context=None):
 158                 if not self.entry_archive_page:
 159                         raise Http404
 160                 entries = self.blog.entries.all()
 161                 if year:
 162                         entries = entries.filter(date__year=year)
 163                 if month:
 164                         entries = entries.filter(date__month=month)
 165                 if day:
 166                         entries = entries.filter(date__day=day)
 167
 168                 pagination = paginate(entries, self.entries_per_page, request.GET.get('page', 1))
 169                 context = {}
 170                 context.update(extra_context or {})
 171                 context.update({'blog': self.blog, 'year': year, 'month': month, 'day': day, 'pagination': pagination})
 172                 return self.entry_archive_page.render_to_response(node, request, extra_context=context)
 173
 174         def tag_view(self, request, tag_slugs, node=None, extra_context=None):
 175                 tags = []
 176                 for tag_slug in tag_slugs.replace('+', '/').split('/'):
 177                         if tag_slug: # ignore blank slugs, handles for multiple consecutive separators (+ or /)
 178                                 try:
 179                                         tag = self.blog.entry_tags.get(slug=tag_slug)
 180                                 except:
 181                                         raise Http404
 182                                 tags.append(tag)
 183                 if len(tags) <= 0:
 184                         raise Http404
 185
 186                 entries = self.blog.entries.all()
 187                 for tag in tags:
 188                         entries = entries.filter(tags=tag)
 189                 if entries.count() <= 0:
 190                         raise Http404
 191
 192                 pagination = paginate(entries, self.entries_per_page, request.GET.get('page', 1))
 193                 context = {}
 194                 context.update(extra_context or {})
 195                 context.update({'blog': self.blog, 'tags': tags, 'pagination': pagination})
 196                 return self.tag_page.render_to_response(node, request, extra_context=context)
 197
 198         def tag_archive_view(self, request, node=None, extra_context=None):
 199                 if not self.tag_archive_page:
 200                         raise Http404
 201                 context = {}
 202                 context.update(extra_context or {})
 203                 context.update({'blog': self.blog})
 204                 return self.tag_archive_page.render_to_response(node, request, extra_context=context)
 205
 206
 207 class Newsletter(Entity, Titled):
 208         pass
 209
 210
 211 register_value_model(Newsletter)
 212
 213
 214 class NewsletterArticle(Entity, Titled):
 215         newsletter = models.ForeignKey(Newsletter, related_name='articles')
 216         authors = models.ManyToManyField(getattr(settings, 'PHILO_PERSON_MODULE', 'auth.User'), related_name='newsletterarticles')
 217         date = models.DateTimeField(default=datetime.now)
 218         lede = models.TextField(null=True, blank=True)
 219         full_text = models.TextField()
 220
 221         class Meta:
 222                 get_latest_by = 'date'
 223                 ordering = ['-date']
 224                 unique_together = (('newsletter', 'slug'),)
 225
 226
 227 register_value_model(NewsletterArticle)
 228
 229
 230 class NewsletterIssue(Entity, Titled):
 231         newsletter = models.ForeignKey(Newsletter, related_name='issues')
 232         number = models.PositiveIntegerField()
 233         articles = models.ManyToManyField(NewsletterArticle, related_name='issues')
 234
 235         class Meta:
 236                 ordering = ['-number']
 237                 unique_together = (('newsletter', 'number'),)
 238
 239
 240 register_value_model(NewsletterIssue)
 241
 242
 243 class NewsletterView(MultiView):
 244         ARTICLE_PERMALINK_STYLE_CHOICES = (
 245                 ('D', 'Year, month, and day'),
 246                 ('M', 'Year and month'),
 247                 ('Y', 'Year'),
 248                 ('S', 'Slug only')
 249         )
 250
 251         newsletter = models.ForeignKey(Newsletter, related_name='newsletterviews')
 252
 253         index_page = models.ForeignKey(Page, related_name='newsletter_index_related')
 254         article_page = models.ForeignKey(Page, related_name='newsletter_article_related')
 255         article_archive_page = models.ForeignKey(Page, related_name='newsletter_article_archive_related', null=True, blank=True)
 256         issue_page = models.ForeignKey(Page, related_name='newsletter_issue_related')
 257         issue_archive_page = models.ForeignKey(Page, related_name='newsletter_issue_archive_related', null=True, blank=True)
 258
 259         article_permalink_style = models.CharField(max_length=1, choices=ARTICLE_PERMALINK_STYLE_CHOICES)
 260         article_permalink_base = models.CharField(max_length=255, blank=False, default='articles')
 261         issue_permalink_base = models.CharField(max_length=255, blank=False, default='issues')
 262
 263         def get_subpath(self, obj):
 264                 if isinstance(obj, NewsletterArticle):
 265                         if obj.newsletter == self.newsletter:
 266                                 article_view_args = {'slug': obj.slug}
 267                                 if self.article_permalink_style in 'DMY':
 268                                         article_view_args.update({'year': str(obj.date.year).zfill(4)})
 269                                         if self.article_permalink_style in 'DM':
 270                                                 article_view_args.update({'month': str(obj.date.month).zfill(2)})
 271                                                 if self.article_permalink_style == 'D':
 272                                                         article_view_args.update({'day': str(obj.date.day).zfill(2)})
 273                                 return reverse(self.article_view, urlconf=self, kwargs=article_view_args)
 274                 elif isinstance(obj, NewsletterIssue):
 275                         if obj.newsletter == self.newsletter:
 276                                 return reverse(self.issue_view, urlconf=self, kwargs={'number': str(obj.number)})
 277                 raise ViewCanNotProvideSubpath
 278
 279         @property
 280         def urlpatterns(self):
 281                 base_patterns = patterns('',
 282                         url(r'^$', self.index_view),
 283                         url((r'^(?:%s)/?$' % self.issue_permalink_base), self.issue_archive_view),
 284                         url((r'^(?:%s)/(?P<number>\d+)/?$' % self.issue_permalink_base), self.issue_view)
 285                 )
 286                 article_patterns = patterns('',
 287                         url((r'^(?:%s)/?$' % self.article_permalink_base), self.article_archive_view)
 288                 )
 289                 if self.article_permalink_style in 'DMY':
 290                         article_patterns += patterns('',
 291                                 url((r'^(?:%s)/(?P<year>\d{4})/?$' % self.article_permalink_base), self.article_archive_view)
 292                         )
 293                         if self.article_permalink_style in 'DM':
 294                                 article_patterns += patterns('',
 295                                         url((r'^(?:%s)/(?P<year>\d{4})/(?P<month>\d{2})/?$' % self.article_permalink_base), self.article_archive_view)
 296                                 )
 297                                 if self.article_permalink_style == 'D':
 298                                         article_patterns += patterns('',
 299                                                 url((r'^(?:%s)/(?P<year>\d{4})/(?P<month>\d{2})/(?P<day>\d{2})/?$' % self.article_permalink_base), self.article_archive_view),
 300                                                 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)
 301                                         )
 302                                 else:
 303                                         article_patterns += patterns('',
 304                                                 url((r'^(?:%s)/(?P<year>\d{4})/(?P<month>\d{2})/(?P<slug>[-\w]+)/?$' % self.article_permalink_base), self.article_view)
 305                                         )
 306                         else:
 307                                 article_patterns += patterns('',
 308                                         url((r'^(?:%s)/(?P<year>\d{4})/(?P<slug>[-\w]+)/?$' % self.article_permalink_base), self.article_view)
 309                                 )
 310                 else:
 311                         article_patterns += patterns('',
 312                                 url((r'^(?:%s)/(?P<slug>[-\w]+)/?$' % self.article_permalink_base), self.article_view)
 313                         )
 314                 return base_patterns + article_patterns
 315
 316         def index_view(self, request, node=None, extra_context=None):
 317                 context = {}
 318                 context.update(extra_context or {})
 319                 context.update({'newsletter': self.newsletter})
 320                 return self.index_page.render_to_response(node, request, extra_context=context)
 321
 322         def article_view(self, request, slug, year=None, month=None, day=None, node=None, extra_context=None):
 323                 articles = self.newsletter.articles.all()
 324                 if year:
 325                         articles = articles.filter(date__year=year)
 326                 if month:
 327                         articles = articles.filter(date__month=month)
 328                 if day:
 329                         articles = articles.filter(date__day=day)
 330                 try:
 331                         article = articles.get(slug=slug)
 332                 except:
 333                         raise Http404
 334                 context = {}
 335                 context.update(extra_context or {})
 336                 context.update({'newsletter': self.newsletter, 'article': article})
 337                 return self.article_page.render_to_response(node, request, extra_context=context)
 338
 339         def article_archive_view(self, request, year=None, month=None, day=None, node=None, extra_context=None):
 340                 if not self.article_archive_page:
 341                         raise Http404
 342                 articles = self.newsletter.articles.all()
 343                 if year:
 344                         articles = articles.filter(date__year=year)
 345                 if month:
 346                         articles = articles.filter(date__month=month)
 347                 if day:
 348                         articles = articles.filter(date__day=day)
 349                 context = {}
 350                 context.update(extra_context or {})
 351                 context.update({'newsletter': self.newsletter, 'year': year, 'month': month, 'day': day, 'articles': articles})
 352                 return self.article_archive_page.render_to_response(node, request, extra_context=context)
 353
 354         def issue_view(self, request, number, node=None, extra_context=None):
 355                 try:
 356                         issue = self.newsletter.issues.get(number=number)
 357                 except:
 358                         raise Http404
 359                 context = {}
 360                 context.update(extra_context or {})
 361                 context.update({'newsletter': self.newsletter, 'issue': issue})
 362                 return self.issue_page.render_to_response(node, request, extra_context=context)
 363
 364         def issue_archive_view(self, request, node=None, extra_context=None):
 365                 if not self.issue_archive_page:
 366                         raise Http404
 367                 context = {}
 368                 context.update(extra_context or {})
 369                 context.update({'newsletter': self.newsletter})
 370                 return self.issue_archive_page.render_to_response(node, request, extra_context=context)