wagtail-cjkcms 24.6.1__tar.gz → 24.6.2__tar.gz

{wagtail_cjkcms-24.6.1 → wagtail_cjkcms-24.6.2}/CHANGELOG.md

@@ -14,6 +14,11 @@ migrated to this file.
 ### Fixed
 ### Removed
 
+
+## [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

{wagtail_cjkcms-24.6.1/wagtail_cjkcms.egg-info → wagtail_cjkcms-24.6.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: wagtail-cjkcms
-Version: 24.6.1
+Version: 24.6.2
 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

{wagtail_cjkcms-24.6.1 → wagtail_cjkcms-24.6.2}/cjkcms/__init__.py

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

{wagtail_cjkcms-24.6.1 → wagtail_cjkcms-24.6.2}/cjkcms/settings.py

@@ -459,6 +459,9 @@ class _DefaultSettings:
         ("btn-outline-link", "Link Outline"),
     ]
 
+    CJKCMS_VERSION_MONITOR_TOKEN = ""  # blank token = disabled version monitor api
+    CJKCMS_VERSION_MONITOR_ALLOWED_DOMAINS = []  # disallow from any domain by default
+
     def __getattribute__(self, attr: str):
         # First load from Django settings.
         # If it does not exist, load from _DefaultSettings.

{wagtail_cjkcms-24.6.1 → wagtail_cjkcms-24.6.2}/cjkcms/urls.py

@@ -1,6 +1,7 @@
 from django.urls import include, path
 from wagtail.contrib.sitemaps.views import sitemap
 from cjkcms import search_urls as cjkcms_search_urls
+from .views import VersionView
 
 # from .settings import cms_settings
 from cjkcms.views import (
@@ -13,6 +14,8 @@ urlpatterns = [
     path("favicon.ico", favicon, name="cjkcms_favicon"),
     path("robots.txt", robots, name="cjkcms_robots"),
     path("sitemap.xml", sitemap, name="cjkcms_sitemap"),
+    # version reporting
+    path("api/versions/<str:token>/", VersionView.as_view(), name="get_versions"),
     # Search
     path("search/", include(cjkcms_search_urls)),
 ]

{wagtail_cjkcms-24.6.1 → wagtail_cjkcms-24.6.2}/cjkcms/views.py

@@ -13,6 +13,16 @@ from wagtail.models import Page, get_page_models
 # from coderedcms.importexport import convert_csv_to_json, import_pages, ImportPagesFromCSVFileForm
 from cjkcms.templatetags.cjkcms_tags import get_name_of_class
 
+from rest_framework.views import APIView
+from rest_framework.response import Response
+from rest_framework import status
+from django.conf import settings
+from django.http import JsonResponse
+import django
+from wagtail import __version__ as wagtail_version
+from cjkcms import __version__ as cjkcms_version
+import sys
+
 
 def search(request):
     """
@@ -84,46 +94,30 @@ def robots(request):
     return render(request, "cjkcms/robots.txt", content_type="text/plain")
 
 
-# @login_required
-# def import_index(request):
-#     """
-#     Landing page to replace wagtailimportexport.
-#     """
-#     return render(request, 'wagtailimportexport/index.html')
-
-
-# @login_required
-# def import_pages_from_csv_file(request):
-#     """
-#     Overwrite of the `import_pages` view from wagtailimportexport.  By default, the `import_pages`
-#     view expects a json file to be uploaded.  This view converts the uploaded csv into the json
-#     format that the importer expects.
-#     """
-
-#     if request.method == 'POST':
-#         form = ImportPagesFromCSVFileForm(request.POST, request.FILES)
-#         if form.is_valid():
-#             import_data = convert_csv_to_json(
-#                 form.cleaned_data['file'].read().decode('utf-8').splitlines(),
-#                 form.cleaned_data['page_type']
-#             )
-#             parent_page = form.cleaned_data['parent_page']
-#             try:
-#                 page_count = import_pages(import_data, parent_page)
-#             except LookupError as e:
-#                 messages.error(request, _(
-#                     "Import failed: %(reason)s") % {'reason': e}
-#                 )
-#             else:
-#                 messages.success(request, ngettext(
-#                     "%(count)s page imported.",
-#                     "%(count)s pages imported.",
-#                     page_count) % {'count': page_count}
-#                 )
-#             return redirect('wagtailadmin_explore', parent_page.pk)
-#     else:
-#         form = ImportPagesFromCSVFileForm()
-
-#     return render(request, 'wagtailimportexport/import_from_csv.html', {
-#         'form': form,
-#     })
+class VersionView(APIView):
+
+    def get(self, request, token):
+        monitor_token = settings.CJKCMS_VERSION_MONITOR_TOKEN
+        allowed_domains = settings.CJKCMS_VERSION_MONITOR_ALLOWED_DOMAINS
+
+        host = request.META.get("HTTP_HOST")
+
+        token_ok = len(token) < 12 or token != monitor_token
+        domain_ok = allowed_domains = ["*"] or host in allowed_domains
+
+        # minimum required token length is 12 characters
+        # this also prevents sites from reporting when default
+        # empty token has not been replaced in local config with a proper one
+
+        if token_ok and domain_ok:
+            return JsonResponse(
+                {"error": "Forbidden."}, status=status.HTTP_403_FORBIDDEN
+            )
+
+        data = {
+            "python": sys.version,
+            "django": django.get_version(),
+            "wagtail": wagtail_version,
+            "cjkcms": cjkcms_version,
+        }
+        return Response(data)

wagtail_cjkcms-24.6.2/docs/api_reference/api/version_monitor.md

@@ -0,0 +1,38 @@
+# Version monitor
+
+## Purpose
+
+The purpose of this feature is to enable easy monitoring of setups with multiple websites, where it is easy to get 
+forget about keeping all websites up to date with software components. 
+
+Administrator can easily implement a dashboard for simultaneous monitoring of multiple websites, making sure that 
+software components are up to date everywhere.
+
+## Description
+
+In order to enable remote monitoring of versions of basic software components (django, wagtail, cms), a new api route 
+has been added:
+/api/versions/<TOKEN_MIN_12_CHARACTERS>/
+
+This returns a JSON response with versions of key software components.
+
+For security, it has been disabled by default. Two settings entries control access to the feature.
+Set them in your local settings, to enable monitoring:
+
+```
+CJKCMS_VERSION_MONITOR_TOKEN = "123456789ABCDEF" # token - min 12 chars
+CJKCMS_VERSION_MONITOR_ALLOWED_DOMAINS = ["*"] # allowed domains - by default blank
+```
+
+## Output
+
+If an api call does not pass security checks, 403 is returned. If security checks are ok, the following type of JSON response is returned:
+
+```json
+{
+    "python": "3.12.3 (main, May 27 2024, 19:00:21) [GCC 11.4.0]",
+    "django": "5.0.6",
+    "wagtail": "6.1.2",
+    "cjkcms": "24.6.1"
+}
+```

{wagtail_cjkcms-24.6.1 → wagtail_cjkcms-24.6.2/wagtail_cjkcms.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: wagtail-cjkcms
-Version: 24.6.1
+Version: 24.6.2
 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

{wagtail_cjkcms-24.6.1 → wagtail_cjkcms-24.6.2}/wagtail_cjkcms.egg-info/SOURCES.txt

@@ -339,6 +339,7 @@ docs/requirements.txt
 docs/unit_testing.md
 docs/why-another-cms.md
 docs/api_reference/api/mailchimp.md
+docs/api_reference/api/version_monitor.md
 docs/api_reference/blocks/content_blocks.md
 docs/api_reference/blocks/html_blocks.md
 docs/api_reference/blocks/layout_blocks.md