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
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=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)
40 verbose_name_plural = "blog entries"
43 register_value_model(BlogEntry)
46 class BlogView(MultiView, FeedMultiViewMixin):
47 ENTRY_PERMALINK_STYLE_CHOICES = (
48 ('D', 'Year, month, and day'),
49 ('M', 'Year and month'),
55 blog = models.ForeignKey(Blog, related_name='blogviews')
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)
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()
71 def __unicode__(self):
72 return u'BlogView for %s' % self.blog.title
76 return self.entries_per_page
80 return self.blog.title
82 def get_subpath(self, obj):
83 if isinstance(obj, BlogEntry):
84 if obj.blog == self.blog:
85 kwargs = {'slug': obj.slug}
86 if self.entry_permalink_style in 'DMY':
87 kwargs.update({'year': str(obj.date.year).zfill(4)})
88 if self.entry_permalink_style in 'DM':
89 kwargs.update({'month': str(obj.date.month).zfill(2)})
90 if self.entry_permalink_style == 'D':
91 kwargs.update({'day': str(obj.date.day).zfill(2)})
92 return reverse(self.entry_view, urlconf=self, kwargs=kwargs)
93 elif isinstance(obj, Tag):
94 if obj in self.blog.entry_tags:
95 return reverse('entries_by_tag', urlconf=self, kwargs={'tag_slugs': obj.slug})
96 elif isinstance(obj, (str, unicode)):
97 split_obj = obj.split(':')
98 if len(split_obj) > 1:
101 kwargs.update({'year': str(int(split_obj[1])).zfill(4)})
102 if len(split_obj) > 2:
103 kwargs.update({'month': str(int(split_obj[2])).zfill(2)})
104 if len(split_obj) > 3:
105 kwargs.update({'day': str(int(split_obj[3])).zfill(2)})
106 return reverse('entries_by_day', urlconf=self, kwargs=kwargs)
107 return reverse('entries_by_month', urlconf=self, kwargs=kwargs)
108 return reverse('entries_by_year', urlconf=self, kwargs=kwargs)
111 raise ViewCanNotProvideSubpath
113 def get_context(self):
114 return {'blog': self.blog}
117 def urlpatterns(self):
118 urlpatterns = patterns('',
119 url(r'^', include(self.feed_patterns(self.get_all_entries, self.index_page, 'index'))),
120 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')))
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, node=None, 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, node=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, node=None, extra_context=None):
183 for tag_slug in tag_slugs.replace('+', '/').split('/'):
184 if tag_slug: # ignore blank slugs, handles for multiple consecutive separators (+ or /)
186 tag = self.blog.entry_tags.get(slug=tag_slug)
193 entries = self.blog.entries.all()
195 entries = entries.filter(tags=tag)
196 if entries.count() <= 0:
199 return entries, extra_context
201 def get_obj_description(self, obj):
204 def entry_view(self, request, slug, year=None, month=None, day=None, node=None, extra_context=None):
205 entries = self.blog.entries.all()
207 entries = entries.filter(date__year=year)
209 entries = entries.filter(date__month=month)
211 entries = entries.filter(date__day=day)
213 entry = entries.get(slug=slug)
216 context = self.get_context()
217 context.update(extra_context or {})
218 context.update({'entry': entry})
219 return self.entry_page.render_to_response(node, request, extra_context=context)
221 def tag_archive_view(self, request, node=None, extra_context=None):
222 if not self.tag_archive_page:
225 context.update(extra_context or {})
226 context.update({'blog': self.blog})
227 return self.tag_archive_page.render_to_response(node, request, extra_context=context)
230 class Newsletter(Entity, Titled):
234 register_value_model(Newsletter)
237 class NewsletterArticle(Entity, Titled):
238 newsletter = models.ForeignKey(Newsletter, related_name='articles')
239 authors = models.ManyToManyField(getattr(settings, 'PHILO_PERSON_MODULE', 'auth.User'), related_name='newsletterarticles')
240 date = models.DateTimeField(default=datetime.now)
241 lede = models.TextField(null=True, blank=True)
242 full_text = models.TextField()
245 get_latest_by = 'date'
247 unique_together = (('newsletter', 'slug'),)
250 register_value_model(NewsletterArticle)
253 class NewsletterIssue(Entity, Titled):
254 newsletter = models.ForeignKey(Newsletter, related_name='issues')
255 number = models.PositiveIntegerField()
256 articles = models.ManyToManyField(NewsletterArticle, related_name='issues')
259 ordering = ['-number']
260 unique_together = (('newsletter', 'number'),)
263 register_value_model(NewsletterIssue)
266 class NewsletterView(MultiView, FeedMultiViewMixin):
267 ARTICLE_PERMALINK_STYLE_CHOICES = (
268 ('D', 'Year, month, and day'),
269 ('M', 'Year and month'),
274 newsletter = models.ForeignKey(Newsletter, related_name='newsletterviews')
276 index_page = models.ForeignKey(Page, related_name='newsletter_index_related')
277 article_page = models.ForeignKey(Page, related_name='newsletter_article_related')
278 article_archive_page = models.ForeignKey(Page, related_name='newsletter_article_archive_related', null=True, blank=True)
279 issue_page = models.ForeignKey(Page, related_name='newsletter_issue_related')
280 issue_archive_page = models.ForeignKey(Page, related_name='newsletter_issue_archive_related', null=True, blank=True)
282 article_permalink_style = models.CharField(max_length=1, choices=ARTICLE_PERMALINK_STYLE_CHOICES)
283 article_permalink_base = models.CharField(max_length=255, blank=False, default='articles')
284 issue_permalink_base = models.CharField(max_length=255, blank=False, default='issues')
286 feed_suffix = models.CharField(max_length=255, blank=False, default=FeedMultiViewMixin.feed_suffix)
287 feeds_enabled = models.BooleanField()
288 list_var = 'articles'
291 def feed_title(self):
292 return self.newsletter.title
294 def get_subpath(self, obj):
295 if isinstance(obj, NewsletterArticle):
296 if obj.newsletter == self.newsletter:
297 kwargs = {'slug': obj.slug}
298 if self.article_permalink_style in 'DMY':
299 kwargs.update({'year': str(obj.date.year).zfill(4)})
300 if self.article_permalink_style in 'DM':
301 kwargs.update({'month': str(obj.date.month).zfill(2)})
302 if self.article_permalink_style == 'D':
303 kwargs.update({'day': str(obj.date.day).zfill(2)})
304 return reverse(self.article_view, urlconf=self, kwargs=kwargs)
305 elif isinstance(obj, NewsletterIssue):
306 if obj.newsletter == self.newsletter:
307 return reverse('issue', urlconf=self, kwargs={'number': str(obj.number)})
308 raise ViewCanNotProvideSubpath
311 def urlpatterns(self):
312 urlpatterns = patterns('',
313 url(r'^', include(self.feed_patterns(self.get_all_articles, self.index_page, 'index'))),
314 url(r'^(?:%s)/(?P<number>\d+)/' % self.issue_permalink_base, include(self.feed_patterns(self.get_articles_by_issue, self.issue_page, 'issue')))
316 if self.issue_archive_page:
317 urlpatterns += patterns('',
318 url(r'^(?:%s)/$' % self.issue_permalink_base, self.issue_archive_view)
320 if self.article_archive_page:
321 urlpatterns += patterns('',
322 url(r'^(?:%s)/' % self.article_permalink_base, include(self.feed_patterns(self.get_all_articles, self.article_archive_page, 'articles')))
324 if self.article_permalink_style in 'DMY':
325 urlpatterns += patterns('',
326 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')))
328 if self.article_permalink_style in 'DM':
329 urlpatterns += patterns('',
330 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')))
332 if self.article_permalink_style == 'D':
333 urlpatterns += patterns('',
334 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')))
337 if self.article_permalink_style == 'Y':
338 urlpatterns += patterns('',
339 url(r'^(?:%s)/(?P<year>\d{4})/(?P<slug>[\w-]+)/$' % self.article_permalink_base, self.article_view)
341 elif self.article_permalink_style == 'M':
342 urlpatterns += patterns('',
343 url(r'^(?:%s)/(?P<year>\d{4})/(?P<month>\d{2})/(?P<slug>[\w-]+)/$' % self.article_permalink_base, self.article_view)
345 elif self.article_permalink_style == 'D':
346 urlpatterns += patterns('',
347 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)
350 urlpatterns += patterns('',
351 url(r'^(?:%s)/(?P<slug>[-\w]+)/?$' % self.article_permalink_base, self.article_view)
356 def get_context(self):
357 return {'newsletter': self.newsletter}
359 def get_all_articles(self, request, node, extra_context=None):
360 return self.newsletter.articles.all(), extra_context
362 def get_articles_by_ymd(self, request, year, month=None, day=None, node=None, extra_context=None):
363 articles = self.newsletter.articles.filter(dat__year=year)
365 articles = articles.filter(date__month=month)
367 articles = articles.filter(date__day=day)
370 def get_articles_by_issue(self, request, number, node=None, extra_context=None):
372 issue = self.newsletter.issues.get(number=number)
375 context = extra_context or {}
376 context.update({'issue': issue})
377 return issue.articles.all(), context
379 def article_view(self, request, slug, year=None, month=None, day=None, node=None, extra_context=None):
380 articles = self.newsletter.articles.all()
382 articles = articles.filter(date__year=year)
384 articles = articles.filter(date__month=month)
386 articles = articles.filter(date__day=day)
388 article = articles.get(slug=slug)
391 context = self.get_context()
392 context.update(extra_context or {})
393 context.update({'article': article})
394 return self.article_page.render_to_response(node, request, extra_context=context)
396 def issue_archive_view(self, request, node=None, extra_context=None):
397 if not self.issue_archive_page:
400 context.update(extra_context or {})
401 context.update({'newsletter': self.newsletter})
402 return self.issue_archive_page.render_to_response(node, request, extra_context=context)
404 def get_obj_description(self, obj):
405 return obj.lede or obj.full_text