wagtail-cjkcms 24.2.7__tar.gz → 25.1.6__tar.gz

wagtail_cjkcms-25.1.6/CHANGELOG.md

@@ -0,0 +1,243 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Calendar Versioning](https://calver.org/).
+
+Pre-2023/08-15 changelog is available in [CHANGELOG_old.md](CHANGELOG_old.md), it will be gradually 
+migrated to this file.
+
+## [Unreleased]
+### Added
+### Changed
+### Fixed
+### Removed
+
+## [25.1.3] - 2025-01-03
+### Fixed
+ - Fixed problems on some websites resulting from renaming navbar_search.html. Restored the previous template file name.
+
+## [25.1.1] - 2025-01-01
+### Fixed
+ - Fixed regression bug causing menu items to be hidden. This required me to fully remove
+ check for the deprecated menu items visibility options.
+
+## [24.12.4] - 2024-12-31
+### Removed
+ - Removed deprecated menu visibility management via visible_for field in NavBlocks
+CMS blocks are JSON-based, and ignored in migrations, so If we removed the field in block defintion, this would not cause the data in database disappear. As a result we might have blocks in various websites which are strangely invisible to users, even if nothing is set in the visible block definition. So for safety, a new setting has been added: CJKCMS_NAVBAR_SHOW_VISIBLE_FOR = False. Switch it to True to restore visibility of that block component, if you have problems with any websites. For security, implementation of the visibility checks in templates (can_show_item value.visible_for ) was NOT removed from code.
+- Corrected issue with fixed top navbars. Important - this changed some implementation details (e.g. css styling), so check your site if it uses fixed navbar
+
+## [24.12.2] - 2024-12-31
+### Added
+ - "countdown" content block using VincentLoy's library. See https://vincentloy.github.io/simplyCountdown.js/ for more info
+ - added themes and tests for the "countdown" block
+
+
+## [24.9.1] - 2024-09-02
+### Added
+ - Support for breadcrumbs per-page visibility
+ - breadcrumb_title page property for all CMS pages, choosing new "breadcrumb_label" field or page title if new field empty
+ - Added new templatetag with tests: first_not_empty which returns first not empty argument from the list, e.g. {% first_not_empty var1 var2 var3 %} 
+
+## [24.8.1] - 2024-08-27
+### Fixed
+ - Update malformed robots.txt file
+
+## [24.6.4] - 2024-06-28
+### Changed
+ - Update mdb-ui-kit version to 7.3.2
+
+## [24.6.4] - 2024-06-26
+### Fixed
+ - Fixed responsiveness of the 404 template 
+
+## [24.6.3] - 2024-06-25
+### Added
+ -  HighlightBlock, allows an element to stand out with the ability to change the colour of the background, border, text from the basic bootstrap colour palette also allows an icon to be added
+
+## [24.6.2] - 2024-06-02
+### Added
+ - API endpoint to allow remote monitoring of software component versions. Disabled by default. See /docs/api/version_monitor.md for details
+
+## [24.6.1] - 2024-06-01
+### Changed
+ - MDBootstrap kit updated to 7.3.0
+ - Restored availability of MDBootstrap CDN ich choice of Bootstrap themes
+ - Updated dropdown init code in base_link_block to work with MDBootstrap 7.3.0+
+### Fixed
+ - Dark theme was incorrectly forced when MDB was in use; now respects the choice in backend->settings->layout
+
+## [24.5.1] - 2024-05-01
+### Added
+ - Support for custom bs/mdb variables: when layout->theme set to "custom", loads /static/cjkcms/css/cjkcms-custom-theme.css. Define this file in your project using e.g. template copied from /static/cjkcms/css/cjkcms-custom-theme-disabled.css and redefine any css vars
+ - Support for stretched-link in any Button Link, including in any card. To achieve a stretched link, add "stretched-link" to custom css classes in button's advanced settings. To achieve an invisible button link (e.g. image link), add "stretched-link zero-sized" to custom css of the button.
+
+
+## [24.3.3] - 2024-03-21
+### Added
+ - Correct processing of theme_css and theme_js for both full URLs (https:...) and local static paths (local/path/to.css)
+ - Support for client-side theme switching in both bootstrap and mdbootstrap
+### Fixed
+ - Problem with stretched-link not working in mdbootstrap when btn class used (required updating mdb-uikit to 7.x)
+### Changed
+ - MDB light and dark now packaged with the CMS, not loaded from CDN
+ - !!! Breaking change: navbar_color_scheme setting renamed to color_scheme and used as data-mdb/bs-theme setting for theme switching
+ - !!! Breaking configuration changes in Layout settings: navbar_collapse_mode, navbar_format, navbar_langselector and frontend_theme:
+   changed choices in the model from None to [], this may result in re-setting these settings in Backend->Settings->Layout to defaults.
+   Check each website after updating the CMS for layout of the HP, navbar collapse screen width, and theme layout.
+
+## [24.3.2] - 2024-03-20
+### Fixed
+ - Renamed "libs" to "cjkcms_libs" in frontend scripts, to avoid name clash with htmx
+ Note: turns out, this was a misdiagnosed issue, there was no clash. But, it is better to have a more specific variable name,
+ rather than a generic "libs", so we'll keep this change.
+
+
+## [24.3.1] - 2024-03-11
+### Added
+ - Missing social media fields in settings/social-media, and icons, including new X to replace Twitter
+ - Updated fontawesome CDN call to v.6.5.1 to include new X icon.
+
+
+## [24.2.7] - 2024-02-18
+### Fixed
+ - Rebuilt search box/button customisation for cleaner code and more flexibility
+
+
+## [24.2.6] - 2024-02-18
+### Fixed
+ - Removed packages from pyproject.toml to rely on autodiscovery of setuptools
+
+
+## [24.2.4] - 2024-02-18
+### Fixed
+ - Broken setup dependencies in pyproject.toml
+
+## [24.2.4] - 2024-02-18
+### Added
+ - Customisable search box, with five different out-of-the-box display styles.
+ - Updated setup configuration. Restored dependency on wagtail-seo and wagtail-cache which now support Wagtail 6.
+
+# [24.2.1] - 2024-02-08
+### Fixed
+ - Ensured compatibility with Wagtail 6.0 and Django 5.0.x
+
+## [24.1.1] - 2024-01-07
+### Fixed
+ - Code refactoring
+ = Ensured compatibility with Wagtail 5.2.x and Django 5.0.x
+### Added
+ - Added some unit tests
+
+
+
+## [23.12.2] - 2023-12-07
+### Fixed
+ - Fixed Vimeo oembed provider which was broken due to Vimeo API changes (there should be no www. in the oembed url)
+
+
+## [23.12.1] - 2023-12-04
+### Fixed
+ - issue #7 resolved - unnecessary print statement
+ - changed starge definition to STORAGES (req. Django 4.2+)
+
+## [23.10.6]
+### Added
+ - default_seo_image in Settings->Layout->Branding, to be used in meta tags and social media cards when no image is specified for a page
+### Fixed
+ - in project templates, ALL_LAYOUT_STREAMBLOCKS now get properly updated with ALL_CONTENT_STREMBLOCKS.
+
+
+## [23.10.5]
+### Fixed
+ - codespell related fixes
+ - fixed broken webpack project template
+ - started building docs for webpack project template
+
+## [23.10.4]
+### Added
+ - Responsive images classes for text editor image blocks (centered, left, right)
+### Changed
+### Fixed
+ - Missing sitemap app in base.py in project templates
+ - Corrected broken EMAIL_BACKEND in base.py in webpack project template
+### Removed
+
+## [23.10.3] - 2023-10-07
+### Added
+ - 25 Bootswatch themes to choose from in the settings
+### Changed
+ - Rewritten inclusion of frontend CSS and JS assets to support new themes
+
+
+## [23.10.2] - 2023-10-07
+### Fixed
+ - Search bar layout - vertical alignment
+ - Full search form - fixed broken template
+
+ ### Added
+ - Breadcrumbs template snippet - needs to be activated in Settings->Layout
+ - New section in the docs
+ 
+
+## [23.10.1] - 2023-10-01
+### Added
+ - Added EventCalendar content block. Use snippets to create EventCalendars, and to display them on pages.
+
+
+## [23.9.2] - 2023-09-07
+### Added
+ - AdvancedSettings for Page blocks and Navigation models supports conditional visibility: all, none, not-logged-in, logged-in, logged-in and in group(s), logged-in and not in group(s). Tests needed. 
+
+
+## [23.9.1] - 2023-09-04
+### Added
+ - New template snippet: actionbar.html. This will further be developed to include customisable calls to action in the page header.
+
+## [23.8.11] - 2023-08-22
+### Fixed
+ - broken icons in the backend
+
+
+## [23.8.10] - 2023-08-21
+### Added
+ - Images in Snippet Index Views: ThumbnailColumn("image", width=50, classname="w-rounded") in SnippetViews. Requires Wagtail >=5.1
+
+## [23.8.9] - 2023-08-21
+### Added
+ - Added dynamic labels to all collapsed layout block types
+### Removed
+ - Removed unused modeladmin imports (deprecated)
+
+## [23.8.8] - 2023-08-20
+### Fixed
+ - broken requirements in pyproject.toml
+
+## [23.8.7] - 2023-08-20
+### Added
+ - Added individual navigation bar alignment options, to allow some menu items to be aligned to the left and some to the right, working smoothly with social media icons display in menu position.
+### Changed
+ - Documentation uses material mkdocs theme
+### Fixed
+ - Social media icons include_block tag replaced with include tag
+ - Fixed display of page, document and image names in collapsed navbar entries
+ - Fixed template variable in social media icons template block
+
+## [23.8.6] - 2023-08-19
+
+### Added
+- new changelog in a proper format (new changes at the top)
+- Added aria-label to menubar logo and social media icons
+
+### Changed
+- dependencies updated to use cjkpl's forked pypi packages for wagtail-color-panel and wagtail-seo, as original packages do not yet have a Wagtail 5.x support
+
+<!-- >
+## [Unreleased]
+### Added
+### Changed
+### Fixed
+### Removed
+< -->

{wagtail-cjkcms-24.2.7/wagtail_cjkcms.egg-info → wagtail_cjkcms-25.1.6}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: wagtail-cjkcms
-Version: 24.2.7
+Version: 25.1.6
 Summary: Wagtail Content Management System, installable as a Django app into any Wagtail 4.1.x/5.x/6.x site.
 Author-email: Grzegorz Krol <gk@cjk.pl>
 License: BSD-3-Clause
@@ -32,8 +32,8 @@ License-File: LICENSE
 Requires-Dist: django-bootstrap5
 Requires-Dist: django>=4.2
 Requires-Dist: wagtail>=5.1
-Requires-Dist: wagtail-seo
-Requires-Dist: wagtail-cache
+Requires-Dist: wagtail-seo>=2.5.0
+Requires-Dist: wagtail-cache>=2.5.1
 Requires-Dist: cjkcms-color-panel
 
 ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/wagtail-cjkcms)

{wagtail-cjkcms-24.2.7 → wagtail_cjkcms-25.1.6}/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 "")

{wagtail-cjkcms-24.2.7 → wagtail_cjkcms-25.1.6}/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 = [

wagtail_cjkcms-25.1.6/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}")

{wagtail-cjkcms-24.2.7 → wagtail_cjkcms-25.1.6}/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"

wagtail_cjkcms-25.1.6/cjkcms/migrations/0018_layoutsettings_search_format.py

@@ -0,0 +1,23 @@
+# Generated by Django 5.0.2 on 2024-02-18 13:58
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("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",
+            ),
+        ),
+    ]

wagtail_cjkcms-25.1.6/cjkcms/migrations/0019_layoutsettings_searchbox_input_class_and_more.py

@@ -0,0 +1,45 @@
+# Generated by Django 5.0.2 on 2024-02-18 22:01
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("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",
+            ),
+        ),
+        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",
+            ),
+        ),
+        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",
+            ),
+        ),
+    ]

wagtail_cjkcms-25.1.6/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"
+            ),
+        ),
+    ]

wagtail_cjkcms-25.1.6/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",
+            ),
+        ),
+    ]