imio.smartweb.core 1.2.90__tar.gz → 1.3__tar.gz

{imio_smartweb_core-1.2.90 → imio_smartweb_core-1.3}/CHANGES.rst

@@ -2,6 +2,23 @@ Changelog
 =========
 
 
+1.3 (2025-03-04)
+----------------
+
+- TELE-1975 : IDEABOX. Add specific profile, add campaign view content type
+  [boulch, thomlamb]
+
+
+1.2.91 (2025-03-03)
+-------------------
+
+- Accessibility : Added aria-label to subsite-logo link
+  [thomlamb]
+
+- Accessibility : Add title / target attributes to "my account" action link
+  [boulch]
+
+
 1.2.90 (2025-02-24)
 -------------------
 

{imio_smartweb_core-1.2.90 → imio_smartweb_core-1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: imio.smartweb.core
-Version: 1.2.90
+Version: 1.3
 Summary: Core product for iMio websites
 Home-page: https://github.com/imio/imio.smartweb.core
 Author: Christophe Boulanger
@@ -203,6 +203,23 @@ Changelog
 =========
 
 
+1.3 (2025-03-04)
+----------------
+
+- TELE-1975 : IDEABOX. Add specific profile, add campaign view content type
+  [boulch, thomlamb]
+
+
+1.2.91 (2025-03-03)
+-------------------
+
+- Accessibility : Added aria-label to subsite-logo link
+  [thomlamb]
+
+- Accessibility : Add title / target attributes to "my account" action link
+  [boulch]
+
+
 1.2.90 (2025-02-24)
 -------------------
 

{imio_smartweb_core-1.2.90 → imio_smartweb_core-1.3}/setup.py

@@ -16,7 +16,7 @@ long_description = "\n\n".join(
 
 setup(
     name="imio.smartweb.core",
-    version="1.2.90",
+    version="1.3",
     description="Core product for iMio websites",
     long_description=long_description,
     # Get more from https://pypi.org/classifiers/

{imio_smartweb_core-1.2.90 → imio_smartweb_core-1.3}/src/imio/smartweb/core/browser/controlpanel.py

@@ -22,11 +22,10 @@ class ISendinblueTextRowSchema(Interface):
 
 
 class ISmartwebControlPanel(Interface):
-    url_formdefs_api = schema.TextLine(
-        title=_("Url to get forms from your e-guichet"),
-        description=_(
-            "Example : https://COMMUNE-formulaires.guichet-citoyen.be/api/formdefs/"
-        ),
+    # https://COMMUNE-formulaires.guichet-citoyen.be/api
+    url_ts = schema.TextLine(
+        title=_("Url to e-guichet"),
+        description=_("Example : https://COMMUNE.guichet-citoyen.be"),
         required=False,
     )
 
@@ -36,6 +35,21 @@ class ISmartwebControlPanel(Interface):
         required=False,
     )
 
+    iaideabox_api_username = schema.TextLine(
+        title=_(
+            "Username to consume e-guichet ideabox API (get Campaign, projects,...)"
+        ),
+        default="ideabox",
+        required=False,
+    )
+
+    iaideabox_api_password = schema.Password(
+        title=_(
+            "Password to consume e-guichet ideabox API (get Campaign, projects,...)"
+        ),
+        required=False,
+    )
+
     propose_directory_url = schema.URI(
         title=_("Url to propose a new citizen contact"),
         required=False,
@@ -203,17 +217,40 @@ class SmartwebControlPanelForm(RegistryEditForm):
         iadeliberation_pwd = api.portal.get_registry_record(
             "smartweb.iadeliberation_api_password"
         )
+
+        iaideabox_pwd = api.portal.get_registry_record(
+            "smartweb.iaideabox_api_password"
+        )
+
         secret_key_api = api.portal.get_registry_record("smartweb.secret_key_api")
 
         # if data is None when we apply changes for password fields we keep password from registry
         if not data.get("iadeliberation_api_password"):
             data["iadeliberation_api_password"] = iadeliberation_pwd
 
+        if not data.get("iaideabox_api_password"):
+            data["iaideabox_api_password"] = iaideabox_pwd
+
         if not data.get("secret_key_api"):
             data["secret_key_api"] = secret_key_api
 
         return super().applyChanges(data)
 
+    def updateFields(self):
+        """Override updateFields to hide fields based on ideabox profile installation."""
+        super(SmartwebControlPanelForm, self).updateFields()
+
+        # Check if the 'ideabox' profile is installed
+        portal_setup = api.portal.get_tool(name="portal_setup")
+        profile_version = portal_setup.getLastVersionForProfile(
+            "imio.smartweb.core:ideabox"
+        )
+
+        if profile_version == "unknown":
+            # Hide the field related to Idea Box if the profile is not installed
+            self.fields = self.fields.omit("iaideabox_api_username")
+            self.fields = self.fields.omit("iaideabox_api_password")
+
 
 SmartwebControlPanelView = layout.wrap_form(
     SmartwebControlPanelForm, ControlPanelFormWrapper

{imio_smartweb_core-1.2.90 → imio_smartweb_core-1.3}/src/imio/smartweb/core/browser/utils.py

@@ -2,6 +2,8 @@
 from imio.smartweb.core.contents import IPages
 from imio.smartweb.core.contents.pages.procedure.utils import sign_url
 from imio.smartweb.core.utils import get_plausible_vars
+from imio.smartweb.core.utils import get_ts_api_url
+from imio.smartweb.core.utils import get_value_from_registry
 from imio.smartweb.locales import SmartwebMessageFactory as _
 from plone import api
 from plone.api.portal import get_registry_record
@@ -54,7 +56,8 @@ class UtilsView(BrowserView):
 
     def is_eguichet_aware(self):
         self.request.response.setHeader("Content-Type", "application/json")
-        url = api.portal.get_registry_record("smartweb.url_formdefs_api")
+        wcs_api = get_ts_api_url("wcs")
+        url = f"{wcs_api}/formdefs/"
         key = api.portal.get_registry_record("smartweb.secret_key_api")
         orig = "ia.smartweb"
         if not url:

{imio_smartweb_core-1.2.90 → imio_smartweb_core-1.3}/src/imio/smartweb/core/configure.zcml

@@ -14,7 +14,10 @@
   <include package="collective.solr" />
   <include package="collective.taxonomy" />
   <include package="collective.z3cform.datagridfield" />
-
+  
+  <!-- Call this one before overrides adapter zope.container.interfaces.INameChooser-->
+  <include package="plone.app.content" />
+  
   <!-- Temporary fix for plone.gallery 1.0.1 -->
   <include package="plone.app.contentmenu" />
   <include package="plone.gallery" />
@@ -24,6 +27,7 @@
   <include package="imio.smartweb.locales" />
 
   <include file="indexers.zcml" />
+  <include file="overrides.zcml" />
   <include file="permissions.zcml" />
   <include file="profiles.zcml" />
   <include file="subscribers.zcml" />

{imio_smartweb_core-1.2.90 → imio_smartweb_core-1.3}/src/imio/smartweb/core/contents/__init__.py

@@ -21,6 +21,8 @@ from .publication.content import Publication  # NOQA
 from .publication.content import IPublication  # NOQA
 from .rest.base import RestView  # NOQA
 from .rest.base import IRestView  # NOQA
+from .rest.campaign.content import CampaignView  # NOQA
+from .rest.campaign.content import ICampaignView  # NOQA
 from .rest.directory.content import DirectoryView  # NOQA
 from .rest.directory.content import IDirectoryView  # NOQA
 from .rest.events.content import EventsView  # NOQA

imio_smartweb_core-1.3/src/imio/smartweb/core/contents/rest/campaign/configure.zcml

@@ -0,0 +1,80 @@
+<configure
+    xmlns="http://namespaces.zope.org/zope"
+    xmlns:browser="http://namespaces.zope.org/browser"
+    xmlns:plone="http://namespaces.plone.org/plone"
+    i18n_domain="imio.smartweb">
+
+  <browser:page
+      name="view"
+      for="imio.smartweb.core.contents.ICampaignView"
+      class=".view.CampaignViewView"
+      template="view.pt"
+      permission="zope2.View"
+      layer="imio.smartweb.core.interfaces.IImioSmartwebCoreLayer"
+      />
+
+  <plone:service
+    name="@results"
+    method="GET"
+    accept="application/json"
+    for="imio.smartweb.core.contents.ICampaignView"
+    factory=".endpoint.CampaignEndpointGet"
+    permission="zope2.View"
+    layer="imio.smartweb.core.interfaces.IImioSmartwebCoreLayer"
+    />
+
+  <plone:service
+    name="@auth"
+    method="GET"
+    accept="text/plain"
+    for="imio.smartweb.core.contents.ICampaignView"
+    factory=".endpoint.AuthCampaignEndpointGet"
+    permission="zope.Public"
+    layer="imio.smartweb.core.interfaces.IImioSmartwebCoreLayer"
+    />
+
+  <plone:service
+    name="@zones"
+    method="GET"
+    accept="application/json"
+    for="imio.smartweb.core.contents.ICampaignView"
+    factory=".endpoint.ZonesEndpointGet"
+    permission="zope2.View"
+    layer="imio.smartweb.core.interfaces.IImioSmartwebCoreLayer"
+    />
+
+
+  <!-- endpoint to get topics from TS -->
+  <plone:service
+    name="@ts_topics"
+    method="GET"
+    accept="application/json"
+    for="imio.smartweb.core.contents.ICampaignView"
+    factory=".endpoint.TsTopicsEndpointGet"
+    permission="zope2.View"
+    layer="imio.smartweb.core.interfaces.IImioSmartwebCoreLayer"
+    />
+
+  <!-- endpoint to expose smartweb topics to TS -->
+  <plone:service
+    name="@topics"
+    method="GET"
+    accept="application/json"
+    for="plone.dexterity.interfaces.IDexterityContent"
+    factory=".endpoint.TopicsEndpointGet"
+    permission="zope2.View"
+    layer="imio.smartweb.core.interfaces.IImioSmartwebCoreLayer"
+    />
+
+  <!-- endpoint to expose smartweb AND TS topics to campaign view -->
+  <plone:service
+    name="@all_topics"
+    method="GET"
+    accept="application/json"
+    for="imio.smartweb.core.contents.ICampaignView"
+    factory=".endpoint.AllTopicsEndpointGet"
+    permission="zope2.View"
+    layer="imio.smartweb.core.interfaces.IImioSmartwebCoreLayer"
+    />
+
+</configure>

imio_smartweb_core-1.3/src/imio/smartweb/core/contents/rest/campaign/content.py

@@ -0,0 +1,83 @@
+# -*- coding: utf-8 -*-
+
+from collective.instancebehavior.interfaces import IInstanceBehaviorAssignableContent
+from imio.smartweb.core.contents import RestView
+from imio.smartweb.core.utils import get_basic_auth_json
+from imio.smartweb.core.utils import get_ts_api_url
+from imio.smartweb.core.utils import get_value_from_registry
+from imio.smartweb.locales import SmartwebMessageFactory as _
+from plone import api
+from plone.app.content.namechooser import NormalizingNameChooser
+from plone.i18n.normalizer import idnormalizer
+from plone.supermodel import model
+from zope import schema
+from zope.component import getUtility
+from zope.container.interfaces import INameChooser
+from zope.interface import implementer
+
+import logging
+
+logger = logging.getLogger("imio.smartweb.core")
+
+
+class ICampaignView(model.Schema):
+    """ """
+
+    linked_campaign = schema.Choice(
+        vocabulary="imio.smartweb.vocabulary.PublikCampaigns",
+        title=_("E-Guichet campaign"),
+        required=False,
+        default=None,
+    )
+
+    propose_project_url = schema.TextLine(
+        title=_("Propose project URL"),
+        description=_("URL to propose a project"),
+        required=False,
+    )
+
+    nb_results = schema.Int(
+        title=_("Number of items to display"), default=20, required=True
+    )
+
+    display_map = schema.Bool(
+        title=_("Display map"),
+        description=_("If selected, map will be displayed"),
+        required=False,
+        default=True,
+    )
+
+
+@implementer(ICampaignView, IInstanceBehaviorAssignableContent)
+class CampaignView(RestView):
+    """Campaign class"""
+
+
+@implementer(INameChooser)
+class CampaignNameChooser(NormalizingNameChooser):
+    def chooseName(self, name, obj):
+        """Génère un ID basé sur le titre récupéré de l'API."""
+        if ICampaignView.providedBy(obj):
+            if not obj.title:
+                # Récupération du titre via l'API
+                wcs_api = get_ts_api_url("wcs")
+                ts_campaign_endpoint = "imio-ideabox-campagne"
+                url = f"{wcs_api}/cards/{ts_campaign_endpoint}/{obj.linked_campaign}"
+                user = get_value_from_registry("smartweb.iaideabox_api_username")
+                pwd = get_value_from_registry("smartweb.iaideabox_api_password")
+                json_campaign = get_basic_auth_json(url, user, pwd)
+
+                if json_campaign and "fields" in json_campaign:
+                    obj.title = json_campaign["fields"].get(
+                        "titre", "campagne-sans-nom"
+                    )
+                else:
+                    obj.title = "campaign-without-name"
+
+            # Normaliser l'ID en utilisant le titre
+            normalized_id = idnormalizer.normalize(obj.title)
+
+            # Vérifier que l'ID généré est bien unique dans le conteneur
+            return super().chooseName(normalized_id, obj)
+
+        return super().chooseName(name, obj)

imio_smartweb_core-1.3/src/imio/smartweb/core/contents/rest/campaign/endpoint.py

@@ -0,0 +1,211 @@
+# -*- coding: utf-8 -*-
+
+from imio.smartweb.common.utils import get_vocabulary
+from imio.smartweb.core.contents.rest.base import BaseEndpoint
+from imio.smartweb.core.contents.rest.base import BaseService
+from imio.smartweb.core.utils import get_basic_auth_json
+from imio.smartweb.core.utils import get_ts_api_url
+from plone import api
+from plone.i18n.normalizer import idnormalizer
+from plone.restapi.interfaces import IExpandableElement
+from zope.component import adapter
+from zope.i18n import translate
+from zope.interface import implementer
+from zope.interface import Interface
+
+import base64
+import requests
+
+
+def get_ideabox_basic_auth_header() -> str:
+    user = api.portal.get_registry_record("smartweb.iaideabox_api_username")
+    pwd = api.portal.get_registry_record("smartweb.iaideabox_api_password")
+    usrPass = f"{user}:{pwd}".encode("utf-8")
+    b64Val = base64.b64encode(usrPass)
+    return f"Basic {b64Val.decode('utf-8')}"
+
+
+class BaseTsEndpoint(BaseEndpoint):
+    def __init__(self, *args, **kwargs):
+        super(BaseTsEndpoint, self).__init__(*args, **kwargs)
+        self.user = api.portal.get_registry_record("smartweb.iaideabox_api_username")
+        self.pwd = api.portal.get_registry_record("smartweb.iaideabox_api_password")
+
+    def _get_json(self, url):
+        return get_basic_auth_json(url, self.user, self.pwd)
+
+    @property
+    def query_url(self):
+        raise NotImplementedError("query_url must be defined in subclasses")
+
+
+@implementer(IExpandableElement)
+@adapter(Interface, Interface)
+class CampaignEndpoint(BaseTsEndpoint):
+
+    def __call__(self):
+        require_keys = [
+            "uuid",
+            "id",
+            "display_name",
+            "text",
+            "url",
+            "api_url",
+            "fields",
+            "workflow",
+        ]
+        json = self._get_json(self.query_url)
+        json_res = {}
+        if not json:
+            return {}
+        elif "data" in json:
+            # list of projects
+            json["data"] = self.add_b64_image_to_data(json.get("data"))
+            projects = [
+                {k: v for k, v in d.items() if k in require_keys}
+                for d in json.get("data")
+            ]
+            json_res["items"] = projects
+            json_res["items_total"] = json.get("count")
+
+        else:
+            # single project
+            json.pop("evolution")
+            json.pop("roles")
+            json.pop("submission")
+            json.pop("user")
+            json_res = json
+        # Return a json which represents a project or which contains a list of projects
+        return json_res
+
+    def add_b64_image_to_data(self, data):
+        for d in data:
+            # get image
+            image_url = d.get("fields").get("images_raw")[0].get("image").get("url")
+            content = self.get_image(image_url).content
+            b64_content = base64.b64encode(content).decode("utf-8")
+            d["fields"]["images_raw"][0]["image"]["content"] = b64_content
+        return data
+
+    def get_image(self, image_url):
+        if not image_url:
+            return
+        headers = {"Accept": "image/*"}
+        headers["Authorization"] = get_ideabox_basic_auth_header()
+        response = requests.get(image_url, headers=headers)
+        return response
+
+    @property
+    def query_url(self):
+        wcs_api = get_ts_api_url("wcs")
+        if "id" in self.request.form:
+            # we want a specific project
+            project_id = self.request.form.get("id")
+            url = f"{wcs_api}/cards/imio-ideabox-projet/{project_id}?full=on"
+        else:
+            # we want (filtered) list of projects for a specific campaign with eventually extra pamams (zone, topic, ...)
+            extra_params = [f"{k}={v}" for k, v in self.request.form.items()]
+            extra_params = "&".join(extra_params)
+            campaign_id = self.context.linked_campaign
+            url = f"{wcs_api}/cards/imio-ideabox-projet/list?campagne={campaign_id}&full=on&filter-statut=Vote|Enregistr%C3%A9e&filter-statut-operator=in&{extra_params}"
+        return url
+
+
+@implementer(IExpandableElement)
+@adapter(Interface, Interface)
+class ZonesEndpoint(BaseTsEndpoint):
+
+    def __call__(self):
+        json = self._get_json(self.query_url)
+        json_res = {"items": json["data"], "items_total": json.get("count")}
+        return json_res
+
+    @property
+    def query_url(self):
+        wcs_api = get_ts_api_url("wcs")
+        campaign_id = self.context.linked_campaign
+        return f"{wcs_api}/cards/imio-ideabox-zone/list?campagne={campaign_id}"
+
+
+@implementer(IExpandableElement)
+@adapter(Interface, Interface)
+class TsTopicsEndpoint(BaseTsEndpoint):
+
+    def __call__(self):
+        json = self._get_json(self.query_url)
+        json_res = {"items": json["data"], "items_total": json.get("count")}
+        return json_res
+
+    @property
+    def query_url(self):
+        wcs_api = get_ts_api_url("wcs")
+        campaign_id = self.context.linked_campaign
+        return f"{wcs_api}/cards/imio-ideabox-theme/list?campagne={campaign_id}"
+
+
+@implementer(IExpandableElement)
+@adapter(Interface, Interface)
+class TopicsEndpoint(BaseEndpoint):
+
+    def __call__(self):
+        # get all topics from smartweb vocabulary (populate select in React campaign view)
+        topics_vocabulary = get_vocabulary("imio.smartweb.vocabulary.Topics")
+        current_lang = api.portal.get_current_language()[:2]
+        json_res = {
+            "items": [
+                {
+                    "value": term.value,
+                    "title": translate(term.title, target_language=current_lang),
+                }
+                for term in topics_vocabulary
+            ],
+            "items_total": len(topics_vocabulary),
+        }
+        return json_res
+
+
+@implementer(IExpandableElement)
+@adapter(Interface, Interface)
+class AllTopicsEndpoint(TopicsEndpoint):
+
+    def __call__(self):
+        topics = super(AllTopicsEndpoint, self).__call__()
+        ts_endpoint = TsTopicsEndpoint(self.context, self.request)
+        ts_topics = ts_endpoint()
+        ts_topics = [
+            {"title": i.get("text"), "value": i.get("id")} for i in ts_topics["items"]
+        ]
+        topics["items"].extend(ts_topics)
+        topics["items"].sort(key=lambda x: idnormalizer.normalize(x["title"]))
+        topics["items_total"] += len(ts_topics)
+        return topics
+
+
+class CampaignEndpointGet(BaseService):
+    def reply(self):
+        return CampaignEndpoint(self.context, self.request)()
+
+
+class AuthCampaignEndpointGet(BaseService):
+    def reply(self):
+        return get_ideabox_basic_auth_header()
+
+
+class ZonesEndpointGet(BaseService):
+    def reply(self):
+        return ZonesEndpoint(self.context, self.request)()
+
+
+class TsTopicsEndpointGet(BaseService):
+    def reply(self):
+        return ZonesEndpoint(self.context, self.request)()
+
+
+class TopicsEndpointGet(BaseService):
+    def reply(self):
+        return TopicsEndpoint(self.context, self.request)()
+
+
+class AllTopicsEndpointGet(BaseService):
+    def reply(self):
+        return AllTopicsEndpoint(self.context, self.request)()

imio_smartweb_core-1.3/src/imio/smartweb/core/contents/rest/campaign/view.pt

@@ -0,0 +1,19 @@
+<html
+         metal:use-macro="context/main_template/macros/master"
+         i18n:domain="imio.smartweb">
+<body>
+<metal:main fill-slot="content-core">
+  <div class="full-width">
+    <smartweb-campaign tal:attributes="query-url view/local_query_url;
+                                       query-zones-url view/local_query_zones_url; 
+                                       query-topics-url view/local_query_topics_url; 
+                                       batch-size view/batch_size;
+                                       propose-url view/propose_url;
+                                       current-language view/current_language;
+                                       display-map view/display_map;
+                                       view-path view/view_path;
+                                       context-authenticated-user view/context_authenticated_user;"></smartweb-campaign>
+  </div>
+</metal:main>
+</body>
+</html>

imio_smartweb_core-1.3/src/imio/smartweb/core/contents/rest/campaign/view.py

@@ -0,0 +1,29 @@
+# -*- coding: utf-8 -*-
+
+from imio.smartweb.core.contents.rest.view import BaseRestView
+from imio.smartweb.core.interfaces import IOgpViewUtils
+from plone import api
+from zope.interface import implementer
+
+
+@implementer(IOgpViewUtils)
+class CampaignViewView(BaseRestView):
+    """CampaignView view"""
+
+    @property
+    def propose_url(self):
+        return self.context.propose_project_url
+
+    @property
+    def display_map(self):
+        return self.context.display_map
+
+    @property
+    def local_query_zones_url(self):
+        base_url = self.context.absolute_url()
+        return f"{base_url}/@zones"
+
+    @property
+    def local_query_topics_url(self):
+        base_url = self.context.absolute_url()
+        return f"{base_url}/@all_topics"

{imio_smartweb_core-1.2.90 → imio_smartweb_core-1.3}/src/imio/smartweb/core/contents/rest/configure.zcml

@@ -1,6 +1,7 @@
 <configure
     xmlns="http://namespaces.zope.org/zope">
 
+  <include package=".campaign" />
   <include package=".directory" />
   <include package=".events" />
   <include package=".news" />

{imio_smartweb_core-1.2.90 → imio_smartweb_core-1.3}/src/imio/smartweb/core/interfaces.py

@@ -26,6 +26,10 @@ class IImioSmartwebCoreLayer(
     """Marker interface that defines a browser layer."""
 
 
+class IImioIdeaboxLayer(Interface):
+    """Marker interface that defines a browser layer."""
+
+
 class IArcgisViewUtils(Interface):
     """ """
 

imio_smartweb_core-1.3/src/imio/smartweb/core/overrides.zcml

@@ -0,0 +1,10 @@
+<configure
+    xmlns="http://namespaces.zope.org/zope">
+
+  <adapter
+      for="plone.dexterity.interfaces.IDexterityContainer"
+      factory="imio.smartweb.core.contents.rest.campaign.content.CampaignNameChooser"
+      provides="zope.container.interfaces.INameChooser"
+      />
+
+</configure>

{imio_smartweb_core-1.2.90 → imio_smartweb_core-1.3}/src/imio/smartweb/core/profiles/default/metadata.xml

@@ -1,6 +1,6 @@
 <?xml version='1.0' encoding='UTF-8'?>
 <metadata>
-  <version>1064</version>
+  <version>1066</version>
   <dependencies>
     <dependency>profile-plone.app.dexterity:default</dependency>
     <dependency>profile-plone.app.imagecropping:default</dependency>

imio_smartweb_core-1.3/src/imio/smartweb/core/profiles/ideabox/browserlayer.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<layers>
+  <layer
+      name="imio.smartweb.core.ideabox"
+      interface="imio.smartweb.core.interfaces.IImioIdeaboxLayer"
+      />
+</layers>

imio_smartweb_core-1.3/src/imio/smartweb/core/profiles/ideabox/metadata.xml

@@ -0,0 +1,5 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<metadata>
+  <version>1062</version>
+  <description>Profile to enable Ideabox on an existing Plone6 site</description>
+</metadata>