-
Notifications
You must be signed in to change notification settings - Fork 69
/
models.py
412 lines (343 loc) · 12.2 KB
/
models.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
"""Blog listing and blog detail pages."""
from django import forms
from django.core.cache import cache
from django.core.cache.utils import make_template_fragment_key
from django.core.paginator import EmptyPage, PageNotAnInteger, Paginator
from django.db import models
from django.shortcuts import render
from modelcluster.fields import ParentalKey, ParentalManyToManyField
from modelcluster.contrib.taggit import ClusterTaggableManager
from rest_framework.fields import Field
from taggit.models import TaggedItemBase
from wagtail.api import APIField
from wagtail.admin.edit_handlers import (
FieldPanel,
StreamFieldPanel,
MultiFieldPanel,
InlinePanel,
)
from wagtail.snippets.edit_handlers import SnippetChooserPanel
from wagtail.core.fields import StreamField
from wagtail.core.models import Page, Orderable
from wagtail.images.edit_handlers import ImageChooserPanel
from wagtail.images.api.fields import ImageRenditionField
from wagtail.contrib.routable_page.models import RoutablePageMixin, route
from wagtail.snippets.models import register_snippet
from streams import blocks
class ImageSerializedField(Field):
"""A custom serializer used in Wagtails v2 API."""
def to_representation(self, value):
"""Return the image URL, title and dimensions."""
return {
"url": value.file.url,
"title": value.title,
"width": value.width,
"height": value.height,
}
class BlogAuthorsOrderable(Orderable):
"""This allows us to select one or more blog authors from Snippets."""
page = ParentalKey("blog.BlogDetailPage", related_name="blog_authors")
author = models.ForeignKey(
"blog.BlogAuthor",
on_delete=models.CASCADE,
)
panels = [
SnippetChooserPanel("author"),
]
@property
def author_name(self):
return self.author.name
@property
def author_website(self):
return self.author.website
@property
def author_image(self):
return self.author.image
api_fields = [
APIField("author_name"),
APIField("author_website"),
# This is using a custom django rest framework serializer
APIField("author_image", serializer=ImageSerializedField()),
# The below APIField is using a Wagtail-built DRF Serializer that supports
# custom image rendition sizes
APIField(
"image",
serializer=ImageRenditionField(
'fill-200x250',
source="author_image"
)
),
]
class BlogAuthor(models.Model):
"""Blog author for snippets."""
name = models.CharField(max_length=100)
website = models.URLField(blank=True, null=True)
image = models.ForeignKey(
"wagtailimages.Image",
on_delete=models.SET_NULL,
null=True,
blank=False,
related_name="+",
)
panels = [
MultiFieldPanel(
[
FieldPanel("name"),
ImageChooserPanel("image"),
],
heading="Name and Image",
),
MultiFieldPanel(
[
FieldPanel("website"),
],
heading="Links"
)
]
def __str__(self):
"""String repr of this class."""
return self.name
class Meta: # noqa
verbose_name = "Blog Author"
verbose_name_plural = "Blog Authors"
register_snippet(BlogAuthor)
class BlogCategory(models.Model):
"""Blog catgory for a snippet."""
name = models.CharField(max_length=255)
slug = models.SlugField(
verbose_name="slug",
allow_unicode=True,
max_length=255,
help_text='A slug to identify posts by this category',
)
panels = [
FieldPanel("name"),
FieldPanel("slug"),
]
class Meta:
verbose_name = "Blog Category"
verbose_name_plural = "Blog Categories"
ordering = ["name"]
def __str__(self):
return self.name
register_snippet(BlogCategory)
class BlogListingPage(RoutablePageMixin, Page):
"""Listing page lists all the Blog Detail Pages."""
template = "blog/blog_listing_page.html"
ajax_template = "blog/blog_listing_page_ajax.html"
max_count = 1
subpage_types = ['blog.VideoBlogPage', 'blog.ArticleBlogPage']
custom_title = models.CharField(
max_length=100,
blank=False,
null=False,
help_text='Overwrites the default title',
)
content_panels = Page.content_panels + [
FieldPanel("custom_title"),
]
def get_context(self, request, *args, **kwargs):
"""Adding custom stuff to our context."""
context = super().get_context(request, *args, **kwargs)
# Get all posts
all_posts = BlogDetailPage.objects.live().public().order_by('-first_published_at')
if request.GET.get('tag', None):
tags = request.GET.get('tag')
all_posts = all_posts.filter(tags__slug__in=[tags])
# Paginate all posts by 2 per page
paginator = Paginator(all_posts, 2)
# Try to get the ?page=x value
page = request.GET.get("page")
try:
# If the page exists and the ?page=x is an int
posts = paginator.page(page)
except PageNotAnInteger:
# If the ?page=x is not an int; show the first page
posts = paginator.page(1)
except EmptyPage:
# If the ?page=x is out of range (too high most likely)
# Then return the last page
posts = paginator.page(paginator.num_pages)
# "posts" will have child pages; you'll need to use .specific in the template
# in order to access child properties, such as youtube_video_id and subtitle
context["posts"] = posts
context["categories"] = BlogCategory.objects.all()
return context
@route(r"^july-2019/$", name="july_2019")
@route(r"^year/(\d+)/(\d+)/$", name="blogs_by_year")
def blogs_by_year(self, request, year=None, month=None):
context = self.get_context(request)
# Implement your BlogDetailPage filter. Maybe something like this:
# if year is not None and month is not None:
# posts = BlogDetailPage.objects.live().public().filter(year=year, month=month)
# else:
# # No year and no month were set, assume this is july-2019 only posts
# posts = BlogDetailPage.objects.live().public().filter(year=2019, month=07)
# print(year)
# print(month)
# context["posts"] = posts
# Note: The below template (latest_posts.html) will need to be adjusted
return render(request, "blog/latest_posts.html", context)
@route(r"^category/(?P<cat_slug>[-\w]*)/$", name="category_view")
def category_view(self, request, cat_slug):
"""Find blog posts based on a category."""
context = self.get_context(request)
try:
# Look for the blog category by its slug.
category = BlogCategory.objects.get(slug=cat_slug)
except Exception:
# Blog category doesnt exist (ie /blog/category/missing-category/)
# Redirect to self.url, return a 404.. that's up to you!
category = None
if category is None:
# This is an additional check.
# If the category is None, do something. Maybe default to a particular category.
# Or redirect the user to /blog/ ¯\_(ツ)_/¯
pass
context["posts"] = BlogDetailPage.objects.live().public().filter(categories__in=[category])
# Note: The below template (latest_posts.html) will need to be adjusted
return render(request, "blog/latest_posts.html", context)
@route(r'^latest/$', name="latest_posts")
def latest_blog_posts_only_shows_last_5(self, request, *args, **kwargs):
context = self.get_context(request, *args, **kwargs)
context["posts"] = context["posts"][:1]
return render(request, "blog/latest_posts.html", context)
def get_sitemap_urls(self, request):
# Uncomment to have no sitemap for this page
# return []
sitemap = super().get_sitemap_urls(request)
sitemap.append(
{
"location": self.full_url + self.reverse_subpage("latest_posts"),
"lastmod": (self.last_published_at or self.latest_revision_created_at),
"priority": 0.9,
}
)
return sitemap
class BlogPageTag(TaggedItemBase):
content_object = ParentalKey(
'BlogDetailPage',
related_name='tagged_items',
on_delete=models.CASCADE,
)
class BlogDetailPage(Page):
"""Parental blog detail page."""
subpage_types = []
parent_page_types = ['blog.BlogListingPage']
tags = ClusterTaggableManager(through=BlogPageTag, blank=True)
custom_title = models.CharField(
max_length=100,
blank=False,
null=False,
help_text='Overwrites the default title',
)
banner_image = models.ForeignKey(
"wagtailimages.Image",
blank=False,
null=True,
related_name="+",
on_delete=models.SET_NULL,
)
categories = ParentalManyToManyField("blog.BlogCategory", blank=True)
content = StreamField(
[
("title_and_text", blocks.TitleAndTextBlock()),
("full_richtext", blocks.RichtextBlock()),
("simple_richtext", blocks.SimpleRichtextBlock()),
("cards", blocks.CardBlock()),
("cta", blocks.CTABlock()),
],
null=True,
blank=True,
)
content_panels = Page.content_panels + [
FieldPanel("custom_title"),
FieldPanel("tags"),
ImageChooserPanel("banner_image"),
MultiFieldPanel(
[
InlinePanel("blog_authors", label="Author", min_num=1, max_num=4)
],
heading="Author(s)"
),
MultiFieldPanel(
[
FieldPanel("categories", widget=forms.CheckboxSelectMultiple)
],
heading="Categories"
),
StreamFieldPanel("content"),
]
api_fields = [
APIField("blog_authors"),
APIField("content"),
]
def save(self, *args, **kwargs):
"""Create a template fragment key.
Then delete the key."""
key = make_template_fragment_key(
"blog_post_preview",
[self.id]
)
cache.delete(key)
return super().save(*args, **kwargs)
# First subclassed blog post page
class ArticleBlogPage(BlogDetailPage):
"""A subclassed blog post page for articles."""
template = "blog/article_blog_page.html"
subtitle = models.CharField(
max_length=100,
blank=True,
null=True
)
intro_image = models.ForeignKey(
"wagtailimages.Image",
blank=True,
null=True,
on_delete=models.SET_NULL,
help_text='Best size for this image will be 1400x400'
)
content_panels = Page.content_panels + [
FieldPanel("custom_title"),
FieldPanel("subtitle"),
FieldPanel("tags"),
ImageChooserPanel("banner_image"),
ImageChooserPanel("intro_image"),
MultiFieldPanel(
[
InlinePanel("blog_authors", label="Author", min_num=1, max_num=4)
],
heading="Author(s)"
),
MultiFieldPanel(
[
FieldPanel("categories", widget=forms.CheckboxSelectMultiple)
],
heading="Categories"
),
StreamFieldPanel("content"),
]
# Second subclassed page
class VideoBlogPage(BlogDetailPage):
"""A video subclassed page."""
template = "blog/video_blog_page.html"
youtube_video_id = models.CharField(max_length=30)
content_panels = Page.content_panels + [
FieldPanel("custom_title"),
FieldPanel("tags"),
ImageChooserPanel("banner_image"),
MultiFieldPanel(
[
InlinePanel("blog_authors", label="Author", min_num=1, max_num=4)
],
heading="Author(s)"
),
MultiFieldPanel(
[
FieldPanel("categories", widget=forms.CheckboxSelectMultiple)
],
heading="Categories"
),
FieldPanel("youtube_video_id"),
StreamFieldPanel("content"),
]