Add Related Actions.

A related action can be attached to a job. It is shown to the user as a button on the form view of the jobs.
When the button is used, the related action is called and must return an OpenERP "client action".

Examples of related actions:
* Open the form view of the record that is concerned by the job.
* Open a browser on the URL of the record on an external system.

Author: guewen

connector/CHANGES.rst

@@ -7,6 +7,7 @@ Changelog
 * Job arguments can now contain unicode strings (thanks to Stéphane Bidoul) lp:1288187
 * List view of the jobs improved
 * Jobs now support multicompany (thanks to Laurent Mignon) https://lists.launchpad.net/openerp-connector-community/msg00253.html)
+* An action can be assigned to a job.  The action is called with a button on the job and could be something like open a form view or an url.
 
 2.1.1 (2014-02-06)
 ~~~~~~~~~~~~~~~~~~

connector/connector.py

@@ -304,3 +304,22 @@ def bind(self, external_id, binding_id):
         :type binding_id: int
         """
         raise NotImplementedError
+
+    def unwrap_binding(self, binding_id, browse=False):
+        """ For a binding record, gives the normal record.
+
+        Example: when called with a ``magento.product.product`` id,
+        it will return the corresponding ``product.product`` id.
+
+        :param browse: when True, returns a browse_record instance
+                       rather than an ID
+        """
+        raise NotImplementedError
+
+    def unwrap_model(self):
+        """ For a binding model, gives the normal model.
+
+        Example: when called on a binder for ``magento.product.product``,
+        it will return ``product.product``.
+        """
+        raise NotImplementedError

connector/queue/job.py

@@ -19,10 +19,11 @@
 #
 ##############################################################################
 
-import sys
-import logging
 import inspect
+import functools
+import logging
 import uuid
+import sys
 from datetime import datetime, timedelta, MINYEAR
 from pickle import loads, dumps, UnpicklingError
 
@@ -598,6 +599,11 @@ def postpone(self, result=None, seconds=None):
         if result is not None:
             self.result = result
 
+    def related_action(self, session):
+        if not hasattr(self.func, 'related_action'):
+            return None
+        return self.func.related_action(session, self)
+
 
 def job(func):
     """ Decorator for jobs.
@@ -630,7 +636,7 @@ def job(func):
                     infinite retries. Default is 5.
      * eta: the job can be executed only after this datetime
             (or now + timedelta if a timedelta or integer is given)
-     
+
      * description : a human description of the job,
                      intended to discriminate job instances
                      (Default is the func.__doc__ or 'Function %s' % func.__name__)
@@ -655,6 +661,9 @@ def export_one_thing(session, model_name, one_thing):
         # => the job will be executed with a low priority and not before a
         # delay of 5 hours from now
 
+    See also: :py:func:`related_action` a related action can be attached
+    to a job
+
     """
     def delay(session, model_name, *args, **kwargs):
         """Enqueue the function. Return the uuid of the created job."""
@@ -665,3 +674,61 @@ def delay(session, model_name, *args, **kwargs):
             **kwargs)
     func.delay = delay
     return func
+
+
+def related_action(action=lambda session, job: None, **kwargs):
+    """ Attach a *Related Action* to a job.
+
+    A *Related Action* will appear as a button on the OpenERP view.
+    The button will execute the action, usually it will open the
+    form view of the record related to the job.
+
+    The ``action`` must be a callable that responds to arguments::
+
+        session, job, **kwargs
+
+    Example usage:
+
+    .. code-block:: python
+
+        def related_action_partner(session, job):
+            model = job.args[0]
+            partner_id = job.args[1]
+            # eventually get the real ID if partner_id is a binding ID
+            action = {
+                'name': _("Partner"),
+                'type': 'ir.actions.act_window',
+                'res_model': model,
+                'view_type': 'form',
+                'view_mode': 'form',
+                'res_id': partner_id,
+            }
+            return action
+
+        @job
+        @related_action(action=related_action_partner)
+        def export_partner(session, model_name, partner_id):
+            # ...
+
+    The kwargs are transmitted to the action:
+
+    .. code-block:: python
+
+        def related_action_product(session, job, extra_arg=1):
+            assert extra_arg == 2
+            model = job.args[0]
+            product_id = job.args[1]
+
+        @job
+        @related_action(action=related_action_product, extra_arg=2)
+        def export_product(session, model_name, product_id):
+            # ...
+
+    """
+    def decorate(func):
+        if kwargs:
+            func.related_action = functools.partial(action, **kwargs)
+        else:
+            func.related_action = action
+        return func
+    return decorate

connector/queue/model.py

@@ -80,6 +80,22 @@ class QueueJob(orm.Model):
         'active': True,
     }
 
+    def open_related_action(self, cr, uid, ids, context=None):
+        """ Open the related action associated to the job """
+        if hasattr(ids, '__iter__'):
+            assert len(ids) == 1, "1 ID expected, got %s" % ids
+            ids = ids[0]
+        session = ConnectorSession(cr, uid, context=context)
+        storage = OpenERPJobStorage(session)
+        job = self.browse(cr, uid, ids, context=context)
+        job = storage.load(job.uuid)
+        action = job.related_action(session)
+        if action is None:
+            raise orm.except_orm(
+                _('Error'),
+                _('No action available for this job'))
+        return action
+
     def _change_job_state(self, cr, uid, ids, state, result=None, context=None):
         """ Change the state of the `Job` object itself so it
         will change the other fields (date, result, ...)

connector/queue/model_view.xml

@@ -66,6 +66,10 @@
                             string="Set to 'Done'"
                             type="object"
                             groups="connector.group_connector_manager"/>
+                        <button name="open_related_action"
+                            string="Related"
+                            type="object"
+                            />
                         <field name="state"
                             widget="statusbar"
                             statusbar_visible="pending,enqueued,started,done"

connector/related_action.py

@@ -0,0 +1,75 @@
+# -*- coding: utf-8 -*-
+##############################################################################
+#
+#    Author: Guewen Baconnier
+#    Copyright 2014 Camptocamp SA
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU Affero General Public License as
+#    published by the Free Software Foundation, either version 3 of the
+#    License, or (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU Affero General Public License for more details.
+#
+#    You should have received a copy of the GNU Affero General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+##############################################################################
+
+"""
+Related Actions
+
+Related actions are associated with jobs.
+When called on a job, they will return an action to the client.
+
+"""
+
+from openerp.tools.translate import _
+from .connector import Environment, Binder
+
+
+def unwrap_binding(session, job, id_pos=2, binder_class=Binder):
+    """ Open a form view with the unwrapped record.
+
+    For instance, for a job on a ``magento.product.product``,
+    it will open a ``product.product`` form view with the unwrapped
+    record.
+
+    :param id_pos: position of the binding ID in the args
+    :param binder_class: base class to search for the binder
+    """
+    binding_model = job.args[0]
+    # shift one to the left because session is not in job.args
+    binding_id = job.args[id_pos - 1]
+    action = {
+        'name': _('Related Record'),
+        'type': 'ir.actions.act_window',
+        'view_type': 'form',
+        'view_mode': 'form',
+    }
+    # try to get an unwrapped record
+    binding = session.browse(binding_model, binding_id)
+    if not binding.exists():
+        # it has been deleted
+        return None
+    env = Environment(binding.backend_id, session, binding_model)
+    binder = env.get_connector_unit(binder_class)
+    try:
+        model = binder.unwrap_model()
+        record_id = binder.unwrap_binding(binding_id)
+    except ValueError:
+        # the binding record will be displayed
+        action.update({
+            'res_model': binding_model,
+            'res_id': binding_id,
+        })
+    else:
+        # the unwrapped record will be displayed
+        action.update({
+            'res_model': model,
+            'res_id': record_id,
+        })
+    return action

connector/session.py

@@ -138,7 +138,7 @@ def change_context(self, values):
         :param values: values to apply on the context
         :type values: dict
         """
-        original_context = self._context
+        original_context = self.context
         self._context = original_context.copy()
         self._context.update(values)
         yield

connector/tests/__init__.py

@@ -28,6 +28,7 @@
 import test_producer
 import test_connector
 import test_mapper
+import test_related_action
 
 fast_suite = [
 ]
@@ -42,4 +43,5 @@
     test_producer,
     test_connector,
     test_mapper,
+    test_related_action,
 ]