feat: custom exporter for comments and tests

Author: erral

src/collective/exportimport/configure.zcml

@@ -147,6 +147,7 @@
   <adapter factory=".serializer.ChoiceFieldSerializer" />
   <adapter factory=".serializer.long_converter" />
   <adapter factory=".serializer.ExportingBlocksJSONFieldSerializer" />
+  <adapter zcml:condition="installed plone.app.discussion" factory=".serializer.CommentSerializer" />
 
   <!-- Deserializers -->
   <adapter factory=".deserializer.RichTextFieldDeserializerWithoutUnescape" />

src/collective/exportimport/export_other.py

@@ -3,6 +3,7 @@
 from App.config import getConfiguration
 from collective.exportimport import _
 from collective.exportimport import config
+from collective.exportimport.interfaces import IMigrationMarker
 from OFS.interfaces import IOrderedContainer
 from operator import itemgetter
 from plone import api
@@ -30,6 +31,7 @@
 from zope.component import getUtility
 from zope.component import queryMultiAdapter
 from zope.component import queryUtility
+from zope.interface import alsoProvides
 from zope.interface import providedBy
 
 import json
@@ -602,7 +604,8 @@ def get_default_page_info(self, obj):
 
     class ExportDiscussion(BaseExport):
         def __call__(self, download_to_server=False):
-            self.title = _(u"Export comments")
+            alsoProvides(self.request, IMigrationMarker)
+            self.title = _("Export comments")
             self.download_to_server = download_to_server
             if not self.request.form.get("form.submitted", False):
                 return self.index()

src/collective/exportimport/import_other.py

@@ -635,10 +635,10 @@ def import_data(self, data):
                 conversation = IConversation(obj)
 
                 for item in conversation_data["conversation"]["items"]:
-                    if isinstance(item["text"], dict) and item["text"].get("mime-type"):
-                        item["mime-type"] = item["text"]["mime-type"]
                     if isinstance(item["text"], dict) and item["text"].get("data"):
                         item["text"] = item["text"]["data"]
+                    if isinstance(item["text"], dict) and item["text"].get("mime-type"):
+                        item["mime-type"] = item["text"]["mime-type"]
 
                     comment = Comment()
                     comment_id = int(item["comment_id"])
@@ -655,7 +655,7 @@ def import_data(self, data):
                         .replace(u"\r<br />", u"\r\n")
                         .replace(u"<br />", u"\r\n")
                     )
-                    comment.mime_type = item.get("mime-type", None)
+                    comment.mime_type = item.get("mime-type", "text/html")
 
                     if item["user_notification"]:
                         comment.user_notification = True

src/collective/exportimport/serializer.py

@@ -61,6 +61,13 @@
 else:
     HAS_PAC = True
 
+try:
+    pkg_resources.get_distribution("plone.app.discussion")
+except pkg_resources.DistributionNotFound:
+    HAS_PAD = False
+else:
+    HAS_PAD = True
+
 
 FILE_SIZE_WARNING = 10000000
 IMAGE_SIZE_WARNING = 5000000
@@ -586,6 +593,22 @@ def fix_criteria(self, criterion):
             return query
 
 
+if HAS_PAD:
+    from plone.app.discussion.interfaces import IComment
+    from plone.restapi.interfaces import ISerializeToJson
+    from plone.restapi.serializer.discussion import CommentSerializer as Base
+
+    @implementer(ISerializeToJson)
+    @adapter(IComment, IMigrationMarker)
+    class CommentSerializer(Base):
+
+        def __call__(self, include_items=True):
+            data = super().__call__(include_items)
+            data["text"]["data"] = self.context.text
+            data["text"]["mime-type"] = self.context.mime_type
+            return data
+
+
 def get_dx_blob_path(obj):
     return get_blob_path(obj._blob)
 

src/collective/exportimport/tests/test_export.py

@@ -527,8 +527,26 @@ def test_export_discussion(self):
         )
         conversation = IConversation(doc1)
         comment = createObject("plone.Comment")
-        comment.text = u"Comment text"
+        comment.text = "Comment text"
+
+        comment_html = createObject("plone.Comment")
+        comment_html.text = "Comment text <strong>with HTML</strong>"
+        comment_html.mime_type = "text/html"
+
+        comment_intelligent_text = createObject("plone.Comment")
+        comment_intelligent_text.text = "Comment text with link https://plone.org"
+        comment_intelligent_text.mime_type = "text/x-web-intelligent"
+
+        comment_markdown = createObject("plone.Comment")
+        comment_markdown.text = (
+            "Comment text with link [Link to Plone](https://plone.org)"
+        )
+        comment_markdown.mime_type = "text/x-web-markdown"
+
         conversation.addComment(comment)
+        conversation.addComment(comment_html)
+        conversation.addComment(comment_intelligent_text)
+        conversation.addComment(comment_markdown)
         transaction.commit()
 
         browser = self.open_page("@@export_discussion")
@@ -538,9 +556,36 @@ def test_export_discussion(self):
             contents = DATA[-1]
         data = json.loads(contents)
         self.assertEqual(data[0]["uuid"], doc1.UID())
+
         self.assertEqual(
             data[0]["conversation"]["items"][0]["text"]["data"], "Comment text"
         )
+        self.assertEqual(
+            data[0]["conversation"]["items"][0]["text"]["mime-type"], "text/plain"
+        )
+        self.assertEqual(
+            data[0]["conversation"]["items"][1]["text"]["data"],
+            "Comment text <strong>with HTML</strong>",
+        )
+        self.assertEqual(
+            data[0]["conversation"]["items"][1]["text"]["mime-type"], "text/html"
+        )
+        self.assertEqual(
+            data[0]["conversation"]["items"][2]["text"]["data"],
+            "Comment text with link https://plone.org",
+        )
+        self.assertEqual(
+            data[0]["conversation"]["items"][2]["text"]["mime-type"],
+            "text/x-web-intelligent",
+        )
+        self.assertEqual(
+            data[0]["conversation"]["items"][3]["text"]["data"],
+            "Comment text with link [Link to Plone](https://plone.org)",
+        )
+        self.assertEqual(
+            data[0]["conversation"]["items"][3]["text"]["mime-type"],
+            "text/x-web-markdown",
+        )
 
     def test_export_ordering(self):
         # First create some content.