Changes between Version 26 and Version 27 of WorkFlow

Timestamp:

Jan 31, 2006, 4:25:36 PM (18 years ago)

Author:

Alec Thomas

Comment:

Documented html_value option and added small manipulator example

WorkFlow

@@ -113 +113 @@
  * '''label''': Descriptive label.
  * '''value''': Default value.
+ * '''html_value''': This option is most useful to plugins. If it exists it is the content displayed instead of the normal '''value'''. This can be useful for fields with ticket ID's, to display the correct TracLinks for the tickets.
  * '''order''': Sort order placement. (Determines relative placement in forms.)
  * '''hidden''': Field is not displayed. Useful for storing extra ticket attributes programmatically (false by default).
@@ -134 +135 @@
    * cols: Width in columns.
    * rows: Height in lines.
+
+== Example Manipulator ==
+
+The following manipulator adds ''duplicate'' ticket closing with a reference to the duplicate, basically implementing #1395.
+
+{{{
+#!python
+class DuplicateField(Component):
+    """ Allow a ticket to be closed with a reference to a ticket ID that is a
+        duplicate. """
+
+    implements(ITicketManipulator, ITicketFieldProvider)
+
+    # ITicketFieldProvider methods
+    def get_custom_fields(self):
+        # 'duplicate' is where the duplicate ticket ID is stored
+        yield Text('duplicate', label='Duplicate of', hidden=True)
+
+    # ITicketManipulator methods
+    def filter_fields(self, req, ticket, fields):
+        # If ticket is closed as a duplicate, unhide the duplicate field
+        if ticket.values.get('status') == 'closed' and ticket.values.get('resolution') == 'duplicate':
+            for field in fields:
+                if field['name'] == 'duplicate':
+                    field['hidden'] = False
+                    field['html_value'] = wiki_to_oneliner('#' + field['value'], self.env)
+
+    def filter_actions(self, req, ticket, actions):
+        # Remove 'duplicate' option from resolve, and inject "duplicate of .." control
+        for idx, (action, label, controls) in enumerate(actions):
+            if action == 'resolve':
+                controls[0]['options'].remove('duplicate')
+                value = req.args.get('duplicate_of', ticket.values.get('duplicate'))
+                actions.insert(idx + 1, ('resolve_duplicate', 'duplicate',
+                               (Text('duplicate_of', label='of:', hidden=False,
+                                     value=value, title='Ticket ID that this is a duplicate of'),)))
+                break
+
+    def validate_ticket(self, req, ticket):
+        # If resolving as duplicate, update duplicate field
+        if req.args.get('action') == 'resolve_duplicate':
+            dup_id = req.args.get('duplicate_of', '')
+            if not dup_id:
+                raise TracError('Duplicate ticket ID not provided')
+            try:
+                duplicate = Ticket(self.env, int(dup_id))
+            except TracError:
+                raise TracError('Invalid duplicate ticket ID %s' % dup_id)
+            except:
+                raise TracError('Invalid duplicate ticket ID %s, must be an integer' % dup_id)
+            duplicate.save_changes(req.authname, '#%i has been marked as a ' \
+                                   'duplicate of this ticket' % ticket.id)
+            for field in ticket.fields:
+                if field['name'] == 'duplicate':
+                    req.args['duplicate'] = str(dup_id)
+            req.args['action'] = 'resolve'
+            req.args['resolve_resolution'] = 'duplicate'
+        elif req.args.get('action') == 'reopen':
+            ticket['duplicate'] = ''
+}}}