From 0f93c6dc1a2f0f74e92d2716ae9c3603f67c6ef3 Mon Sep 17 00:00:00 2001
From: Maurits van Rees <maurits@vanrees.org>
Date: Fri, 13 Sep 2024 13:05:43 +0200
Subject: [PATCH] Add survey-group-introduction view.

This returns the 'introduction' field of one of its surveys.
This is very similar to the survey-group-image view, so I refactored this to share some code.
Refs https://github.com/syslabcom/scrum/issues/2597
---
 src/osha/oira/content/browser/configure.zcml |  8 +++
 src/osha/oira/content/browser/surveygroup.py | 58 +++++++++++++++-----
 2 files changed, 53 insertions(+), 13 deletions(-)

diff --git a/src/osha/oira/content/browser/configure.zcml b/src/osha/oira/content/browser/configure.zcml
index 74bd76bd..f63c2523 100644
--- a/src/osha/oira/content/browser/configure.zcml
+++ b/src/osha/oira/content/browser/configure.zcml
@@ -79,6 +79,14 @@
       layer="osha.oira.interfaces.IOSHAContentSkinLayer"
       />
 
+  <browser:page
+      name="survey-group-introduction"
+      for="euphorie.content.surveygroup.ISurveyGroup"
+      class=".surveygroup.SurveyGroupIntroduction"
+      permission="zope2.View"
+      layer="osha.oira.interfaces.IOSHAContentSkinLayer"
+      />
+
   <!-- Sector -->
   <adapter
       name="euphorie.sector"
diff --git a/src/osha/oira/content/browser/surveygroup.py b/src/osha/oira/content/browser/surveygroup.py
index 2b2d7b55..57125539 100644
--- a/src/osha/oira/content/browser/surveygroup.py
+++ b/src/osha/oira/content/browser/surveygroup.py
@@ -1,7 +1,7 @@
-from Acquisition import aq_base
 from Acquisition import aq_parent
 from euphorie.content import MessageFactory as _
 from plone import api
+from plone.base.utils import base_hasattr
 from plonetheme.nuplone.skin import actions
 from Products.Five import BrowserView
 
@@ -41,8 +41,14 @@ def verify(self, container, context):
         return True
 
 
-class SurveyGroupImage(BrowserView):
-    """Return the image of the surveygroup."""
+class SurveyGroupAttribute(BrowserView):
+    """Base view to return an attribute of a surveygroup from its surveys.
+
+    We want to show both an 'image' and 'introduction' for a survey group,
+    and we can get them from one of its surveys.
+    """
+
+    attribute_name = ""
 
     @property
     def surveys(self):
@@ -60,28 +66,54 @@ def surveys(self):
             if obj.getId() != published:
                 yield obj
 
-    def get_obj_image_url(self, obj):
-        """Return the URL of the image of the given object.
+    def get_obj_attribute(self, obj):
+        """Return the attribute of the given object."""
+        if not obj:
+            return
+        if not base_hasattr(obj, self.attribute_name):
+            return
+        return getattr(obj, self.attribute_name)
 
-        The image is set by a cron script,
-        see e.g. https://github.com/syslabcom/scrum/issues/2552.
 
-        This might change in the future.
-        """
-        if obj and aq_base(obj.image):
-            return f"{obj.absolute_url()}/@@images/image"
+class SurveyGroupImage(SurveyGroupAttribute):
+    """Return the image of the surveygroup."""
+
+    attribute_name = "image"
 
     def __call__(self):
         """Check all the surveys, if they have an image, redirect to that image.
 
+        The image is set by a cron script,
+        see e.g. https://github.com/syslabcom/scrum/issues/2552.
+
+        This might change in the future.
+
         Return a fallback if it does not exist.
         """
         for survey in self.surveys:
-            image_url = self.get_obj_image_url(survey)
-            if image_url:
+            if self.get_obj_attribute(survey):
+                image_url = f"{survey.absolute_url()}/@@images/image"
                 return self.request.response.redirect(image_url)
 
         self.request.response.redirect(
             f"{api.portal.get().absolute_url()}"
             f"/++resource++osha.oira.content/clipboard.svg"
         )
+
+
+class SurveyGroupIntroduction(SurveyGroupAttribute):
+    """Return the introduction of the surveygroup."""
+
+    attribute_name = "introduction"
+
+    def __call__(self):
+        """Check all the surveys, if they have an introduction, show it.
+
+        We only need to return the contents of the field, which is expected
+        to be html.
+        """
+        for survey in self.surveys:
+            value = self.get_obj_attribute(survey)
+            if value:
+                return value
+        return ""