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