djangocms-render-context 1.0.0__py3-none-any.whl → 1.2.0__py3-none-any.whl

djangocms_render_context/__init__.py

@@ -1 +1 @@
-__version__ = "1.0.0"
+__version__ = "1.2.0"

djangocms_render_context/cms_plugins.py

@@ -21,6 +21,7 @@ class RenderContextPlugin(CMSPluginBase):
             _("Sources"),
             {
                 "fields": (
+                    "mimetype",
                     "context",
                     "file",
                     (
@@ -30,6 +31,13 @@ class RenderContextPlugin(CMSPluginBase):
                 ),
             },
         ),
+        (
+            _("Source settings"),
+            {
+                "classes": ["collapse"],
+                "fields": ("config",),
+            },
+        ),
         (
             _("Templates"),
             {
@@ -37,6 +45,7 @@ class RenderContextPlugin(CMSPluginBase):
                 "fields": (
                     "template",
                     "template_list",
+                    "path",
                 ),
             },
         ),

djangocms_render_context/forms.py

@@ -1,3 +1,4 @@
+import logging
 from collections.abc import Callable
 from typing import Union
 
@@ -9,21 +10,39 @@ from django.forms import ALL_FIELDS, ModelForm
 from django.template import Context, Template, TemplateDoesNotExist
 from django.template.exceptions import TemplateSyntaxError
 from django.template.loader import get_template
+from django.urls import reverse_lazy
+from django.urls.exceptions import NoReverseMatch
 from django.utils.translation import gettext_lazy as _
 from filer.models.filemodels import File
+from sekizai.context import SekizaiContext
 
 from .cache import get_cache_key
 from .exceptions import SourceParseFailure
-from .loaders import SUPPORTED_FILE_TYPES, get_data_from_file, get_data_from_url
+from .loaders import (
+    CONTEXT_DATA_FORMATS,
+    LOADERS,
+    SUPPORTED_FILE_TYPES,
+    get_data_from_file,
+    get_data_from_url,
+    value_to_bytes,
+)
+from .utils import get_context_from_path
 
 TEMPLATES = (("", ""),)
 
 sourceType = Union[str, File]  # noqa: UP007
 
+logger = logging.getLogger(__name__)
+
 
 class RenderContextForm(ModelForm):
     """Render Context Form."""
 
+    mimetype = forms.ChoiceField(
+        label=_("Type of Data for context"),
+        choices=CONTEXT_DATA_FORMATS,
+        help_text=_("The format must be consistent with the data in the context."),
+    )
     template_list = forms.ChoiceField(
         label=_("Template list"),
         required=False,
@@ -31,9 +50,39 @@ class RenderContextForm(ModelForm):
         help_text=_("List of templates. If Template is specified, the template set in the list will not be used."),
     )
 
+    class Media:
+        js = [
+            # "https://cdn.jsdelivr.net/npm/jspreadsheet-ce@5/dist/index.min.js",
+            "djangocms_render_context/js-dist/index.min.js",
+            # "https://cdn.jsdelivr.net/npm/jsuites@5/dist/jsuites.min.js",
+            "djangocms_render_context/js-dist/jsuites.min.js",
+            # https://github.com/nodeca/js-yaml
+            "djangocms_render_context/js-dist/js-yaml.min.js",
+            # https://github.com/rufuspollock/csv.js
+            "djangocms_render_context/js-dist/csv.min.js",
+            "djangocms_render_context/js/spreadsheet.js",
+        ]
+        css = {
+            "all": [
+                # "https://cdn.jsdelivr.net/npm/jspreadsheet-ce@5/dist/jspreadsheet.min.css",
+                "djangocms_render_context/css-dist/jspreadsheet.min.css",
+                # "https://cdn.jsdelivr.net/npm/jsuites@5/dist/jsuites.min.css",
+                "djangocms_render_context/css-dist/jsuites.min.css",
+                # "https://fonts.googleapis.com/icon?family=Material+Icons",
+                "djangocms_render_context/css-dist/icon-family-Material-Icons.css",
+                "djangocms_render_context/css/spreadsheet.css",
+            ],
+        }
+
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
         self.fields["file"].help_text += " " + _("Supported formats are:") + " " + ", ".join(SUPPORTED_FILE_TYPES)
+        pathname = getattr(settings, "DJANGOCMS_RENDER_CONTEXT_JSI18N", "jsi18n")
+        try:
+            path = reverse_lazy(pathname, kwargs={"packages": "djangocms_render_context"})
+            self.media._js_lists[-1].append(path)
+        except NoReverseMatch as err:
+            logger.error(err)
 
     def clean_template_list(self) -> None:
         if self.cleaned_data["template_list"]:
@@ -51,10 +100,16 @@ class RenderContextForm(ModelForm):
         except SourceParseFailure as error:
             self.add_error(name, error)
 
+    def check_context_data(self, value: str, mimetype: str) -> Context:
+        try:
+            return Context(LOADERS[mimetype](value_to_bytes(value, mimetype)))
+        except SourceParseFailure as error:
+            self.add_error("context", error)
+
     def check_context(self, cleaned_data: dict) -> Context:
         context = Context({})
         if cleaned_data["context"]:
-            context = Context(cleaned_data["context"])
+            context = self.check_context_data(cleaned_data["context"], cleaned_data["mimetype"])
         elif cleaned_data["file"]:
             context = self.check_value("file", cleaned_data["file"], get_data_from_file)
         elif cleaned_data["source"]:
@@ -78,15 +133,25 @@ class RenderContextForm(ModelForm):
             template = get_template(cleaned_data["template_list"]).template
         if template:
             try:
-                template.render(context)
+                template.render(SekizaiContext(context))
             except (TemplateDoesNotExist, TemplateSyntaxError) as error:
                 self.add_error(field_name, error)
 
+    def check_path(self, cleaned_data: dict, context: Context) -> Context:
+        """Check path."""
+        if cleaned_data["path"]:
+            try:
+                context = Context(get_context_from_path(context, cleaned_data["path"]))
+            except (IndexError, KeyError, ValueError, TypeError) as error:
+                self.add_error("path", _("The data path is not valid. Error: %s") % error)
+        return context
+
     def clean(self) -> None:
         """Clean form."""
         cleaned_data = super().clean()
         if self.is_valid():
             context = self.check_context(cleaned_data)
+            context = self.check_path(cleaned_data, context)
             self.check_template(cleaned_data, context)
 
     def save(self, *args, **kwargs):

djangocms_render_context/loaders.py

@@ -1,3 +1,5 @@
+import base64
+import binascii
 import csv
 import json
 import xml.etree.ElementTree as ET
@@ -47,6 +49,17 @@ def get_data_from_file(source: File) -> dataType:
     return LOADERS[source.mime_type](source.file.read())
 
 
+def value_to_bytes(value: str, mimetype: str) -> bytes:
+    if mimetype == "application/vnd.oasis.opendocument.spreadsheet":
+        try:
+            content = base64.b64decode(value)
+        except (binascii.Error, ValueError) as err:
+            raise SourceParseFailure(err) from err
+    else:
+        content = value.encode("utf8")
+    return content
+
+
 def load_json(content: bytes) -> dataType:
     try:
         return json.load(BytesIO(content))
@@ -90,7 +103,7 @@ def load_spreadsheet(content: bytes) -> dataType:
     try:
         handle = zipfile.ZipFile(BytesIO(content))
         payload = handle.read("content.xml")
-    except (zipfile.BadZipFile, KeyError) as err:
+    except (zipfile.BadZipFile, KeyError, ValueError) as err:
         raise SourceParseFailure(err) from err
     finally:
         if handle is None:
@@ -212,3 +225,10 @@ LOADERS = {
     "application/xml": load_xml,
     "application/vnd.oasis.opendocument.spreadsheet": load_spreadsheet,
 }
+CONTEXT_DATA_FORMATS = (
+    ("application/json", "JSON"),
+    ("application/yaml", "YAML"),
+    ("application/xml", "XML"),
+    ("text/csv", "CSV"),
+    ("application/vnd.oasis.opendocument.spreadsheet", "ODS (in Base64)"),
+)

djangocms_render_context/locale/cs/LC_MESSAGES/django.po

@@ -7,7 +7,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: PACKAGE VERSION\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2025-12-11 13:17+0100\n"
+"POT-Creation-Date: 2026-01-09 09:26+0100\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: Zdeněk Böhm <zdenek.bohm@nic.cz>\n"
 "Language-Team: LANGUAGE <LL@li.org>\n"
@@ -17,6 +17,16 @@ msgstr ""
 "Content-Transfer-Encoding: 8bit\n"
 "Plural-Forms: nplurals=3; plural=(n==1) ? 0 : (n>=2 && n<=4) ? 1 : 2;\n"
 
+msgid ""
+"Additional configuration for spreadsheet with source data. The configuration "
+"is automatically added or updated when the spreadsheet is saved."
+msgstr ""
+"Další konfigurace pro tabulku se zdrojovými daty. Konfigurace je automaticky "
+"doplněna nebo aktualizována při ukládání tabulky."
+
+msgid "Configuration"
+msgstr "Konfigurace"
+
 msgid ""
 "Context data file. If Data is specified for the context, the source file is "
 "not used even though it is specified."
@@ -25,11 +35,11 @@ msgstr ""
 "zdrojový soubor nepoužije i přesto, že je zadán."
 
 msgid ""
-"Context data in JSON format. They take precedence over the source file and "
-"source URL."
+"Context data in selected format. They take precedence over the source file "
+"and source URL."
 msgstr ""
-"Data pro kontext ve formátu JSON. Mají přednost před zdrojovým souborem a "
-"URL zdroje."
+"Data pro kontext v nastaveném formátu. Mají přednost před zdrojovým souborem "
+"a URL zdroje."
 
 msgid "Data for context"
 msgstr "Data pro kontext"
@@ -37,10 +47,15 @@ msgstr "Data pro kontext"
 msgid "Data not entered."
 msgstr "Data nejsou zadána."
 
+msgid "Data path"
+msgstr "Cesta k datům"
+
 msgid ""
 "Django template for the context. It takes precedence over the template "
-"selected from the list."
-msgstr "Django šablona. Má přednost přes šablonou vybranou ze seznamu."
+"selected from the list. The context is available through the \"data\" value."
+msgstr ""
+"Django šablona. Má přednost přes šablonou vybranou ze seznamu. Kontext je "
+"dostupný přes hodnotu \"data\"."
 
 msgid "Download period from source URL"
 msgstr "Perioda stahování ze URL zdroje"
@@ -70,6 +85,9 @@ msgstr "URL zdroje"
 msgid "Source file"
 msgstr "Zdrojový soubor."
 
+msgid "Source settings"
+msgstr "Nastavení zdroje"
+
 msgid "Sources"
 msgstr "Zdroje"
 
@@ -94,6 +112,19 @@ msgstr ""
 "kontext nebo Zdrojový soubor, tak se URL zdroje nepoužije i přesto, že je "
 "zadáno."
 
+msgid "The data path is not valid. Error: %s"
+msgstr "Cesta k datům není platná. Chyba: %s"
+
+msgid "The format must be consistent with the data in the context."
+msgstr "Formát musí odpovídat datům v kontextu."
+
+msgid ""
+"The path to the data in the form \"name.name.name\". The \"data\" context in "
+"the template starts from this key."
+msgstr ""
+"Cesta k datům ve tvaru \"name.name.name\". Od tohoto klíče začíná kontext "
+"\"data\" v šabloně."
+
 msgid ""
 "The time in minutes during which data will not be retrieved from the Source "
 "URL, but will remain in the cache. If set to zero, data from the source URL "
@@ -103,5 +134,8 @@ msgstr ""
 "zůstanou ponechána v cache. Je-li nastavena nula, tak se data z URL zdroje "
 "do cache neukládají, ale načítají se pokaždé."
 
+msgid "Type of Data for context"
+msgstr "Typ dat pro kontext"
+
 msgid "Unsupported file mime type: "
 msgstr "Nepodporovaný mime typ souboru: "

djangocms_render_context/locale/cs/LC_MESSAGES/djangojs.po

@@ -0,0 +1,130 @@
+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER
+# This file is distributed under the same license as the PACKAGE package.
+# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: PACKAGE VERSION\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2026-01-20 08:21+0100\n"
+"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
+"Last-Translator: Zdeněk Böhm <zdenek.bohm@nic.cz>\n"
+"Language-Team: LANGUAGE <LL@li.org>\n"
+"Language: cs\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=3; plural=(n==1) ? 0 : (n>=2 && n<=4) ? 1 : 2;\n"
+
+msgid "(Press Alt+Enter to keep changes. / Alt+Q to cancel.)"
+msgstr "(Alt+Enter ponechat změny. / Alt+Q ztušit.)"
+
+msgid "About"
+msgstr "O aplikaci"
+
+msgid "Add comments"
+msgstr "Přidat poznámku"
+
+msgid "Are you sure?"
+msgstr "Jste si jistí?"
+
+msgid "Clear comments"
+msgstr "Smazat poznámku"
+
+msgid "Close this window."
+msgstr "Zavřít toto okno."
+
+msgid "Copy"
+msgstr "Kopírovat"
+
+msgid "Cut"
+msgstr "Vyjmout"
+
+msgid "Data conversion error"
+msgstr "Chyba v konverzi dat"
+
+msgid "Data serialization error"
+msgstr "Chyba při serializaci dat"
+
+msgid "Delete selected columns"
+msgstr "Smazat vybrané sloupce"
+
+msgid "Delete selected rows"
+msgstr "Smazat vybrané řádky"
+
+msgid "Display"
+msgstr "Zobrazit"
+
+msgid "Edit CSV"
+msgstr "Editovat CSV"
+
+msgid "Edit comments"
+msgstr "Upravit poznámku"
+
+msgid "Enter a URL:"
+msgstr "Zadejte URL:"
+
+msgid "Error in Source settings"
+msgstr "Chyba v Nastavení zdroje"
+
+msgid "Error message"
+msgstr "Chybové hlášení"
+
+msgid "Insert a new column after"
+msgstr "Vložit nový sloupec za tento"
+
+msgid "Insert a new column before"
+msgstr "Vložit nový sloupec před tento"
+
+msgid "Insert a new row after"
+msgstr "Vložit nový řádek za tento"
+
+msgid "Insert a new row before"
+msgstr "Vložit nový řádek před tento"
+
+msgid "Order ascending"
+msgstr "Setřídit vzestupně"
+
+msgid "Order descending"
+msgstr "Setřídit sestupně"
+
+msgid "Parse Data Error"
+msgstr "Chyba při parsování dat"
+
+msgid "Paste"
+msgstr "Vložit"
+
+msgid "Rename this cell"
+msgstr "Přejmenovat tuto buňku"
+
+msgid "Rename this column"
+msgstr "Přejmenovat tento sloupec"
+
+msgid "Save as"
+msgstr "Uložit jako"
+
+msgid "Show data in spreadsheet."
+msgstr "Zobrazit data v tabulce."
+
+msgid "Source"
+msgstr "Zdroj"
+
+msgid "Spreadsheet"
+msgstr "Tabulka"
+
+msgid ""
+"This data cannot be serialized in the selected format. Please select a "
+"different format."
+msgstr ""
+"Tato data nelze to vybraného formátu serializovat. Vyberte prosím jiný "
+"formát."
+
+msgid "Toggle source"
+msgstr "Přepnout na zdroj"
+
+msgid "Toggle spreadsheet"
+msgstr "Přepnout na tabulku"
+
+msgid "View source data."
+msgstr "Zobrazit zdrojová data."

djangocms_render_context/migrations/0001_initial.py

@@ -1,7 +1,6 @@
 # Generated by Django 5.2.8 on 2025-12-10 09:02
 
 import django.db.models.deletion
-import djangocms_render_context.encoders
 import filer.fields.file
 from django.db import migrations, models
 
@@ -35,7 +34,6 @@ class Migration(migrations.Migration):
                     "context",
                     models.JSONField(
                         blank=True,
-                        encoder=djangocms_render_context.encoders.PrettyJsonEncoder,
                         help_text="Context data in JSON format. They take precedence over the source file and source URL.",
                         null=True,
                         verbose_name="Data for context",

djangocms_render_context/migrations/0002_rendercontext_mimetype.py

@@ -0,0 +1,33 @@
+# Generated by Django 5.2.9 on 2026-01-09 07:40
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("djangocms_render_context", "0001_initial"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="rendercontext",
+            name="mimetype",
+            field=models.CharField(
+                default="application/json",
+                help_text="The format must be consistent with the data in the context.",
+                max_length=255,
+                verbose_name="Type of Data for context",
+            ),
+        ),
+        migrations.AlterField(
+            model_name="rendercontext",
+            name="context",
+            field=models.TextField(
+                blank=True,
+                help_text="Context data in selected format. They take precedence over the source file and source URL.",
+                null=True,
+                verbose_name="Data for context",
+            ),
+        ),
+    ]

djangocms_render_context/migrations/0003_rendercontext_config_and_path.py

@@ -0,0 +1,46 @@
+# Generated by Django 5.2.9 on 2026-01-29 13:20
+
+import djangocms_render_context.encoders
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("djangocms_render_context", "0002_rendercontext_mimetype"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="rendercontext",
+            name="config",
+            field=models.JSONField(
+                blank=True,
+                encoder=djangocms_render_context.encoders.PrettyJsonEncoder,
+                help_text="Additional configuration for spreadsheet with source data. The configuration is automatically added or updated when the spreadsheet is saved.",
+                null=True,
+                verbose_name="Configuration",
+            ),
+        ),
+        migrations.AddField(
+            model_name="rendercontext",
+            name="path",
+            field=models.CharField(
+                blank=True,
+                help_text='The path to the data in the form "name.name.name". The "data" context in the template starts from this key.',
+                max_length=255,
+                null=True,
+                verbose_name="Data path",
+            ),
+        ),
+        migrations.AlterField(
+            model_name="rendercontext",
+            name="template",
+            field=models.TextField(
+                blank=True,
+                help_text='Django template for the context. It takes precedence over the template selected from the list. The context is available through the "data" value.',
+                null=True,
+                verbose_name="Template",
+            ),
+        ),
+    ]

djangocms_render_context/models.py

@@ -1,4 +1,5 @@
 import logging
+from typing import Any, Optional, Union
 
 from cms.models.pluginmodel import CMSPlugin
 from django.db import models
@@ -7,18 +8,36 @@ from filer.fields.file import FilerFileField
 
 from .encoders import PrettyJsonEncoder
 from .exceptions import SourceParseFailure
-from .loaders import get_cached_data_from_url, get_data_from_file
+from .loaders import LOADERS, get_cached_data_from_url, get_data_from_file, value_to_bytes
+from .utils import get_context_from_path
+
+contentType = Optional[Union[dict[Any, Any], list[Any]]]  # noqa: UP045, UP007
 
 LOGGER = logging.getLogger(__name__)
 
 
 class RenderContext(CMSPlugin):
-    context = models.JSONField(
+    mimetype = models.CharField(
+        verbose_name=_("Type of Data for context"),
+        max_length=255,
+        default="application/json",
+        help_text=_("The format must be consistent with the data in the context."),
+    )
+    context = models.TextField(
         verbose_name=_("Data for context"),
         null=True,
         blank=True,
+        help_text=_("Context data in selected format. They take precedence over the source file and source URL."),
+    )
+    config = models.JSONField(
+        verbose_name=_("Configuration"),
+        null=True,
+        blank=True,
         encoder=PrettyJsonEncoder,
-        help_text=_("Context data in JSON format. They take precedence over the source file and source URL."),
+        help_text=_(
+            "Additional configuration for spreadsheet with source data. "
+            "The configuration is automatically added or updated when the spreadsheet is saved."
+        ),
     )
     file = FilerFileField(
         verbose_name=_("Source file"),
@@ -52,7 +71,10 @@ class RenderContext(CMSPlugin):
         verbose_name=_("Template"),
         null=True,
         blank=True,
-        help_text=_("Django template for the context. It takes precedence over the template selected from the list."),
+        help_text=_(
+            "Django template for the context. It takes precedence over the template selected from the list."
+            ' The context is available through the "data" value.'
+        ),
     )
     template_list = models.CharField(
         verbose_name=_("Template list"),
@@ -61,6 +83,16 @@ class RenderContext(CMSPlugin):
         max_length=255,
         help_text=_("List of templates. If Template is specified, the template set in the list will not be used."),
     )
+    path = models.CharField(
+        verbose_name=_("Data path"),
+        null=True,
+        blank=True,
+        max_length=255,
+        help_text=_(
+            'The path to the data in the form "name.name.name".'
+            ' The "data" context in the template starts from this key.'
+        ),
+    )
 
     def __str__(self):
         text = []
@@ -80,17 +112,26 @@ class RenderContext(CMSPlugin):
             text.append(_("No template."))
         return " + ".join([str(t) for t in text])
 
-    def get_data(self):
+    def get_data_by_path(self, data: contentType) -> contentType:
+        if self.path:
+            try:
+                data = get_context_from_path(data, self.path)
+            except (IndexError, KeyError, ValueError, TypeError) as err:
+                LOGGER.error(err)
+                return {}
+        return data
+
+    def get_data(self) -> contentType:
         if self.context:
-            return self.context
+            return self.get_data_by_path(LOADERS[self.mimetype](value_to_bytes(self.context, self.mimetype)))
         elif self.file:
             try:
-                return get_data_from_file(self.file)
+                return self.get_data_by_path(get_data_from_file(self.file))
             except SourceParseFailure as err:
                 LOGGER.error(err)
         elif self.source:
             try:
-                return get_cached_data_from_url(self.pk, self.source, self.cached)
+                return self.get_data_by_path(get_cached_data_from_url(self.pk, self.source, self.cached))
             except SourceParseFailure as err:
                 LOGGER.error(err)
         return None

djangocms_render_context/static/djangocms_render_context/css-dist/icon-family-Material-Icons.css

@@ -0,0 +1,20 @@
+@font-face {
+  font-family: 'Material Icons';
+  font-style: normal;
+  font-weight: 400;
+  src: url(https://fonts.gstatic.com/s/materialicons/v145/flUhRq6tzZclQEJ-Vdg-IuiaDsNZ.ttf) format('truetype');
+}
+
+.material-icons {
+  font-family: 'Material Icons';
+  font-weight: normal;
+  font-style: normal;
+  font-size: 24px;
+  line-height: 1;
+  letter-spacing: normal;
+  text-transform: none;
+  display: inline-block;
+  white-space: nowrap;
+  word-wrap: normal;
+  direction: ltr;
+}