Ticket #2706: tracdiscussion-anti-spam-patch.diff

setup.py

@@ -14 +14 @@
-    'TracDiscussion.timeline = tracdiscussion.timeline',
-    'TracDiscussion.admin = tracdiscussion.admin',
-    'TracDiscussion.search = tracdiscussion.search',
+    'TracDiscussion.spam = tracdiscussion.spam',
-    'TracDiscussion.notification = tracdiscussion.notification']},
-  install_requires = ['TracWebAdmin'],
-  keywords = 'trac discussion',

tracdiscussion/core.py

@@ -17 +17 @@
-    implements(INavigationContributor, IRequestHandler, ITemplateProvider,
-      IPermissionRequestor)
-
+    discussion_manipulators = ExtensionPoint(IDiscussionManipulator)
+
-    title = Option('discussion', 'title', 'Discussion',
-      'Main navigation bar button title.')
-

tracdiscussion/api.py

@@ -9 +9 @@
-from trac.util.text import to_unicode
-import time
-
+class InvalidDiscussionPost(TracError):
+    """Exception raised when a ticket fails validation."""
+
+class IDiscussionManipulator(Interface):
+    """Miscellaneous manipulation of forum posts."""
+
+    def validate_message(self, req, author, body):
+        """Validate a new message post in a topic.
+
+        Must return a list of `(field, message)` tuples, one for each problem
+        detected. `field` can be `None` to indicate an overall problem with the
+        ticket. Therefore, a return value of `[]` means everything is OK."""
+
+    def validate_topic(self, req, author, subject, body):
+        """Validate a new topic.
+
+        Must return a list of `(field, message)` tuples, one for each problem
+        detected. `field` can be `None` to indicate an overall problem with the
+        ticket. Therefore, a return value of `[]` means everything is OK."""
+
+
-class DiscussionApi(object):
-    def __init__(self, component, req):
-        self.env = component.env
-        self.log = component.log
+        self.discussion_manipulators = component.discussion_manipulators
-
-    # Main request processing function
-
@@ -531 +553 @@
-                new_author = req.args.get('author')
-                new_body = req.args.get('body')
-                new_time = int(time.time())
+                for manipulator in self.discussion_manipulators:
+                    for field, message in manipulator.validate_topic(req, new_author, new_subject, new_body):
+                        if field:
+                            raise InvalidDiscussionPost("The field %s in message is invalid: %s" %
+                                                (field, message))
+                        else:
+                            raise InvalidDiscussionPost("Invalid post: %s" % message)
-
-                # Add topic.
-                self.add_topic(cursor, forum['id'], new_subject, new_time,
@@ -641 +670 @@
-                new_author = req.args.get('author')
-                new_body = req.args.get('body')
-                new_time = int(time.time())
+                # Custom validation rules
+                for manipulator in self.discussion_manipulators:
+                    for field, message in manipulator.validate_message(req, new_author, new_body):
+                        if field:
+                            raise InvalidDiscussionPost("The field %s in message is invalid: %s" %
+                                                (field, message))
+                        else:
+                            raise InvalidDiscussionPost("Invalid post: %s" % message)
-
-                # Add message.
-                if message: