Changeset 3631

Timestamp:

05/07/08 21:05:24 (8 months ago)

Author:

retracile

Message:

AdvancedTicketWorkflowPlugin: Add a 'run_external' workflow operation. Bump the version number.

Files:

• advancedticketworkflowplugin/0.11/advancedworkflow/controller.py (modified) (3 diffs)
• advancedticketworkflowplugin/0.11/setup.py (modified) (1 diff)

advancedticketworkflowplugin/0.11/advancedworkflow/controller.py

@@ -3 +3 @@
-"""
-
+from subprocess import call
-from genshi.builder import tag
-
@@ -9 +10 @@
-from trac.ticket.api import ITicketActionController
-from trac.ticket.default_workflow import ConfigurableTicketWorkflow
-
-# TODO:
-#    set_owner_to_previous
-#    run_external
-
-
@@ -199 +196 @@
-            owner = ''
-        return owner
+
+
+class TicketWorkflowOpRunExternal(Component):
+    """Action to allow running an external command as a side-effect.
+
+    If it is a lengthy task, it should daemonize so the webserver can get back
+    to doing its thing.  If the script exits with a non-zero return code, an
+    error will be logged to the Trac log.
+
+    <someaction>.operations = run_external
+    <someaction>.run_external = echo "blah blah blah" >> /var/log/blah
+    <someaction>.run_external_hint = Clue the user in.
+
+    Don't forget to add the `TicketWorkflowOpRunExternal` to the workflow
+    option in [ticket].
+    If there is no workflow option, the line will look like this:
+
+    workflow = ConfigurableTicketWorkflow,TicketWorkflowOpRunExternal
+    """
+
+    implements(ITicketActionController)
+
+    # ITicketActionController methods
+
+    def get_ticket_actions(self, req, ticket):
+        """Finds the actions that use this operation"""
+        controller = ConfigurableTicketWorkflow(self.env)
+        return controller.get_actions_by_operation_for_req(req, ticket,
+                                                           'run_external')
+
+    def get_all_status(self):
+        """Provide any additional status values"""
+        # We don't have anything special here; the statuses will be recognized
+        # by the default controller.
+        return []
+
+    def render_ticket_action_control(self, req, ticket, action):
+        """Returns the action control"""
+        actions = ConfigurableTicketWorkflow(self.env).actions
+        label = actions[action]['name']
+        hint = self.config.get('ticket-workflow',
+                               action + '.run_external_hint').strip()
+        if hint is None:
+            hint = "Will run external script."
+        return (label, tag(''), hint)
+
+    def get_ticket_changes(self, req, ticket, action):
+        """No changes to the ticket"""
+        return {}
+
+    def apply_action_side_effects(self, req, ticket, action):
+        """Run the external script"""
+        script = self.config.get('ticket-workflow',
+                                action + '.run_external').strip()
+        retval = call(script, shell=True)
+        if retval:
+            self.env.log.error("External script %r exited with %s." % (script,
+                                                                       retval))

advancedticketworkflowplugin/0.11/setup.py

@@ -5 +5 @@
-setup(  
-        name='AdvancedTicketWorkflowPlugin',
-2
+3
-        author = 'Eli Carter',
-        author_email = 'elicarter@retracile.net',