eea.plotly 1.0__tar.gz → 1.2__tar.gz

{eea_plotly-1.0/eea.plotly.egg-info → eea_plotly-1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: eea.plotly
-Version: 1.0
+Version: 1.2
 Summary: volto-plotlycharts backend support
 Home-page: https://github.com/eea/eea.plotly
 Author: European Environment Agency: IDM2 A-Team
@@ -21,6 +21,9 @@ Classifier: License :: OSI Approved :: GNU General Public License v2 (GPLv2)
 Description-Content-Type: text/x-rst
 Requires-Dist: setuptools
 Requires-Dist: plone.volto
+Requires-Dist: collective.folderishtypes
+Requires-Dist: plotly==5.24.1
+Requires-Dist: kaleido
 Provides-Extra: test
 Requires-Dist: plone.app.testing; extra == "test"
 Dynamic: author
@@ -142,6 +145,16 @@ EEA_ - European Environment Agency (EU)
 Changelog
 =========
 
+1.2 - (2025-03-13)
+---------------------------
+* Change: Add theme property
+  [razvanMiu]
+
+1.1 - (2025-02-07)
+---------------------------
+* Change: permission typo
+  [razvanMiu]
+
 1.0 - (2025-02-06)
 ---------------------------
 * Change: Release [razvanMiu]

eea_plotly-1.2/docs/HISTORY.txt

@@ -0,0 +1,22 @@
+Changelog
+=========
+
+1.2 - (2025-03-13)
+---------------------------
+* Change: Add theme property
+  [razvanMiu]
+
+1.1 - (2025-02-07)
+---------------------------
+* Change: permission typo
+  [razvanMiu]
+
+1.0 - (2025-02-06)
+---------------------------
+* Change: Release [razvanMiu]
+
+1.0 - (2025-02-06)
+-----------------------
+
+* Initial release.
+  [eea]

{eea_plotly-1.0 → eea_plotly-1.2}/eea/plotly/__init__.py

@@ -1,7 +1,6 @@
 """ Main product initializer
 """
 from zope.i18nmessageid.message import MessageFactory
-__import__('pkg_resources').declare_namespace(__name__)
 
 EEAMessageFactory = MessageFactory('eea')
 

eea_plotly-1.2/eea/plotly/behaviors.py

@@ -0,0 +1,35 @@
+""" behavior module """
+
+import json
+
+from plone.autoform.interfaces import IFormFieldProvider
+from plone.supermodel import model
+from plone.schema import JSONField
+from plone.namedfile.field import NamedBlobFile
+from zope.interface import directlyProvides, provider
+
+
+from eea.plotly.interfaces import IPlotlyVisualizationField, IPlotlyFileField
+
+
+VIZ_SCHEMA = json.dumps({"type": "object", "properties": {}})
+
+
+@provider(IFormFieldProvider)
+class IPlotlyVisualization(model.Schema):
+    """ A plotly visualization behavior provider """
+
+    visualization = JSONField(
+        title="Visualization", required=False, default={}, schema=VIZ_SCHEMA
+    )
+
+    directlyProvides(visualization, IPlotlyVisualizationField)
+
+    file = NamedBlobFile(
+        title="File",
+        required=False,
+        description="Data sources file",
+        readonly=True,
+    )
+
+    directlyProvides(file, IPlotlyFileField)

eea_plotly-1.2/eea/plotly/browser/configure.zcml

@@ -0,0 +1,26 @@
+<configure xmlns="http://namespaces.zope.org/zope"
+    xmlns:browser="http://namespaces.zope.org/browser" i18n_domain="eea">
+
+    <browser:page
+        name="plotly-controlpanel"
+        for="Products.CMFPlone.interfaces.IPloneSiteRoot"
+        class=".controlpanel.PlotlyControlPanelFormWrapper"
+        layer="eea.plotly.interfaces.IPlotlyLayer"
+        permission="cmf.ManagePortal"
+    />
+
+    <browser:page
+        name="view"
+        for="eea.plotly.behaviors.IPlotlyVisualization"
+        template="pt/visualization_view.pt"
+        permission="zope2.View"
+    />
+
+    <browser:view
+        name="plotly_preview.svg"
+        for="eea.plotly.behaviors.IPlotlyVisualization"
+        class=".preview.PlotlyPreview"
+        permission="zope2.View"
+    />
+
+</configure>

{eea_plotly-1.0 → eea_plotly-1.2}/eea/plotly/browser/controlpanel.py

@@ -2,7 +2,7 @@
 from plone.app.registry.browser.controlpanel import ControlPanelFormWrapper
 from plone.app.registry.browser.controlpanel import RegistryEditForm
 
-from eea.plotly.interfaces import IPlotlySettings
+from eea.plotly.controlpanel import IPlotlySettings
 
 
 class PlotlyRegistryEditForm(RegistryEditForm):

eea_plotly-1.2/eea/plotly/browser/preview.py

@@ -0,0 +1,93 @@
+"""RestAPI enpoint @plotly GET"""
+
+import copy
+import json
+import plotly.io as pio
+from plone import api
+from zope.interface import implementer
+from zope.publisher.interfaces import IPublishTraverse
+from Products.Five.browser import BrowserView
+from eea.plotly.controlpanel import IPlotlySettings
+from eea.plotly.utils import sanitizeVisualization
+
+
+def deepUpdate(original, update):
+    """ Recursively update a dictionary with another dictionary."""
+    for key, value in update.items():
+        if isinstance(
+                value, dict) and key in original and isinstance(
+                original[key],
+                dict):
+            deepUpdate(original[key], value)
+        elif key in original:
+            original[key] = value
+
+
+@implementer(IPublishTraverse)
+class PlotlyPreview(BrowserView):
+    """Plotly Preview"""
+
+    name = None
+
+    def render(self):
+        """Render"""
+
+        visualization = copy.deepcopy(
+            sanitizeVisualization(self.context.visualization)
+        )
+
+        if not visualization:
+            self.request.response.setStatus(404)
+            return {
+                "message": "Visualization is not defined",
+                "type": "NotFound"
+            }
+
+        if self.name:
+            theme = None
+            themes = api.portal.get_registry_record(
+                "themes",
+                interface=IPlotlySettings,
+                default=[]
+            )
+            for t in themes:
+                if t.get("id") == self.name:
+                    theme = copy.deepcopy(t)
+                    break
+            if theme and "layout" in visualization:
+                data = theme.get("data", {})
+                layout = theme.get("layout", {})
+                for trIndex, tr in enumerate(visualization.get("data", [])):
+                    trType = tr.get("type", "")
+                    if trType in data:
+                        newTrIndex = min(trIndex, len(data[trType])-1)
+                        newTr = data[trType][newTrIndex]
+                        deepUpdate(tr, newTr)
+                deepUpdate(visualization["layout"], layout)
+                visualization["layout"]["template"] = theme
+
+        fig = pio.from_json(json.dumps(visualization), skip_invalid=True)
+
+        if "template" not in visualization["layout"]:
+            fig.update_layout(template=None)
+
+        image = fig.to_image(format="svg", width=1200, height=900)
+
+        sh = self.request.response.setHeader
+
+        sh(
+            "Content-Type",
+            "image/svg+xml"
+        )
+        sh("Content-Disposition", "inline; filename=%s.svg" % "x")
+
+        return image
+
+    def publishTraverse(self, request, name):
+        """used for traversal via publisher, i.e. when using as a url"""
+        self.name = name
+        return self
+
+    def __call__(self):
+        """Call"""
+        return self.render()

eea_plotly-1.2/eea/plotly/browser/pt/visualization_view.pt

@@ -0,0 +1,17 @@
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"
+  xmlns:tal="http://xml.zope.org/namespaces/tal"
+  xmlns:metal="http://xml.zope.org/namespaces/metal"
+  xmlns:i18n="http://xml.zope.org/namespaces/i18n"
+  lang="en"
+  metal:use-macro="context/@@main_template/macros/master"
+  i18n:domain="plone">
+
+  <body>
+    <metal:main fill-slot="main">
+      <h1 class="documentFirstHeading" tal:content="context/Title">Title</h1>
+
+      <img src="" tal:attributes="src string:${context/absolute_url}/@@plotly_preview.svg" i18n:attributes="alt" alt="Preview" />
+
+    </metal:main>
+  </body>
+</html>

eea_plotly-1.2/eea/plotly/configure.zcml

@@ -0,0 +1,30 @@
+<configure xmlns="http://namespaces.zope.org/zope" xmlns:i18n="http://namespaces.zope.org/i18n"
+    xmlns:plone="http://namespaces.plone.org/plone"
+    i18n_domain="eea">
+
+    <i18n:registerTranslations directory="locales" />
+
+    <include file="profiles.zcml" />
+    <include file="permissions.zcml" />
+
+    <include package=".browser" />
+    <include package=".restapi" />
+    <include package=".serializer" />
+    <include package=".deserializer" />
+    <include package=".upgrades" />
+
+    <interface interface="eea.plotly.interfaces.IPlotlyVisualization" />
+
+    <adapter
+        factory=".controlpanel.PlotlyControlpanel"
+        name="plotly"
+    />
+
+    <plone:behavior
+        name="eea.plotly.visualization"
+        title="EEA-Viz_Plotly"
+        description="Allows adding an interactive plotly chart."
+        provides="eea.plotly.behaviors.IPlotlyVisualization"
+    />
+
+</configure>

eea_plotly-1.2/eea/plotly/controlpanel.py

@@ -0,0 +1,64 @@
+"""Plotly Controlpanel API"""
+import json
+from zope.interface import Interface
+from zope.component import adapter
+from plone.schema import JSONField
+from plone.restapi.controlpanels import RegistryConfigletPanel
+from eea.plotly.interfaces import IPlotlyLayer
+from eea.plotly import EEAMessageFactory as _
+
+TEMPLATES_SCHEMA = json.dumps({
+    "type": "array",
+    "items": {
+        "type": "object",
+        "properties": {}
+    }
+})
+
+THEMES_SCHEMA = json.dumps({
+    "type": "array",
+    "items": {
+        "type": "object",
+        "properties": {}
+    }
+})
+
+
+class IPlotlySettings(Interface):
+    """Client settings for EEA Plotly."""
+    themes = JSONField(
+        title=_(u"Themes"),
+        description=_(
+            u"The JSON representation of plotly themes."
+        ),
+        schema=THEMES_SCHEMA,
+        default=[],
+        widget="plotly_themes",
+        required=False
+    )
+
+    templates = JSONField(
+        title=_(u"Templates"),
+        description=_(
+            u"The JSON representation of plotly templates."
+        ),
+        schema=TEMPLATES_SCHEMA,
+        default=[],
+        widget="plotly_templates",
+        required=False
+    )
+
+
+@adapter(Interface, IPlotlyLayer)
+class PlotlyControlpanel(RegistryConfigletPanel):
+    """Plotly Control Panel"""
+    schema = IPlotlySettings
+    schema_prefix = None
+    configlet_id = "plotly"
+    configlet_category_id = "Products"
+    title = "Plotly Settings"
+    group = "Products"
+    data = {
+        "themes": [],
+        "templates": []
+    }

eea_plotly-1.2/eea/plotly/deserializer/blocks.py

@@ -0,0 +1,32 @@
+""" block-related utils """
+
+from plone.restapi.behaviors import IBlocks
+from plone.restapi.interfaces import IBlockFieldDeserializationTransformer
+from plone.restapi.deserializer.utils import path2uid
+from zope.component import adapter
+from zope.interface import implementer
+from zope.publisher.interfaces.browser import IBrowserRequest
+from eea.plotly.utils import getLink, delProperty
+
+
+@implementer(IBlockFieldDeserializationTransformer)
+@adapter(IBlocks, IBrowserRequest)
+class EmbedVisualizationDeserializationTransformer:
+    """Embed visualization deserialization"""
+
+    order = 9999
+    block_type = "embed_visualization"
+
+    def __init__(self, context, request):
+        self.context = context
+        self.request = request
+
+    def __call__(self, value):
+        delProperty(value, 'visualization')
+        delProperty(value, 'properties')
+        delProperty(value, 'image_scales')
+        if 'vis_url' in value:
+            value['vis_url'] = path2uid(
+                context=self.context, link=getLink(value['vis_url'])
+            )
+        return value

eea_plotly-1.2/eea/plotly/deserializer/configure.zcml

@@ -0,0 +1,11 @@
+<configure xmlns="http://namespaces.zope.org/zope" xmlns:zcml="http://namespaces.zope.org/zcml"
+    i18n_domain="plone.restapi">
+
+    <adapter factory=".dxcontent.DeserializeVisualizationFromJson" />
+    <adapter factory=".dxfields.VisualizationFieldDeserializer" />
+
+    <subscriber
+        provides="plone.restapi.interfaces.IBlockFieldDeserializationTransformer"
+        factory=".blocks.EmbedVisualizationDeserializationTransformer" />
+
+</configure>

eea_plotly-1.2/eea/plotly/deserializer/dxcontent.py

@@ -0,0 +1,113 @@
+""" Deserialize Plotly visualization from JSON """
+from io import StringIO
+import json
+import plotly.io as pio
+from plone.namedfile.file import NamedBlobFile, NamedBlobImage
+from plone.restapi.interfaces import IDeserializeFromJson
+from plone.restapi.deserializer.dxcontent import DeserializeFromJson
+from zope.component import adapter
+from zope.interface import implementer
+from zope.interface import Interface
+from zope.event import notify
+from zope.lifecycleevent import Attributes, ObjectModifiedEvent
+from eea.plotly.behaviors import IPlotlyVisualization
+from eea.plotly.io_csv import CsvWriter
+
+
+@implementer(IDeserializeFromJson)
+@adapter(IPlotlyVisualization, Interface)
+class DeserializeVisualizationFromJson(DeserializeFromJson):
+    """ Deserialize Plotly visualization from JSON """
+
+    def jsonToBinary(self, data):
+        """Convert JSON data to binary"""
+        if not data:
+            return None
+
+        output = StringIO()
+
+        # Extract columns
+        columns = list(data.keys())
+
+        # Extract rows per column
+        rows = []
+
+        # Determine the maximum length of the columns
+        max_length = 0
+        for column in columns:
+            max_length = max(max_length, len(data[column]))
+
+        for column in columns:
+            values = [column] + data[column]
+            # Fill the values with None to match the max length
+            values += [None] * (max_length - len(data[column]))
+            for i, value in enumerate(values):
+                if len(rows) < i + 1:
+                    rows.append([value])
+                else:
+                    rows[i].append(value)
+
+        CsvWriter(output).writerows(rows)
+
+        return output.getvalue().encode('utf-8')
+
+    def __call__(
+            self, validate_all=False, data=None, create=False,
+            mask_validation_errors=True):
+
+        super().__call__(
+            validate_all, data, create, mask_validation_errors
+        )
+
+        ok = False
+        for interface, names in self.modified.items():
+            if (interface == IPlotlyVisualization and
+                    "IPlotlyVisualization.visualization" in names):
+                ok = True
+                break
+
+        if not ok:
+            return self.context
+
+        data = self.jsonToBinary(self.context.visualization.get(
+            "dataSources", {})
+        )
+
+        self.context.file = NamedBlobFile(
+            data=data if data else b"",
+            filename="data.csv",
+            contentType="text/csv"
+        )
+
+        if "dataSources" in self.context.visualization:
+            del self.context.visualization["dataSources"]
+
+        # Notify the object modified event
+        modified = []
+        modified.append(
+            Attributes(
+                IPlotlyVisualization,
+                "IPlotlyVisualization.visualization",
+                "IPlotlyVisualization.file"
+            )
+        )
+        notify(ObjectModifiedEvent(self.context, *modified))
+
+        # Handle preview image
+        fig = pio.from_json(
+            json.dumps({
+                "data": self.context.visualization.get("data", []),
+                "layout": self.context.visualization.get("layout", {}),
+                "frames": self.context.visualization.get("frames", [])
+            }),
+            skip_invalid=True
+        )
+
+        image = fig.to_image(format="svg", width=1200, height=900)
+        self.context.preview_image = NamedBlobImage(
+            data=image,
+            filename="preview.svg",
+            contentType="image/svg+xml"
+        )
+
+        return self.context

eea_plotly-1.2/eea/plotly/deserializer/dxfields.py

@@ -0,0 +1,28 @@
+""" dxfields deserializers """
+
+from zope.component import adapter
+from zope.interface import implementer
+from zope.publisher.interfaces.browser import IBrowserRequest
+from plone.dexterity.interfaces import IDexterityContent
+from plone.restapi.interfaces import IFieldDeserializer
+from plone.restapi.deserializer.dxfields import DefaultFieldDeserializer
+from plone.restapi.deserializer.utils import path2uid
+from eea.plotly.utils import getLink, sanitizeVisualization
+from eea.plotly.interfaces import IPlotlyVisualizationField
+
+
+@implementer(IFieldDeserializer)
+@adapter(IPlotlyVisualizationField, IDexterityContent, IBrowserRequest)
+class VisualizationFieldDeserializer(DefaultFieldDeserializer):
+    """Visualization field deserializer"""
+
+    def __call__(self, value):
+        value = sanitizeVisualization(value)
+
+        if 'provider_url' in value:
+            url = value["provider_url"]
+            value["provider_url"] = path2uid(
+                context=self.context, link=getLink(url)
+            )
+
+        return value

eea_plotly-1.2/eea/plotly/interfaces.py

@@ -0,0 +1,19 @@
+"""Module where all interfaces, events and exceptions live."""
+from zope.interface import Interface
+from zope.publisher.interfaces.browser import IDefaultBrowserLayer
+
+
+class IPlotlyLayer(IDefaultBrowserLayer):
+    """ Marker interface that defines a browser layer. """
+
+
+class IPlotlyVisualizationField(Interface):
+    """ Marker interface for plotly visualization JSON field """
+
+
+class IPlotlyFileField(Interface):
+    """ Marker interface for plotly file field """
+
+
+class IPlotlyVisualization(Interface):
+    """ Marker interface for plotly visualization """

eea_plotly-1.2/eea/plotly/io_csv.py

@@ -0,0 +1,49 @@
+"""CSV reader/writer that handles NULL values."""
+import csv
+NULL = 'NULL'
+
+
+class CsvWriter:
+    """CSV writer that handles NULL values."""
+
+    def __init__(self, *args, **kwrds):
+        dialect = csv.excel
+        self.csv_writer = csv.writer(*args, dialect=dialect, **kwrds)
+
+    def __getattr__(self, name):
+        return getattr(self.csv_writer, name)
+
+    def writerow(self, row):
+        """Write a single row to the CSV file."""
+        self.csv_writer.writerow(
+            [item if item is not None else NULL
+             for item in row]
+        )
+
+    def writerows(self, rows):
+        """Write multiple rows to the CSV file."""
+        for row in rows:
+            self.writerow(row)
+
+
+class CsvReader:
+    """CSV reader that handles NULL values."""
+
+    def __init__(self, *args, **kwrds):
+        try:
+            inputEntity = args[0] or kwrds.get('csvfile')
+            sample = inputEntity.read(1024)
+            inputEntity.seek(0)
+            dialect = csv.Sniffer().sniff(sample)
+        except (csv.Error, TypeError):
+            # No dialect found, use default
+            dialect = csv.excel
+        self.csv_reader = csv.reader(*args, dialect=dialect, **kwrds)
+
+    def __getattr__(self, name):
+        return getattr(self.csv_reader, name)
+
+    def __iter__(self):
+        rows = iter(self.csv_reader)
+        for row in rows:
+            yield [item if item != NULL else None for item in row]

eea_plotly-1.2/eea/plotly/permissions.zcml

@@ -0,0 +1,6 @@
+<configure xmlns="http://namespaces.zope.org/zope" i18n_domain="eea">
+
+    <permission id="eea.plotly.manage" title="eea.plotly: Manage" />
+    <permission id="eea.plotly.add" title="EEA-Viz: Add Chart (interactive)" />
+
+</configure>

{eea_plotly-1.0 → eea_plotly-1.2}/eea/plotly/profiles/default/controlpanel.xml

@@ -9,6 +9,6 @@
       icon_expr=""
       url_expr="string:${portal_url}/@@plotly-controlpanel"
       visible="True">
-    <permission>eea.plotly: Managee</permission>
+    <permission>eea.plotly: Manage</permission>
   </configlet>
 </object>

eea_plotly-1.2/eea/plotly/profiles/default/rolemap.xml

@@ -0,0 +1,14 @@
+<?xml version="1.0"?>
+<rolemap>
+  <permissions>
+    <permission name="eea.plotly: Manage" acquire="True">
+      <role name="Manager" />
+      <role name="Site Administrator" />
+    </permission>
+    <permission name="EEA-Viz: Add Chart (interactive)" acquire="True">
+      <role name="Manager" />
+      <role name="Site Administrator" />
+      <role name="Contributor" />
+    </permission>
+  </permissions>
+</rolemap>