addons/process/process.py

   1 # -*- encoding: utf-8 -*-
   2 ##############################################################################
   3 #
   4 # Copyright (c) 2005-TODAY TINY SPRL. (http://tiny.be) All Rights Reserved.
   5 #
   6 # WARNING: This program as such is intended to be used by professional
   7 # programmers who take the whole responsability of assessing all potential
   8 # consequences resulting from its eventual inadequacies and bugs
   9 # End users who are looking for a ready-to-use solution with commercial
  10 # garantees and support are strongly adviced to contract a Free Software
  11 # Service Company
  12 #
  13 # This program is Free Software; you can redistribute it and/or
  14 # modify it under the terms of the GNU General Public License
  15 # as published by the Free Software Foundation; either version 2
  16 # of the License, or (at your option) any later version.
  17 #
  18 # This program is distributed in the hope that it will be useful,
  19 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  20 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21 # GNU General Public License for more details.
  22 #
  23 # You should have received a copy of the GNU General Public License
  24 # along with this program; if not, write to the Free Software
  25 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  26 #
  27 ##############################################################################
  28
  29 import netsvc
  30 import pooler, tools
  31
  32 from osv import fields, osv
  33
  34 class Env(dict):
  35
  36     def __init__(self, obj, user):
  37         self.__obj = obj
  38         self.__usr = user
  39
  40     def __getitem__(self, name):
  41
  42         if name in ('__obj', '__user'):
  43             return super(ExprContext, self).__getitem__(name)
  44
  45         if name == 'user':
  46             return self.__user
  47
  48         if name == 'object':
  49             return self.__obj
  50
  51         return self.__obj[name]
  52
  53 class process_process(osv.osv):
  54     _name = "process.process"
  55     _description = "Process"
  56     _columns = {
  57         'name': fields.char('Name', size=30,required=True, translate=True),
  58         'active': fields.boolean('Active'),
  59         'note': fields.text('Notes', translate=True),
  60         'node_ids': fields.one2many('process.node', 'process_id', 'Nodes')
  61     }
  62     _defaults = {
  63         'active' : lambda *a: True,
  64     }
  65
  66     def graph_get(self, cr, uid, id, res_model, res_id, scale, context):
  67
  68         pool = pooler.get_pool(cr.dbname)
  69
  70         process = pool.get('process.process').browse(cr, uid, [id])[0]
  71         current_object = pool.get(res_model).browse(cr, uid, [res_id], context)[0]
  72         current_user = pool.get('res.users').browse(cr, uid, [uid], context)[0]
  73
  74         expr_context = Env(current_object, current_user)
  75
  76         notes = process.note
  77         nodes = {}
  78         start = []
  79         transitions = {}
  80
  81         states = dict(pool.get(res_model).fields_get(cr, uid, context=context).get('state', {}).get('selection', {}))
  82         title = "%s - Resource: %s, State: %s" % (process.name, current_object.name, states.get(getattr(current_object, 'state'), 'N/A'))
  83
  84         perm = pool.get(res_model).perm_read(cr, uid, [res_id], context)[0]
  85
  86         for node in process.node_ids:
  87             data = {}
  88             data['name'] = node.name
  89             data['model'] = (node.model_id or None) and node.model_id.model
  90             data['kind'] = node.kind
  91             data['subflow'] = (node.subflow_id or False) and [node.subflow_id.id, node.subflow_id.name]
  92             data['notes'] = node.note
  93             data['active'] = False
  94             data['gray'] = False
  95
  96             if node.menu_id:
  97                 data['menu'] = {'name': node.menu_id.complete_name, 'id': node.menu_id.id}
  98
  99             if node.model_id and node.model_id.model == res_model:
 100                 try:
 101                     data['active'] = eval(node.model_states, expr_context)
 102                 except Exception, e:
 103                     # waring: invalid state expression
 104                     pass
 105
 106             if not data['active']:
 107                 try:
 108                     gray = True
 109                     for cond in node.condition_ids:
 110                         if cond.model_id and cond.model_id.model == res_model:
 111                             gray = gray and eval(cond.model_states, expr_context)
 112                     data['gray'] = not gray
 113                 except:
 114                     pass
 115
 116             nodes[node.id] = data
 117             if node.flow_start:
 118                 start.append(node.id)
 119
 120             for tr in node.transition_out:
 121                 data = {}
 122                 data['name'] = tr.name
 123                 data['source'] = tr.source_node_id.id
 124                 data['target'] = tr.target_node_id.id
 125                 data['notes'] = tr.note
 126                 data['buttons'] = buttons = []
 127                 for b in tr.action_ids:
 128                     button = {}
 129                     button['name'] = b.name
 130                     button['state'] = b.state
 131                     button['action'] = b.action
 132                     buttons.append(button)
 133                 data['roles'] = roles = []
 134                 for r in tr.transition_ids:
 135                     if r.role_id:
 136                         role = {}
 137                         role['name'] = r.role_id.name
 138                         roles.append(role)
 139                 for r in tr.role_ids:
 140                     role = {}
 141                     role['name'] = r.name
 142                     roles.append(role)
 143                 transitions[tr.id] = data
 144
 145         # now populate resource information
 146         def update_relatives(nid, ref_id, ref_model):
 147             relatives = []
 148
 149             for tid, tr in transitions.items():
 150                 if tr['source'] == nid:
 151                     relatives.append(tr['target'])
 152                 if tr['target'] == nid:
 153                     relatives.append(tr['source'])
 154
 155             if not ref_id:
 156                 nodes[nid]['res'] = False
 157                 return
 158
 159             nodes[nid]['res'] = resource = {'id': ref_id, 'model': ref_model}
 160
 161             refobj = pool.get(ref_model).browse(cr, uid, [ref_id], context)[0]
 162             fields = pool.get(ref_model).fields_get(cr, uid, context=context)
 163
 164             resource['name'] = refobj.name_get(context)[0][1]
 165             resource['perm'] = pool.get(ref_model).perm_read(cr, uid, [ref_id], context)[0]
 166
 167             for r in relatives:
 168                 node = nodes[r]
 169                 if 'res' not in node:
 170                     for n, f in fields.items():
 171                         if node['model'] == ref_model:
 172                             update_relatives(r, ref_id, ref_model)
 173
 174                         elif f.get('relation') == node['model']:
 175                             rel = refobj[n]
 176                             if rel and isinstance(rel, list) :
 177                                 rel = rel[0]
 178                             _id = (rel or False) and rel.id
 179                             _model = node['model']
 180                             update_relatives(r, _id, _model)
 181
 182         for nid, node in nodes.items():
 183             if node['active'] or node['model'] == res_model:
 184                 update_relatives(nid, res_id, res_model)
 185                 break
 186
 187         # calculate graph layout
 188         g = tools.graph(nodes.keys(), map(lambda x: (x['source'], x['target']), transitions.values()))
 189         g.process(start)
 190         g.scale(*scale) #g.scale(100, 100, 180, 120)
 191         graph = g.result_get()
 192
 193         # fix the height problem
 194         miny = -1
 195         for k,v in nodes.items():
 196             x = graph[k]['y']
 197             y = graph[k]['x']
 198             if miny == -1:
 199                 miny = y
 200             miny = min(y, miny)
 201             v['x'] = x
 202             v['y'] = y
 203
 204         for k, v in nodes.items():
 205             y = v['y']
 206             v['y'] = min(y - miny + 10, y)
 207
 208         return dict(title=title, perm=perm, notes=notes, nodes=nodes, transitions=transitions)
 209
 210 process_process()
 211
 212 class process_node(osv.osv):
 213     _name = 'process.node'
 214     _description ='Process Nodes'
 215     _columns = {
 216         'name': fields.char('Name', size=30,required=True, translate=True),
 217         'process_id': fields.many2one('process.process', 'Process', required=True, ondelete='cascade'),
 218         'kind': fields.selection([('state','State'), ('subflow','Subflow')], 'Kind of Node', required=True),
 219         'menu_id': fields.many2one('ir.ui.menu', 'Related Menu'),
 220         'note': fields.text('Notes', translate=True),
 221         'model_id': fields.many2one('ir.model', 'Object', ondelete='set null'),
 222         'model_states': fields.char('States Expression', size=128),
 223         'subflow_id': fields.many2one('process.process', 'Subflow', ondelete='set null'),
 224         'flow_start': fields.boolean('Starting Flow'),
 225         'transition_in': fields.one2many('process.transition', 'target_node_id', 'Starting Transitions'),
 226         'transition_out': fields.one2many('process.transition', 'source_node_id', 'Ending Transitions'),
 227         'condition_ids': fields.one2many('process.condition', 'node_id', 'Conditions')
 228     }
 229     _defaults = {
 230         'kind': lambda *args: 'state',
 231         'model_states': lambda *args: False,
 232         'flow_start': lambda *args: False,
 233     }
 234 process_node()
 235
 236 class process_node_condition(osv.osv):
 237     _name = 'process.condition'
 238     _description = 'Condition'
 239     _columns = {
 240         'name': fields.char('Name', size=30, required=True),
 241         'node_id': fields.many2one('process.node', 'Node', required=True, ondelete='cascade'),
 242         'model_id': fields.many2one('ir.model', 'Object', ondelete='set null'),
 243         'model_states': fields.char('Expression', required=True, size=128)
 244     }
 245 process_node_condition()
 246
 247 class process_transition(osv.osv):
 248     _name = 'process.transition'
 249     _description ='Process Transitions'
 250     _columns = {
 251         'name': fields.char('Name', size=32, required=True, translate=True),
 252         'source_node_id': fields.many2one('process.node', 'Source Node', required=True, ondelete='cascade'),
 253         'target_node_id': fields.many2one('process.node', 'Target Node', required=True, ondelete='cascade'),
 254         'action_ids': fields.one2many('process.transition.action', 'transition_id', 'Buttons'),
 255         'transition_ids': fields.many2many('workflow.transition', 'process_transition_ids', 'ptr_id', 'wtr_id', 'Workflow Transitions'),
 256         'role_ids': fields.many2many('res.roles', 'process_transition_roles_rel', 'tid', 'rid', 'Roles'),
 257         'note': fields.text('Description', translate=True),
 258     }
 259 process_transition()
 260
 261 class process_transition_action(osv.osv):
 262     _name = 'process.transition.action'
 263     _description ='Process Transitions Actions'
 264     _columns = {
 265         'name': fields.char('Name', size=32, required=True, translate=True),
 266         'state': fields.selection([('dummy','Dummy'),
 267                                    ('object','Object Method'),
 268                                    ('workflow','Workflow Trigger'),
 269                                    ('action','Action')], 'Type', required=True),
 270         'action': fields.char('Action ID', size=64, states={
 271             'dummy':[('readonly',1)],
 272             'object':[('required',1)],
 273             'workflow':[('required',1)],
 274             'action':[('required',1)],
 275         },),
 276         'transition_id': fields.many2one('process.transition', 'Transition', required=True, ondelete='cascade')
 277     }
 278     _defaults = {
 279         'state': lambda *args: 'dummy',
 280     }
 281 process_transition_action()
 282