Merge branch 'dev' into release/2

Author: vsalvino

coderedcms/blocks/__init__.py

@@ -41,6 +41,7 @@
     CardBlock,
     CarouselBlock,
     ContentWallBlock,
+    FilmStripBlock,
     ImageGalleryBlock,
     ModalBlock,
     NavDocumentLinkWithSubLinkBlock,
@@ -89,6 +90,7 @@
     ("accordion", AccordionBlock()),
     ("card", CardBlock()),
     ("carousel", CarouselBlock()),
+    ("film_strip", FilmStripBlock()),
     ("image_gallery", ImageGalleryBlock()),
     ("modal", ModalBlock(HTML_STREAMBLOCKS)),
     ("pricelist", PriceListBlock()),

coderedcms/blocks/content_blocks.py

@@ -80,6 +80,19 @@ class Meta:
         template = "coderedcms/blocks/carousel_block.html"
 
 
+class FilmStripBlock(BaseBlock):
+    """
+    Enables choosing a Film Strip Snippet.
+    """
+
+    film_strip = SnippetChooserBlock("coderedcms.FilmStrip")
+
+    class Meta:
+        icon = "image"
+        label = _("Film Strip")
+        template = "coderedcms/blocks/film_strip_block.html"
+
+
 class ImageGalleryBlock(BaseBlock):
     """
     Show a collection of images with interactive previews that expand to
@@ -204,7 +217,7 @@ class NavSubLinkBlock(BaseBlock):
 
 class NavExternalLinkWithSubLinkBlock(NavSubLinkBlock, NavExternalLinkBlock):
     """
-    Extermal link with option for sub-links.
+    External link with option for sub-links.
     """
 
     class Meta:

coderedcms/blocks/html_blocks.py

@@ -228,6 +228,7 @@ class PageListBlock(BaseBlock):
         label=_("Classified as"),
         help_text=_("Only show pages that are classified with this term."),
     )
+    # DEPRECATED: Remove in 3.0
     show_preview = blocks.BooleanBlock(
         required=False,
         default=False,

coderedcms/migrations/0036_filmstrip_filmpanel.py

@@ -0,0 +1,113 @@
+# Generated by Django 4.1.7 on 2023-03-30 19:14
+
+import coderedcms.fields
+from django.db import migrations, models
+import django.db.models.deletion
+import modelcluster.fields
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("wagtailimages", "0025_alter_image_file_alter_rendition_file"),
+        ("coderedcms", "0035_remove_googleapisettings_site_and_more"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="FilmStrip",
+            fields=[
+                (
+                    "id",
+                    models.AutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("name", models.CharField(max_length=255, verbose_name="Name")),
+            ],
+            options={
+                "verbose_name": "Film Strip",
+            },
+        ),
+        migrations.CreateModel(
+            name="FilmPanel",
+            fields=[
+                (
+                    "id",
+                    models.AutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                (
+                    "sort_order",
+                    models.IntegerField(blank=True, editable=False, null=True),
+                ),
+                (
+                    "background_color",
+                    models.CharField(
+                        blank=True,
+                        help_text="Hexadecimal, rgba, or CSS color notation (e.g. #ff0011)",
+                        max_length=255,
+                        verbose_name="Background color",
+                    ),
+                ),
+                (
+                    "foreground_color",
+                    models.CharField(
+                        blank=True,
+                        help_text="Hexadecimal, rgba, or CSS color notation (e.g. #ff0011)",
+                        max_length=255,
+                        verbose_name="Text color",
+                    ),
+                ),
+                (
+                    "custom_css_class",
+                    models.CharField(
+                        blank=True,
+                        max_length=255,
+                        verbose_name="Custom CSS class",
+                    ),
+                ),
+                (
+                    "custom_id",
+                    models.CharField(
+                        blank=True, max_length=255, verbose_name="Custom ID"
+                    ),
+                ),
+                (
+                    "content",
+                    coderedcms.fields.CoderedStreamField(
+                        blank=True, use_json_field=True
+                    ),
+                ),
+                (
+                    "background_image",
+                    models.ForeignKey(
+                        blank=True,
+                        null=True,
+                        on_delete=django.db.models.deletion.SET_NULL,
+                        related_name="+",
+                        to="wagtailimages.image",
+                        verbose_name="Background image",
+                    ),
+                ),
+                (
+                    "film_strip",
+                    modelcluster.fields.ParentalKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="film_panels",
+                        to="coderedcms.filmstrip",
+                        verbose_name="Film Panel",
+                    ),
+                ),
+            ],
+            options={
+                "verbose_name": "Film Panel",
+            },
+        ),
+    ]

coderedcms/migrations/0037_coderedpage_related_classifier_term_and_more.py

@@ -0,0 +1,40 @@
+# Generated by Django 4.1.8 on 2023-04-13 21:36
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("coderedcms", "0036_filmstrip_filmpanel"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="coderedpage",
+            name="related_classifier_term",
+            field=models.ForeignKey(
+                blank=True,
+                help_text="When getting related pages, pages with this term will be weighted over other classifier terms. By default, pages with the greatest number of classifiers in common are ranked highest.",
+                null=True,
+                on_delete=django.db.models.deletion.SET_NULL,
+                related_name="+",
+                to="coderedcms.classifierterm",
+                verbose_name="Preferred related classifier term",
+            ),
+        ),
+        migrations.AddField(
+            model_name="coderedpage",
+            name="related_num",
+            field=models.PositiveIntegerField(
+                default=3, verbose_name="Number of related pages to show"
+            ),
+        ),
+        migrations.AddField(
+            model_name="coderedpage",
+            name="related_show",
+            field=models.BooleanField(
+                default=False, verbose_name="Show list of related pages"
+            ),
+        ),
+    ]

coderedcms/models/page_models.py

@@ -146,6 +146,12 @@ class Meta:
     # ajax_template = ''
     # search_template = ''
 
+    # Template used in site search results.
+    search_template = "coderedcms/pages/search_result.html"
+
+    # Template used for related pages, Latest Pages block, and Page Preview block.
+    miniview_template = "coderedcms/pages/page.mini.html"
+
     ###############
     # Content fields
     ###############
@@ -217,6 +223,41 @@ class Meta:
         help_text=_("Enable filtering child pages by these classifiers."),
     )
 
+    #####################
+    # Related Page Fields
+    #####################
+
+    # Subclasses can override this to query on a specific page model, in the
+    # format "appname.Model". By default sibling pages are used.
+    related_query_pagemodel = None
+
+    # Subclasses can override this to enabled related pages by default.
+    related_show_default = False
+
+    related_show = models.BooleanField(
+        default=related_show_default,
+        verbose_name=_("Show list of related pages"),
+    )
+
+    related_num = models.PositiveIntegerField(
+        default=3,
+        verbose_name=_("Number of related pages to show"),
+    )
+
+    related_classifier_term = models.ForeignKey(
+        "coderedcms.ClassifierTerm",
+        blank=True,
+        null=True,
+        on_delete=models.SET_NULL,
+        related_name="+",
+        verbose_name=_("Preferred related classifier term"),
+        help_text=_(
+            "When getting related pages, pages with this term will be "
+            "weighted over other classifier terms. By default, pages with "
+            "the greatest number of classifiers in common are ranked highest."
+        ),
+    )
+
     ###############
     # Layout fields
     ###############
@@ -311,6 +352,14 @@ class Meta:
             ],
             heading=_("Show Child Pages"),
         ),
+        MultiFieldPanel(
+            [
+                FieldPanel("related_show"),
+                FieldPanel("related_num"),
+                FieldPanel("related_classifier_term"),
+            ],
+            heading=_("Related Pages"),
+        ),
     ]
 
     promote_panels = SeoMixin.seo_meta_panels + SeoMixin.seo_struct_panels
@@ -339,6 +388,7 @@ def __init__(self, *args, **kwargs):
         if not self.id:
             self.index_order_by = self.index_order_by_default
             self.index_show_subpages = self.index_show_subpages_default
+            self.related_show = self.related_show_default
 
     @cached_classmethod
     def get_edit_handler(cls):
@@ -455,6 +505,60 @@ def get_index_children(self):
 
         return query
 
+    def get_related_pages(
+        self, pagetype: str = None, num: int = None
+    ) -> models.QuerySet:
+        """
+        Returns a queryset of sibling pages, or the model type
+        defined by ``pagetype`` or ``self.related_query_pagemodel``,
+        ordered by number of shared classifier terms.
+
+        :param str pagetype: The model type to query on. This should
+          be a string in the format "appname.Model".
+          Overrides ``self.related_query_pagemodel``
+
+        :param int num: The number of results to return.
+          Overrides ``self.related_num``.
+        """
+
+        if pagetype is None:
+            pagetype = self.related_query_pagemodel
+
+        if num is None:
+            num = self.related_num
+
+        # Get our related query model, and queryset.
+        if pagetype:
+            querymodel = resolve_model_string(pagetype, self._meta.app_label)
+            r_qs = querymodel.objects.all().live()
+        else:
+            r_qs = self.get_parent().specific.get_index_children()
+
+        # Exclude self to avoid infinite recursion.
+        r_qs = r_qs.exclude(pk=self.pk)
+
+        order_by = []
+
+        # If we have a preferred classifier term, order by that.
+        if self.related_classifier_term:
+            p_ct_q = models.Q(classifier_terms=self.related_classifier_term)
+            r_qs = r_qs.annotate(p_ct=p_ct_q)
+            order_by.append("-p_ct")
+
+        # If this page has a classifier, then order by number of
+        # shared classifier terms.
+        if self.classifier_terms.exists():
+            r_ct_q = models.Q(classifier_terms__in=self.classifier_terms.all())
+            r_qs = r_qs.annotate(r_ct=models.Count("classifier_terms", r_ct_q))
+            order_by.append("-r_ct")
+
+        # Order the related pages, then add distinct to deal with
+        # annotating based on a many to many.
+        if order_by:
+            r_qs = r_qs.order_by(*order_by).distinct()
+
+        return r_qs[:num]
+
     def get_content_walls(self, check_child_setting=True):
         current_content_walls = []
         if check_child_setting:
@@ -478,6 +582,7 @@ def get_context(self, request, *args, **kwargs):
         """
         context = super().get_context(request)
 
+        # Show list of child pages.
         if self.index_show_subpages:
             # Get child pages
             all_children = self.get_index_children()
@@ -528,9 +633,16 @@ def get_context(self, request, *args, **kwargs):
 
             context["index_paginated"] = paged_children
             context["index_children"] = all_children
+
+        # Show a list of related pages.
+        if self.related_show:
+            context["related_pages"] = self.get_related_pages()
+
+        # Content walls.
         context["content_walls"] = self.get_content_walls(
             check_child_setting=False
         )
+
         return context
 
 
@@ -593,6 +705,9 @@ class Meta:
         abstract = True
 
     template = "coderedcms/pages/article_page.html"
+    search_template = "coderedcms/pages/article_page.search.html"
+
+    related_show_default = True
 
     # Override body to provide simpler content
     body = StreamField(
@@ -1593,6 +1708,7 @@ class Meta:
         abstract = True
 
     template = "coderedcms/pages/form_page.html"
+    miniview_template = "coderedcms/pages/form_page.mini.html"
     landing_page_template = "coderedcms/pages/form_page_landing.html"
 
     base_form_class = WagtailAdminFormPageForm