From d6356fe837f6eae2f5ddf0881c5ffb1fd8ee9697 Mon Sep 17 00:00:00 2001
From: cboulanger <christophe.boulanger@imio.be>
Date: Thu, 17 Aug 2023 11:55:38 +0200
Subject: [PATCH 1/2] WEB-3957 : Add new "Please help!" menu in Plone toolbar

---
 CHANGES.rst                                   |   3 +
 .../smartweb/core/browser/static/src/edit.js  |   4 +-
 .../core/browser/static/src/edit.less         |   5 +
 src/imio/smartweb/core/tests/test_toolbar.py  |  44 ++++++-
 .../smartweb/core/viewlets/configure.zcml     |  16 ++-
 src/imio/smartweb/core/viewlets/interfaces.py |  20 +++
 src/imio/smartweb/core/viewlets/toolbar.py    | 115 ++++++++++++++++--
 7 files changed, 194 insertions(+), 13 deletions(-)
 create mode 100644 src/imio/smartweb/core/viewlets/interfaces.py

diff --git a/CHANGES.rst b/CHANGES.rst
index 162c835b..48c10a41 100644
--- a/CHANGES.rst
+++ b/CHANGES.rst
@@ -5,6 +5,9 @@ Changelog
 1.1.20 (unreleased)
 -------------------
 
+- WEB-3957 : Add new "Please help!" menu in Plone toolbar
+  [boulch]
+
 - WEB-3972 : Add "elloha" plugin in external content section
   [boulch]
 
diff --git a/src/imio/smartweb/core/browser/static/src/edit.js b/src/imio/smartweb/core/browser/static/src/edit.js
index dca16631..71a305a1 100644
--- a/src/imio/smartweb/core/browser/static/src/edit.js
+++ b/src/imio/smartweb/core/browser/static/src/edit.js
@@ -1,6 +1,5 @@
 import './edit.less'
 jQuery(document).ready(function ($) {
-
   // Hide / show editor's tools & messages when clicking on "Preview" in Plone toolbar
   $("#contentview-preview a").click(function(e){
     $(".hide-in-preview, #section-byline, #global_statusmessage").toggle("fast");
@@ -11,5 +10,8 @@ jQuery(document).ready(function ($) {
   var auth_sources = $("#plone-authentic-sources-menu").wrap("<ul class='plonetoolbar-authentic-sources-menu'>").parent();
   $(".personaltools-wrapper").prepend(auth_sources);
 
+  // Move smartweb help menu just before user/personaltools-menulink in Plone toolbar
+  var smartweb_help = $("#plone-smartweb-help-menu").wrap("<ul class='plonetoolbar-smartweb-help-menu'>").parent();
+  $(".personaltools-wrapper").prepend(smartweb_help);
 });
 
diff --git a/src/imio/smartweb/core/browser/static/src/edit.less b/src/imio/smartweb/core/browser/static/src/edit.less
index 3e4b07ff..d0570f01 100644
--- a/src/imio/smartweb/core/browser/static/src/edit.less
+++ b/src/imio/smartweb/core/browser/static/src/edit.less
@@ -58,3 +58,8 @@ ul.plonetoolbar-authentic-sources-menu {
   padding-inline-start: 0;
   width: 100%;
 }
+
+ul.plonetoolbar-smartweb-help-menu {
+  padding-inline-start: 0;
+  width: 100%;
+}
diff --git a/src/imio/smartweb/core/tests/test_toolbar.py b/src/imio/smartweb/core/tests/test_toolbar.py
index e73d9374..4b0237fb 100644
--- a/src/imio/smartweb/core/tests/test_toolbar.py
+++ b/src/imio/smartweb/core/tests/test_toolbar.py
@@ -1,16 +1,20 @@
 # -*- coding: utf-8 -*-
 
+from freezegun import freeze_time
 from imio.smartweb.core.viewlets.toolbar import AuthenticSourcesMenuItem
+from imio.smartweb.core.viewlets.toolbar import SmartwebHelpMenuItem
 from imio.smartweb.core.testing import IMIO_SMARTWEB_CORE_INTEGRATION_TESTING
 from imio.smartweb.core.testing import ImioSmartwebTestCase
 from imio.smartweb.core.tests.utils import get_json
 from plone.app.testing import logout
 from plone.app.testing import setRoles
 from plone.app.testing import TEST_USER_ID
+from plone.memoize.interfaces import ICacheChooser
 from zope.browsermenu.interfaces import IBrowserMenu
 from zope.component import getUtility
 
 import json
+import os
 import requests_mock
 
 
@@ -55,8 +59,46 @@ def test_sources_authentic_url(self, m):
             "localhost:8080/Plone/manage-directory",
         )
 
-    def test_available(self):
+    def test_available_sources_authentic(self):
         menu = AuthenticSourcesMenuItem(self.portal, self.request)
         self.assertTrue(menu.available())
         logout()
         self.assertFalse(menu.available())
+
+    def test_help_menu_url(self):
+        # freeze_time for _cache_key
+        with freeze_time("2023-08-18 11:19:50"):
+            menu = getUtility(
+                IBrowserMenu, name="plone_contentmenu", context=self.portal
+            )
+            items = menu.getMenuItems(self.portal, self.request)
+            smartweb_help_submenu = items[4].get("submenu")
+            self.assertEqual(
+                smartweb_help_submenu[0].get("action"),
+                "https://docs.imio.be/iasmartweb/smartweb_v6",
+            )
+            self.assertEqual(
+                smartweb_help_submenu[1].get("action"),
+                "https://support.imio.be",
+            )
+            self.assertEqual(
+                smartweb_help_submenu[2].get("action"),
+                "https://my-formulaires.imio.be/ateliers-imio/ateliers-iasmartweb-1",
+            )
+            os.environ["help_menu_rtfm"] = "https://kamoulox.docs.be"
+            cache_utility = getUtility(ICacheChooser)
+            ramcache = cache_utility("plone_smartweb_help_menu 5641167.0").ramcache
+            # clear ramcache
+            ramcache._getStorage()._data.clear()
+            items = menu.getMenuItems(self.portal, self.request)
+            smartweb_help_submenu = items[4].get("submenu")
+            self.assertEqual(
+                smartweb_help_submenu[0].get("action"),
+                "https://kamoulox.docs.be",
+            )
+
+    def test_available_help_menu(self):
+        menu = SmartwebHelpMenuItem(self.portal, self.request)
+        self.assertTrue(menu.available())
+        logout()
+        self.assertFalse(menu.available())
diff --git a/src/imio/smartweb/core/viewlets/configure.zcml b/src/imio/smartweb/core/viewlets/configure.zcml
index 94349e72..35861989 100644
--- a/src/imio/smartweb/core/viewlets/configure.zcml
+++ b/src/imio/smartweb/core/viewlets/configure.zcml
@@ -329,8 +329,8 @@
       />
 
   <browser:menu
-      id="authentic-sources-menu"
-      title=""
+      id="plone_authentic_sources_menu"
+      title="Authentic sources menu"
       class=".toolbar.AuthenticSourcesMenu"
       />
 
@@ -340,4 +340,16 @@
       factory=".toolbar.AuthenticSourcesMenuItem"
       provides="plone.app.contentmenu.interfaces.IContentMenuItem" />
 
+  <browser:menu
+      id="plone_smartweb_help_menu"
+      title="Smartweb help menu"
+      class=".toolbar.SmartwebHelpMenu"
+      />
+
+  <adapter
+      for="* *"
+      name="smartweb.menu.smartweb_help"
+      factory=".toolbar.SmartwebHelpMenuItem"
+      provides="plone.app.contentmenu.interfaces.IContentMenuItem" />
+
 </configure>
diff --git a/src/imio/smartweb/core/viewlets/interfaces.py b/src/imio/smartweb/core/viewlets/interfaces.py
new file mode 100644
index 00000000..039a9736
--- /dev/null
+++ b/src/imio/smartweb/core/viewlets/interfaces.py
@@ -0,0 +1,20 @@
+# -*- coding: utf-8 -*-
+
+from zope.browsermenu.interfaces import IBrowserMenu
+from zope.browsermenu.interfaces import IBrowserSubMenuItem
+
+
+class IAuthenticSourcesMenu(IBrowserMenu):
+    """The authentic sources menu."""
+
+
+class ISmartwebHelpMenu(IBrowserMenu):
+    """The smartweb help menu."""
+
+
+class IAuthenticSourcesSubMenuItem(IBrowserSubMenuItem):
+    """The authentic sources submenu item."""
+
+
+class ISmartwebHelpSubMenuItem(IBrowserSubMenuItem):
+    """The smartweb help submenu item."""
diff --git a/src/imio/smartweb/core/viewlets/toolbar.py b/src/imio/smartweb/core/viewlets/toolbar.py
index 4e68b31e..b1216c3d 100644
--- a/src/imio/smartweb/core/viewlets/toolbar.py
+++ b/src/imio/smartweb/core/viewlets/toolbar.py
@@ -2,22 +2,30 @@
 
 from imio.smartweb.core import config
 from imio.smartweb.core.utils import get_json
+from imio.smartweb.core.viewlets.interfaces import IAuthenticSourcesMenu
+from imio.smartweb.core.viewlets.interfaces import IAuthenticSourcesSubMenuItem
+from imio.smartweb.core.viewlets.interfaces import ISmartwebHelpMenu
+from imio.smartweb.core.viewlets.interfaces import ISmartwebHelpSubMenuItem
 from imio.smartweb.locales import SmartwebMessageFactory as _
 from plone import api
 from plone.app.contentmenu.menu import BrowserMenu
 from plone.app.contentmenu.menu import BrowserSubMenuItem
 from plone.memoize import ram
 from time import time
-from zope.browsermenu.interfaces import IBrowserMenu
 from zope.interface import implementer
 
+import os
 import re
 
 
-@implementer(IBrowserMenu)
+def _cache_key(func, obj, context, request):
+    return (obj.id, time() // (5 * 60))
+
+
+@implementer(IAuthenticSourcesSubMenuItem)
 class AuthenticSourcesMenuItem(BrowserSubMenuItem):
     title = _("Authentic sources")
-    submenuId = "authentic-sources-menu"
+    submenuId = "plone_authentic_sources_menu"
     icon = "boxes"
     extra = {
         "id": "plone-authentic-sources-menu",
@@ -49,9 +57,9 @@ def selected(self):
         return False
 
 
-@implementer(IBrowserMenu)
+@implementer(IAuthenticSourcesMenu)
 class AuthenticSourcesMenu(BrowserMenu):
-    @ram.cache(lambda *args: time() // (60 * 60))
+    @ram.cache(_cache_key)
     def getMenuItems(self, context, request):
         news_entity_url = self.get_entity_from_authentic_source(
             config.NEWS_URL, "smartweb.news_entity_uid"
@@ -62,9 +70,13 @@ def getMenuItems(self, context, request):
         directory_entity_url = self.get_entity_from_authentic_source(
             config.DIRECTORY_URL, "smartweb.directory_entity_uid"
         )
-        news = {"url": news_entity_url, "icon": "newspaper"}
-        events = {"url": events_entity_url, "icon": "calendar-event"}
-        directory = {"url": directory_entity_url, "icon": "file-person"}
+        news = {"url": news_entity_url, "icon": "newspaper", "id": "news"}
+        events = {"url": events_entity_url, "icon": "calendar-event", "id": "events"}
+        directory = {
+            "url": directory_entity_url,
+            "icon": "file-person",
+            "id": "directory",
+        }
         authentic_sources = [news, events, directory]
 
         menu_items = []
@@ -79,7 +91,11 @@ def getMenuItems(self, context, request):
                 "action": source["url"],
                 "selected": False,
                 "icon": source["icon"],
-                "extra": {"id": "some-id", "separator": None, "class": ""},
+                "extra": {
+                    "id": f'plone-authentic-sources-menu{source["id"]}',
+                    "separator": None,
+                    "class": "",
+                },
                 "submenu": None,
             }
             menu_items.append(menu_item)
@@ -93,3 +109,84 @@ def get_entity_from_authentic_source(self, authentic_sources_url, registry_key):
         if not result or not result.get("items"):
             return None
         return result.get("items")[0].get("@id")
+
+
+@implementer(ISmartwebHelpSubMenuItem)
+class SmartwebHelpMenuItem(BrowserSubMenuItem):
+    title = _("Please help!")
+    submenuId = "plone_smartweb_help_menu"
+    icon = "info-circle"
+    extra = {
+        "id": "plone-smartweb-help-menu",
+        "li_class": "plonetoolbar-smartweb-help-menu",
+    }
+
+    order = 50
+
+    @property
+    def action(self):
+        return "#"
+
+    def available(self):
+        permission = "Modify portal content"
+        return api.user.has_permission(permission, obj=self.context)
+
+
+@implementer(ISmartwebHelpMenu)
+class SmartwebHelpMenu(BrowserMenu):
+    @ram.cache(_cache_key)
+    def getMenuItems(self, context, request):
+        rtfm_action = os.environ.get(
+            "help_menu_rtfm", "https://docs.imio.be/iasmartweb/smartweb_v6"
+        )
+        support_action = os.environ.get("help_menu_support", "https://support.imio.be")
+        workshop_action = os.environ.get(
+            "help_menu_workshop",
+            "https://my-formulaires.imio.be/ateliers-imio/ateliers-iasmartweb-1",
+        )
+
+        # Read The Funny Manual... (no?)
+        rtfm = {
+            "title": _("Read documentation"),
+            "description": "",
+            "action": rtfm_action,
+            "selected": False,
+            "icon": "eye-fill",
+            "extra": {
+                "id": "plone-smartweb-help-menu-rtfm",
+                "separator": None,
+                "class": "",
+            },
+            "submenu": None,
+        }
+
+        support = {
+            "title": _("Ask a question"),
+            "description": "",
+            "action": support_action,
+            "selected": False,
+            "icon": "chat-square-heart-fill",
+            "extra": {
+                "id": "plone-smartweb-help-menu-support",
+                "separator": None,
+                "class": "",
+            },
+            "submenu": None,
+        }
+
+        workshop = {
+            "title": _("Take part of workshop"),
+            "description": "",
+            "action": workshop_action,
+            "selected": False,
+            "icon": "rocket-takeoff-fill",
+            "extra": {
+                "id": "plone-smartweb-help-menu-workshop",
+                "separator": None,
+                "class": "",
+            },
+            "submenu": None,
+        }
+
+        menu_items = [rtfm, support, workshop]
+        return menu_items

From bed4737cfab96b7c6b38c91366ad1edc928b364d Mon Sep 17 00:00:00 2001
From: Laurent Lasudry <lasudry@gmail.com>
Date: Sun, 20 Aug 2023 14:39:15 +0200
Subject: [PATCH 2/2] Simplify cache invalidation code in tests

---
 src/imio/smartweb/core/tests/test_toolbar.py | 56 +++++++++-----------
 1 file changed, 24 insertions(+), 32 deletions(-)

diff --git a/src/imio/smartweb/core/tests/test_toolbar.py b/src/imio/smartweb/core/tests/test_toolbar.py
index 4b0237fb..fee7efb7 100644
--- a/src/imio/smartweb/core/tests/test_toolbar.py
+++ b/src/imio/smartweb/core/tests/test_toolbar.py
@@ -1,6 +1,5 @@
 # -*- coding: utf-8 -*-
 
-from freezegun import freeze_time
 from imio.smartweb.core.viewlets.toolbar import AuthenticSourcesMenuItem
 from imio.smartweb.core.viewlets.toolbar import SmartwebHelpMenuItem
 from imio.smartweb.core.testing import IMIO_SMARTWEB_CORE_INTEGRATION_TESTING
@@ -9,7 +8,7 @@
 from plone.app.testing import logout
 from plone.app.testing import setRoles
 from plone.app.testing import TEST_USER_ID
-from plone.memoize.interfaces import ICacheChooser
+from plone.memoize.ram import choose_cache
 from zope.browsermenu.interfaces import IBrowserMenu
 from zope.component import getUtility
 
@@ -66,36 +65,29 @@ def test_available_sources_authentic(self):
         self.assertFalse(menu.available())
 
     def test_help_menu_url(self):
-        # freeze_time for _cache_key
-        with freeze_time("2023-08-18 11:19:50"):
-            menu = getUtility(
-                IBrowserMenu, name="plone_contentmenu", context=self.portal
-            )
-            items = menu.getMenuItems(self.portal, self.request)
-            smartweb_help_submenu = items[4].get("submenu")
-            self.assertEqual(
-                smartweb_help_submenu[0].get("action"),
-                "https://docs.imio.be/iasmartweb/smartweb_v6",
-            )
-            self.assertEqual(
-                smartweb_help_submenu[1].get("action"),
-                "https://support.imio.be",
-            )
-            self.assertEqual(
-                smartweb_help_submenu[2].get("action"),
-                "https://my-formulaires.imio.be/ateliers-imio/ateliers-iasmartweb-1",
-            )
-            os.environ["help_menu_rtfm"] = "https://kamoulox.docs.be"
-            cache_utility = getUtility(ICacheChooser)
-            ramcache = cache_utility("plone_smartweb_help_menu 5641167.0").ramcache
-            # clear ramcache
-            ramcache._getStorage()._data.clear()
-            items = menu.getMenuItems(self.portal, self.request)
-            smartweb_help_submenu = items[4].get("submenu")
-            self.assertEqual(
-                smartweb_help_submenu[0].get("action"),
-                "https://kamoulox.docs.be",
-            )
+        menu = getUtility(IBrowserMenu, name="plone_contentmenu", context=self.portal)
+        items = menu.getMenuItems(self.portal, self.request)
+        smartweb_help_submenu = items[4].get("submenu")
+        self.assertEqual(
+            smartweb_help_submenu[0].get("action"),
+            "https://docs.imio.be/iasmartweb/smartweb_v6",
+        )
+        self.assertEqual(
+            smartweb_help_submenu[1].get("action"), "https://support.imio.be"
+        )
+        self.assertEqual(
+            smartweb_help_submenu[2].get("action"),
+            "https://my-formulaires.imio.be/ateliers-imio/ateliers-iasmartweb-1",
+        )
+
+        os.environ["help_menu_rtfm"] = "https://kamoulox.docs.be"
+        cache = choose_cache("imio.smartweb.core.viewlets.toolbar.getMenuItems")
+        cache.ramcache.invalidateAll()
+        items = menu.getMenuItems(self.portal, self.request)
+        smartweb_help_submenu = items[4].get("submenu")
+        self.assertEqual(
+            smartweb_help_submenu[0].get("action"), "https://kamoulox.docs.be"
+        )
 
     def test_available_help_menu(self):
         menu = SmartwebHelpMenuItem(self.portal, self.request)