Fixes duplicate form while replying to Comment

news/88.bugfix

@@ -0,0 +1 @@
+Fixed mishandling of dynamic form label updates - New Comment & Thread @rohnsha0

plone/app/discussion/browser/comments.pt

@@ -288,9 +288,18 @@
 
       <fieldset>
 
-        <legend i18n:translate="label_add_comment">Add comment</legend>
-
-        <p tal:content="view/comment_transform_message">
+        <legend class="comment-form-legend"
+                data-new-comment-text="Add a new comment"
+                data-reply-text="Reply here (this thread)"
+                i18n:translate="label_add_comment"
+        >Add a new comment</legend>
+
+        <p class="comment-form-description"
+           tal:content="view/comment_transform_message"
+           tal:attributes="
+             data-reply-html view/get_reply_transform_message;
+           "
+        >
                 You can add a comment by filling out the form below. Plain text
                 formatting.
         </p>
@@ -299,5 +308,76 @@
 
       </fieldset>
     </div>
+
+    <!-- JavaScript to handle dynamic form label updates -->
+    <script type="text/javascript">
+    (function() {
+        'use strict';
+
+        // Cache selectors for better performance
+        var REPLY_FORM_SELECTOR = '.reply';
+        var LEGEND_SELECTOR = '.comment-form-legend';
+        var DESCRIPTION_SELECTOR = '.comment-form-description';
+        var IN_REPLY_TO_SELECTOR = 'input[name*="in_reply_to"]';
+
+        // Update form labels for reply forms
+        function updateFormLabels(form) {
+            var legend = form.querySelector(LEGEND_SELECTOR);
+            var description = form.querySelector(DESCRIPTION_SELECTOR);
+            var inReplyToField = form.querySelector(IN_REPLY_TO_SELECTOR);
+            var isReply = inReplyToField && inReplyToField.value;
+
+            if (legend) {
+                legend.textContent = isReply && legend.dataset.replyText ?
+                    legend.dataset.replyText :
+                    legend.dataset.newCommentText || legend.textContent;
+            }
+
+            if (description) {
+                description.innerHTML = isReply && description.dataset.replyHtml ?
+                    description.dataset.replyHtml :
+                    description.textContent.trim();
+            }
+        }
+
+        // Process all reply forms
+        function processReplyForms() {
+            document.querySelectorAll(REPLY_FORM_SELECTOR).forEach(updateFormLabels);
+        }
+
+        // Initialize observer for dynamically added forms
+        function initObserver() {
+            var observer = new MutationObserver(function(mutations) {
+                mutations.forEach(function(mutation) {
+                    mutation.addedNodes.forEach(function(node) {
+                        if (node.nodeType === Node.ELEMENT_NODE) {
+                            // Check if this node is or contains a reply form
+                            var forms = node.matches && node.matches(REPLY_FORM_SELECTOR) ?
+                                [node] :
+                                (node.querySelectorAll ? Array.from(node.querySelectorAll(REPLY_FORM_SELECTOR)) : []);
+
+                            forms.forEach(updateFormLabels);
+                        }
+                    });
+                });
+            });
+
+            observer.observe(document.body, { childList: true, subtree: true });
+        }
+
+        // Initialize when DOM is ready
+        function init() {
+            processReplyForms();
+            initObserver();
+        }
+
+        if (document.readyState === 'loading') {
+            document.addEventListener('DOMContentLoaded', init);
+        } else {
+            init();
+        }
+    })();
+    </script>
+
   </div>
 </tal:block>

plone/app/discussion/browser/comments.py

@@ -53,6 +53,27 @@
     "transformed into clickable links.",
 )
 
+# New reply descriptions
+COMMENT_DESCRIPTION_PLAIN_TEXT_REPLY = _(
+    "comment_description_plain_text_reply",
+    default="You can reply to this comment by filling out the form below. "
+    "Plain text formatting.",
+)
+
+COMMENT_DESCRIPTION_MARKDOWN_REPLY = _(
+    "comment_description_markdown_reply",
+    default="You can reply to this comment by filling out the form below. "
+    "Plain text formatting. You can use the Markdown syntax for "
+    "links and images.",
+)
+
+COMMENT_DESCRIPTION_INTELLIGENT_TEXT_REPLY = _(
+    "comment_description_intelligent_text_reply",
+    default="You can reply to this comment by filling out the form below. "
+    "Plain text formatting. Web and email addresses are "
+    "transformed into clickable links.",
+)
+
 COMMENT_DESCRIPTION_MODERATION_ENABLED = _(
     "comment_description_moderation_enabled",
     default="Comments are moderated.",
@@ -62,7 +83,15 @@
 class CommentForm(extensible.ExtensibleForm, form.Form):
     ignoreContext = True  # don't use context to get widget data
     id = None
-    label = _("Add a comment")
+
+    @property
+    def label(self):
+        """Dynamic label based on whether this is a reply or new comment."""
+        if self.is_reply():
+            return _("Reply here (this thread)")
+        else:
+            return _("Add a new comment")
+
     fields = field.Fields(IComment).omit(
         "portal_type",
         "__parent__",
@@ -79,6 +108,11 @@ class CommentForm(extensible.ExtensibleForm, form.Form):
     # See https://github.com/plone/Products.CMFPlone/issues/3623
     enable_autofocus = False
 
+    def is_reply(self):
+        """Check if this form is being used to reply to an existing comment."""
+        in_reply_to = self.request.get("form.widgets.in_reply_to", None)
+        return bool(in_reply_to)
+
     def updateFields(self):
         super().updateFields()
         self.fields["user_notification"].widgetFactory = SingleCheckBoxFieldWidget
@@ -383,7 +417,7 @@ def comment_transform_message(self):
         registry = queryUtility(IRegistry)
         settings = registry.forInterface(IDiscussionSettings, check=False)
 
-        # text transform setting
+        # text transform setting - always use new comment descriptions for main form
         if settings.text_transform == "text/x-web-intelligent":
             message = translate(
                 Message(COMMENT_DESCRIPTION_INTELLIGENT_TEXT), context=self.request
@@ -417,6 +451,50 @@ def comment_transform_message(self):
 
         return message
 
+    def get_reply_transform_message(self):
+        """Returns the description for reply forms,
+        dependent on the text_transform setting and the comment moderation
+        workflow in the discussion control panel.
+        """
+        context = aq_inner(self.context)
+        registry = queryUtility(IRegistry)
+        settings = registry.forInterface(IDiscussionSettings, check=False)
+
+        # text transform setting - use reply descriptions
+        if settings.text_transform == "text/x-web-intelligent":
+            message = translate(
+                Message(COMMENT_DESCRIPTION_INTELLIGENT_TEXT_REPLY),
+                context=self.request,
+            )
+        elif settings.text_transform == "text/x-web-markdown":
+            message = translate(
+                Message(COMMENT_DESCRIPTION_MARKDOWN_REPLY), context=self.request
+            )
+        else:
+            message = translate(
+                Message(COMMENT_DESCRIPTION_PLAIN_TEXT_REPLY), context=self.request
+            )
+
+        # comment workflow
+        wftool = getToolByName(context, "portal_workflow", None)
+        workflow_chain = wftool.getChainForPortalType("Discussion Item")
+        if workflow_chain:
+            comment_workflow = workflow_chain[0]
+            comment_workflow = wftool[comment_workflow]
+            # check if the current workflow implements a pending state. If this
+            # is true comments are moderated
+            if "pending" in comment_workflow.states:
+                message = (
+                    message
+                    + " "
+                    + translate(
+                        Message(COMMENT_DESCRIPTION_MODERATION_ENABLED),
+                        context=self.request,
+                    )
+                )
+
+        return message
+
     def has_replies(self, workflow_actions=False):
         """Returns true if there are replies."""
         if self.get_replies(workflow_actions) is not None: