1 from django.conf import settings
2 from django.conf.urls.defaults import url, patterns, include
3 from django.db import models
4 from django.http import Http404
5 from django.template import loader, Context
6 from django.utils.feedgenerator import Atom1Feed, Rss201rev2Feed
7 from datetime import date, datetime
8 from philo.contrib.penfield.utils import FeedMultiViewMixin
9 from philo.contrib.penfield.validators import validate_pagination_count
10 from philo.exceptions import ViewCanNotProvideSubpath
11 from philo.models import Tag, Titled, Entity, MultiView, Page, register_value_model, TemplateField
12 from philo.utils import paginate
15 class Blog(Entity, Titled):
18 """ Returns a QuerySet of Tags that are used on any entries in this blog. """
19 return Tag.objects.filter(blogentries__blog=self).distinct()
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')}
27 register_value_model(Blog)
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=None)
34 content = models.TextField()
35 excerpt = models.TextField(blank=True, null=True)
36 tags = models.ManyToManyField(Tag, related_name='blogentries', blank=True, null=True)
38 def save(self, *args, **kwargs):
40 self.date = datetime.now()
41 super(BlogEntry, self).save(*args, **kwargs)
45 verbose_name_plural = "blog entries"
46 get_latest_by = "date"
49 register_value_model(BlogEntry)
52 class BlogView(MultiView, FeedMultiViewMixin):
53 ENTRY_PERMALINK_STYLE_CHOICES = (
54 ('D', 'Year, month, and day'),
55 ('M', 'Year and month'),
61 blog = models.ForeignKey(Blog, related_name='blogviews')
63 index_page = models.ForeignKey(Page, related_name='blog_index_related')
64 entry_page = models.ForeignKey(Page, related_name='blog_entry_related')
65 entry_archive_page = models.ForeignKey(Page, related_name='blog_entry_archive_related', null=True, blank=True)
66 tag_page = models.ForeignKey(Page, related_name='blog_tag_related')
67 tag_archive_page = models.ForeignKey(Page, related_name='blog_tag_archive_related', null=True, blank=True)
68 entries_per_page = models.IntegerField(blank=True, validators=[validate_pagination_count], null=True)
70 entry_permalink_style = models.CharField(max_length=1, choices=ENTRY_PERMALINK_STYLE_CHOICES)
71 entry_permalink_base = models.CharField(max_length=255, blank=False, default='entries')
72 tag_permalink_base = models.CharField(max_length=255, blank=False, default='tags')
73 feed_suffix = models.CharField(max_length=255, blank=False, default=FeedMultiViewMixin.feed_suffix)
74 feeds_enabled = models.BooleanField()
77 def __unicode__(self):
78 return u'BlogView for %s' % self.blog.title
82 return self.entries_per_page
84 def get_reverse_params(self, obj):
85 if isinstance(obj, BlogEntry):
86 if obj.blog == self.blog:
87 kwargs = {'slug': obj.slug}
88 if self.entry_permalink_style in 'DMY':
89 kwargs.update({'year': str(obj.date.year).zfill(4)})
90 if self.entry_permalink_style in 'DM':
91 kwargs.update({'month': str(obj.date.month).zfill(2)})
92 if self.entry_permalink_style == 'D':
93 kwargs.update({'day': str(obj.date.day).zfill(2)})
94 return self.entry_view, [], kwargs
95 elif isinstance(obj, Tag):
96 if obj in self.blog.entry_tags:
97 return 'entries_by_tag', [], {'tag_slugs': obj.slug}
98 elif isinstance(obj, (date, datetime)):
100 'year': str(obj.year).zfill(4),
101 'month': str(obj.month).zfill(2),
102 'day': str(obj.day).zfill(2)
104 return 'entries_by_day', [], kwargs
105 raise ViewCanNotProvideSubpath
107 def get_context(self):
108 return {'blog': self.blog}
111 def urlpatterns(self):
112 urlpatterns = patterns('',
113 url(r'^', include(self.feed_patterns(self.get_all_entries, self.index_page, 'index'))),
115 if self.feeds_enabled:
116 urlpatterns += patterns('',
117 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'),
119 urlpatterns += patterns('',
120 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 if self.tag_archive_page:
123 urlpatterns += patterns('',
124 url((r'^(?:%s)/?$' % self.tag_permalink_base), self.tag_archive_view)
127 if self.entry_archive_page:
128 if self.entry_permalink_style in 'DMY':
129 urlpatterns += patterns('',
130 url(r'^(?P<year>\d{4})/', include(self.feed_patterns(self.get_entries_by_ymd, self.entry_archive_page, 'entries_by_year')))
132 if self.entry_permalink_style in 'DM':
133 urlpatterns += patterns('',
134 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 if self.entry_permalink_style == 'D':
137 urlpatterns += patterns('',
138 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')))
141 if self.entry_permalink_style == 'D':
142 urlpatterns += patterns('',
143 url(r'^(?P<year>\d{4})/(?P<month>\d{2})/(?P<day>\d{2})/(?P<slug>[-\w]+)/?$', self.entry_view)
145 elif self.entry_permalink_style == 'M':
146 urlpatterns += patterns('',
147 url(r'^(?P<year>\d{4})/(?P<month>\d{2})/(?P<slug>[-\w]+)/?$', self.entry_view)
149 elif self.entry_permalink_style == 'Y':
150 urlpatterns += patterns('',
151 url(r'^(?P<year>\d{4})/(?P<slug>[-\w]+)/?$', self.entry_view)
153 elif self.entry_permalink_style == 'B':
154 urlpatterns += patterns('',
155 url((r'^(?:%s)/(?P<slug>[-\w]+)/?$' % self.entry_permalink_base), self.entry_view)
158 urlpatterns = patterns('',
159 url(r'^(?P<slug>[-\w]+)/?$', self.entry_view)
163 def get_all_entries(self, request, extra_context=None):
164 return self.blog.entries.all(), extra_context
166 def get_entries_by_ymd(self, request, year=None, month=None, day=None, extra_context=None):
167 if not self.entry_archive_page:
169 entries = self.blog.entries.all()
171 entries = entries.filter(date__year=year)
173 entries = entries.filter(date__month=month)
175 entries = entries.filter(date__day=day)
177 context = extra_context or {}
178 context.update({'year': year, 'month': month, 'day': day})
179 return entries, context
181 def get_entries_by_tag(self, request, tag_slugs, extra_context=None):
182 tag_slugs = tag_slugs.replace('+', '/').split('/')
183 tags = self.blog.entry_tags.filter(slug__in=tag_slugs)
188 # Raise a 404 on an incorrect slug.
189 found_slugs = [tag.slug for tag in tags]
190 for slug in tag_slugs:
191 if slug and slug not in found_slugs:
194 entries = self.blog.entries.all()
196 entries = entries.filter(tags=tag)
198 context = self.get_context()
199 context.update(extra_context or {})
200 context.update({'tags': tags})
202 return entries, context
204 def add_item(self, feed, obj, kwargs=None):
205 title = loader.get_template("penfield/feeds/blog_entry/title.html")
206 description = loader.get_template("penfield/feeds/blog_entry/description.html")
208 'title': title.render(Context({'entry': obj})),
209 'description': description.render(Context({'entry': obj})),
210 'author_name': obj.author.get_full_name(),
213 defaults.update(kwargs or {})
214 super(BlogView, self).add_item(feed, obj, defaults)
216 def get_feed(self, feed_type, extra_context, kwargs=None):
217 tags = (extra_context or {}).get('tags', None)
218 title = self.blog.title
221 title += " - %s" % ', '.join([tag.name for tag in tags])
226 defaults.update(kwargs or {})
227 return super(BlogView, self).get_feed(feed_type, extra_context, defaults)
229 def entry_view(self, request, slug, year=None, month=None, day=None, extra_context=None):
230 entries = self.blog.entries.all()
232 entries = entries.filter(date__year=year)
234 entries = entries.filter(date__month=month)
236 entries = entries.filter(date__day=day)
238 entry = entries.get(slug=slug)
241 context = self.get_context()
242 context.update(extra_context or {})
243 context.update({'entry': entry})
244 return self.entry_page.render_to_response(request, extra_context=context)
246 def tag_archive_view(self, request, extra_context=None):
247 if not self.tag_archive_page:
250 context.update(extra_context or {})
251 context.update({'blog': self.blog})
252 return self.tag_archive_page.render_to_response(request, extra_context=context)
255 class Newsletter(Entity, Titled):
259 register_value_model(Newsletter)
262 class NewsletterArticle(Entity, Titled):
263 newsletter = models.ForeignKey(Newsletter, related_name='articles')
264 authors = models.ManyToManyField(getattr(settings, 'PHILO_PERSON_MODULE', 'auth.User'), related_name='newsletterarticles')
265 date = models.DateTimeField(default=None)
266 lede = TemplateField(null=True, blank=True, verbose_name='Summary')
267 full_text = TemplateField(db_index=True)
268 tags = models.ManyToManyField(Tag, related_name='newsletterarticles', blank=True, null=True)
270 def save(self, *args, **kwargs):
271 if self.date is None:
272 self.date = datetime.now()
273 super(NewsletterArticle, self).save(*args, **kwargs)
276 get_latest_by = 'date'
278 unique_together = (('newsletter', 'slug'),)
281 register_value_model(NewsletterArticle)
284 class NewsletterIssue(Entity, Titled):
285 newsletter = models.ForeignKey(Newsletter, related_name='issues')
286 numbering = models.CharField(max_length=50, help_text='For example, 04.02 for volume 4, issue 2.')
287 articles = models.ManyToManyField(NewsletterArticle, related_name='issues')
290 ordering = ['-numbering']
291 unique_together = (('newsletter', 'numbering'),)
294 register_value_model(NewsletterIssue)
297 class NewsletterView(MultiView, FeedMultiViewMixin):
298 ARTICLE_PERMALINK_STYLE_CHOICES = (
299 ('D', 'Year, month, and day'),
300 ('M', 'Year and month'),
305 newsletter = models.ForeignKey(Newsletter, related_name='newsletterviews')
307 index_page = models.ForeignKey(Page, related_name='newsletter_index_related')
308 article_page = models.ForeignKey(Page, related_name='newsletter_article_related')
309 article_archive_page = models.ForeignKey(Page, related_name='newsletter_article_archive_related', null=True, blank=True)
310 issue_page = models.ForeignKey(Page, related_name='newsletter_issue_related')
311 issue_archive_page = models.ForeignKey(Page, related_name='newsletter_issue_archive_related', null=True, blank=True)
313 article_permalink_style = models.CharField(max_length=1, choices=ARTICLE_PERMALINK_STYLE_CHOICES)
314 article_permalink_base = models.CharField(max_length=255, blank=False, default='articles')
315 issue_permalink_base = models.CharField(max_length=255, blank=False, default='issues')
317 feed_suffix = models.CharField(max_length=255, blank=False, default=FeedMultiViewMixin.feed_suffix)
318 feeds_enabled = models.BooleanField()
319 list_var = 'articles'
321 def __unicode__(self):
322 return self.newsletter.__unicode__()
324 def get_reverse_params(self, obj):
325 if isinstance(obj, NewsletterArticle):
326 if obj.newsletter == self.newsletter:
327 kwargs = {'slug': obj.slug}
328 if self.article_permalink_style in 'DMY':
329 kwargs.update({'year': str(obj.date.year).zfill(4)})
330 if self.article_permalink_style in 'DM':
331 kwargs.update({'month': str(obj.date.month).zfill(2)})
332 if self.article_permalink_style == 'D':
333 kwargs.update({'day': str(obj.date.day).zfill(2)})
334 return self.article_view, [], kwargs
335 elif isinstance(obj, NewsletterIssue):
336 if obj.newsletter == self.newsletter:
337 return 'issue', [], {'numbering': obj.numbering}
338 elif isinstance(obj, (date, datetime)):
340 'year': str(obj.year).zfill(4),
341 'month': str(obj.month).zfill(2),
342 'day': str(obj.day).zfill(2)
344 return 'articles_by_day', [], kwargs
345 raise ViewCanNotProvideSubpath
348 def urlpatterns(self):
349 urlpatterns = patterns('',
350 url(r'^', include(self.feed_patterns(self.get_all_articles, self.index_page, 'index'))),
351 url(r'^(?:%s)/(?P<numbering>.+)/' % self.issue_permalink_base, include(self.feed_patterns(self.get_articles_by_issue, self.issue_page, 'issue')))
353 if self.issue_archive_page:
354 urlpatterns += patterns('',
355 url(r'^(?:%s)/$' % self.issue_permalink_base, self.issue_archive_view)
357 if self.article_archive_page:
358 urlpatterns += patterns('',
359 url(r'^(?:%s)/' % self.article_permalink_base, include(self.feed_patterns(self.get_all_articles, self.article_archive_page, 'articles')))
361 if self.article_permalink_style in 'DMY':
362 urlpatterns += patterns('',
363 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')))
365 if self.article_permalink_style in 'DM':
366 urlpatterns += patterns('',
367 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')))
369 if self.article_permalink_style == 'D':
370 urlpatterns += patterns('',
371 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')))
374 if self.article_permalink_style == 'Y':
375 urlpatterns += patterns('',
376 url(r'^(?:%s)/(?P<year>\d{4})/(?P<slug>[\w-]+)/$' % self.article_permalink_base, self.article_view)
378 elif self.article_permalink_style == 'M':
379 urlpatterns += patterns('',
380 url(r'^(?:%s)/(?P<year>\d{4})/(?P<month>\d{2})/(?P<slug>[\w-]+)/$' % self.article_permalink_base, self.article_view)
382 elif self.article_permalink_style == 'D':
383 urlpatterns += patterns('',
384 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)
387 urlpatterns += patterns('',
388 url(r'^(?:%s)/(?P<slug>[-\w]+)/?$' % self.article_permalink_base, self.article_view)
393 def get_context(self):
394 return {'newsletter': self.newsletter}
396 def get_all_articles(self, request, extra_context=None):
397 return self.newsletter.articles.all(), extra_context
399 def get_articles_by_ymd(self, request, year, month=None, day=None, extra_context=None):
400 articles = self.newsletter.articles.filter(dat__year=year)
402 articles = articles.filter(date__month=month)
404 articles = articles.filter(date__day=day)
407 def get_articles_by_issue(self, request, numbering, extra_context=None):
409 issue = self.newsletter.issues.get(numbering=numbering)
410 except NewsletterIssue.DoesNotExist:
412 context = extra_context or {}
413 context.update({'issue': issue})
414 return issue.articles.all(), context
416 def article_view(self, request, slug, year=None, month=None, day=None, extra_context=None):
417 articles = self.newsletter.articles.all()
419 articles = articles.filter(date__year=year)
421 articles = articles.filter(date__month=month)
423 articles = articles.filter(date__day=day)
425 article = articles.get(slug=slug)
426 except NewsletterArticle.DoesNotExist:
428 context = self.get_context()
429 context.update(extra_context or {})
430 context.update({'article': article})
431 return self.article_page.render_to_response(request, extra_context=context)
433 def issue_archive_view(self, request, extra_context=None):
434 if not self.issue_archive_page:
437 context.update(extra_context or {})
438 context.update({'newsletter': self.newsletter})
439 return self.issue_archive_page.render_to_response(request, extra_context=context)
441 def add_item(self, feed, obj, kwargs=None):
442 title = loader.get_template("penfield/feeds/newsletter_article/title.html")
443 description = loader.get_template("penfield/feeds/newsletter_article/description.html")
445 'title': title.render(Context({'article': obj})),
446 'author_name': ', '.join([author.get_full_name() for author in obj.authors.all()]),
448 'description': description.render(Context({'article': obj})),
449 'categories': [tag.name for tag in obj.tags.all()]
451 defaults.update(kwargs or {})
452 super(NewsletterView, self).add_item(feed, obj, defaults)
454 def get_feed(self, feed_type, extra_context, kwargs=None):
455 title = self.newsletter.title
460 defaults.update(kwargs or {})
461 return super(NewsletterView, self).get_feed(feed_type, extra_context, defaults)