1 # -*- encoding: utf-8 -*-
2 ##############################################################################
4 # Copyright (c) 2004-2008 TINY SPRL. (http://tiny.be) All Rights Reserved.
8 # WARNING: This program as such is intended to be used by professional
9 # programmers who take the whole responsability of assessing all potential
10 # consequences resulting from its eventual inadequacies and bugs
11 # End users who are looking for a ready-to-use solution with commercial
12 # garantees and support are strongly adviced to contract a Free Software
15 # This program is Free Software; you can redistribute it and/or
16 # modify it under the terms of the GNU General Public License
17 # as published by the Free Software Foundation; either version 2
18 # of the License, or (at your option) any later version.
20 # This program is distributed in the hope that it will be useful,
21 # but WITHOUT ANY WARRANTY; without even the implied warranty of
22 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 # GNU General Public License for more details.
25 # You should have received a copy of the GNU General Public License
26 # along with this program; if not, write to the Free Software
27 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
29 ##############################################################################
31 from osv import fields,osv
34 from tools.config import config
38 class actions(osv.osv):
39 _name = 'ir.actions.actions'
42 'name': fields.char('Action Name', required=True, size=64),
43 'type': fields.char('Action Type', required=True, size=32),
44 'usage': fields.char('Action Usage', size=32),
45 'parent_id': fields.many2one('ir.actions.server', 'Parent Action'),
48 'usage': lambda *a: False,
52 class report_custom(osv.osv):
53 _name = 'ir.actions.report.custom'
54 _table = 'ir_act_report_custom'
55 _sequence = 'ir_actions_id_seq'
57 'name': fields.char('Report Name', size=64, required=True, translate=True),
58 'type': fields.char('Report Type', size=32, required=True),
59 'model':fields.char('Object', size=64, required=True),
60 'report_id': fields.integer('Report Ref.', required=True),
61 'usage': fields.char('Action Usage', size=32),
62 'multi': fields.boolean('On multiple doc.', help="If set to true, the action will not be displayed on the right toolbar of a form views.")
65 'multi': lambda *a: False,
66 'type': lambda *a: 'ir.actions.report.custom',
70 class report_xml(osv.osv):
72 def _report_content(self, cursor, user, ids, name, arg, context=None):
74 for report in self.browse(cursor, user, ids, context=context):
75 data = report[name + '_data']
76 if not data and report[name[:-8]]:
78 fp = tools.file_open(report[name[:-8]], mode='rb')
85 def _report_content_inv(self, cursor, user, id, name, value, arg, context=None):
86 self.write(cursor, user, id, {name+'_data': value}, context=context)
88 def _report_sxw(self, cursor, user, ids, name, arg, context=None):
90 for report in self.browse(cursor, user, ids, context=context):
92 res[report.id] = report.report_rml.replace('.rml', '.sxw')
94 res[report.id] = False
97 _name = 'ir.actions.report.xml'
98 _table = 'ir_act_report_xml'
99 _sequence = 'ir_actions_id_seq'
101 'name': fields.char('Name', size=64, required=True, translate=True),
102 'type': fields.char('Report Type', size=32, required=True),
103 'model': fields.char('Object', size=64, required=True),
104 'report_name': fields.char('Internal Name', size=64, required=True),
105 'report_xsl': fields.char('XSL path', size=256),
106 'report_xml': fields.char('XML path', size=256),
107 'report_rml': fields.char('RML path', size=256,
108 help="The .rml path of the file or NULL if the content is in report_rml_content"),
109 'report_sxw': fields.function(_report_sxw, method=True, type='char',
111 'report_sxw_content_data': fields.binary('SXW content'),
112 'report_rml_content_data': fields.binary('RML content'),
113 'report_sxw_content': fields.function(_report_content,
114 fnct_inv=_report_content_inv, method=True,
115 type='binary', string='SXW content',),
116 'report_rml_content': fields.function(_report_content,
117 fnct_inv=_report_content_inv, method=True,
118 type='binary', string='RML content'),
119 'auto': fields.boolean('Automatic XSL:RML', required=True),
120 'usage': fields.char('Action Usage', size=32),
121 'header': fields.boolean('Add RML header',
122 help="Add or not the coporate RML header"),
123 'multi': fields.boolean('On multiple doc.',
124 help="If set to true, the action will not be displayed on the right toolbar of a form views."),
125 'report_type': fields.selection([
130 ], string='Type', required=True),
131 'groups_id': fields.many2many('res.groups', 'res_groups_report_rel', 'uid', 'gid', 'Groups'),
132 'attachment': fields.char('Save As Attachment Prefix', size=32, help='This is the prefix of the file name the print will be saved as attachement. Keep empty to not save the printed reports')
135 'type': lambda *a: 'ir.actions.report.xml',
136 'multi': lambda *a: False,
137 'auto': lambda *a: True,
138 'header': lambda *a: True,
139 'report_sxw_content': lambda *a: False,
140 'report_type': lambda *a: 'pdf',
141 'attachment': lambda *a: False,
146 class act_window(osv.osv):
147 _name = 'ir.actions.act_window'
148 _table = 'ir_act_window'
149 _sequence = 'ir_actions_id_seq'
151 # def search(self, cr, uid, args, offset=0, limit=2000, order=None,
152 # context=None, count=False):
153 # if context is None:
155 # ids = osv.orm.orm.search(self, cr, uid, args, offset, limit, order,
159 # user_groups = self.pool.get('res.users').read(cr, uid, [uid])[0]['groups_id']
161 # for act in self.browse(cr, uid, ids):
162 # if not len(act.groups_id):
163 # result.append(act.id)
165 # for g in act.groups_id:
166 # if g.id in user_groups:
167 # result.append(act.id)
171 def _views_get_fnc(self, cr, uid, ids, name, arg, context={}):
173 for act in self.browse(cr, uid, ids):
174 res[act.id]=[(view.view_id.id, view.view_mode) for view in act.view_ids]
175 if (not act.view_ids):
176 modes = act.view_mode.split(',')
179 res[act.id].append((act.view_id.id, act.view_id.type))
181 if act.view_id and (t == act.view_id.type) and not find:
184 res[act.id].append((False, t))
186 if 'calendar' not in modes:
187 mobj = self.pool.get(act.res_model)
188 if mobj._date_name in mobj._columns:
189 res[act.id].append((False, 'calendar'))
193 'name': fields.char('Action Name', size=64, translate=True),
194 'type': fields.char('Action Type', size=32, required=True),
195 'view_id': fields.many2one('ir.ui.view', 'View Ref.', ondelete='cascade'),
196 'domain': fields.char('Domain Value', size=250),
197 'context': fields.char('Context Value', size=250),
198 'res_model': fields.char('Object', size=64),
199 'src_model': fields.char('Source Object', size=64),
200 'target': fields.selection([('current','Current Window'),('new','New Window')], 'Target Window'),
201 'view_type': fields.selection((('tree','Tree'),('form','Form')),string='Type of view'),
202 'view_mode': fields.char('Mode of view', size=250),
203 'usage': fields.char('Action Usage', size=32),
204 'view_ids': fields.one2many('ir.actions.act_window.view', 'act_window_id', 'Views'),
205 'views': fields.function(_views_get_fnc, method=True, type='binary', string='Views'),
206 'limit': fields.integer('Limit', help='Default limit for the list view'),
207 'auto_refresh': fields.integer('Auto-Refresh',
208 help='Add an auto-refresh on the view'),
209 'groups_id': fields.many2many('res.groups', 'ir_act_window_group_rel',
210 'act_id', 'gid', 'Groups'),
213 'type': lambda *a: 'ir.actions.act_window',
214 'view_type': lambda *a: 'form',
215 'view_mode': lambda *a: 'tree,form',
216 'context': lambda *a: '{}',
217 'limit': lambda *a: 80,
218 'target': lambda *a: 'current',
219 'auto_refresh': lambda *a: 0,
223 class act_window_view(osv.osv):
224 _name = 'ir.actions.act_window.view'
225 _table = 'ir_act_window_view'
226 _rec_name = 'view_id'
228 'sequence': fields.integer('Sequence'),
229 'view_id': fields.many2one('ir.ui.view', 'View'),
230 'view_mode': fields.selection((
234 ('calendar', 'Calendar')), string='Type of view', required=True),
235 'act_window_id': fields.many2one('ir.actions.act_window', 'Action', ondelete='cascade'),
236 'multi': fields.boolean('On multiple doc.',
237 help="If set to true, the action will not be displayed on the right toolbar of a form views."),
240 'multi': lambda *a: False,
245 class act_wizard(osv.osv):
246 _name = 'ir.actions.wizard'
247 _table = 'ir_act_wizard'
248 _sequence = 'ir_actions_id_seq'
250 'name': fields.char('Wizard info', size=64, required=True, translate=True),
251 'type': fields.char('Action type', size=32, required=True),
252 'wiz_name': fields.char('Wizard name', size=64, required=True),
253 'multi': fields.boolean('Action on multiple doc.', help="If set to true, the wizard will not be displayed on the right toolbar of a form views."),
254 'groups_id': fields.many2many('res.groups', 'res_groups_wizard_rel', 'uid', 'gid', 'Groups'),
255 'model': fields.char('Object', size=64),
258 'type': lambda *a: 'ir.actions.wizard',
259 'multi': lambda *a: False,
263 class act_url(osv.osv):
264 _name = 'ir.actions.url'
265 _table = 'ir_act_url'
266 _sequence = 'ir_actions_id_seq'
268 'name': fields.char('Action Name', size=64, translate=True),
269 'type': fields.char('Action Type', size=32, required=True),
270 'url': fields.text('Action Url',required=True),
271 'target': fields.selection((
272 ('new', 'New Window'),
273 ('self', 'This Window')),
274 'Action Target', required=True
278 'type': lambda *a: 'ir.actions.act_url',
279 'target': lambda *a: 'new'
283 def model_get(self, cr, uid, context={}):
284 wkf_pool = self.pool.get('workflow')
285 ids = wkf_pool.search(cr, uid, [])
286 osvs = wkf_pool.read(cr, uid, ids, ['osv'])
289 mpool = self.pool.get('ir.model')
291 model = osv.get('osv')
292 id = mpool.search(cr, uid, [('model','=',model)])
293 name = mpool.read(cr, uid, id)[0]['name']
294 res.append((model, name))
298 class ir_model_fields(osv.osv):
299 _inherit = 'ir.model.fields'
300 _rec_name = 'complete_name'
302 'complete_name': fields.char('Complete Name', required=True, size=64, select=1),
305 def name_search(self, cr, uid, name, args=None, operator='ilike', context=None, limit=80):
307 def get_fields(cr, uid, field, rel):
309 mobj = self.pool.get('ir.model')
310 id = mobj.search(cr, uid, [('model','=',rel)])
312 obj = self.pool.get('ir.model.fields')
313 ids = obj.search(cr, uid, [('model_id','in',id)])
314 records = obj.read(cr, uid, ids)
315 for record in records:
317 fld = field + '/' + record['name']
319 result.append((id, fld))
326 return super(ir_model_fields, self).name_search(cr, uid, name, args, operator, context, limit)
328 if context.get('key') != 'server_action':
329 return super(ir_model_fields, self).name_search(cr, uid, name, args, operator, context, limit)
332 obj = self.pool.get('ir.model.fields')
333 ids = obj.search(cr, uid, args)
334 records = obj.read(cr, uid, ids)
335 for record in records:
337 field = record['name']
339 if record['ttype'] == 'many2one':
340 rel = record['relation']
341 res = get_fields(cr, uid, field, record['relation'])
345 result.append((id, field))
348 obj.write(cr, uid, [rs[0]], {'complete_name':rs[1]})
354 result = super(ir_model_fields, self).name_search(cr, uid, name, [('complete_name','ilike',name), ('id','in',iids)], operator, context, limit)
360 class server_object_lines(osv.osv):
361 _name = 'ir.server.object.lines'
362 _sequence = 'ir_actions_id_seq'
364 'server_id': fields.many2one('ir.actions.server', 'Object Mapping'),
365 'col1': fields.many2one('ir.model.fields', 'Destination', required=True),
366 'value': fields.text('Value', required=True),
367 'type': fields.selection([
369 ('equation','Formula')
370 ], 'Type', required=True, size=32, change_default=True),
373 'type': lambda *a: 'equation',
375 server_object_lines()
378 # Actions that are run on the server side
380 class actions_server(osv.osv):
381 _name = 'ir.actions.server'
382 _table = 'ir_act_server'
383 _sequence = 'ir_actions_id_seq'
385 'name': fields.char('Action Name', required=True, size=64),
386 'state': fields.selection([
387 ('python','Python Code'),
389 ('trigger','Trigger'),
392 ('object_create','Create Object'),
393 ('object_write','Write Object'),
394 ('client_action','Client Action'),
395 ('other','Others Actions'),
396 ], 'Action State', required=True, size=32, change_default=True),
397 'code': fields.text('Python Code'),
398 'sequence': fields.integer('Sequence'),
399 'model_id': fields.many2one('ir.model', 'Object', required=True),
400 'trigger_name': fields.char('Trigger Name', size=128),
401 'trigger_obj_id': fields.reference('Trigger On', selection=model_get, size=128),
402 'message': fields.text('Message', translate=True),
403 'address': fields.many2one('ir.model.fields', 'Email / Mobile'),
404 'sms': fields.char('SMS', size=160, translate=True),
405 'child_ids': fields.one2many('ir.actions.actions', 'parent_id', 'Others Actions'),
406 'usage': fields.char('Action Usage', size=32),
407 'type': fields.char('Report Type', size=32, required=True),
408 'srcmodel_id': fields.many2one('ir.model', 'Model'),
409 'fields_lines': fields.one2many('ir.server.object.lines', 'server_id', 'Fields Mapping'),
410 'otype': fields.selection([
411 ('copy','Create in Same Model'),
412 ('new','Create in Other Model')
413 ], 'Create Model', size=32, change_default=True),
416 'state': lambda *a: 'dummy',
417 'type': lambda *a: 'ir.actions.server',
418 'sequence': lambda *a: 0,
419 'code': lambda *a: """# You can use the following variables
426 # If you plan to return an action, assign: action = {...}
428 'otype': lambda *a: 'copy',
431 def get_field_value(self, cr, uid, action, context):
432 obj_pool = self.pool.get(action.model_id.model)
433 id = context.get('active_id')
434 obj = obj_pool.browse(cr, uid, id)
438 if '/' in action.address.complete_name:
439 fields = action.address.complete_name.split('/')
440 elif '.' in action.address.complete_name:
441 fields = action.address.complete_name.split('.')
445 obj = getattr(obj, field)
447 logger.notifyChannel('Workflow', netsvc.LOG_ERROR, 'Failed to parse : %s' % (match.group()))
451 def merge_message(self, cr, uid, keystr, action, context):
452 logger = netsvc.Logger()
455 obj_pool = self.pool.get(action.model_id.model)
456 id = context.get('active_id')
457 obj = obj_pool.browse(cr, uid, id)
459 field = match.group()
460 field = field.replace('[','')
461 field = field.replace(']','')
462 field = field.strip()
464 fields = field.split('.')
467 obj = getattr(obj, field)
469 logger.notifyChannel('Workflow', netsvc.LOG_ERROR, 'Failed to parse : %s' % (match.group()))
473 com = re.compile('\[\[(.+?)\]\]')
474 message = com.sub(merge, keystr)
478 # Context should contains:
480 # id : current id of the object
482 # False : Finnished correctly
483 # ACTION_ID : Action to launch
484 def run(self, cr, uid, ids, context={}):
485 logger = netsvc.Logger()
486 for action in self.browse(cr, uid, ids, context):
487 if action.state=='python':
489 'self': self.pool.get(action.model_id.model),
496 exec action.code in localdict
497 if 'action' in localdict:
498 return localdict['action']
500 if action.state == 'email':
501 user = config['email_from']
502 subject = action.name
504 address = self.get_field_value(cr, uid, str(action.message), action, context)
505 body = self.merge_message(cr, uid, action, context)
507 if tools.email_send_attach(user, address, subject, body, debug=False) == True:
508 logger.notifyChannel('email', netsvc.LOG_INFO, 'Email successfully send to : %s' % (address))
510 logger.notifyChannel('email', netsvc.LOG_ERROR, 'Failed to send email to : %s' % (address))
512 if action.state == 'trigger':
513 wf_service = netsvc.LocalService("workflow")
514 res = str(action.trigger_obj_id).split(',')
517 wf_service.trg_validate(uid, model, int(id), action.trigger_name, cr)
519 if action.state == 'sms':
520 #TODO: set the user and password from the system
521 # for the sms gateway user / password
524 to = self.get_field_value(cr, uid, str(action.message), action, context)
525 #TODO: Apply message mearge with the field
526 if tools.sms_send(user, password, api_id, text, to) == True:
527 logger.notifyChannel('sms', netsvc.LOG_INFO, 'SMS successfully send to : %s' % (action.address))
529 logger.notifyChannel('sms', netsvc.LOG_ERROR, 'Failed to send SMS to : %s' % (action.address))
530 if action.state == 'other':
532 'self': self.pool.get(action.model_id.model),
540 for act in action.child_ids:
541 code = """action = {'model':'%s','type':'%s', %s}""" % (action.model_id.model, act.type, act.usage)
542 exec code in localdict
543 if 'action' in localdict:
544 return localdict['action']
545 if action.state == 'object_write':
547 for exp in action.fields_lines:
549 if exp.type == 'equation':
550 expr = self.merge_message(cr, uid, euq, action, context)
554 res[exp.col1.name] = expr
555 obj_pool = self.pool.get(action.model_id.model)
556 obj_pool.write(cr, uid, [context.get('active_id')], res)
558 if action.state == 'object_create':
560 for exp in action.fields_lines:
562 if exp.type == 'equation':
563 expr = self.merge_message(cr, uid, euq, action, context)
567 res[exp.col1.name] = expr
570 if action.state == 'object_create' and action.otype == 'new':
571 obj_pool = self.pool.get(action.srcmodel_id.model)
572 obj_pool.create(cr, uid, res)
574 obj_pool = self.pool.get(action.model_id.model)
575 id = context.get('active_id')
576 obj_pool.copy(cr, uid, id, res)
581 class act_window_close(osv.osv):
582 _name = 'ir.actions.act_window_close'
583 _table = 'ir_actions'
584 _sequence = 'ir_actions_id_seq'
586 'name': fields.char('Action Name', size=64, translate=True),
587 'type': fields.char('Action Type', size=32, required=True),
590 'type': lambda *a: 'ir.actions.act_window_close',
594 # This model use to register action services.
595 # if action type is 'configure', it will be start on configuration wizard.
596 # if action type is 'service',
597 # - if start_type= 'at once', it will be start at one time on start date
598 # - if start_type='auto', it will be start on auto starting from start date, and stop on stop date
599 # - if start_type="manual", it will start and stop on manually
600 class ir_actions_todo(osv.osv):
601 _name = 'ir.actions.todo'
603 'name':fields.char('Name',size=64,required=True, select=True),
604 'note':fields.text('Text'),
605 'start_date': fields.datetime('Start Date'),
606 'end_date': fields.datetime('End Date'),
607 'action_id':fields.many2one('ir.actions.act_window', 'Action', select=True,required=True, ondelete='cascade'),
608 'sequence':fields.integer('Sequence'),
609 'active': fields.boolean('Active'),
610 'type':fields.selection([('configure', 'Configure'),('service', 'Service'),('other','Other')], string='Type', required=True),
611 'start_on':fields.selection([('at_once', 'At Once'),('auto', 'Auto'),('manual','Manual')], string='Start On'),
612 'groups_id': fields.many2many('res.groups', 'res_groups_act_todo_rel', 'act_todo_id', 'group_id', 'Groups'),
613 'users_id': fields.many2many('res.users', 'res_users_act_todo_rel', 'act_todo_id', 'user_id', 'Users'),
614 'state':fields.selection([('open', 'Not Started'),('done', 'Done'),('skip','Skipped'),('cancel','Cancel')], string='State', required=True)
617 'state': lambda *a: 'open',
618 'sequence': lambda *a: 10,
619 'active':lambda *a:True,
620 'type':lambda *a:'configure'
625 # This model to use run all configuration actions
626 class ir_actions_configuration_wizard(osv.osv_memory):
627 _name='ir.actions.configuration.wizard'
628 def next_configuration_action(self,cr,uid,context={}):
629 item_obj = self.pool.get('ir.actions.todo')
630 item_ids = item_obj.search(cr, uid, [('type','=','configure'),('state', '=', 'open'),('active','=',True)], limit=1, context=context)
631 if item_ids and len(item_ids):
632 item = item_obj.browse(cr, uid, item_ids[0], context=context)
635 def _get_action_name(self, cr, uid, context={}):
636 next_action=self.next_configuration_action(cr,uid,context=context)
638 return next_action.note
640 return "Your database is now fully configured.\n\nClick 'Continue' and enjoy your OpenERP experience..."
643 def _get_action(self, cr, uid, context={}):
644 next_action=self.next_configuration_action(cr,uid,context=context)
646 return next_action.id
649 def _progress_get(self,cr,uid, context={}):
650 total = self.pool.get('ir.actions.todo').search_count(cr, uid, [], context)
651 todo = self.pool.get('ir.actions.todo').search_count(cr, uid, [('type','=','configure'),('active','=',True),('state','<>','open')], context)
652 return max(5.0,round(todo*100/total))
655 'name': fields.text('Next Wizard',readonly=True),
656 'progress': fields.float('Configuration Progress', readonly=True),
657 'item_id':fields.many2one('ir.actions.todo', 'Next Configuration Wizard',invisible=True, readonly=True),
660 'progress': _progress_get,
661 'item_id':_get_action,
662 'name':_get_action_name,
664 def button_skip(self,cr,uid,ids,context=None):
665 item_obj = self.pool.get('ir.actions.todo')
666 item_id=self.read(cr,uid,ids)[0]['item_id']
668 item = item_obj.browse(cr, uid, item_id, context=context)
669 item_obj.write(cr, uid, item.id, {
675 'res_model': 'ir.actions.configuration.wizard',
676 'type': 'ir.actions.act_window',
679 return {'type':'ir.actions.act_window_close'}
681 def button_continue(self, cr, uid, ids, context=None):
682 item_obj = self.pool.get('ir.actions.todo')
683 item_id=self.read(cr,uid,ids)[0]['item_id']
685 item = item_obj.browse(cr, uid, item_id, context=context)
686 item_obj.write(cr, uid, item.id, {
690 'view_mode': item.action_id.view_mode,
691 'view_type': item.action_id.view_type,
692 'view_id':item.action_id.view_id and [item.action_id.view_id.id] or False,
693 'res_model': item.action_id.res_model,
694 'type': item.action_id.type,
695 'target':item.action_id.target,
697 user_action=self.pool.get('res.users').browse(cr,uid,uid)
698 act_obj=self.pool.get(user_action.menu_id.type)
699 action_ids=act_obj.search(cr,uid,[('name','=',user_action.menu_id.name)])
700 action_open=act_obj.browse(cr,uid,action_ids)[0]
701 if context.get('menu',False):
703 'view_type': action_open.view_type,
704 'view_id':action_open.view_id and [action_open.view_id.id] or False,
705 'res_model': action_open.res_model,
706 'type': action_open.type,
707 'domain':action_open.domain
709 return {'type':'ir.actions.act_window_close' }
710 ir_actions_configuration_wizard()
712 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: