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 osv import fields, osv, orm
23 from tools.translate import _
24 from datetime import datetime
25 from datetime import timedelta
26 from tools.safe_eval import safe_eval
27 from tools import ustr
34 def get_datetime(date_field):
35 '''Return a datetime from a date string or a datetime string'''
36 #complete date time if date_field contains only a date
37 date_split = date_field.split(' ')
38 if len(date_split) == 1:
39 date_field = date_split[0] + " 00:00:00"
41 return datetime.strptime(date_field[:19], '%Y-%m-%d %H:%M:%S')
44 class base_action_rule(osv.osv):
45 """ Base Action Rules """
47 _name = 'base.action.rule'
48 _description = 'Action Rules'
50 def _state_get(self, cr, uid, context=None):
52 @param self: The object pointer
53 @param cr: the current row, from the database cursor,
54 @param uid: the current user’s ID for security checks,
55 @param context: A standard dictionary for contextual values """
56 return self.state_get(cr, uid, context=context)
58 def state_get(self, cr, uid, context=None):
60 @param self: The object pointer
61 @param cr: the current row, from the database cursor,
62 @param uid: the current user’s ID for security checks,
63 @param context: A standard dictionary for contextual values """
66 def priority_get(self, cr, uid, context=None):
68 @param self: The object pointer
69 @param cr: the current row, from the database cursor,
70 @param uid: the current user’s ID for security checks,
71 @param context: A standard dictionary for contextual values """
75 'name': fields.char('Rule Name', size=64, required=True),
76 'model_id': fields.many2one('ir.model', 'Object', required=True),
77 'create_date': fields.datetime('Create Date', readonly=1),
78 'active': fields.boolean('Active', help="If the active field is set to False,\
79 it will allow you to hide the rule without removing it."),
80 'sequence': fields.integer('Sequence', help="Gives the sequence order \
81 when displaying a list of rules."),
82 'trg_date_type': fields.selection([
84 ('create', 'Creation Date'),
85 ('action_last', 'Last Action Date'),
87 ('deadline', 'Deadline'),
88 ], 'Trigger Date', size=16),
89 'trg_date_range': fields.integer('Delay after trigger date', \
90 help="Delay After Trigger Date,\
91 specifies you can put a negative number. If you need a delay before the \
92 trigger date, like sending a reminder 15 minutes before a meeting."),
93 'trg_date_range_type': fields.selection([('minutes', 'Minutes'), ('hour', 'Hours'), \
94 ('day', 'Days'), ('month', 'Months')], 'Delay type'),
95 'trg_user_id': fields.many2one('res.users', 'Responsible'),
96 'trg_partner_id': fields.many2one('res.partner', 'Partner'),
97 'trg_partner_categ_id': fields.many2one('res.partner.category', 'Partner Category'),
98 'trg_state_from': fields.selection(_state_get, 'Status', size=16),
99 'trg_state_to': fields.selection(_state_get, 'Button Pressed', size=16),
101 'act_method': fields.char('Call Object Method', size=64),
102 'act_user_id': fields.many2one('res.users', 'Set Responsible to'),
103 'act_state': fields.selection(_state_get, 'Set State to', size=16),
104 'act_email_cc': fields.char('Add Watchers (Cc)', size=250, help="\
105 These people will receive a copy of the future communication between partner \
106 and users by email"),
107 'act_remind_partner': fields.boolean('Remind Partner', help="Check \
108 this if you want the rule to send a reminder by email to the partner."),
109 'act_remind_user': fields.boolean('Remind Responsible', help="Check \
110 this if you want the rule to send a reminder by email to the user."),
111 'act_reply_to': fields.char('Reply-To', size=64),
112 '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."),
113 'act_mail_to_user': fields.boolean('Mail to Responsible', help="Check\
114 this if you want the rule to send an email to the responsible person."),
115 'act_mail_to_watchers': fields.boolean('Mail to Watchers (CC)',
116 help="Check this if you want \
117 the rule to mark CC(mail to any other person defined in actions)."),
118 'act_mail_to_email': fields.char('Mail to these Emails', size=128, \
119 help="Email-id of the persons whom mail is to be sent"),
120 'act_mail_body': fields.text('Mail body', help="Content of mail"),
121 'regex_name': fields.char('Regex on Resource Name', size=128, help="Regular expression for matching name of the resource\
122 \ne.g.: 'urgent.*' will search for records having name starting with the string 'urgent'\
123 \nNote: This is case sensitive search."),
124 '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"),
125 'filter_id':fields.many2one('ir.filters', 'Filter', required=False),
126 'act_email_from' : fields.char('Email From', size=64, required=False,
127 help="Use a python expression to specify the right field on which one than we will use for the 'From' field of the header"),
128 'act_email_to' : fields.char('Email To', size=64, required=False,
129 help="Use a python expression to specify the right field on which one than we will use for the 'To' field of the header"),
130 'last_run': fields.datetime('Last Run', readonly=1),
134 'active': lambda *a: True,
135 'trg_date_type': lambda *a: 'none',
136 'trg_date_range_type': lambda *a: 'day',
137 'act_mail_to_user': lambda *a: 0,
138 'act_remind_partner': lambda *a: 0,
139 'act_remind_user': lambda *a: 0,
140 'act_mail_to_watchers': lambda *a: 0,
145 def onchange_model_id(self, cr, uid, ids, name):
146 #This is not a good solution as it will affect the domain only on onchange
147 res = {'domain':{'filter_id':[]}}
149 model_name = self.pool.get('ir.model').read(cr, uid, [name], ['model'])
151 mod_name = model_name[0]['model']
152 res['domain'] = {'filter_id': [('model_id','=',mod_name)]}
154 res['value'] = {'filter_id':False}
157 def post_action(self, cr, uid, ids, model, context=None):
158 # Searching for action rules
159 cr.execute("SELECT model.model, rule.id FROM base_action_rule rule \
160 LEFT JOIN ir_model model on (model.id = rule.model_id) \
163 # Check if any rule matching with current object
164 for obj_name, rule_id in res:
165 if not (model == obj_name):
166 continue # TODO add this condition in the WHERE clause above.
168 obj = self.pool.get(obj_name)
169 # If the rule doesn't involve a time condition, run it immediately
170 # Otherwise we let the scheduler run the action
171 if self.browse(cr, uid, rule_id, context=context).trg_date_type == 'none':
172 self._action(cr, uid, [rule_id], obj.browse(cr, uid, ids, context=context), context=context)
175 def _create(self, old_create, model, context=None):
177 Return a wrapper around `old_create` calling both `old_create` and
178 `post_action`, in that order.
180 def wrapper(cr, uid, vals, context=context):
183 new_id = old_create(cr, uid, vals, context=context)
184 if not context.get('action'):
185 self.post_action(cr, uid, [new_id], model, context=context)
189 def _write(self, old_write, model, context=None):
191 Return a wrapper around `old_write` calling both `old_write` and
192 `post_action`, in that order.
194 def wrapper(cr, uid, ids, vals, context=context):
197 if isinstance(ids, (str, int, long)):
199 old_write(cr, uid, ids, vals, context=context)
200 if not context.get('action'):
201 self.post_action(cr, uid, ids, model, context=context)
205 def _register_hook(self, cr, uid, ids, context=None):
207 Wrap every `create` and `write` methods of the models specified by
208 the rules (given by `ids`).
210 for action_rule in self.browse(cr, uid, ids, context=context):
211 model = action_rule.model_id.model
212 obj_pool = self.pool.get(model)
213 if not hasattr(obj_pool, 'base_action_ruled'):
214 obj_pool.create = self._create(obj_pool.create, model, context=context)
215 obj_pool.write = self._write(obj_pool.write, model, context=context)
216 obj_pool.base_action_ruled = True
220 def create(self, cr, uid, vals, context=None):
221 res_id = super(base_action_rule, self).create(cr, uid, vals, context=context)
222 self._register_hook(cr, uid, [res_id], context=context)
225 def write(self, cr, uid, ids, vals, context=None):
226 super(base_action_rule, self).write(cr, uid, ids, vals, context=context)
227 self._register_hook(cr, uid, ids, context=context)
230 def _check(self, cr, uid, automatic=False, use_new_cursor=False, \
233 This Function is call by scheduler.
235 rule_pool = self.pool.get('base.action.rule')
236 rule_ids = rule_pool.search(cr, uid, [], context=context)
237 self._register_hook(cr, uid, rule_ids, context=context)
239 rules = self.browse(cr, uid, rule_ids, context=context)
241 model = rule.model_id.model
242 model_pool = self.pool.get(model)
245 last_run = get_datetime(rule.last_run)
247 for obj_id in model_pool.search(cr, uid, [], context=context):
248 obj = model_pool.browse(cr, uid, obj_id, context=context)
249 # Calculate when this action should next occur for this object
251 if rule.trg_date_type=='create' and hasattr(obj, 'create_date'):
252 base = obj.create_date
253 elif (rule.trg_date_type=='action_last'
254 and hasattr(obj, 'create_date')):
255 if hasattr(obj, 'date_action_last') and obj.date_action_last:
256 base = obj.date_action_last
258 base = obj.create_date
259 elif (rule.trg_date_type=='deadline'
260 and hasattr(obj, 'date_deadline')
261 and obj.date_deadline):
262 base = obj.date_deadline
263 elif (rule.trg_date_type=='date'
264 and hasattr(obj, 'date')
269 'minutes': lambda interval: timedelta(minutes=interval),
270 'day': lambda interval: timedelta(days=interval),
271 'hour': lambda interval: timedelta(hours=interval),
272 'month': lambda interval: timedelta(months=interval),
274 base = get_datetime(base)
275 delay = fnct[rule.trg_date_range_type](rule.trg_date_range)
276 action_date = base + delay
277 if (not last_run or (last_run <= action_date < now)):
278 self._action(cr, uid, [rule.id], [obj], context=context)
279 rule_pool.write(cr, uid, [rule.id], {'last_run': now},
282 def format_body(self, body):
283 """ Foramat Action rule's body
284 @param self: The object pointer """
285 return body and tools.ustr(body) or ''
287 def format_mail(self, obj, body):
290 'object_subject': hasattr(obj, 'name') and obj.name or False,
291 'object_date': hasattr(obj, 'date') and obj.date or False,
292 'object_description': hasattr(obj, 'description') and obj.description or False,
293 'object_user': hasattr(obj, 'user_id') and (obj.user_id and obj.user_id.name) or '/',
294 'object_user_email': hasattr(obj, 'user_id') and (obj.user_id and \
295 obj.user_id.user_email) or '/',
296 'object_user_phone': hasattr(obj, 'partner_address_id') and (obj.partner_address_id and \
297 obj.partner_address_id.phone) or '/',
298 'partner': hasattr(obj, 'partner_id') and (obj.partner_id and obj.partner_id.name) or '/',
299 'partner_email': hasattr(obj, 'partner_address_id') and (obj.partner_address_id and\
300 obj.partner_address_id.email) or '/',
302 return self.format_body(body % data)
304 def email_send(self, cr, uid, obj, emails, body, emailfrom=None, context=None):
306 @param self: The object pointer
307 @param cr: the current row, from the database cursor,
308 @param uid: the current user’s ID for security checks,
309 @param email: pass the emails
310 @param emailfrom: Pass name the email From else False
311 @param context: A standard dictionary for contextual values """
314 emailfrom = tools.config.get('email_from', False)
319 mail_message = self.pool.get('mail.message')
320 body = self.format_mail(obj, body)
322 if hasattr(obj, 'user_id') and obj.user_id and obj.user_id.user_email:
323 emailfrom = obj.user_id.user_email
325 name = '[%d] %s' % (obj.id, tools.ustr(obj.name))
326 emailfrom = tools.ustr(emailfrom)
329 raise osv.except_osv(_('Error!'),
330 _("No Email ID Found for your Company address!"))
331 return mail_message.schedule_with_attach(cr, uid, emailfrom, emails, name, body, model='base.action.rule', reply_to=reply_to, res_id=obj.id)
334 def do_check(self, cr, uid, action, obj, context=None):
336 @param self: The object pointer
337 @param cr: the current row, from the database cursor,
338 @param uid: the current user’s ID for security checks,
339 @param context: A standard dictionary for contextual values """
344 if action.model_id.model == action.filter_id.model_id:
345 context.update(eval(action.filter_id.context))
346 obj_ids = obj._table.search(cr, uid, eval(action.filter_id.domain), context=context)
347 if not obj.id in obj_ids:
351 if getattr(obj, 'user_id', False):
352 ok = ok and (not action.trg_user_id.id or action.trg_user_id.id==obj.user_id.id)
353 if getattr(obj, 'partner_id', False):
354 ok = ok and (not action.trg_partner_id.id or action.trg_partner_id.id==obj.partner_id.id)
356 not action.trg_partner_categ_id.id or
358 obj.partner_id.id and
359 (action.trg_partner_categ_id.id in map(lambda x: x.id, obj.partner_id.category_id or []))
362 state_to = context.get('state_to', False)
363 state = getattr(obj, 'state', False)
365 ok = ok and (not action.trg_state_from or action.trg_state_from==state)
367 ok = ok and (not action.trg_state_to or action.trg_state_to==state_to)
368 elif action.trg_state_to:
370 reg_name = action.regex_name
373 ptrn = re.compile(ustr(reg_name))
374 _result = ptrn.search(ustr(obj.name))
377 regex_n = not reg_name or result_name
381 def do_action(self, cr, uid, action, model_obj, obj, context=None):
383 @param self: The object pointer
384 @param cr: the current row, from the database cursor,
385 @param uid: the current user’s ID for security checks,
386 @param action: pass action
387 @param model_obj: pass Model object
388 @param context: A standard dictionary for contextual values """
392 if action.server_action_id:
393 context.update({'active_id':obj.id, 'active_ids':[obj.id]})
394 self.pool.get('ir.actions.server').run(cr, uid, [action.server_action_id.id], context)
397 if hasattr(obj, 'user_id') and action.act_user_id:
398 obj.user_id = action.act_user_id
399 write['user_id'] = action.act_user_id.id
400 if hasattr(obj, 'date_action_last'):
401 write['date_action_last'] = time.strftime('%Y-%m-%d %H:%M:%S')
402 if hasattr(obj, 'state') and action.act_state:
403 obj.state = action.act_state
404 write['state'] = action.act_state
406 if hasattr(obj, 'categ_id') and action.act_categ_id:
407 obj.categ_id = action.act_categ_id
408 write['categ_id'] = action.act_categ_id.id
410 model_obj.write(cr, uid, [obj.id], write, context)
412 if hasattr(model_obj, 'remind_user') and action.act_remind_user:
413 model_obj.remind_user(cr, uid, [obj.id], context, attach=action.act_remind_attach)
414 if hasattr(model_obj, 'remind_partner') and action.act_remind_partner:
415 model_obj.remind_partner(cr, uid, [obj.id], context, attach=action.act_remind_attach)
416 if action.act_method:
417 getattr(model_obj, 'act_method')(cr, uid, [obj.id], action, context)
420 if hasattr(obj, 'user_id') and action.act_mail_to_user:
422 emails.append(obj.user_id.user_email)
424 if action.act_mail_to_watchers:
425 emails += (action.act_email_cc or '').split(',')
426 if action.act_mail_to_email:
427 emails += (action.act_mail_to_email or '').split(',')
429 locals_for_emails = {
430 'user' : self.pool.get('res.users').browse(cr, uid, uid, context=context),
434 if action.act_email_to:
435 emails.append(safe_eval(action.act_email_to, {}, locals_for_emails))
437 emails = filter(None, emails)
438 if len(emails) and action.act_mail_body:
439 emails = list(set(emails))
440 email_from = safe_eval(action.act_email_from, {}, locals_for_emails)
443 return re.findall(r'([^ ,<@]+@[^> ,]+)', text or '')
444 emails = to_email(','.join(filter(None, emails)))
445 email_froms = to_email(email_from)
447 self.email_send(cr, uid, obj, emails, action.act_mail_body, emailfrom=email_froms[0])
450 def _action(self, cr, uid, ids, objects, scrit=None, context=None):
452 @param self: The object pointer
453 @param cr: the current row, from the database cursor,
454 @param uid: the current user’s ID for security checks,
455 @param ids: List of Basic Action Rule’s IDs,
456 @param objects: pass objects
457 @param context: A standard dictionary for contextual values """
461 context.update({'action': True})
465 for action in self.browse(cr, uid, ids, context=context):
467 if self.do_check(cr, uid, action, obj, context=context):
468 model_obj = self.pool.get(action.model_id.model)
469 self.do_action(cr, uid, action, model_obj, obj, context=context)
471 context.update({'action': False})
474 def _check_mail(self, cr, uid, ids, context=None):
476 @param self: The object pointer
477 @param cr: the current row, from the database cursor,
478 @param uid: the current user’s ID for security checks,
479 @param ids: List of Action Rule’s IDs
480 @param context: A standard dictionary for contextual values """
482 empty = orm.browse_null()
483 rule_obj = self.pool.get('base.action.rule')
484 for rule in self.browse(cr, uid, ids, context=context):
485 if rule.act_mail_body:
487 rule_obj.format_mail(empty, rule.act_mail_body)
488 except (ValueError, KeyError, TypeError):
493 (_check_mail, 'Error: The mail is not well formated', ['act_mail_body']),
499 class ir_cron(osv.osv):
503 def _poolJobs(self, db_name, check=False):
504 if not self._init_done:
505 self._init_done = True
507 db = pooler.get_db(db_name)
512 next = datetime.now().strftime('%Y-%m-%d %H:00:00')
513 # Putting nextcall always less than current time in order to call it every time
514 cr.execute('UPDATE ir_cron set nextcall = \'%s\' where numbercall<>0 and active and model=\'base.action.rule\' ' % (next))
519 super(ir_cron, self)._poolJobs(db_name, check=check)
524 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: