[patch] More graceful wiki page validation with req.warning

[hyuga <hyugaricdeau@…>]

This does away with the InvalidWikiPage exception entirely, and instead of raising an error upon finding the first invalid field, all page_manipulators are allowed to perform validation, and add warnings to req.warning. This was all warnings are displayed, and can also be displayed during preview, diff, and when trying to submit:

trac/wiki/web_ui.py

@@ -43 +43 @@
 from trac.wiki.model import WikiPage
 
 
-class InvalidWikiPage(TracError):
-    """Exception raised when a Wiki page fails validation."""
-
-
 class WikiModule(Component):
 
     implements(IContentConverter, INavigationContributor, IPermissionRequestor,
@@ -130 +126 @@
                     if a in req.args:
                         action = a
                         break
-                if action == 'edit' and not has_collision:
+                valid = self._validate(context)
+                if action == 'edit' and not has_collision and valid:
                     self._do_save(context)
                 else:
                     return self._render_editor(context, action, has_collision)
@@ -167 +164 @@
 
     # Internal methods
 
+    def _validate(self, context):
+        req = context.req
+        page = context.resource
+        
+        valid = True
+        # Give the manipulators a pass at post-processing the page
+        for manipulator in self.page_manipulators:
+            for field, message in manipulator.validate_wiki_page(req, page):
+                valid = False
+                if field:
+                    req.warning(_("The Wiki page field '%(field)s' is "
+                                  "invalid: %(message)s",
+                                  field=field, message=message))
+                else:
+                    req.warning(_("Invalid Wiki page: %(message)s",
+                                  message=message))
+        return valid
+
     def _page_data(self, context, action=''):
         page_name = context.name()
         title = context.summary()
@@ -253 +268 @@
             # WIKI_ADMIN
             page.readonly = int('readonly' in req.args)
 
-        # Give the manipulators a pass at post-processing the page
-        for manipulator in self.page_manipulators:
-            for field, message in manipulator.validate_wiki_page(req, page):
-                if field:
-                    raise InvalidWikiPage(_("The Wiki page field '%(field)s' "
-                                            "is invalid: %(message)s",
-                                            field=field, message=message))
-                else:
-                    raise InvalidWikiPage(_("Invalid Wiki page: %(message)s",
-                                            message=message))
-
         try:
             page.save(get_reporter_id(req, 'author'), req.args.get('comment'),
                       req.remote_addr)

[hyuga <hyugaricdeau@…>]

Same patch as displayed in the ticket description.

[ThurnerRupert]

could be applied immediately, no?

[ThurnerRupert]

i mean immediately after release :)

[cboos]

Looks like this was a missing bit of #152 / #4100 related functionality, so it would be nice to get in 0.11 itself for consistency.

ebray, can you please look into updating the patch?

[ebray <hyugaricdeau@…>]

Here's an updated version of the patch.

[ebray <hyugaricdeau@…>]

Here's an updated version of the patch (the previous version of this had a small typo).

[cboos]

Thanks for the updated patch!

[cboos]

Applied in r7033.

Only thing modified is that I left the InvalidWikiPage exception in, but marked it deprecated.

[cboos]

Oh, by the way, for testing the change I had to write a little IWikiPageManipulator plugin, and as I think it can be universally used, I'll donate it to the world:

from trac.core import *
from trac.wiki.api import IWikiPageManipulator

class NeedSpam(Component):
    """Enforce feeding the wiki comment with SPAM!"""

    implements(IWikiPageManipulator)

    # IWikiPageManipulator methods

    def prepare_wiki_page(self, req, page, fields):
        pass

    def validate_wiki_page(self, req, page):
        if 'spam' not in req.args.get('comment', ''):
            yield ('comment', 'No SPAM provided!')