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