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 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
  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))
 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             obj_pool.__setattr__('create', self._create(obj_pool.create, model, context=context))
 185             obj_pool.__setattr__('write', self._write(obj_pool.write, model, context=context))
 186         return True
 187
 188     def create(self, cr, uid, vals, context=None):
 189         res_id = super(base_action_rule, self).create(cr, uid, vals, context)
 190         self._register_hook(cr, uid, [res_id], context=context)
 191         return res_id
 192
 193     def write(self, cr, uid, ids, vals, context=None):
 194         res = super(base_action_rule, self).write(cr, uid, ids, vals, context)
 195         self._register_hook(cr, uid, ids, context=context)
 196         return res
 197
 198     def _check(self, cr, uid, automatic=False, use_new_cursor=False, \
 199                        context=None):
 200         """
 201         This Function is call by scheduler.
 202         """
 203         rule_pool = self.pool.get('base.action.rule')
 204         rule_ids = rule_pool.search(cr, uid, [], context=context)
 205         return self._register_hook(cr, uid, rule_ids, context=context)
 206
 207
 208     def format_body(self, body):
 209         """ Foramat Action rule's body
 210             @param self: The object pointer """
 211         return body and tools.ustr(body) or ''
 212
 213     def format_mail(self, obj, body):
 214         """ Foramat Mail
 215             @param self: The object pointer """
 216
 217         data = {
 218             'object_id': obj.id,
 219             'object_subject': hasattr(obj, 'name') and obj.name or False,
 220             'object_date': hasattr(obj, 'date') and obj.date or False,
 221             'object_description': hasattr(obj, 'description') and obj.description or False,
 222             'object_user': hasattr(obj, 'user_id') and (obj.user_id and obj.user_id.name) or '/',
 223             'object_user_email': hasattr(obj, 'user_id') and (obj.user_id and \
 224                                     obj.user_id.address_id and obj.user_id.address_id.email) or '/',
 225             'object_user_phone': hasattr(obj, 'user_id') and (obj.user_id and\
 226                                      obj.user_id.address_id and obj.user_id.address_id.phone) or '/',
 227             'partner': hasattr(obj, 'partner_id') and (obj.partner_id and obj.partner_id.name) or '/',
 228             'partner_email': hasattr(obj, 'partner_address_id') and (obj.partner_address_id and\
 229                                          obj.partner_address_id.email) or '/',
 230         }
 231         return self.format_body(body % data)
 232
 233     def email_send(self, cr, uid, obj, emails, body, emailfrom=None, context=None):
 234         """ send email
 235             @param self: The object pointer
 236             @param cr: the current row, from the database cursor,
 237             @param uid: the current user’s ID for security checks,
 238             @param email: pass the emails
 239             @param emailfrom: Pass name the email From else False
 240             @param context: A standard dictionary for contextual values """
 241
 242         if not emailfrom:
 243             emailfrom = tools.config.get('email_from', False)
 244
 245         if context is None:
 246             context = {}
 247
 248         body = self.format_mail(obj, body)
 249         if not emailfrom:
 250             if hasattr(obj, 'user_id')  and obj.user_id and obj.user_id.address_id and\
 251                         obj.user_id.address_id.email:
 252                 emailfrom = obj.user_id.address_id.email
 253
 254         name = '[%d] %s' % (obj.id, tools.ustr(obj.name))
 255         emailfrom = tools.ustr(emailfrom)
 256         reply_to = emailfrom
 257         if not emailfrom:
 258             raise osv.except_osv(_('Error!'),
 259                     _("No E-Mail ID Found for your Company address!"))
 260         return tools.email_send(emailfrom, emails, name, body, reply_to=reply_to, openobject_id=str(obj.id))
 261
 262
 263     def do_check(self, cr, uid, action, obj, context={}):
 264         """ check Action
 265             @param self: The object pointer
 266             @param cr: the current row, from the database cursor,
 267             @param uid: the current user’s ID for security checks,
 268             @param context: A standard dictionary for contextual values """
 269         ok = True
 270         if action.filter_id:
 271             if action.model_id.model == action.filter_id.model_id:
 272                 context.update(eval(action.filter_id.context))
 273                 obj_ids = obj._table.search(cr, uid, eval(action.filter_id.domain), context=context)
 274                 if not obj.id in obj_ids:
 275                     ok = False
 276             else:
 277                 ok = False
 278         if hasattr(obj, 'user_id'):
 279             ok = ok and (not action.trg_user_id.id or action.trg_user_id.id==obj.user_id.id)
 280         if hasattr(obj, 'partner_id'):
 281             ok = ok and (not action.trg_partner_id.id or action.trg_partner_id.id==obj.partner_id.id)
 282             ok = ok and (
 283                 not action.trg_partner_categ_id.id or
 284                 (
 285                     obj.partner_id.id and
 286                     (action.trg_partner_categ_id.id in map(lambda x: x.id, obj.partner_id.category_id or []))
 287                 )
 288             )
 289         state_to = context.get('state_to', False)
 290         if hasattr(obj, 'state'):
 291             ok = ok and (not action.trg_state_from or action.trg_state_from==obj.state)
 292         if state_to:
 293             ok = ok and (not action.trg_state_to or action.trg_state_to==state_to)
 294         elif action.trg_state_to:
 295             ok = False
 296         reg_name = action.regex_name
 297         result_name = True
 298         if reg_name:
 299             ptrn = re.compile(str(reg_name))
 300             _result = ptrn.search(str(obj.name))
 301             if not _result:
 302                 result_name = False
 303         regex_n = not reg_name or result_name
 304         ok = ok and regex_n
 305         return ok
 306
 307     def do_action(self, cr, uid, action, model_obj, obj, context={}):
 308         """ Do Action
 309             @param self: The object pointer
 310             @param cr: the current row, from the database cursor,
 311             @param uid: the current user’s ID for security checks,
 312             @param action: pass action
 313             @param model_obj: pass Model object
 314             @param context: A standard dictionary for contextual values """
 315
 316         if action.server_action_id:
 317             context.update({'active_id':obj.id, 'active_ids':[obj.id]})
 318             self.pool.get('ir.actions.server').run(cr, uid, [action.server_action_id.id], context)
 319         write = {}
 320
 321         if hasattr(obj, 'user_id') and action.act_user_id:
 322             obj.user_id = action.act_user_id
 323             write['user_id'] = action.act_user_id.id
 324         if hasattr(obj, 'date_action_last'):
 325             write['date_action_last'] = time.strftime('%Y-%m-%d %H:%M:%S')
 326         if hasattr(obj, 'state') and action.act_state:
 327             obj.state = action.act_state
 328             write['state'] = action.act_state
 329
 330         if hasattr(obj, 'categ_id') and action.act_categ_id:
 331             obj.categ_id = action.act_categ_id
 332             write['categ_id'] = action.act_categ_id.id
 333
 334         model_obj.write(cr, uid, [obj.id], write, context)
 335
 336         if hasattr(model_obj, 'remind_user') and action.act_remind_user:
 337             model_obj.remind_user(cr, uid, [obj.id], context, attach=action.act_remind_attach)
 338         if hasattr(model_obj, 'remind_partner') and action.act_remind_partner:
 339             model_obj.remind_partner(cr, uid, [obj.id], context, attach=action.act_remind_attach)
 340         if action.act_method:
 341             getattr(model_obj, 'act_method')(cr, uid, [obj.id], action, context)
 342         emails = []
 343         if hasattr(obj, 'user_id') and action.act_mail_to_user:
 344             if obj.user_id and obj.user_id.address_id:
 345                 emails.append(obj.user_id.address_id.email)
 346
 347         if action.act_mail_to_watchers:
 348             emails += (action.act_email_cc or '').split(',')
 349         if action.act_mail_to_email:
 350             emails += (action.act_mail_to_email or '').split(',')
 351         emails = filter(None, emails)
 352         if len(emails) and action.act_mail_body:
 353             emails = list(set(emails))
 354             email_from = eval(action.act_email_from, {
 355                 'user' : self.pool.get('res.users').browse(cr, uid, uid, context=context),
 356                 'obj' : obj,
 357             })
 358             self.email_send(cr, uid, obj, emails, action.act_mail_body, emailfrom=email_from)
 359         return True
 360
 361     def _action(self, cr, uid, ids, objects, scrit=None, context={}):
 362         """ Do Action
 363             @param self: The object pointer
 364             @param cr: the current row, from the database cursor,
 365             @param uid: the current user’s ID for security checks,
 366             @param ids: List of Basic Action Rule’s IDs,
 367             @param objects: pass objects
 368             @param context: A standard dictionary for contextual values """
 369         context.update({'action': True})
 370         if not scrit:
 371             scrit = []
 372         for action in self.browse(cr, uid, ids):
 373             model_obj = self.pool.get(action.model_id.model)
 374             for obj in objects:
 375                 ok = self.do_check(cr, uid, action, obj, context=context)
 376                 if not ok:
 377                     continue
 378
 379                 base = False
 380                 if action.trg_date_type=='create' and hasattr(obj, 'create_date'):
 381                     base = datetime.strptime(obj.create_date[:19], '%Y-%m-%d %H:%M:%S')
 382                 elif action.trg_date_type=='action_last' and hasattr(obj, 'create_date'):
 383                     if hasattr(obj, 'date_action_last') and obj.date_action_last:
 384                         base = datetime.strptime(obj.date_action_last, '%Y-%m-%d %H:%M:%S')
 385                     else:
 386                         base = datetime.strptime(obj.create_date[:19], '%Y-%m-%d %H:%M:%S')
 387                 elif action.trg_date_type=='deadline' and hasattr(obj, 'date_deadline') \
 388                                 and obj.date_deadline:
 389                     base = datetime.strptime(obj.date_deadline, '%Y-%m-%d %H:%M:%S')
 390                 elif action.trg_date_type=='date' and hasattr(obj, 'date') and obj.date:
 391                     base = datetime.strptime(obj.date, '%Y-%m-%d %H:%M:%S')
 392                 if base:
 393                     fnct = {
 394                         'minutes': lambda interval: timedelta(minutes=interval),
 395                         'day': lambda interval: timedelta(days=interval),
 396                         'hour': lambda interval: timedelta(hours=interval),
 397                         'month': lambda interval: timedelta(months=interval),
 398                     }
 399                     d = base + fnct[action.trg_date_range_type](action.trg_date_range)
 400                     dt = d.strftime('%Y-%m-%d %H:%M:%S')
 401                     ok = False
 402                     if hasattr(obj, 'date_action_last') and hasattr(obj, 'date_action_next'):
 403                         ok = (dt <= time.strftime('%Y-%m-%d %H:%M:%S')) and \
 404                                 ((not obj.date_action_next) or \
 405                                 (dt >= obj.date_action_next and \
 406                                 obj.date_action_last < obj.date_action_next))
 407                         if not ok:
 408                             if not obj.date_action_next or dt < obj.date_action_next:
 409                                 obj.date_action_next = dt
 410                                 model_obj.write(cr, uid, [obj.id], {'date_action_next': dt}, context)
 411                 else:
 412                     ok = action.trg_date_type == 'none'
 413
 414                 if ok:
 415                     self.do_action(cr, uid, action, model_obj, obj, context)
 416                     break
 417         context.update({'action': False})
 418         return True
 419
 420     def _check_mail(self, cr, uid, ids, context=None):
 421         """ Check Mail
 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 Action Rule’s IDs
 426             @param context: A standard dictionary for contextual values """
 427
 428         empty = orm.browse_null()
 429         rule_obj = self.pool.get('base.action.rule')
 430         for rule in self.browse(cr, uid, ids):
 431             if rule.act_mail_body:
 432                 try:
 433                     rule_obj.format_mail(empty, rule.act_mail_body)
 434                 except (ValueError, KeyError, TypeError):
 435                     return False
 436         return True
 437
 438     _constraints = [
 439         (_check_mail, 'Error: The mail is not well formated', ['act_mail_body']),
 440     ]
 441
 442 base_action_rule()
 443
 444
 445 class ir_cron(osv.osv):
 446     _inherit = 'ir.cron'
 447
 448     def _poolJobs(self, db_name, check=False):
 449         try:
 450             db = pooler.get_db(db_name)
 451         except:
 452             return False
 453         cr = db.cursor()
 454         try:
 455             next = datetime.now().strftime('%Y-%m-%d %H:00:00')
 456             # Putting nextcall always less than current time in order to call it every time
 457             cr.execute('UPDATE ir_cron set nextcall = \'%s\' where numbercall<>0 and active and model=\'base.action.rule\' ' % (next))
 458         finally:
 459             cr.commit()
 460             cr.close()
 461
 462         super(ir_cron, self)._poolJobs(db_name, check=check)
 463
 464 ir_cron()
 465
 466
 467 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: