Export/import of choices and options

Author: reinhardt

src/euphorie/content/browser/export.py

@@ -16,7 +16,9 @@
 from euphorie.content.browser.upload import COMMA_REPLACEMENT
 from euphorie.content.browser.upload import NSMAP
 from euphorie.content.browser.upload import ProfileQuestionLocationFields
+from euphorie.content.choice import IChoice
 from euphorie.content.module import IModule
+from euphorie.content.option import IOption
 from euphorie.content.profilequestion import IProfileQuestion
 from euphorie.content.risk import IKinneyEvaluation
 from euphorie.content.risk import IRisk
@@ -303,9 +305,9 @@ def exportSurvey(self, parent, survey):
         if self.include_intro_text and StripMarkup(survey.introduction):
             node = self._add_string_or_html(node, survey.introduction, "introduction")
         if survey.classification_code:
-            etree.SubElement(node, "classification-code").text = (
-                survey.classification_code
-            )
+            etree.SubElement(
+                node, "classification-code"
+            ).text = survey.classification_code
         etree.SubElement(node, "language").text = survey.language
         enable_web_training = getattr(survey, "enable_web_training", False)
         if enable_web_training:
@@ -410,6 +412,8 @@ def exportProfileQuestion(self, parent, profile):
                 self.exportModule(node, child)
             elif IRisk.providedBy(child):
                 self.exportRisk(node, child)
+            elif IChoice.providedBy(child):
+                self.exportChoice(node, child)
         return node
 
     def exportModule(self, parent, module):
@@ -442,6 +446,8 @@ def exportModule(self, parent, module):
                 self.exportModule(node, child)
             elif IRisk.providedBy(child):
                 self.exportRisk(node, child)
+            elif IChoice.providedBy(child):
+                self.exportChoice(node, child)
         return node
 
     def exportRisk(self, parent, risk):
@@ -552,3 +558,33 @@ def exportTrainingQuestion(self, parent, training_question):
             training_question.wrong_answer_2
         )
         return node
+
+    def exportChoice(self, parent, choice):
+        """:returns: An XML node with the details of an
+        :obj:`euphorie.content.choice`."""
+        node = etree.SubElement(parent, "choice")
+        if getattr(choice, "external_id", None):
+            node.attrib["external-id"] = choice.external_id
+        etree.SubElement(node, "title").text = choice.title
+        node = self._add_string_or_html(node, choice.description, "description")
+        etree.SubElement(
+            node,
+            "allow-multiple-options",
+            attrib={"value": "true" if choice.allow_multiple_options else "false"},
+        )
+        etree.SubElement(node, "condition").text = choice.get_client_condition()
+        for child in choice.values():
+            if IOption.providedBy(child):
+                self.exportOption(node, child)
+
+    def exportOption(self, parent, option):
+        """:returns: An XML node with the details of an
+        :obj:`euphorie.content.option`."""
+        node = etree.SubElement(parent, "option")
+        if getattr(option, "external_id", None):
+            node.attrib["external-id"] = option.external_id
+        etree.SubElement(node, "title").text = option.title
+        node = self._add_string_or_html(node, option.description, "description")
+        etree.SubElement(node, "condition-id").text = "/".join(
+            option.getPhysicalPath()[-3:]
+        )

src/euphorie/content/browser/upload.py

@@ -20,6 +20,7 @@
 from euphorie.content.utils import IToolTypesInfo
 from io import BytesIO
 from markdownify import markdownify
+from plone import api
 from plone.autoform.form import AutoExtensibleForm
 from plone.base.utils import safe_bytes
 from plone.dexterity.utils import createContentInContainer
@@ -215,6 +216,47 @@ class SurveyImporter:
 
     def __init__(self, context):
         self.context = context
+        self.options = {}
+        self.conditions = []
+
+    def ImportOption(self, node, choice):
+        """
+        Create a new :obj:`euphorie.content.option` object for a
+        :obj:`euphorie.content.module` given the details for a Option as an XML
+        node.
+
+        :returns: :obj:`euphorie.content.option`.
+        """
+        option = createContentInContainer(
+            choice, "euphorie.option", title=str(node.title)
+        )
+        option.external_id = attr_unicode(node, "external-id")
+        option.description = el_unicode(
+            node, "description", is_etranslate_compatible=self.is_etranslate_compatible
+        )
+        self.options[el_unicode(node, "condition-id")] = option
+
+    def ImportChoice(self, node, module):
+        """
+        Create a new :obj:`euphorie.content.choice` object for a
+        :obj:`euphorie.content.module` given the details for a Choice as an XML
+        node.
+
+        :returns: :obj:`euphorie.content.choice`.
+        """
+        choice = createContentInContainer(
+            module, "euphorie.choice", title=str(node.title)
+        )
+        choice.external_id = attr_unicode(node, "external-id")
+        choice.description = el_unicode(
+            node, "description", is_etranslate_compatible=self.is_etranslate_compatible
+        )
+        choice.allow_multiple_options = el_bool(node, "allow-multiple-options")
+        condition = el_unicode(node, "condition")
+        if condition:
+            self.conditions.append((choice, condition))
+        for child in node.iterchildren(tag=XMLNS + "option"):
+            self.ImportOption(child, choice)
 
     def ImportImage(self, node):
         """Import a base64 encoded image from an XML node.
@@ -350,6 +392,9 @@ def ImportModule(self, node, survey):
         for child in node.iterchildren(tag=XMLNS + "risk"):
             self.ImportRisk(child, module)
 
+        for child in node.iterchildren(tag=XMLNS + "choice"):
+            self.ImportChoice(child, module)
+
         for child in node.iterchildren(tag=XMLNS + "module"):
             self.ImportModule(child, module)
 
@@ -396,6 +441,9 @@ def ImportProfileQuestion(self, node, survey):
         for child in node.iterchildren(tag=XMLNS + "risk"):
             self.ImportRisk(child, profile)
 
+        for child in node.iterchildren(tag=XMLNS + "choice"):
+            self.ImportChoice(child, profile)
+
         for child in node.iterchildren(tag=XMLNS + "module"):
             self.ImportModule(child, profile)
         return profile
@@ -468,13 +516,26 @@ def ImportSurvey(self, node, group, version_title):
                 x.replace(COMMA_REPLACEMENT, ",").strip()
                 for x in el_unicode(node, "tool-category", "").split(",")
             ]
+
+        self.options = {}
+        self.conditions = []
+
         for child in node.iterchildren():
             if child.tag == XMLNS + "profile-question":
                 self.ImportProfileQuestion(child, survey)
             elif child.tag == XMLNS + "module":
                 self.ImportModule(child, survey)
             elif child.tag == XMLNS + "training_question":
                 self.ImportTrainingQuestion(child, survey)
+
+        for choice, condition in self.conditions:
+            for option_id in condition.split("|"):
+                if option_id in self.options:
+                    api.relation.create(
+                        source=choice,
+                        target=self.options[option_id],
+                        relationship="condition",
+                    )
         return survey
 
     def __call__(