addons/base_action_rule/base_action_rule.py

   1 # -*- coding: utf-8 -*-
   2 ##############################################################################
   3 #
   4 #    OpenERP, Open Source Management Solution
   5 #    Copyright (C) 2004-2010 Tiny SPRL (<http://tiny.be>).
   6 #
   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.
  11 #
  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.
  16 #
  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/>.
  19 #
  20 ##############################################################################
  21
  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 import pooler
  28 import re
  29 import time
  30 import tools
  31
  32
  33 def get_datetime(date_field):
  34     return datetime.strptime(date_field[:19], '%Y-%m-%d %H:%M:%S')
  35
  36
  37 class base_action_rule(osv.osv):
  38     """ Base Action Rules """
  39
  40     _name = 'base.action.rule'
  41     _description = 'Action Rules'
  42
  43     def _state_get(self, cr, uid, context={}):
  44         """ Get State
  45             @param self: The object pointer
  46             @param cr: the current row, from the database cursor,
  47             @param uid: the current user’s ID for security checks,
  48             @param context: A standard dictionary for contextual values """
  49         return self.state_get(cr, uid, context=context)
  50
  51     def state_get(self, cr, uid, context={}):
  52         """ Get State
  53             @param self: The object pointer
  54             @param cr: the current row, from the database cursor,
  55             @param uid: the current user’s ID for security checks,
  56             @param context: A standard dictionary for contextual values """
  57         return [('', '')]
  58
  59     def priority_get(self, cr, uid, context={}):
  60         """ Get Priority
  61             @param self: The object pointer
  62             @param cr: the current row, from the database cursor,
  63             @param uid: the current user’s ID for security checks,
  64             @param context: A standard dictionary for contextual values """
  65         return [('', '')]
  66
  67     _columns = {
  68         'name':  fields.char('Rule Name', size=64, required=True),
  69         'model_id': fields.many2one('ir.model', 'Object', required=True),
  70         'create_date': fields.datetime('Create Date', readonly=1),
  71         'active': fields.boolean('Active', help="If the active field is set to False,\
  72  it will allow you to hide the rule without removing it."),
  73         'sequence': fields.integer('Sequence', help="Gives the sequence order \
  74 when displaying a list of rules."),
  75         'trg_date_type':  fields.selection([
  76             ('none', 'None'),
  77             ('create', 'Creation Date'),
  78             ('action_last', 'Last Action Date'),
  79             ('date', 'Date'),
  80             ('deadline', 'Deadline'),
  81             ], 'Trigger Date', size=16),
  82         'trg_date_range': fields.integer('Delay after trigger date', \
  83                                          help="Delay After Trigger Date,\
  84 specifies you can put a negative number. If you need a delay before the \
  85 trigger date, like sending a reminder 15 minutes before a meeting."),
  86         'trg_date_range_type': fields.selection([('minutes', 'Minutes'), ('hour', 'Hours'), \
  87                                 ('day', 'Days'), ('month', 'Months')], 'Delay type'),
  88         'trg_user_id':  fields.many2one('res.users', 'Responsible'),
  89         'trg_partner_id': fields.many2one('res.partner', 'Partner'),
  90         'trg_partner_categ_id': fields.many2one('res.partner.category', 'Partner Category'),
  91         'trg_state_from': fields.selection(_state_get, 'State', size=16),
  92         'trg_state_to': fields.selection(_state_get, 'Button Pressed', size=16),
  93
  94         'act_method': fields.char('Call Object Method', size=64),
  95         'act_user_id': fields.many2one('res.users', 'Set Responsible to'),
  96         'act_state': fields.selection(_state_get, 'Set State to', size=16),
  97         'act_email_cc': fields.char('Add Watchers (Cc)', size=250, help="\
  98 These people will receive a copy of the future communication between partner \
  99 and users by email"),
 100         'act_remind_partner': fields.boolean('Remind Partner', help="Check \
 101 this if you want the rule to send a reminder by email to the partner."),
 102         'act_remind_user': fields.boolean('Remind Responsible', help="Check \
 103 this if you want the rule to send a reminder by email to the user."),
 104         'act_reply_to': fields.char('Reply-To', size=64),
 105         '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."),
 106         'act_mail_to_user': fields.boolean('Mail to Responsible', help="Check\
 107  this if you want the rule to send an email to the responsible person."),
 108         'act_mail_to_watchers': fields.boolean('Mail to Watchers (CC)',
 109                                                 help="Check this if you want \
 110 the rule to mark CC(mail to any other person defined in actions)."),
 111         'act_mail_to_email': fields.char('Mail to these Emails', size=128, \
 112         help="Email-id of the persons whom mail is to be sent"),
 113         'act_mail_body': fields.text('Mail body', help="Content of mail"),
 114         'regex_name': fields.char('Regex on Resource Name', size=128, help="Regular expression for matching name of the resource\
 115 \ne.g.: 'urgent.*' will search for records having name starting with the string 'urgent'\
 116 \nNote: This is case sensitive search."),
 117         '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"),
 118         'filter_id':fields.many2one('ir.filters', 'Filter', required=False),
 119         'act_email_from' : fields.char('Email From', size=64, required=False,
 120                 help="Use a python expression to specify the right field on which one than we will use for the 'From' field of the header"),
 121         'last_run': fields.datetime('Last Run', readonly=1),
 122     }
 123
 124     _defaults = {
 125         'active': lambda *a: True,
 126         'trg_date_type': lambda *a: 'none',
 127         'trg_date_range_type': lambda *a: 'day',
 128         'act_mail_to_user': lambda *a: 0,
 129         'act_remind_partner': lambda *a: 0,
 130         'act_remind_user': lambda *a: 0,
 131         'act_mail_to_watchers': lambda *a: 0,
 132     }
 133
 134     _order = 'sequence'
 135
 136     def onchange_model_id(self, cr, uid, ids, name):
 137         #This is not a good solution as it will affect the domain only on onchange
 138         res = {'domain':{'filter_id':[]}}
 139         if name:
 140             model_name = self.pool.get('ir.model').read(cr, uid, [name], ['model'])
 141             if model_name:
 142                 mod_name = model_name[0]['model']
 143                 res['domain'] = {'filter_id': [('model_id','=',mod_name)]}
 144         else:
 145             res['value'] = {'filter_id':False}
 146         return res
 147
 148     def pre_action(self, cr, uid, ids, model, context=None):
 149         # Searching for action rules
 150         cr.execute("SELECT model.model, rule.id  FROM base_action_rule rule \
 151                         LEFT JOIN ir_model model on (model.id = rule.model_id) \
 152                         WHERE active")
 153         res = cr.fetchall()
 154         # Check if any rule matching with current object
 155         for obj_name, rule_id in res:
 156             if not (model == obj_name):
 157                 continue
 158             else:
 159                 obj = self.pool.get(obj_name)
 160                 # If the rule doesn't involve a time condition, run it immediately
 161                 # Otherwise we let the scheduler run the action
 162                 if self.browse(cr, uid, rule_id, context=context).trg_date_type == 'none':
 163                     self._action(cr, uid, [rule_id], obj.browse(cr, uid, ids, context=context), context=context)
 164         return True
 165
 166     def _create(self, old_create, model, context=None):
 167         if not context:
 168             context  = {}
 169         def make_call_old(cr, uid, vals, context=context):
 170             new_id = old_create(cr, uid, vals, context=context)
 171             if not context.get('action'):
 172                 self.pre_action(cr, uid, [new_id], model, context=context)
 173             return new_id
 174         return make_call_old
 175
 176     def _write(self, old_write, model, context=None):
 177         if not context:
 178             context  = {}
 179         def make_call_old(cr, uid, ids, vals, context=context):
 180             if isinstance(ids, (str, int, long)):
 181                 ids = [ids]
 182             if not context.get('action'):
 183                 self.pre_action(cr, uid, ids, model, context=context)
 184             return old_write(cr, uid, ids, vals, context=context)
 185         return make_call_old
 186
 187     def _register_hook(self, cr, uid, ids, context=None):
 188         if not context:
 189             context = {}
 190         for action_rule in self.browse(cr, uid, ids, context=context):
 191             model = action_rule.model_id.model
 192             obj_pool = self.pool.get(model)
 193             if not hasattr(obj_pool, 'base_action_ruled'):
 194                 obj_pool.create = self._create(obj_pool.create, model, context=context)
 195                 obj_pool.write = self._write(obj_pool.write, model, context=context)
 196                 obj_pool.base_action_ruled = True
 197
 198         return True
 199     def create(self, cr, uid, vals, context=None):
 200         res_id = super(base_action_rule, self).create(cr, uid, vals, context)
 201         self._register_hook(cr, uid, [res_id], context=context)
 202         return res_id
 203
 204     def write(self, cr, uid, ids, vals, context=None):
 205         res = super(base_action_rule, self).write(cr, uid, ids, vals, context)
 206         self._register_hook(cr, uid, ids, context=context)
 207         return res
 208
 209     def _check(self, cr, uid, automatic=False, use_new_cursor=False, \
 210                        context=None):
 211         """
 212         This Function is call by scheduler.
 213         """
 214         rule_pool = self.pool.get('base.action.rule')
 215         rule_ids = rule_pool.search(cr, uid, [], context=context)
 216         self._register_hook(cr, uid, rule_ids, context=context)
 217
 218         rules = self.browse(cr, uid, rule_ids, context=context)
 219         for rule in rules:
 220             model = rule.model_id.model
 221             model_pool = self.pool.get(model)
 222             last_run = False
 223             if rule.last_run:
 224                 last_run = get_datetime(rule.last_run)
 225             now = datetime.now()
 226             for obj_id in model_pool.search(cr, uid, [], context=context):
 227                 obj = model_pool.browse(cr, uid, obj_id, context=context)
 228                 # Calculate when this action should next occur for this object
 229                 base = False
 230                 if rule.trg_date_type=='create' and hasattr(obj, 'create_date'):
 231                     base = obj.create_date
 232                 elif (rule.trg_date_type=='action_last'
 233                         and hasattr(obj, 'create_date')):
 234                     if hasattr(obj, 'date_action_last') and obj.date_action_last:
 235                         base = obj.date_action_last
 236                     else:
 237                         base = obj.create_date
 238                 elif (rule.trg_date_type=='deadline'
 239                         and hasattr(obj, 'date_deadline')
 240                         and obj.date_deadline):
 241                     base = obj.date_deadline
 242                 elif (rule.trg_date_type=='date'
 243                         and hasattr(obj, 'date')
 244                         and obj.date):
 245                     base = obj.date
 246                 if base:
 247                     fnct = {
 248                         'minutes': lambda interval: timedelta(minutes=interval),
 249                         'day': lambda interval: timedelta(days=interval),
 250                         'hour': lambda interval: timedelta(hours=interval),
 251                         'month': lambda interval: timedelta(months=interval),
 252                     }
 253                     base = get_datetime(base)
 254                     delay = fnct[rule.trg_date_range_type](rule.trg_date_range)
 255                     action_date = base + delay
 256                 if (not last_run or (last_run <= action_date < now)):
 257                     self._action(cr, uid, [rule.id], [obj], context=context)
 258             rule_pool.write(cr, uid, [rule.id], {'last_run': now},
 259                             context=context)
 260
 261     def format_body(self, body):
 262         """ Foramat Action rule's body
 263             @param self: The object pointer """
 264         return body and tools.ustr(body) or ''
 265
 266     def format_mail(self, obj, body):
 267         """ Foramat Mail
 268             @param self: The object pointer """
 269
 270         data = {
 271             'object_id': obj.id,
 272             'object_subject': hasattr(obj, 'name') and obj.name or False,
 273             'object_date': hasattr(obj, 'date') and obj.date or False,
 274             'object_description': hasattr(obj, 'description') and obj.description or False,
 275             'object_user': hasattr(obj, 'user_id') and (obj.user_id and obj.user_id.name) or '/',
 276             'object_user_email': hasattr(obj, 'user_id') and (obj.user_id and \
 277                                     obj.user_id.address_id and obj.user_id.address_id.email) or '/',
 278             'object_user_phone': hasattr(obj, 'user_id') and (obj.user_id and\
 279                                      obj.user_id.address_id and obj.user_id.address_id.phone) or '/',
 280             'partner': hasattr(obj, 'partner_id') and (obj.partner_id and obj.partner_id.name) or '/',
 281             'partner_email': hasattr(obj, 'partner_address_id') and (obj.partner_address_id and\
 282                                          obj.partner_address_id.email) or '/',
 283         }
 284         return self.format_body(body % data)
 285
 286     def email_send(self, cr, uid, obj, emails, body, emailfrom=None, context=None):
 287         """ send email
 288             @param self: The object pointer
 289             @param cr: the current row, from the database cursor,
 290             @param uid: the current user’s ID for security checks,
 291             @param email: pass the emails
 292             @param emailfrom: Pass name the email From else False
 293             @param context: A standard dictionary for contextual values """
 294
 295         if not emailfrom:
 296             emailfrom = tools.config.get('email_from', False)
 297
 298         if context is None:
 299             context = {}
 300
 301         body = self.format_mail(obj, body)
 302         if not emailfrom:
 303             if hasattr(obj, 'user_id')  and obj.user_id and obj.user_id.address_id and\
 304                         obj.user_id.address_id.email:
 305                 emailfrom = obj.user_id.address_id.email
 306
 307         name = '[%d] %s' % (obj.id, tools.ustr(obj.name))
 308         emailfrom = tools.ustr(emailfrom)
 309         reply_to = emailfrom
 310         if not emailfrom:
 311             raise osv.except_osv(_('Error!'),
 312                     _("No E-Mail ID Found for your Company address!"))
 313         return tools.email_send(emailfrom, emails, name, body, reply_to=reply_to, openobject_id=str(obj.id))
 314
 315
 316     def do_check(self, cr, uid, action, obj, context=None):
 317         """ check Action
 318             @param self: The object pointer
 319             @param cr: the current row, from the database cursor,
 320             @param uid: the current user’s ID for security checks,
 321             @param context: A standard dictionary for contextual values """
 322         if context is None:
 323             context = {}
 324         ok = True
 325         if action.filter_id:
 326             if action.model_id.model == action.filter_id.model_id:
 327                 context.update(eval(action.filter_id.context))
 328                 obj_ids = obj._table.search(cr, uid, eval(action.filter_id.domain), context=context)
 329                 if not obj.id in obj_ids:
 330                     ok = False
 331             else:
 332                 ok = False
 333         if getattr(obj, 'user_id', False):
 334             ok = ok and (not action.trg_user_id.id or action.trg_user_id.id==obj.user_id.id)
 335         if getattr(obj, 'partner_id', False):
 336             ok = ok and (not action.trg_partner_id.id or action.trg_partner_id.id==obj.partner_id.id)
 337             ok = ok and (
 338                 not action.trg_partner_categ_id.id or
 339                 (
 340                     obj.partner_id.id and
 341                     (action.trg_partner_categ_id.id in map(lambda x: x.id, obj.partner_id.category_id or []))
 342                 )
 343             )
 344         state_to = context.get('state_to', False)
 345         state = getattr(obj, 'state', False)
 346         if state:
 347             ok = ok and (not action.trg_state_from or action.trg_state_from==state)
 348         if state_to:
 349             ok = ok and (not action.trg_state_to or action.trg_state_to==state_to)
 350         elif action.trg_state_to:
 351             ok = False
 352         reg_name = action.regex_name
 353         result_name = True
 354         if reg_name:
 355             ptrn = re.compile(str(reg_name))
 356             _result = ptrn.search(str(obj.name))
 357             if not _result:
 358                 result_name = False
 359         regex_n = not reg_name or result_name
 360         ok = ok and regex_n
 361         return ok
 362
 363     def do_action(self, cr, uid, action, model_obj, obj, context=None):
 364         """ Do Action
 365             @param self: The object pointer
 366             @param cr: the current row, from the database cursor,
 367             @param uid: the current user’s ID for security checks,
 368             @param action: pass action
 369             @param model_obj: pass Model object
 370             @param context: A standard dictionary for contextual values """
 371         if context is None:
 372             context = {}
 373
 374         if action.server_action_id:
 375             context.update({'active_id':obj.id, 'active_ids':[obj.id]})
 376             self.pool.get('ir.actions.server').run(cr, uid, [action.server_action_id.id], context)
 377         write = {}
 378
 379         if hasattr(obj, 'user_id') and action.act_user_id:
 380             obj.user_id = action.act_user_id
 381             write['user_id'] = action.act_user_id.id
 382         if hasattr(obj, 'date_action_last'):
 383             write['date_action_last'] = time.strftime('%Y-%m-%d %H:%M:%S')
 384         if hasattr(obj, 'state') and action.act_state:
 385             obj.state = action.act_state
 386             write['state'] = action.act_state
 387
 388         if hasattr(obj, 'categ_id') and action.act_categ_id:
 389             obj.categ_id = action.act_categ_id
 390             write['categ_id'] = action.act_categ_id.id
 391
 392         model_obj.write(cr, uid, [obj.id], write, context)
 393
 394         if hasattr(model_obj, 'remind_user') and action.act_remind_user:
 395             model_obj.remind_user(cr, uid, [obj.id], context, attach=action.act_remind_attach)
 396         if hasattr(model_obj, 'remind_partner') and action.act_remind_partner:
 397             model_obj.remind_partner(cr, uid, [obj.id], context, attach=action.act_remind_attach)
 398         if action.act_method:
 399             getattr(model_obj, 'act_method')(cr, uid, [obj.id], action, context)
 400
 401         emails = []
 402         if hasattr(obj, 'user_id') and action.act_mail_to_user:
 403             if obj.user_id and obj.user_id.address_id:
 404                 emails.append(obj.user_id.address_id.email)
 405
 406         if action.act_mail_to_watchers:
 407             emails += (action.act_email_cc or '').split(',')
 408         if action.act_mail_to_email:
 409             emails += (action.act_mail_to_email or '').split(',')
 410         emails = filter(None, emails)
 411         if len(emails) and action.act_mail_body:
 412             emails = list(set(emails))
 413             email_from = safe_eval(action.act_email_from, {}, {
 414                 'user' : self.pool.get('res.users').browse(cr, uid, uid, context=context),
 415                 'obj' : obj,
 416             })
 417             self.email_send(cr, uid, obj, emails, action.act_mail_body, emailfrom=email_from)
 418         return True
 419
 420     def _action(self, cr, uid, ids, objects, scrit=None, context=None):
 421         """ Do Action
 422             @param self: The object pointer
 423             @param cr: the current row, from the database cursor,
 424             @param uid: the current user’s ID for security checks,
 425             @param ids: List of Basic Action Rule’s IDs,
 426             @param objects: pass objects
 427             @param context: A standard dictionary for contextual values """
 428         if context is None:
 429             context = {}
 430
 431         context.update({'action': True})
 432         if not scrit:
 433             scrit = []
 434
 435         for action in self.browse(cr, uid, ids, context):
 436             model_obj = self.pool.get(action.model_id.model)
 437             for obj in objects:
 438                 ok = self.do_check(cr, uid, action, obj, context=context)
 439                 if not ok:
 440                     continue
 441
 442                 if ok:
 443                     self.do_action(cr, uid, action, model_obj, obj, context)
 444                     break
 445         context.update({'action': False})
 446         return True
 447
 448     def _check_mail(self, cr, uid, ids, context=None):
 449         """ Check Mail
 450             @param self: The object pointer
 451             @param cr: the current row, from the database cursor,
 452             @param uid: the current user’s ID for security checks,
 453             @param ids: List of Action Rule’s IDs
 454             @param context: A standard dictionary for contextual values """
 455
 456         empty = orm.browse_null()
 457         rule_obj = self.pool.get('base.action.rule')
 458         for rule in self.browse(cr, uid, ids):
 459             if rule.act_mail_body:
 460                 try:
 461                     rule_obj.format_mail(empty, rule.act_mail_body)
 462                 except (ValueError, KeyError, TypeError):
 463                     return False
 464         return True
 465
 466     _constraints = [
 467         (_check_mail, 'Error: The mail is not well formated', ['act_mail_body']),
 468     ]
 469
 470 base_action_rule()
 471
 472
 473 class ir_cron(osv.osv):
 474     _inherit = 'ir.cron'
 475
 476     def _poolJobs(self, db_name, check=False):
 477         try:
 478             db = pooler.get_db(db_name)
 479         except:
 480             return False
 481         cr = db.cursor()
 482         try:
 483             next = datetime.now().strftime('%Y-%m-%d %H:00:00')
 484             # Putting nextcall always less than current time in order to call it every time
 485             cr.execute('UPDATE ir_cron set nextcall = \'%s\' where numbercall<>0 and active and model=\'base.action.rule\' ' % (next))
 486         finally:
 487             cr.commit()
 488             cr.close()
 489
 490         super(ir_cron, self)._poolJobs(db_name, check=check)
 491
 492 ir_cron()
 493
 494
 495 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: