addons/process/process.py

   1 # -*- encoding: utf-8 -*-
   2 ##############################################################################
   3 #
   4 #    OpenERP, Open Source Management Solution
   5 #    Copyright (C) 2004-2009 Tiny SPRL (<http://tiny.be>). All Rights Reserved
   6 #    $Id$
   7 #
   8 #    This program is free software: you can redistribute it and/or modify
   9 #    it under the terms of the GNU General Public License as published by
  10 #    the Free Software Foundation, either version 3 of the License, or
  11 #    (at your option) any later version.
  12 #
  13 #    This program is distributed in the hope that it will be useful,
  14 #    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 #    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 #    GNU General Public License for more details.
  17 #
  18 #    You should have received a copy of the GNU General Public License
  19 #    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20 #
  21 ##############################################################################
  22
  23 import netsvc
  24 import pooler, tools
  25
  26 from osv import fields, osv
  27
  28 class Env(dict):
  29
  30     def __init__(self, obj, user):
  31         self.__obj = obj
  32         self.__usr = user
  33
  34     def __getitem__(self, name):
  35
  36         if name in ('__obj', '__user'):
  37             return super(ExprContext, self).__getitem__(name)
  38
  39         if name == 'user':
  40             return self.__user
  41
  42         if name == 'object':
  43             return self.__obj
  44
  45         return self.__obj[name]
  46
  47 class process_process(osv.osv):
  48     _name = "process.process"
  49     _description = "Process"
  50     _columns = {
  51         'name': fields.char('Name', size=30,required=True, translate=True),
  52         'active': fields.boolean('Active'),
  53         'model_id': fields.many2one('ir.model', 'Object', ondelete='set null'),
  54         'note': fields.text('Notes', translate=True),
  55         'node_ids': fields.one2many('process.node', 'process_id', 'Nodes')
  56     }
  57     _defaults = {
  58         'active' : lambda *a: True,
  59     }
  60
  61     def search_by_model(self, cr, uid, res_model, context):
  62         pool = pooler.get_pool(cr.dbname)
  63         model_ids = (res_model or None) and pool.get('ir.model').search(cr, uid, [('model', '=', res_model)])
  64
  65         domain = (model_ids or []) and [('model_id', 'in', model_ids)]
  66         result = []
  67
  68         # search all processes
  69         res = pool.get('process.process').search(cr, uid, domain)
  70         if res:
  71             res = pool.get('process.process').browse(cr, uid, res, context)
  72             for process in res:
  73                 result.append((process.id, process.name))
  74             return result
  75
  76         # else search process nodes
  77         res = pool.get('process.node').search(cr, uid, domain)
  78         if res:
  79             res = pool.get('process.node').browse(cr, uid, res, context)
  80             for node in res:
  81                 if (node.process_id.id, node.process_id.name) not in result:
  82                     result.append((node.process_id.id, node.process_id.name))
  83
  84         return result
  85
  86     def graph_get(self, cr, uid, id, res_model, res_id, scale, context):
  87
  88         pool = pooler.get_pool(cr.dbname)
  89
  90         process = pool.get('process.process').browse(cr, uid, [id], context)[0]
  91
  92         name = process.name
  93         resource = None
  94         state = 'N/A'
  95
  96         expr_context = {}
  97         states = {}
  98         perm = None
  99
 100         if res_model:
 101             states = dict(pool.get(res_model).fields_get(cr, uid, context=context).get('state', {}).get('selection', {}))
 102
 103         if res_id:
 104             current_object = pool.get(res_model).browse(cr, uid, [res_id], context)[0]
 105             current_user = pool.get('res.users').browse(cr, uid, [uid], context)[0]
 106             expr_context = Env(current_object, current_user)
 107             resource = current_object.name
 108             if 'state' in current_object:
 109                 state = states.get(current_object.state, 'N/A')
 110             perm = pool.get(res_model).perm_read(cr, uid, [res_id], context)[0]
 111
 112         notes = process.note or "N/A"
 113         nodes = {}
 114         start = []
 115         transitions = {}
 116
 117         for node in process.node_ids:
 118             data = {}
 119             data['name'] = node.name
 120             data['model'] = (node.model_id or None) and node.model_id.model
 121             data['kind'] = node.kind
 122             data['subflow'] = (node.subflow_id or False) and [node.subflow_id.id, node.subflow_id.name]
 123             data['notes'] = node.note
 124             data['active'] = False
 125             data['gray'] = False
 126             data['url'] = node.help_url
 127
 128             # get assosiated workflow
 129             if data['model']:
 130                 wkf_ids = self.pool.get('workflow').search(cr, uid, [('osv', '=', data['model'])])
 131                 data['workflow'] = (wkf_ids or False) and wkf_ids[0]
 132
 133             if 'directory_id' in node and node.directory_id:
 134                 data['directory_id'] = node.directory_id.id
 135
 136             if node.menu_id:
 137                 data['menu'] = {'name': node.menu_id.complete_name, 'id': node.menu_id.id}
 138
 139             if node.model_id and node.model_id.model == res_model:
 140                 try:
 141                     data['active'] = eval(node.model_states, expr_context)
 142                 except Exception, e:
 143                     pass
 144
 145             if not data['active']:
 146                 try:
 147                     gray = True
 148                     for cond in node.condition_ids:
 149                         if cond.model_id and cond.model_id.model == res_model:
 150                             gray = gray and eval(cond.model_states, expr_context)
 151                     data['gray'] = not gray
 152                 except:
 153                     pass
 154
 155             nodes[node.id] = data
 156             if node.flow_start:
 157                 start.append(node.id)
 158
 159             for tr in node.transition_out:
 160                 data = {}
 161                 data['name'] = tr.name
 162                 data['source'] = tr.source_node_id.id
 163                 data['target'] = tr.target_node_id.id
 164                 data['notes'] = tr.note
 165                 data['buttons'] = buttons = []
 166                 for b in tr.action_ids:
 167                     button = {}
 168                     button['name'] = b.name
 169                     button['state'] = b.state
 170                     button['action'] = b.action
 171                     buttons.append(button)
 172                 data['roles'] = roles = []
 173                 for r in tr.transition_ids:
 174                     if r.role_id:
 175                         role = {}
 176                         role['name'] = r.role_id.name
 177                         roles.append(role)
 178                 for r in tr.role_ids:
 179                     role = {}
 180                     role['name'] = r.name
 181                     roles.append(role)
 182                 transitions[tr.id] = data
 183
 184         # now populate resource information
 185         def update_relatives(nid, ref_id, ref_model):
 186             relatives = []
 187
 188             for tid, tr in transitions.items():
 189                 if tr['source'] == nid:
 190                     relatives.append(tr['target'])
 191                 if tr['target'] == nid:
 192                     relatives.append(tr['source'])
 193
 194             if not ref_id:
 195                 nodes[nid]['res'] = False
 196                 return
 197
 198             nodes[nid]['res'] = resource = {'id': ref_id, 'model': ref_model}
 199
 200             refobj = pool.get(ref_model).browse(cr, uid, [ref_id], context)[0]
 201             fields = pool.get(ref_model).fields_get(cr, uid, context=context)
 202
 203             # chech for directory_id from inherited from document module
 204             if nodes[nid].get('directory_id', False):
 205                 resource['directory'] = self.pool.get('document.directory').get_resource_path(cr, uid, nodes[nid]['directory_id'], ref_model, ref_id)
 206
 207             resource['name'] = refobj.name_get(context)[0][1]
 208             resource['perm'] = pool.get(ref_model).perm_read(cr, uid, [ref_id], context)[0]
 209
 210             for r in relatives:
 211                 node = nodes[r]
 212                 if 'res' not in node:
 213                     for n, f in fields.items():
 214                         if node['model'] == ref_model:
 215                             update_relatives(r, ref_id, ref_model)
 216
 217                         elif f.get('relation') == node['model']:
 218                             rel = refobj[n]
 219                             if rel and isinstance(rel, list) :
 220                                 rel = rel[0]
 221                             try: # XXX: rel has been reported as string (check it)
 222                                 _id = (rel or False) and rel.id
 223                                 _model = node['model']
 224                                 update_relatives(r, _id, _model)
 225                             except:
 226                                 pass
 227
 228         if res_id:
 229             for nid, node in nodes.items():
 230                 if not node['gray'] and (node['active'] or node['model'] == res_model):
 231                     update_relatives(nid, res_id, res_model)
 232                     break
 233
 234         # calculate graph layout
 235         g = tools.graph(nodes.keys(), map(lambda x: (x['source'], x['target']), transitions.values()))
 236         g.process(start)
 237         g.scale(*scale) #g.scale(100, 100, 180, 120)
 238         graph = g.result_get()
 239
 240         # fix the height problem
 241         miny = -1
 242         for k,v in nodes.items():
 243             x = graph[k]['x']
 244             y = graph[k]['y']
 245             if miny == -1:
 246                 miny = y
 247             miny = min(y, miny)
 248             v['x'] = x
 249             v['y'] = y
 250
 251         for k, v in nodes.items():
 252             y = v['y']
 253             v['y'] = min(y - miny + 10, y)
 254
 255         return dict(name=name, resource=resource, state=state, perm=perm, notes=notes, nodes=nodes, transitions=transitions)
 256
 257     def copy(self, cr, uid, id, default=None, context={}):
 258         """ Deep copy the entire process.
 259         """
 260
 261         if not default:
 262             default = {}
 263
 264         pool = pooler.get_pool(cr.dbname)
 265         process = pool.get('process.process').browse(cr, uid, [id], context)[0]
 266
 267         nodes = {}
 268         transitions = {}
 269
 270         # first copy all nodes and and map the new nodes with original for later use in transitions
 271         for node in process.node_ids:
 272             for t in node.transition_in:
 273                 tr = transitions.setdefault(t.id, {})
 274                 tr['target'] = node.id
 275             for t in node.transition_out:
 276                 tr = transitions.setdefault(t.id, {})
 277                 tr['source'] = node.id
 278             nodes[node.id] = pool.get('process.node').copy(cr, uid, node.id, context=context)
 279
 280         # then copy transitions with new nodes
 281         for tid, tr in transitions.items():
 282             vals = {
 283                 'source_node_id': nodes[tr['source']],
 284                 'target_node_id': nodes[tr['target']]
 285             }
 286             tr = pool.get('process.transition').copy(cr, uid, tid, default=vals, context=context)
 287
 288         # and finally copy the process itself with new nodes
 289         default.update({
 290             'active': True,
 291             'node_ids': [(6, 0, nodes.values())]
 292         })
 293         return super(process_process, self).copy(cr, uid, id, default, context)
 294
 295 process_process()
 296
 297 class process_node(osv.osv):
 298     _name = 'process.node'
 299     _description ='Process Nodes'
 300     _columns = {
 301         'name': fields.char('Name', size=30,required=True, translate=True),
 302         'process_id': fields.many2one('process.process', 'Process', required=True, ondelete='cascade'),
 303         'kind': fields.selection([('state','State'), ('subflow','Subflow')], 'Kind of Node', required=True),
 304         'menu_id': fields.many2one('ir.ui.menu', 'Related Menu'),
 305         'note': fields.text('Notes', translate=True),
 306         'model_id': fields.many2one('ir.model', 'Object', ondelete='set null'),
 307         'model_states': fields.char('States Expression', size=128),
 308         'subflow_id': fields.many2one('process.process', 'Subflow', ondelete='set null'),
 309         'flow_start': fields.boolean('Starting Flow'),
 310         'transition_in': fields.one2many('process.transition', 'target_node_id', 'Starting Transitions'),
 311         'transition_out': fields.one2many('process.transition', 'source_node_id', 'Ending Transitions'),
 312         'condition_ids': fields.one2many('process.condition', 'node_id', 'Conditions'),
 313         'help_url': fields.char('Help URL', size=255)
 314     }
 315     _defaults = {
 316         'kind': lambda *args: 'state',
 317         'model_states': lambda *args: False,
 318         'flow_start': lambda *args: False,
 319     }
 320
 321     def copy_data(self, cr, uid, id, default=None, context={}):
 322         if not default:
 323             default = {}
 324         default.update({
 325             'transition_in': [],
 326             'transition_out': []
 327         })
 328         return super(process_node, self).copy_data(cr, uid, id, default, context)
 329
 330 process_node()
 331
 332 class process_node_condition(osv.osv):
 333     _name = 'process.condition'
 334     _description = 'Condition'
 335     _columns = {
 336         'name': fields.char('Name', size=30, required=True),
 337         'node_id': fields.many2one('process.node', 'Node', required=True, ondelete='cascade'),
 338         'model_id': fields.many2one('ir.model', 'Object', ondelete='set null'),
 339         'model_states': fields.char('Expression', required=True, size=128)
 340     }
 341 process_node_condition()
 342
 343 class process_transition(osv.osv):
 344     _name = 'process.transition'
 345     _description ='Process Transitions'
 346     _columns = {
 347         'name': fields.char('Name', size=32, required=True, translate=True),
 348         'source_node_id': fields.many2one('process.node', 'Source Node', required=True, ondelete='cascade'),
 349         'target_node_id': fields.many2one('process.node', 'Target Node', required=True, ondelete='cascade'),
 350         'action_ids': fields.one2many('process.transition.action', 'transition_id', 'Buttons'),
 351         'transition_ids': fields.many2many('workflow.transition', 'process_transition_ids', 'ptr_id', 'wtr_id', 'Workflow Transitions'),
 352         'role_ids': fields.many2many('res.roles', 'process_transition_roles_rel', 'tid', 'rid', 'Roles'),
 353         'note': fields.text('Description', translate=True),
 354     }
 355 process_transition()
 356
 357 class process_transition_action(osv.osv):
 358     _name = 'process.transition.action'
 359     _description ='Process Transitions Actions'
 360     _columns = {
 361         'name': fields.char('Name', size=32, required=True, translate=True),
 362         'state': fields.selection([('dummy','Dummy'),
 363                                    ('object','Object Method'),
 364                                    ('workflow','Workflow Trigger'),
 365                                    ('action','Action')], 'Type', required=True),
 366         'action': fields.char('Action ID', size=64, states={
 367             'dummy':[('readonly',1)],
 368             'object':[('required',1)],
 369             'workflow':[('required',1)],
 370             'action':[('required',1)],
 371         },),
 372         'transition_id': fields.many2one('process.transition', 'Transition', required=True, ondelete='cascade')
 373     }
 374     _defaults = {
 375         'state': lambda *args: 'dummy',
 376     }
 377
 378     def copy_data(self, cr, uid, id, default=None, context={}):
 379         if not default:
 380             default = {}
 381
 382         state = self.pool.get('process.transition.action').browse(cr, uid, [id], context)[0].state
 383         if state:
 384             default['state'] = state
 385
 386         return super(process_transition_action, self).copy_data(cr, uid, id, default, context)
 387
 388 process_transition_action()
 389
 390 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: