Initial commit

env/lib/python3.10/site-packages/wagtail/admin/forms/comments.py

@@ -0,0 +1,87 @@
+from django.forms import BooleanField, ValidationError
+from django.utils.timezone import now
+from django.utils.translation import gettext as _
+from modelcluster.forms import BaseChildFormSet
+
+from .models import WagtailAdminModelForm
+
+
+class CommentReplyForm(WagtailAdminModelForm):
+    class Meta:
+        fields = ("text",)
+
+    def clean(self):
+        cleaned_data = super().clean()
+        user = self.for_user
+
+        if not self.instance.pk:
+            self.instance.user = user
+        elif self.instance.user != user:
+            # trying to edit someone else's comment reply
+            if any(field for field in self.changed_data):
+                # includes DELETION_FIELD_NAME, as users cannot delete each other's individual comment replies
+                # if deleting a whole thread, this should be done by deleting the parent Comment instead
+                self.add_error(
+                    None, ValidationError(_("You cannot edit another user's comment."))
+                )
+        return cleaned_data
+
+
+class CommentForm(WagtailAdminModelForm):
+    """
+    This is designed to be subclassed and have the user overridden to enable user-based validation within the edit handler system
+    """
+
+    resolved = BooleanField(required=False)
+
+    class Meta:
+        formsets = {
+            "replies": {
+                "form": CommentReplyForm,
+                "inherit_kwargs": ["for_user"],
+            }
+        }
+
+    def clean(self):
+        cleaned_data = super().clean()
+        user = self.for_user
+
+        if not self.instance.pk:
+            self.instance.user = user
+        elif self.instance.user != user:
+            # trying to edit someone else's comment
+            if (
+                any(
+                    field
+                    for field in self.changed_data
+                    if field not in ["resolved", "position", "contentpath"]
+                )
+                or cleaned_data["contentpath"].split(".")[0]
+                != self.instance.contentpath.split(".")[0]
+            ):
+                # users can resolve each other's base comments and change their positions within a field, or move a comment between blocks in a StreamField
+                self.add_error(
+                    None, ValidationError(_("You cannot edit another user's comment."))
+                )
+        return cleaned_data
+
+    def save(self, *args, **kwargs):
+        if self.cleaned_data.get("resolved", False):
+            if not getattr(self.instance, "resolved_at"):
+                self.instance.resolved_at = now()
+                self.instance.resolved_by = self.for_user
+        else:
+            self.instance.resolved_by = None
+            self.instance.resolved_at = None
+        return super().save(*args, **kwargs)
+
+
+class CommentFormSet(BaseChildFormSet):
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        valid_comment_ids = [
+            comment.id
+            for comment in self.queryset
+            if comment.has_valid_contentpath(self.instance)
+        ]
+        self.queryset = self.queryset.filter(id__in=valid_comment_ids)