making it easier to add new actions, and more docco

Author: Richard Jones

doc/customizing.txt

@@ -2,7 +2,7 @@
 Customising Roundup
 ===================
 
-:Version: $Revision: 1.39 $
+:Version: $Revision: 1.40 $
 
 .. This document borrows from the ZopeBook section on ZPT. The original is at:
    http://www.zope.org/Documentation/Books/ZopeBook/current/ZPT.stx
@@ -1872,6 +1872,25 @@ So now, if the edit attempts to set the assignedto to a user that doesn't have
 the "Fixer" Permission, the error will be raised.
 
 
+Setting up a "wizard" (or "druid") for controlled adding of issues
+------------------------------------------------------------------
+
+1. set up the page templates you wish to use for data input
+2. determine what actions need to be taken between the pages - these are
+   usually to validate user choices and determine what page is next
+3. encode those actions in methods on the interfaces Client class and insert
+   hooks to those actions in the "actions" attribute on that class, like so::
+
+    actions = client.Class.actions + (
+        ('page1_submit', page1SubmitAction),
+        ...
+    )
+
+    def page1SubmitAction(self):
+        # do the page 1 submit stuff, redirecting the user to the appropriate
+        # next page if necessary
+
+
 -------------------
 
 Back to `Table of Contents`_

roundup/cgi/client.py

@@ -1,4 +1,4 @@
-# $Id: client.py,v 1.33 2002-09-15 22:41:15 richard Exp $
+# $Id: client.py,v 1.34 2002-09-16 05:32:09 richard Exp $
 
 __doc__ = """
 WWW request handler (also used in the stand-alone server).
@@ -344,8 +344,8 @@ def renderTemplate(self, name, extension, **kwargs):
             # let the template render figure stuff out
             return pt.render(self, None, None, **kwargs)
         except PageTemplate.PTRuntimeError, message:
-            return '<strong>%s</strong><ol>%s</ol>'%(message,
-                '<li>'.join(pt._v_errors))
+            return '<strong>%s</strong><ol><li>%s</ol>'%(message,
+                '<li>'.join([cgi.escape(x) for x in pt._v_errors]))
         except NoTemplate, message:
             return '<strong>%s</strong>'%message
         except:
@@ -369,21 +369,21 @@ def content(self):
         return self.renderTemplate(self.classname, self.template)
 
     # these are the actions that are available
-    actions = {
-        'edit':     'editItemAction',
-        'editCSV':  'editCSVAction',
-        'new':      'newItemAction',
-        'register': 'registerAction',
-        'login':    'loginAction',
-        'logout':   'logout_action',
-        'search':   'searchAction',
-    }
+    actions = (
+        ('edit',     'editItemAction'),
+        ('editCSV',  'editCSVAction'),
+        ('new',      'newItemAction'),
+        ('register', 'registerAction'),
+        ('login',    'loginAction'),
+        ('logout',   'logout_action'),
+        ('search',   'searchAction'),
+    )
     def handle_action(self):
         ''' Determine whether there should be an _action called.
 
             The action is defined by the form variable :action which
             identifies the method on this object to call. The four basic
-            actions are defined in the "actions" dictionary on this class:
+            actions are defined in the "actions" sequence on this class:
              "edit"      -> self.editItemAction
              "new"       -> self.newItemAction
              "register"  -> self.registerAction
@@ -397,11 +397,14 @@ def handle_action(self):
         try:
             # get the action, validate it
             action = self.form[':action'].value
-            if not self.actions.has_key(action):
+            for name, method in selc.actions:
+                if name == action:
+                    break
+            else:
                 raise ValueError, 'No such action "%s"'%action
 
             # call the mapped action
-            getattr(self, self.actions[action])()
+            getattr(self, method)()
         except Redirect:
             raise
         except Unauthorised:

roundup/cgi/templating.py

@@ -173,7 +173,7 @@ def render(self, client, classname, request, **options):
 
         if self._v_errors:
             raise PageTemplate.PTRuntimeError, \
-                'Page Template %s has errors.' % self.id
+                'Page Template %s has errors.'%self.id
 
         # figure the context
         classname = classname or client.classname