1 # -*- coding: utf-8 -*-
2 ##############################################################################
4 # OpenERP, Open Source Management Solution
5 # Copyright (C) 2004-2010 Tiny SPRL (<http://tiny.be>).
7 # This program is free software: you can redistribute it and/or modify
8 # it under the terms of the GNU Affero General Public License as
9 # published by the Free Software Foundation, either version 3 of the
10 # License, or (at your option) any later version.
12 # This program is distributed in the hope that it will be useful,
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU Affero General Public License for more details.
17 # You should have received a copy of the GNU Affero General Public License
18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
20 ##############################################################################
22 from datetime import datetime
23 from osv import fields, osv, orm
24 from tools.translate import _
25 from datetime import datetime
26 from datetime import timedelta
32 class base_action_rule(osv.osv):
33 """ Base Action Rules """
35 _name = 'base.action.rule'
36 _description = 'Action Rules'
38 def _state_get(self, cr, uid, context={}):
40 @param self: The object pointer
41 @param cr: the current row, from the database cursor,
42 @param uid: the current user’s ID for security checks,
43 @param context: A standard dictionary for contextual values """
44 return self.state_get(cr, uid, context=context)
46 def state_get(self, cr, uid, context={}):
48 @param self: The object pointer
49 @param cr: the current row, from the database cursor,
50 @param uid: the current user’s ID for security checks,
51 @param context: A standard dictionary for contextual values """
54 def priority_get(self, cr, uid, context={}):
56 @param self: The object pointer
57 @param cr: the current row, from the database cursor,
58 @param uid: the current user’s ID for security checks,
59 @param context: A standard dictionary for contextual values """
63 'name': fields.many2one('ir.model', 'Object', required=True),
64 'create_date': fields.datetime('Create Date', readonly=1),
65 'active': fields.boolean('Active', help="If the active field is set to False,\
66 it will allow you to hide the rule without removing it."),
67 'sequence': fields.integer('Sequence', help="Gives the sequence order \
68 when displaying a list of rules."),
69 'trg_date_type': fields.selection([
71 ('create', 'Creation Date'),
72 ('action_last', 'Last Action Date'),
74 ('deadline', 'Deadline'),
75 ], 'Trigger Date', size=16),
76 'trg_date_range': fields.integer('Delay after trigger date', \
77 help="Delay After Trigger Date,\
78 specifies you can put a negative number. If you need a delay before the \
79 trigger date, like sending a reminder 15 minutes before a meeting."),
80 'trg_date_range_type': fields.selection([('minutes', 'Minutes'), ('hour', 'Hours'), \
81 ('day', 'Days'), ('month', 'Months')], 'Delay type'),
82 'trg_user_id': fields.many2one('res.users', 'Responsible'),
83 'trg_partner_id': fields.many2one('res.partner', 'Partner'),
84 'trg_partner_categ_id': fields.many2one('res.partner.category', 'Partner Category'),
85 'trg_state_from': fields.selection(_state_get, 'State', size=16),
86 'trg_state_to': fields.selection(_state_get, 'Button Pressed', size=16),
88 'act_method': fields.char('Call Object Method', size=64),
89 'act_user_id': fields.many2one('res.users', 'Set Responsible to'),
90 'act_state': fields.selection(_state_get, 'Set State to', size=16),
91 'act_email_cc': fields.char('Add Watchers (Cc)', size=250, help="\
92 These people will receive a copy of the future communication between partner \
94 'act_remind_partner': fields.boolean('Remind Partner', help="Check \
95 this if you want the rule to send a reminder by email to the partner."),
96 'act_remind_user': fields.boolean('Remind Responsible', help="Check \
97 this if you want the rule to send a reminder by email to the user."),
98 'act_reply_to': fields.char('Reply-To', size=64),
99 'act_remind_attach': fields.boolean('Remind with Attachment', help="Check this if you want that all documents attached to the object be attached to the reminder email sent."),
100 'act_mail_to_user': fields.boolean('Mail to Responsible', help="Check\
101 this if you want the rule to send an email to the responsible person."),
102 'act_mail_to_watchers': fields.boolean('Mail to Watchers (CC)',
103 help="Check this if you want \
104 the rule to mark CC(mail to any other person defined in actions)."),
105 'act_mail_to_email': fields.char('Mail to these Emails', size=128, \
106 help="Email-id of the persons whom mail is to be sent"),
107 'act_mail_body': fields.text('Mail body', help="Content of mail"),
108 'regex_name': fields.char('Regex on Resource Name', size=128, help="Regular expression for matching name of the resource\
109 \ne.g.: 'urgent.*' will search for records having name starting with the string 'urgent'\
110 \nNote: This is case sensitive search."),
111 'server_action_id': fields.many2one('ir.actions.server', 'Server Action', help="Describes the action name.\neg:on which object which action to be taken on basis of which condition"),
112 'filter_id':fields.many2one('ir.filters', 'Filter', required=False),
116 'active': lambda *a: True,
117 'trg_date_type': lambda *a: 'none',
118 'trg_date_range_type': lambda *a: 'day',
119 'act_mail_to_user': lambda *a: 0,
120 'act_remind_partner': lambda *a: 0,
121 'act_remind_user': lambda *a: 0,
122 'act_mail_to_watchers': lambda *a: 0,
127 def onchange_model_id(self, cr, uid, ids, name):
128 res = {'domain':{'filter_id':[]}}
130 model_name = self.pool.get('ir.model').read(cr, uid, [name], ['model'])
132 mod_name = model_name[0]['model']
133 res['domain'] = {'filter_id': [('model_id','=',mod_name)]}
135 res['value'] = {'filter_id':False}
138 def pre_action(self, cr, uid, ids, model, context=None):
139 # Searching for action rules
140 cr.execute("SELECT model.model, rule.id FROM base_action_rule rule \
141 LEFT JOIN ir_model model on (model.id = rule.name) \
144 # Check if any rule matching with current object
145 for obj_name, rule_id in res:
146 if not (model == obj_name):
149 obj = self.pool.get(obj_name)
150 self._action(cr, uid, [rule_id], obj.browse(cr, uid, ids, context=context))
153 def _create(self, old_create, model, context=None):
156 def make_call_old(cr, uid, vals, context=context):
157 new_id = old_create(cr, uid, vals, context=context)
158 if not context.get('action'):
159 self.pre_action(cr, uid, [new_id], model, context=context)
163 def _write(self, old_write, model, context=None):
166 def make_call_old(cr, uid, ids, vals, context=context):
167 if isinstance(ids, (str, int, long)):
169 if not context.get('action'):
170 self.pre_action(cr, uid, ids, model, context=context)
171 return old_write(cr, uid, ids, vals, context=context)
174 def _register_hook(self, cr, uid, ids, context=None):
177 for action_rule in self.browse(cr, uid, ids, context=context):
178 model = action_rule.name.model
179 obj_pool = self.pool.get(model)
180 obj_pool.__setattr__('create', self._create(obj_pool.create, model, context=context))
181 obj_pool.__setattr__('write', self._write(obj_pool.write, model, context=context))
184 def create(self, cr, uid, vals, context=None):
185 res_id = super(base_action_rule, self).create(cr, uid, vals, context)
186 self._register_hook(cr, uid, [res_id], context=context)
189 def write(self, cr, uid, ids, vals, context=None):
190 res = super(base_action_rule, self).write(cr, uid, ids, vals, context)
191 self._register_hook(cr, uid, ids, context=context)
194 def _check(self, cr, uid, automatic=False, use_new_cursor=False, \
197 This Function is call by scheduler.
199 rule_pool = self.pool.get('base.action.rule')
200 rule_ids = rule_pool.search(cr, uid, [], context=context)
201 return self._register_hook(cr, uid, rule_ids, context=context)
204 def format_body(self, body):
205 """ Foramat Action rule's body
206 @param self: The object pointer """
207 return body and tools.ustr(body) or ''
209 def format_mail(self, obj, body):
211 @param self: The object pointer """
215 'object_subject': hasattr(obj, 'name') and obj.name or False,
216 'object_date': hasattr(obj, 'date') and obj.date or False,
217 'object_description': hasattr(obj, 'description') and obj.description or False,
218 'object_user': hasattr(obj, 'user_id') and (obj.user_id and obj.user_id.name) or '/',
219 'object_user_email': hasattr(obj, 'user_id') and (obj.user_id and \
220 obj.user_id.address_id and obj.user_id.address_id.email) or '/',
221 'object_user_phone': hasattr(obj, 'user_id') and (obj.user_id and\
222 obj.user_id.address_id and obj.user_id.address_id.phone) or '/',
223 'partner': hasattr(obj, 'partner_id') and (obj.partner_id and obj.partner_id.name) or '/',
224 'partner_email': hasattr(obj, 'partner_address_id') and (obj.partner_address_id and\
225 obj.partner_address_id.email) or '/',
227 return self.format_body(body % data)
229 def email_send(self, cr, uid, obj, emails, body, emailfrom=tools.config.get('email_from', False), context={}):
231 @param self: The object pointer
232 @param cr: the current row, from the database cursor,
233 @param uid: the current user’s ID for security checks,
234 @param email: pass the emails
235 @param emailfrom: Pass name the email From else False
236 @param context: A standard dictionary for contextual values """
237 body = self.format_mail(obj, body)
239 if hasattr(obj, 'user_id') and obj.user_id and obj.user_id.address_id and\
240 obj.user_id.address_id.email:
241 emailfrom = obj.user_id.address_id.email
243 name = '[%d] %s' % (obj.id, tools.ustr(obj.name))
244 emailfrom = tools.ustr(emailfrom)
247 raise osv.except_osv(_('Error!'),
248 _("No E-Mail ID Found for your Company address!"))
249 return tools.email_send(emailfrom, emails, name, body, reply_to=reply_to, openobject_id=str(obj.id))
252 def do_check(self, cr, uid, action, obj, context={}):
254 @param self: The object pointer
255 @param cr: the current row, from the database cursor,
256 @param uid: the current user’s ID for security checks,
257 @param context: A standard dictionary for contextual values """
260 if action.name.model == action.filter_id.model_id:
261 context.update(eval(action.filter_id.context))
262 obj_ids = obj._table.search(cr, uid, eval(action.filter_id.domain), context=context)
263 if not obj.id in obj_ids:
267 if hasattr(obj, 'user_id'):
268 ok = ok and (not action.trg_user_id.id or action.trg_user_id.id==obj.user_id.id)
269 if hasattr(obj, 'partner_id'):
270 ok = ok and (not action.trg_partner_id.id or action.trg_partner_id.id==obj.partner_id.id)
272 not action.trg_partner_categ_id.id or
274 obj.partner_id.id and
275 (action.trg_partner_categ_id.id in map(lambda x: x.id, obj.partner_id.category_id or []))
278 state_to = context.get('state_to', False)
279 if hasattr(obj, 'state'):
280 ok = ok and (not action.trg_state_from or action.trg_state_from==obj.state)
282 ok = ok and (not action.trg_state_to or action.trg_state_to==state_to)
283 elif action.trg_state_to:
285 reg_name = action.regex_name
288 ptrn = re.compile(str(reg_name))
289 _result = ptrn.search(str(obj.name))
292 regex_n = not reg_name or result_name
296 def do_action(self, cr, uid, action, model_obj, obj, context={}):
298 @param self: The object pointer
299 @param cr: the current row, from the database cursor,
300 @param uid: the current user’s ID for security checks,
301 @param action: pass action
302 @param model_obj: pass Model object
303 @param context: A standard dictionary for contextual values """
305 if action.server_action_id:
306 context.update({'active_id':obj.id, 'active_ids':[obj.id]})
307 self.pool.get('ir.actions.server').run(cr, uid, [action.server_action_id.id], context)
310 if hasattr(obj, 'user_id') and action.act_user_id:
311 obj.user_id = action.act_user_id
312 write['user_id'] = action.act_user_id.id
313 if hasattr(obj, 'date_action_last'):
314 write['date_action_last'] = time.strftime('%Y-%m-%d %H:%M:%S')
315 if hasattr(obj, 'state') and action.act_state:
316 obj.state = action.act_state
317 write['state'] = action.act_state
319 if hasattr(obj, 'categ_id') and action.act_categ_id:
320 obj.categ_id = action.act_categ_id
321 write['categ_id'] = action.act_categ_id.id
323 model_obj.write(cr, uid, [obj.id], write, context)
325 if hasattr(model_obj, 'remind_user') and action.act_remind_user:
326 model_obj.remind_user(cr, uid, [obj.id], context, attach=action.act_remind_attach)
327 if hasattr(model_obj, 'remind_partner') and action.act_remind_partner:
328 model_obj.remind_partner(cr, uid, [obj.id], context, attach=action.act_remind_attach)
329 if action.act_method:
330 getattr(model_obj, 'act_method')(cr, uid, [obj.id], action, context)
332 if hasattr(obj, 'user_id') and action.act_mail_to_user:
333 if obj.user_id and obj.user_id.address_id:
334 emails.append(obj.user_id.address_id.email)
336 if action.act_mail_to_watchers:
337 emails += (action.act_email_cc or '').split(',')
338 if action.act_mail_to_email:
339 emails += (action.act_mail_to_email or '').split(',')
340 emails = filter(None, emails)
341 if len(emails) and action.act_mail_body:
342 emails = list(set(emails))
343 self.email_send(cr, uid, obj, emails, action.act_mail_body)
346 def _action(self, cr, uid, ids, objects, scrit=None, context={}):
348 @param self: The object pointer
349 @param cr: the current row, from the database cursor,
350 @param uid: the current user’s ID for security checks,
351 @param ids: List of Basic Action Rule’s IDs,
352 @param objects: pass objects
353 @param context: A standard dictionary for contextual values """
354 context.update({'action': True})
357 for action in self.browse(cr, uid, ids):
358 model_obj = self.pool.get(action.name.model)
360 ok = self.do_check(cr, uid, action, obj, context=context)
365 if hasattr(obj, 'create_date') and action.trg_date_type=='create':
366 base = datetime.strptime(obj.create_date[:19], '%Y-%m-%d %H:%M:%S')
367 elif hasattr(obj, 'create_date') and action.trg_date_type=='action_last':
368 if hasattr(obj, 'date_action_last') and obj.date_action_last:
369 base = datetime.strptime(obj.date_action_last, '%Y-%m-%d %H:%M:%S')
371 base = datetime.strptime(obj.create_date[:19], '%Y-%m-%d %H:%M:%S')
372 elif hasattr(obj, 'date_deadline') and action.trg_date_type=='deadline' \
373 and obj.date_deadline:
374 base = datetime.strptime(obj.date_deadline, '%Y-%m-%d %H:%M:%S')
375 elif hasattr(obj, 'date') and action.trg_date_type=='date' and obj.date:
376 base = datetime.strptime(obj.date, '%Y-%m-%d %H:%M:%S')
379 'minutes': lambda interval: timedelta(minutes=interval),
380 'day': lambda interval: timedelta(days=interval),
381 'hour': lambda interval: timedelta(hours=interval),
382 'month': lambda interval: timedelta(months=interval),
384 d = base + fnct[action.trg_date_range_type](action.trg_date_range)
385 dt = d.strftime('%Y-%m-%d %H:%M:%S')
387 if hasattr(obj, 'date_action_last') and hasattr(obj, 'date_action_next'):
388 ok = (dt <= time.strftime('%Y-%m-%d %H:%M:%S')) and \
389 ((not obj.date_action_next) or \
390 (dt >= obj.date_action_next and \
391 obj.date_action_last < obj.date_action_next))
393 if not obj.date_action_next or dt < obj.date_action_next:
394 obj.date_action_next = dt
395 model_obj.write(cr, uid, [obj.id], {'date_action_next': dt}, context)
397 ok = action.trg_date_type == 'none'
400 self.do_action(cr, uid, action, model_obj, obj, context)
402 context.update({'action': False})
405 def _check_mail(self, cr, uid, ids, context=None):
407 @param self: The object pointer
408 @param cr: the current row, from the database cursor,
409 @param uid: the current user’s ID for security checks,
410 @param ids: List of Action Rule’s IDs
411 @param context: A standard dictionary for contextual values """
413 empty = orm.browse_null()
414 rule_obj = self.pool.get('base.action.rule')
415 for rule in self.browse(cr, uid, ids):
416 if rule.act_mail_body:
418 rule_obj.format_mail(empty, rule.act_mail_body)
419 except (ValueError, KeyError, TypeError):
424 (_check_mail, 'Error: The mail is not well formated', ['act_mail_body']),
430 class ir_cron(osv.osv):
433 def _poolJobs(self, db_name, check=False):
435 db = pooler.get_db(db_name)
440 next = datetime.now().strftime('%Y-%m-%d %H:00:00')
441 # Putting nextcall always less than current time in order to call it every time
442 cr.execute('UPDATE ir_cron set nextcall = \'%s\' where numbercall<>0 and active and model=\'base.action.rule\' ' % (next))
447 super(ir_cron, self)._poolJobs(db_name, check=check)
452 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: