wagtail-cjkcms 24.2.7__py2.py3-none-any.whl → 25.1.6__py2.py3-none-any.whl

cjkcms/__init__.py

@@ -1,4 +1,4 @@
-VERSION = (24, 2, 7, "")
+VERSION = (25, 1, 6, "")
 
 __version_info__ = VERSION
 __version__ = ".".join(map(str, VERSION[:3])) + (f"-{VERSION[3]}" if VERSION[3] else "")

cjkcms/blocks/__init__.py

@@ -31,8 +31,10 @@ from .content_blocks import (  # noqa
     NavPageLinkWithSubLinkBlock,
     PriceListBlock,
     ReusableContentBlock,
+    HighlightBlock,
 )
 from .content.events import PublicEventBlock, EventCalendarBlock
+from .content.countdown import CountdownBlock
 from .layout_blocks import CardGridBlock, GridBlock, HeroBlock
 from cjkcms.settings import cms_settings
 
@@ -75,6 +77,8 @@ CONTENT_STREAMBLOCKS = HTML_STREAMBLOCKS + [
     ("pricelist", PriceListBlock()),
     ("reusable_content", ReusableContentBlock()),
     ("event_calendar", EventCalendarBlock()),
+    ("highlight", HighlightBlock()),
+    ("countdown", CountdownBlock()),
 ]
 
 NAVIGATION_STREAMBLOCKS = [

cjkcms/blocks/content/countdown.py

@@ -0,0 +1,116 @@
+from cjkcms.blocks.base_blocks import BaseBlock
+from wagtail import blocks
+from django.utils.translation import gettext_lazy as _
+from datetime import datetime, timedelta, timezone
+import re
+
+
+def convert_to_utc(naive_dt, utc_offset_str):
+    # Parse the UTC offset string (e.g., "UTC+05:30" or "UTC-02:00")
+    match = re.match(r"UTC([+-])(\d{2}):(\d{2})", utc_offset_str)
+    if not match:
+        raise ValueError("Invalid UTC offset format. Use 'UTC±HH:MM'.")
+
+    sign = match.group(1)
+    hours = int(match.group(2))
+    minutes = int(match.group(3))
+
+    # Calculate the total offset in minutes
+    total_offset = timedelta(hours=hours, minutes=minutes)
+    if sign == "-":
+        total_offset = -total_offset
+
+    # Create a timezone with the given offset
+    tz = timezone(total_offset)
+
+    # Attach the offset to the naive datetime, making it timezone-aware
+    aware_local_dt = naive_dt.replace(tzinfo=tz)
+
+    # Convert the timezone-aware datetime to UTC
+    utc_dt = aware_local_dt.astimezone(timezone.utc)
+
+    return utc_dt
+
+
+class CountdownBlock(BaseBlock):
+    """
+    Display a countdown to a specific date
+    """
+
+    title = blocks.CharBlock(
+        required=False,
+        max_length=255,
+        label=_("Title"),
+    )
+
+    start_date = blocks.DateTimeBlock(
+        required=True,
+        label=_("Start date and time"),
+        help_text=_("Format: YYYY-MM-DD HH:MM"),
+    )
+
+    timezone = blocks.CharBlock(
+        required=True,
+        default="UTC",
+        max_length=255,
+        label=_("Timezone"),
+        help_text=_("Timezone relative to UTC, e.g. UTC+01:00"),
+    )
+
+    url = blocks.URLBlock(
+        max_length=255,
+        label=_("Link"),
+        required=False,
+        help_text=_("Optional link"),
+    )
+
+    # hide_after_end_date = blocks.BooleanBlock(
+    #     required=False,
+    #     default=False,
+    #     label=_("Hide after end date"),
+    #     help_text=_("Hide this after end date, or show zeros if false"),
+    # )
+
+    theme = blocks.ChoiceBlock(
+        choices=[
+            ("light", _("Light")),
+            ("dark", _("Dark")),
+            ("cyber", _("Cyberpunk")),
+            ("losange", _("Losange")),
+            ("circle", _("Circle")),
+            # ("flipbook", _("Flipbook")),
+        ],
+        default="light",
+        label=_("Theme"),
+    )
+
+    def get_context(self, value, parent_context=None):
+        context = super().get_context(value, parent_context=parent_context)
+        sd = value.get("start_date")
+
+        naive_datetime = datetime(
+            sd.year, sd.month, sd.day, sd.hour, sd.minute
+        )  # Naive datetime
+
+        tz = value.get("timezone")
+        if tz == "UTC" or tz == "":
+            tz = "UTC+00:00"
+
+        utc_offset_string = tz  # String containing UTC offset
+        utc = convert_to_utc(naive_datetime, utc_offset_string)
+
+        # print(naive_datetime, utc, utc_offset_string)
+        context["year"] = utc.year
+        context["month"] = utc.month
+        context["day"] = utc.day
+        context["hour"] = utc.hour
+        context["minute"] = utc.minute
+        context["second"] = 0
+        return context
+
+    class Meta:
+        template = "cjkcms/blocks/countdown.html"
+        icon = "history"
+        label = "Countdown"
+        ordering = ["start_date"]
+        label_format = _("Countdown to {start_date}")

cjkcms/blocks/content_blocks.py

@@ -2,6 +2,7 @@
 Content blocks are for building complex, nested HTML structures that usually
 contain sub-blocks, and may require javascript to function properly.
 """
+
 from django.utils.translation import gettext_lazy as _
 from wagtail import blocks
 from wagtail.documents.blocks import DocumentChooserBlock
@@ -180,15 +181,6 @@ class NavBaseLinkBlock(BaseBlock):
         required=False,
         label=_("Image"),
     )
-    visible_for = blocks.ChoiceBlock(
-        choices=cms_settings.CJKCMS_AUTH_VISIBILITY_CHOICES,
-        default=cms_settings.CJKCMS_AUTH_VISIBILITY_DEFAULT,
-        required=False,
-        label=_("Item visibility"),
-        help_text=_(
-            "DEPRECATED. Use the visibility options in the `Advanced Settings`. "
-        ),
-    )
 
 
 class NavExternalLinkBlock(NavBaseLinkBlock):
@@ -359,3 +351,48 @@ class ReusableContentBlock(BaseBlock):
         label = _("Reusable Content")
         template = "cjkcms/blocks/reusable_content_block.html"
         label_format = "{content} (Reusable Content)"
+
+
+class HighlightBlock(BaseBlock):
+    """
+    Block that highlights a piece of text
+    """
+
+    text = blocks.RichTextBlock(
+        features=cms_settings.CJKCMS_RICHTEXT_FEATURES["default"],
+        label=_("Text"),
+    )
+
+    background_color = blocks.ChoiceBlock(
+        choices=cms_settings.CJKCMS_HIGHLIGHT_COLORS,
+        default=cms_settings.CJKCMS_HIGHLIGHT_DEFAULT_COLOR,
+        required=False,
+        label=_("Background Color"),
+    )
+
+    border_color = blocks.ChoiceBlock(
+        choices=cms_settings.CJKCMS_HIGHLIGHT_COLORS,
+        default=cms_settings.CJKCMS_HIGHLIGHT_DEFAULT_COLOR,
+        required=False,
+        label=_("Border Color"),
+    )
+
+    text_color = blocks.ChoiceBlock(
+        choices=cms_settings.CJKCMS_HIGHLIGHT_COLORS,
+        default="dark",
+        required=False,
+        label=_("Text Color"),
+    )
+
+    icon = blocks.ChoiceBlock(
+        choices=cms_settings.FONT_AWESOME_ICONS,
+        default=cms_settings.FONT_AWESOME_ICONS_DEFAULT,
+        required=False,
+        label=_("Icon"),
+    )
+
+    class Meta:
+        icon = "thumbtack"
+        label = _("Highlight")
+        label_format = _("Highlight")
+        template = "cjkcms/blocks/highlight_block.html"

cjkcms/migrations/0018_layoutsettings_search_format.py

@@ -4,15 +4,20 @@ from django.db import migrations, models
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
-        ('cjkcms', '0017_layoutsettings_default_seo_image'),
+        ("cjkcms", "0017_layoutsettings_default_seo_image"),
     ]
 
     operations = [
         migrations.AddField(
-            model_name='layoutsettings',
-            name='search_format',
-            field=models.CharField(blank=True, choices=[], default='', max_length=50, verbose_name='Search format'),
+            model_name="layoutsettings",
+            name="search_format",
+            field=models.CharField(
+                blank=True,
+                choices=[],
+                default="",
+                max_length=50,
+                verbose_name="Search format",
+            ),
         ),
     ]

cjkcms/migrations/0019_layoutsettings_searchbox_input_class_and_more.py

@@ -4,25 +4,42 @@ from django.db import migrations, models
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
-        ('cjkcms', '0018_layoutsettings_search_format'),
+        ("cjkcms", "0018_layoutsettings_search_format"),
     ]
 
     operations = [
         migrations.AddField(
-            model_name='layoutsettings',
-            name='searchbox_input_class',
-            field=models.CharField(blank=True, default='border-secondary mb-0', help_text='Classes applied to searchbox input', max_length=255, verbose_name='Searchbox input class'),
+            model_name="layoutsettings",
+            name="searchbox_input_class",
+            field=models.CharField(
+                blank=True,
+                default="border-secondary mb-0",
+                help_text="Classes applied to searchbox input",
+                max_length=255,
+                verbose_name="Searchbox input class",
+            ),
         ),
         migrations.AddField(
-            model_name='layoutsettings',
-            name='searchbutton_class',
-            field=models.CharField(blank=True, default='btn btn-outline-secondary', help_text='Classes applied to search button. Add e.g. `fas fa-search` for icon.', max_length=255, verbose_name='Search button (with text) class'),
+            model_name="layoutsettings",
+            name="searchbutton_class",
+            field=models.CharField(
+                blank=True,
+                default="btn btn-outline-secondary",
+                help_text="Classes applied to search button. Add e.g. `fas fa-search` for icon.",
+                max_length=255,
+                verbose_name="Search button (with text) class",
+            ),
         ),
         migrations.AddField(
-            model_name='layoutsettings',
-            name='searchbutton_label',
-            field=models.CharField(blank=True, default='Search', help_text='Leave empty when using icon-only button. Otherwise, add button label.', max_length=255, verbose_name='Search button label'),
+            model_name="layoutsettings",
+            name="searchbutton_label",
+            field=models.CharField(
+                blank=True,
+                default="Search",
+                help_text="Leave empty when using icon-only button. Otherwise, add button label.",
+                max_length=255,
+                verbose_name="Search button label",
+            ),
         ),
     ]

cjkcms/migrations/0020_socialmediasettings_github_and_more.py

@@ -0,0 +1,35 @@
+# Generated by Django 5.0.2 on 2024-03-11 19:20
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("cjkcms", "0019_layoutsettings_searchbox_input_class_and_more"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="socialmediasettings",
+            name="github",
+            field=models.URLField(
+                blank=True, help_text="Your GitHub page URL", verbose_name="GitHub"
+            ),
+        ),
+        migrations.AddField(
+            model_name="socialmediasettings",
+            name="pinterset",
+            field=models.URLField(
+                blank=True,
+                help_text="Your Pinterest page URL",
+                verbose_name="Pinterest",
+            ),
+        ),
+        migrations.AddField(
+            model_name="socialmediasettings",
+            name="tiktok",
+            field=models.URLField(
+                blank=True, help_text="Your TikTok account URL", verbose_name="TikTok"
+            ),
+        ),
+    ]

cjkcms/migrations/0021_remove_layoutsettings_navbar_color_scheme_and_more.py

@@ -0,0 +1,85 @@
+# Generated by Django 5.0.2 on 2024-03-21 15:11
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("cjkcms", "0020_socialmediasettings_github_and_more"),
+    ]
+
+    operations = [
+        migrations.RemoveField(
+            model_name="layoutsettings",
+            name="navbar_color_scheme",
+        ),
+        migrations.AddField(
+            model_name="layoutsettings",
+            name="color_scheme",
+            field=models.CharField(
+                blank=True,
+                choices=[],
+                default="",
+                help_text="Default light/dark/custom theme. (MD/Bootstrap only)",
+                max_length=50,
+                verbose_name="Color scheme",
+            ),
+        ),
+        migrations.AddField(
+            model_name="layoutsettings",
+            name="light_dark_switch",
+            field=models.BooleanField(
+                default=False,
+                help_text="Show switch to toggle light/dark theme (MD/Bootstrap only)",
+                verbose_name="Light/Dark switch",
+            ),
+        ),
+        migrations.AlterField(
+            model_name="layoutsettings",
+            name="frontend_theme",
+            field=models.CharField(
+                blank=True,
+                choices=[],
+                default="",
+                help_text="Change the source of your Bootstrap theme.",
+                max_length=50,
+                verbose_name="Theme variant",
+            ),
+        ),
+        migrations.AlterField(
+            model_name="layoutsettings",
+            name="navbar_collapse_mode",
+            field=models.CharField(
+                blank=True,
+                choices=[],
+                default="",
+                help_text="Control on what screen sizes to show and collapse the navbar menu links.",
+                max_length=50,
+                verbose_name="Collapse navbar menu",
+            ),
+        ),
+        migrations.AlterField(
+            model_name="layoutsettings",
+            name="navbar_format",
+            field=models.CharField(
+                blank=True,
+                choices=[],
+                default="",
+                max_length=50,
+                verbose_name="Navbar format",
+            ),
+        ),
+        migrations.AlterField(
+            model_name="layoutsettings",
+            name="navbar_langselector",
+            field=models.CharField(
+                blank=True,
+                choices=[],
+                default=None,
+                help_text="Choose lang choice selector",
+                max_length=255,
+                null=True,
+                verbose_name="Language selector",
+            ),
+        ),
+    ]

cjkcms/migrations/0022_cjkcmspage_breadcrumb_label_and_more.py

@@ -0,0 +1,23 @@
+# Generated by Django 5.0.6 on 2024-09-02 12:44
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('cjkcms', '0021_remove_layoutsettings_navbar_color_scheme_and_more'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='cjkcmspage',
+            name='breadcrumb_label',
+            field=models.CharField(blank=True, help_text='If empty, page title will be used.', max_length=128, verbose_name='Breadcrumb label'),
+        ),
+        migrations.AddField(
+            model_name='cjkcmspage',
+            name='breadcrumbs_visible',
+            field=models.BooleanField(default=True, help_text='Show breadcrumbs in this page header. For global change, see Settings->Layout', verbose_name='Breadcrumbs'),
+        ),
+    ]

cjkcms/migrations/0023_alter_navbar_language.py

@@ -0,0 +1,18 @@
+# Generated by Django 5.1.4 on 2024-12-31 20:17
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('cjkcms', '0022_cjkcmspage_breadcrumb_label_and_more'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='navbar',
+            name='language',
+            field=models.CharField(blank=True, choices=[], default='_all_', help_text='Select a language to limit display to specific locale.', max_length=10, verbose_name='Show in language'),
+        ),
+    ]

cjkcms/models/admin_sidebar.py

@@ -1,28 +0,0 @@
-from .snippet_models import Navbar, EventCalendar
-from wagtail.snippets.views.snippets import SnippetViewSet
-
-
-class NavbarSnippet(SnippetViewSet):
-    model = Navbar
-    menu_label = "Navigation"
-    menu_icon = "link"  # change as required
-    add_to_admin_menu = True
-    list_display = (
-        "name",
-        "custom_css_class",
-        "custom_id",
-    )
-    search_fields = [
-        "name",
-    ]
-
-
-class EventCalendarSnippet(SnippetViewSet):
-    model = EventCalendar
-    menu_label = "Public Events"
-    menu_icon = "calendar"  # change as required
-    # add_to_admin_menu = True
-    list_display = ("name",)
-    search_fields = [
-        "name",
-    ]

cjkcms/models/page_models.py

@@ -208,6 +208,25 @@ class CjkcmsPage(WagtailCacheMixin, SeoMixin, Page, metaclass=CjkcmsPageMeta):
         blank=True, max_length=255, choices=None, verbose_name=_("Template")  # type: ignore  # noqa: E501
     )
 
+    ###############
+    # Breadcrumbs fields (on layout tab)
+    ###############
+
+    breadcrumbs_visible = models.BooleanField(
+        default=True,
+        verbose_name=_("Breadcrumbs"),
+        help_text=_(
+            "Show breadcrumbs in this page header. For global change, see Settings->Layout"
+        ),
+    )
+
+    breadcrumb_label = models.CharField(
+        blank=True,
+        max_length=128,
+        verbose_name=_("Breadcrumb label"),
+        help_text=_("If empty, page title will be used."),
+    )
+
     ###############
     # SEO overrides
     ###############
@@ -269,6 +288,13 @@ class CjkcmsPage(WagtailCacheMixin, SeoMixin, Page, metaclass=CjkcmsPageMeta):
 
     layout_panels = [
         MultiFieldPanel([FieldPanel("custom_template")], heading=_("Visual Design")),
+        MultiFieldPanel(
+            [
+                FieldPanel("breadcrumbs_visible"),
+                FieldPanel("breadcrumb_label"),
+            ],
+            heading=_("Breadcrumbs settings"),
+        ),
         MultiFieldPanel(
             [
                 FieldPanel("index_show_subpages"),
@@ -347,6 +373,13 @@ class CjkcmsPage(WagtailCacheMixin, SeoMixin, Page, metaclass=CjkcmsPageMeta):
         edit_handler = TabbedInterface(panels)
         return edit_handler.bind_to_model(cls)
 
+    @property
+    def breadcrumb_title(self) -> str:
+        """
+        Gets breadcrumb title, or page title if not set.
+        """
+        return self.breadcrumb_label or self.title  # type: ignore
+
     @property
     def default_seo_image(self) -> "Optional[AbstractImage]":
         """

cjkcms/models/snippet_models.py

@@ -25,6 +25,7 @@ from django.conf import settings
 from cjkcms.fields import CjkcmsStreamField
 from wagtail_color_panel.fields import ColorField
 from wagtail_color_panel.edit_handlers import NativeColorPanel
+from django.forms import ModelForm
 
 
 @register_snippet
@@ -342,7 +343,7 @@ class Navbar(models.Model):
     language = models.CharField(
         blank=True,
         max_length=10,
-        choices=[("_all_", _("All languages"))],
+        choices=[],
         default="_all_",
         verbose_name=_("Show in language"),
         help_text=_("Select a language to limit display to specific locale."),
@@ -371,24 +372,38 @@ class Navbar(models.Model):
     def __str__(self):
         return self.name
 
+    @staticmethod
+    def get_available_langs():
+        available_langs = [("_all_", _("All languages"))]
+        if hasattr(settings, "WAGTAIL_CONTENT_LANGUAGES"):
+            available_langs += settings.WAGTAIL_CONTENT_LANGUAGES
+        return available_langs
+
     def __init__(self, *args, **kwargs):
         """
         Inject custom choices and defaults into the form fields
         to enable customization of settings without causing migration issues.
         """
         super().__init__(*args, **kwargs)
-        # Set choices dynamically.
-
-        available_langs = [("_all_", _("All languages"))]
-        if hasattr(settings, "WAGTAIL_CONTENT_LANGUAGES"):
-            available_langs += settings.WAGTAIL_CONTENT_LANGUAGES
 
-        self._meta.get_field("language").choices = available_langs  # type: ignore
+        self._meta.get_field("language").choices = Navbar.get_available_langs()  # type: ignore
         # Set default dynamically.
         if not self.id:  # type: ignore
             self.language = "_all_"
 
 
+class NavbarForm(ModelForm):
+    class Meta:
+        model = Navbar
+        fields = "__all__"
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+
+        # Set the dynamic choices
+        self.fields["language"].choices = Navbar.get_available_langs()
+
+
 @register_snippet
 class Footer(models.Model):
     """