[REF] Merge a refactoring of the workflow (lp:~openerp-dev/openobject-server/trunk-refactor-workflow-stw)

bzr revid: [email protected]

Author: Stephane Wirtel

openerp/workflow/__init__.py

@@ -1,8 +1,8 @@
 # -*- coding: utf-8 -*-
 ##############################################################################
-#    
+#
 #    OpenERP, Open Source Management Solution
-#    Copyright (C) 2004-2009 Tiny SPRL (<http://tiny.be>).
+#    Copyright (C) 2004-2014 Tiny SPRL (<http://tiny.be>).
 #
 #    This program is free software: you can redistribute it and/or modify
 #    it under the terms of the GNU Affero General Public License as
@@ -15,16 +15,17 @@
 #    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/>.     
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 ##############################################################################
 
-import instance
+from openerp.workflow.service import WorkflowService
 
-wkf_on_create_cache = {}
+# The new API is in openerp.workflow.workflow_service
+# OLD API of the Workflow
 
 def clear_cache(cr, uid):
-    wkf_on_create_cache[cr.dbname]={}
+    WorkflowService.clear_cache(cr.dbname)
 
 def trg_write(uid, res_type, res_id, cr):
     """
@@ -36,10 +37,7 @@ def trg_write(uid, res_type, res_id, cr):
     :param res_id: the model instance id the workflow belongs to
     :param cr: a database cursor
     """
-    ident = (uid,res_type,res_id)
-    cr.execute('select id from wkf_instance where res_id=%s and res_type=%s and state=%s', (res_id or None,res_type or None, 'active'))
-    for (id,) in cr.fetchall():
-        instance.update(cr, id, ident)
+    return WorkflowService.new(cr, uid, res_type, res_id).write()
 
 def trg_trigger(uid, res_type, res_id, cr):
     """
@@ -52,12 +50,7 @@ def trg_trigger(uid, res_type, res_id, cr):
     :param res_id: the model instance id the workflow belongs to
     :param cr: a database cursor
     """
-    cr.execute('select instance_id from wkf_triggers where res_id=%s and model=%s', (res_id,res_type))
-    res = cr.fetchall()
-    for (instance_id,) in res:
-        cr.execute('select %s,res_type,res_id from wkf_instance where id=%s', (uid, instance_id,))
-        ident = cr.fetchone()
-        instance.update(cr, instance_id, ident)
+    return WorkflowService.new(cr, uid, res_type, res_id).trigger()
 
 def trg_delete(uid, res_type, res_id, cr):
     """
@@ -67,8 +60,7 @@ def trg_delete(uid, res_type, res_id, cr):
     :param res_id: the model instance id the workflow belongs to
     :param cr: a database cursor
     """
-    ident = (uid,res_type,res_id)
-    instance.delete(cr, ident)
+    return WorkflowService.new(cr, uid, res_type, res_id).delete()
 
 def trg_create(uid, res_type, res_id, cr):
     """
@@ -78,16 +70,7 @@ def trg_create(uid, res_type, res_id, cr):
     :param res_id: the model instance id to own the created worfklow instance
     :param cr: a database cursor
     """
-    ident = (uid,res_type,res_id)
-    wkf_on_create_cache.setdefault(cr.dbname, {})
-    if res_type in wkf_on_create_cache[cr.dbname]:
-        wkf_ids = wkf_on_create_cache[cr.dbname][res_type]
-    else:
-        cr.execute('select id from wkf where osv=%s and on_create=True', (res_type,))
-        wkf_ids = cr.fetchall()
-        wkf_on_create_cache[cr.dbname][res_type] = wkf_ids
-    for (wkf_id,) in wkf_ids:
-        instance.create(cr, ident, wkf_id)
+    return WorkflowService.new(cr, uid, res_type, res_id).create()
 
 def trg_validate(uid, res_type, res_id, signal, cr):
     """
@@ -98,14 +81,8 @@ def trg_validate(uid, res_type, res_id, signal, cr):
     :signal: the signal name to be fired
     :param cr: a database cursor
     """
-    result = False
-    ident = (uid,res_type,res_id)
-    # ids of all active workflow instances for a corresponding resource (id, model_nam)
-    cr.execute('select id from wkf_instance where res_id=%s and res_type=%s and state=%s', (res_id, res_type, 'active'))
-    for (id,) in cr.fetchall():
-        res2 = instance.validate(cr, id, ident, signal)
-        result = result or res2
-    return result
+    assert isinstance(signal, basestring)
+    return WorkflowService.new(cr, uid, res_type, res_id).validate(signal)
 
 def trg_redirect(uid, res_type, res_id, new_rid, cr):
     """
@@ -120,22 +97,7 @@ def trg_redirect(uid, res_type, res_id, new_rid, cr):
     :param new_rid: the model instance id to own the worfklow instance
     :param cr: a database cursor
     """
-    # get ids of wkf instances for the old resource (res_id)
-#CHECKME: shouldn't we get only active instances?
-    cr.execute('select id, wkf_id from wkf_instance where res_id=%s and res_type=%s', (res_id, res_type))
-    for old_inst_id, wkf_id in cr.fetchall():
-        # first active instance for new resource (new_rid), using same wkf
-        cr.execute(
-            'SELECT id '\
-            'FROM wkf_instance '\
-            'WHERE res_id=%s AND res_type=%s AND wkf_id=%s AND state=%s', 
-            (new_rid, res_type, wkf_id, 'active'))
-        new_id = cr.fetchone()
-        if new_id:
-            # select all workitems which "wait" for the old instance
-            cr.execute('select id from wkf_workitem where subflow_id=%s', (old_inst_id,))
-            for (item_id,) in cr.fetchall():
-                # redirect all those workitems to the wkf instance of the new resource
-                cr.execute('update wkf_workitem set subflow_id=%s where id=%s', (new_id[0], item_id))
+    assert isinstance(new_rid, (long, int))
+    return WorkflowService.new(cr, uid, res_type, res_id).redirect(new_rid)
 
 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4:

openerp/workflow/helpers.py

@@ -0,0 +1,22 @@
+import openerp.sql_db
+
+class Session(object):
+    def __init__(self, cr, uid):
+        assert isinstance(cr, openerp.sql_db.Cursor)
+        assert isinstance(uid, (int, long))
+        self.cr = cr
+        self.uid = uid
+
+class Record(object):
+    def __init__(self, model, record_id):
+        assert isinstance(model, basestring)
+        assert isinstance(record_id, (int, long))
+        self.model = model
+        self.id = record_id
+
+class WorkflowActivity(object):
+    KIND_FUNCTION = 'function'
+    KIND_DUMMY = 'dummy'
+    KIND_STOPALL = 'stopall'
+    KIND_SUBFLOW = 'subflow'
+

openerp/workflow/instance.py

@@ -2,7 +2,7 @@
 ##############################################################################
 #
 #    OpenERP, Open Source Management Solution
-#    Copyright (C) 2004-2009 Tiny SPRL (<http://tiny.be>).
+#    Copyright (C) 2004-2014 Tiny SPRL (<http://tiny.be>).
 #
 #    This program is free software: you can redistribute it and/or modify
 #    it under the terms of the GNU Affero General Public License as
@@ -19,58 +19,115 @@
 #
 ##############################################################################
 import workitem
+from openerp.workflow.helpers import Session
+from openerp.workflow.helpers import Record
+from openerp.workflow.workitem import WorkflowItem
 
-def create(cr, ident, wkf_id):
-    (uid,res_type,res_id) = ident
-    cr.execute('insert into wkf_instance (res_type,res_id,uid,wkf_id) values (%s,%s,%s,%s) RETURNING id', (res_type,res_id,uid,wkf_id))
-    id_new = cr.fetchone()[0]
-    cr.execute('select * from wkf_activity where flow_start=True and wkf_id=%s', (wkf_id,))
-    res = cr.dictfetchall()
-    stack = []
-    workitem.create(cr, res, id_new, ident, stack=stack)
-    update(cr, id_new, ident)
-    return id_new
-
-def delete(cr, ident):
-    (uid,res_type,res_id) = ident
-    cr.execute('delete from wkf_instance where res_id=%s and res_type=%s', (res_id,res_type))
-
-def validate(cr, inst_id, ident, signal, force_running=False):
-    cr.execute("select * from wkf_workitem where inst_id=%s", (inst_id,))
-    stack = []
-    for witem in cr.dictfetchall():
+class WorkflowInstance(object):
+    def __init__(self, session, record, values):
+        assert isinstance(session, Session)
+        assert isinstance(record, Record)
+        self.session = session
+        self.record = record
+
+        if not values:
+            values = {}
+
+        assert isinstance(values, dict)
+        self.instance = values
+
+    @classmethod
+    def create(cls, session, record, workflow_id):
+        assert isinstance(session, Session)
+        assert isinstance(record, Record)
+        assert isinstance(workflow_id, (int, long))
+
+        cr = session.cr
+        cr.execute('insert into wkf_instance (res_type,res_id,uid,wkf_id) values (%s,%s,%s,%s) RETURNING id', (record.model, record.id, session.uid, workflow_id))
+        instance_id = cr.fetchone()[0]
+
+        cr.execute('select * from wkf_activity where flow_start=True and wkf_id=%s', (workflow_id,))
         stack = []
-        workitem.process(cr, witem, ident, signal, force_running, stack=stack)
-        # An action is returned
-    _update_end(cr, inst_id, ident)
-    return stack and stack[0] or False
-
-def update(cr, inst_id, ident):
-    cr.execute("select * from wkf_workitem where inst_id=%s", (inst_id,))
-    for witem in cr.dictfetchall():
+
+        activities = cr.dictfetchall()
+        for activity in activities:
+            WorkflowItem.create(session, record, activity, instance_id, stack)
+
+        cr.execute('SELECT * FROM wkf_instance WHERE id = %s', (instance_id,))
+        values = cr.dictfetchone()
+        wi = WorkflowInstance(session, record, values)
+        wi.update()
+
+        return wi
+
+    def delete(self):
+        self.session.cr.execute('delete from wkf_instance where res_id=%s and res_type=%s', (self.record.id, self.record.model))
+
+    def validate(self, signal, force_running=False):
+        assert isinstance(signal, basestring)
+        assert isinstance(force_running, bool)
+
+        cr = self.session.cr
+        cr.execute("select * from wkf_workitem where inst_id=%s", (self.instance['id'],))
         stack = []
-        workitem.process(cr, witem, ident, stack=stack)
-    return _update_end(cr, inst_id, ident)
-
-def _update_end(cr, inst_id, ident):
-    cr.execute('select wkf_id from wkf_instance where id=%s', (inst_id,))
-    wkf_id = cr.fetchone()[0]
-    cr.execute('select state,flow_stop from wkf_workitem w left join wkf_activity a on (a.id=w.act_id) where w.inst_id=%s', (inst_id,))
-    ok=True
-    for r in cr.fetchall():
-        if (r[0]<>'complete') or not r[1]:
-            ok=False
-            break
-    if ok:
-        cr.execute('select distinct a.name from wkf_activity a left join wkf_workitem w on (a.id=w.act_id) where w.inst_id=%s', (inst_id,))
-        act_names = cr.fetchall()
-        cr.execute("update wkf_instance set state='complete' where id=%s", (inst_id,))
-        cr.execute("update wkf_workitem set state='complete' where subflow_id=%s", (inst_id,))
-        cr.execute("select i.id,w.osv,i.res_id from wkf_instance i left join wkf w on (i.wkf_id=w.id) where i.id IN (select inst_id from wkf_workitem where subflow_id=%s)", (inst_id,))
-        for i in cr.fetchall():
-            for act_name in act_names:
-                validate(cr, i[0], (ident[0],i[1],i[2]), 'subflow.'+act_name[0])
-    return ok
+        for work_item_values in cr.dictfetchall():
+            wi = WorkflowItem(self.session, self.record, work_item_values)
+            wi.process(signal=signal, force_running=force_running, stack=stack)
+            # An action is returned
+        self._update_end()
+        return stack and stack[0] or False
+
+    def update(self):
+        cr = self.session.cr
+
+        cr.execute("select * from wkf_workitem where inst_id=%s", (self.instance['id'],))
+        for work_item_values in cr.dictfetchall():
+            stack = []
+            WorkflowItem(self.session, self.record, work_item_values).process(stack=stack)
+        return self._update_end()
+
+    def _update_end(self):
+        cr = self.session.cr
+        instance_id = self.instance['id']
+        cr.execute('select wkf_id from wkf_instance where id=%s', (instance_id,))
+        wkf_id = cr.fetchone()[0]
+        cr.execute('select state,flow_stop from wkf_workitem w left join wkf_activity a on (a.id=w.act_id) where w.inst_id=%s', (instance_id,))
+        ok=True
+        for r in cr.fetchall():
+            if (r[0]<>'complete') or not r[1]:
+                ok=False
+                break
+        if ok:
+            cr.execute('select distinct a.name from wkf_activity a left join wkf_workitem w on (a.id=w.act_id) where w.inst_id=%s', (instance_id,))
+            act_names = cr.fetchall()
+            cr.execute("update wkf_instance set state='complete' where id=%s", (instance_id,))
+            cr.execute("update wkf_workitem set state='complete' where subflow_id=%s", (instance_id,))
+            cr.execute("select i.id,w.osv,i.res_id from wkf_instance i left join wkf w on (i.wkf_id=w.id) where i.id IN (select inst_id from wkf_workitem where subflow_id=%s)", (instance_id,))
+            for cur_instance_id, cur_model_name, cur_record_id in cr.fetchall():
+                cur_record = Record(cur_model_name, cur_record_id)
+                for act_name in act_names:
+                    WorkflowInstance(self.session, cur_record, {'id':cur_instance_id}).validate('subflow.{}'.format(act_name[0]))
+
+        return ok
+
+
+
+
+
+def create(session, record, workflow_id):
+    return WorkflowInstance(session, record).create(workflow_id)
+
+def delete(session, record):
+    return WorkflowInstance(session, record).delete()
+
+def validate(session, record, instance_id, signal, force_running=False):
+    return WorkflowInstance(session, record).validate(instance_id, signal, force_running)
+
+def update(session, record, instance_id):
+    return WorkflowInstance(session, record).update(instance_id)
+
+def _update_end(session, record, instance_id):
+    return WorkflowInstance(session, record)._update_end(instance_id)
 
 
 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: