Dsetool choices continued

src/euphorie/client/browser/choice.py

@@ -0,0 +1,121 @@
+from euphorie.client import utils
+from euphorie.client.navigation import getTreeData
+from plone import api
+from plone.memoize.instance import memoize
+from Products.Five import BrowserView
+
+
+class IdentificationView(BrowserView):
+    """A view for displaying a choice in the identification phase."""
+
+    variation_class = "variation-risk-assessment"
+
+    @property
+    @memoize
+    def webhelpers(self):
+        return api.content.get_view("webhelpers", self.context.aq_parent, self.request)
+
+    def check_render_condition(self):
+        # Render the page only if the user can inspection rights,
+        # otherwise redirect to the start page of the session.
+        if not self.webhelpers.can_inspect_session:
+            return self.request.response.redirect(
+                "{session_url}/@@start".format(
+                    session_url=self.webhelpers.traversed_session.absolute_url()
+                )
+            )
+        if self.webhelpers.redirectOnSurveyUpdate():
+            return
+
+    @property
+    @memoize
+    def navigation(self):
+        return api.content.get_view("navigation", self.context, self.request)
+
+    def _get_next(self, reply):
+        _next = reply.get("next", None)
+        # In Safari browser we get a list
+        if isinstance(_next, list):
+            _next = _next.pop()
+        return _next
+
+    @property
+    def tree(self):
+        return getTreeData(self.request, self.context)
+
+    @property
+    @memoize
+    def session(self):
+        return self.webhelpers.traversed_session.session
+
+    @property
+    @memoize
+    def survey(self):
+        """This is the survey dexterity object."""
+        return self.webhelpers._survey
+
+    @property
+    @memoize
+    def choice(self):
+        return self.webhelpers.traversed_session.restrictedTraverse(
+            self.context.zodb_path.split("/")
+        )
+
+    @property
+    @memoize
+    def selected(self):
+        return [option.zodb_path for option in self.context.options]
+
+    def set_answer_data(self, reply):
+        """Save the selected options as indicated by the paths in the `answer`
+        field of `reply` (i.e. the request form).
+        If the choice allows multiple options, then selecting none of them counts as
+        a valid answer. In this case the `postponed` attribute is set to True.
+
+        Note that this use of the `postponed` attribute does not exactly match
+        the use for risks in that we don't expect the user to come back and
+        answer later, but it is similar in that we record that the user has
+        been here and clicked “Save” rather than “Skip”.
+        """
+        answer = reply.get("answer", [])
+        if self.choice.allow_multiple_options:
+            self.context.postponed = answer == "postponed"
+        if answer == "postponed":
+            answer = []
+        if not isinstance(answer, (list, tuple)):
+            answer = [answer]
+        # XXX Check if paths are valid?
+        # for path in answer[:]:
+        #     try:
+        #         self.webhelpers.traversed_session.restrictedTraverse(path)
+        #     except KeyError:
+        #        answer.remove(path)
+        return self.context.set_options_by_zodb_path(answer)
+
+    def __call__(self):
+        # Render the page only if the user has inspection rights,
+        # otherwise redirect to the start page of the session.
+        if not self.webhelpers.can_inspect_session:
+            return self.request.response.redirect(
+                self.context.aq_parent.absolute_url() + "/@@start"
+            )
+        self.check_render_condition()
+
+        utils.setLanguage(self.request, self.survey, self.survey.language)
+
+        if self.request.method == "POST":
+            reply = self.request.form
+            if not self.webhelpers.can_edit_session:
+                return self.navigation.proceed_to_next(reply)
+            _next = self._get_next(reply)
+            # Don't persist anything if the user skipped the question
+            if _next == "skip":
+                return self.navigation.proceed_to_next(reply)
+
+            changed = self.set_answer_data(reply)
+
+            if changed:
+                self.session.touch()
+
+            return self.navigation.proceed_to_next(reply)
+        return self.index()

src/euphorie/client/browser/configure.zcml

@@ -71,6 +71,14 @@
       layer="euphorie.client.interfaces.IClientSkinLayer"
       />
 
+  <browser:page
+      name="navigation"
+      for="*"
+      class="euphorie.client.browser.navigation.NavigationView"
+      permission="zope.Public"
+      layer="euphorie.client.interfaces.IClientSkinLayer"
+      />
+
   <browser:page
       name="risk_macros"
       for="*"
@@ -702,6 +710,16 @@
       layer="euphorie.client.interfaces.IClientSkinLayer"
       />
 
+  <!-- Choice -->
+  <browser:page
+      name="identification"
+      for="euphorie.client.model.Choice"
+      class=".choice.IdentificationView"
+      template="templates/choice_identification.pt"
+      permission="euphorie.client.ViewSurvey"
+      layer="euphorie.client.interfaces.IClientSkinLayer"
+      />
+
   <browser:page
       name="tool-more-info"
       for="euphorie.client.adapters.session_traversal.ITraversedSurveySession"

src/euphorie/client/browser/navigation.py

@@ -0,0 +1,105 @@
+from euphorie.client import model
+from euphorie.client.interfaces import CustomRisksModifiedEvent
+from euphorie.client.navigation import FindNextQuestion
+from euphorie.client.navigation import FindPreviousQuestion
+from plone import api
+from plone.memoize.instance import memoize
+from Products.Five import BrowserView
+from sqlalchemy import and_
+from z3c.saconfig import Session
+from zope.event import notify
+
+
+class NavigationView(BrowserView):
+    question_filter = None
+
+    @property
+    @memoize
+    def webhelpers(self):
+        return api.content.get_view("webhelpers", self.context, self.request)
+
+    @property
+    @memoize
+    def session(self):
+        return self.webhelpers.traversed_session.session
+
+    @property
+    @memoize
+    def previous_question(self):
+        return FindPreviousQuestion(
+            self.context, dbsession=self.session, filter=self.question_filter
+        )
+
+    @property
+    @memoize
+    def next_question(self):
+        return FindNextQuestion(
+            self.context, dbsession=self.session, filter=self.question_filter
+        )
+
+    def proceed_to_next(self, reply):
+        _next = reply.get("next", None)
+        # In Safari browser we get a list
+        if isinstance(_next, list):
+            _next = _next.pop()
+        if _next == "previous":
+            target = self.previous_question
+            if target is None:
+                # We ran out of questions, step back to intro page
+                url = "{session_url}/@@identification".format(
+                    session_url=self.webhelpers.traversed_session.absolute_url()
+                )
+                return self.request.response.redirect(url)
+        elif _next in ("next", "skip"):
+            target = self.next_question
+            if target is None:
+                # We ran out of questions, proceed to the action plan
+                if self.webhelpers.use_action_plan_phase:
+                    next_view_name = "@@actionplan"
+                elif self.webhelpers.use_consultancy_phase:
+                    next_view_name = "@@consultancy"
+                else:
+                    next_view_name = "@@report"
+                base_url = self.webhelpers.traversed_session.absolute_url()
+                url = f"{base_url}/{next_view_name}"
+                return self.request.response.redirect(url)
+
+        elif _next == "add_custom_risk" and self.webhelpers.can_edit_session:
+            sql_module = (
+                Session.query(model.Module)
+                .filter(
+                    and_(
+                        model.SurveyTreeItem.session == self.session,
+                        model.Module.zodb_path == "custom-risks",
+                    )
+                )
+                .first()
+            )
+            if not sql_module:
+                url = self.context.absolute_url() + "/@@identification"
+                return self.request.response.redirect(url)
+
+            view = api.content.get_view("identification", sql_module, self.request)
+            view.add_custom_risk()
+            notify(CustomRisksModifiedEvent(self.context.aq_parent))
+            risk_id = self.context.aq_parent.children().count()
+            # Construct the path to the newly added risk: We know that there
+            # is only one custom module, so we can take its id directly. And
+            # to that we can append the risk id.
+            url = "{session_url}/{module}/{risk}/@@identification".format(
+                session_url=self.webhelpers.traversed_session.absolute_url(),
+                module=sql_module.getId(),
+                risk=risk_id,
+            )
+            return self.request.response.redirect(url)
+        elif _next == "actionplan":
+            url = self.webhelpers.traversed_session.absolute_url() + "/@@actionplan"
+            return self.request.response.redirect(url)
+        # stay on current risk
+        else:
+            target = self.context
+        url = ("{session_url}/{path}/@@identification").format(
+            session_url=self.webhelpers.traversed_session.absolute_url(),
+            path="/".join(target.short_path),
+        )
+        return self.request.response.redirect(url)

src/euphorie/client/browser/risk.py

@@ -33,7 +33,6 @@
 from Products.CMFPlone.utils import getAllowedSizes
 from Products.Five import BrowserView
 from Products.Five.browser.pagetemplatefile import ViewPageTemplateFile
-from sqlalchemy import and_
 from z3c.saconfig import Session
 from zope.component import getUtility
 from zope.deprecation import deprecate
@@ -487,10 +486,8 @@ def get_collapsible_section_state(self, collapsible_section_name):
 
     @property
     @memoize
-    def next_question(self):
-        return FindNextQuestion(
-            self.context, dbsession=self.session, filter=self.question_filter
-        )
+    def navigation(self):
+        return api.content.get_view("navigation", self.context, self.request)
 
     @property
     @memoize
@@ -547,11 +544,11 @@ def __call__(self):
         if self.request.method == "POST":
             reply = self.request.form
             if not self.webhelpers.can_edit_session:
-                return self.proceed_to_next(reply)
+                return self.navigation.proceed_to_next(reply)
             _next = self._get_next(reply)
             # Don't persist anything if the user skipped the question
             if _next == "skip":
-                return self.proceed_to_next(reply)
+                return self.navigation.proceed_to_next(reply)
             old_values = {}
             for prop, default in self.monitored_properties.items():
                 val = getattr(self.context, prop, default)
@@ -593,7 +590,7 @@ def __call__(self):
             if changed:
                 self.session.touch()
 
-            return self.proceed_to_next(reply)
+            return self.navigation.proceed_to_next(reply)
 
         else:
             self._prepare_risk()
@@ -1009,80 +1006,6 @@ def _prepare_risk(self):
             or "template-default"
         )
 
-    @property
-    @memoize
-    def previous_question(self):
-        return FindPreviousQuestion(
-            self.context, dbsession=self.session, filter=self.question_filter
-        )
-
-    def proceed_to_next(self, reply):
-        _next = reply.get("next", None)
-        # In Safari browser we get a list
-        if isinstance(_next, list):
-            _next = _next.pop()
-        if _next == "previous":
-            target = self.previous_question
-            if target is None:
-                # We ran out of questions, step back to intro page
-                url = "{session_url}/@@identification".format(
-                    session_url=self.webhelpers.traversed_session.absolute_url()
-                )
-                return self.request.response.redirect(url)
-        elif _next in ("next", "skip"):
-            target = self.next_question
-            if target is None:
-                # We ran out of questions, proceed to the action plan
-                if self.webhelpers.use_action_plan_phase:
-                    next_view_name = "@@actionplan"
-                elif self.webhelpers.use_consultancy_phase:
-                    next_view_name = "@@consultancy"
-                else:
-                    next_view_name = "@@report"
-                base_url = self.webhelpers.traversed_session.absolute_url()
-                url = f"{base_url}/{next_view_name}"
-                return self.request.response.redirect(url)
-
-        elif _next == "add_custom_risk" and self.webhelpers.can_edit_session:
-            sql_module = (
-                Session.query(model.Module)
-                .filter(
-                    and_(
-                        model.SurveyTreeItem.session == self.session,
-                        model.Module.zodb_path == "custom-risks",
-                    )
-                )
-                .first()
-            )
-            if not sql_module:
-                url = self.context.absolute_url() + "/@@identification"
-                return self.request.response.redirect(url)
-
-            view = api.content.get_view("identification", sql_module, self.request)
-            view.add_custom_risk()
-            notify(CustomRisksModifiedEvent(self.context.aq_parent))
-            risk_id = self.context.aq_parent.children().count()
-            # Construct the path to the newly added risk: We know that there
-            # is only one custom module, so we can take its id directly. And
-            # to that we can append the risk id.
-            url = "{session_url}/{module}/{risk}/@@identification".format(
-                session_url=self.webhelpers.traversed_session.absolute_url(),
-                module=sql_module.getId(),
-                risk=risk_id,
-            )
-            return self.request.response.redirect(url)
-        elif _next == "actionplan":
-            url = self.webhelpers.traversed_session.absolute_url() + "/@@actionplan"
-            return self.request.response.redirect(url)
-        # stay on current risk
-        else:
-            target = self.context
-        url = ("{session_url}/{path}/@@identification").format(
-            session_url=self.webhelpers.traversed_session.absolute_url(),
-            path="/".join(target.short_path),
-        )
-        return self.request.response.redirect(url)
-
     @memoize
     def get_existing_measures_with_activation(self):
         saved_standard_measures = {