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