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 import time
  23 import mx.DateTime
  24 import re
  25
  26 import tools
  27 from osv import fields, osv, orm
  28 from osv.orm import except_orm
  29 from tools.translate import _
  30
  31 class base_action_rule(osv.osv):
  32     """ Base Action Rules """
  33
  34     _name = 'base.action.rule'
  35     _description = 'Action Rules'
  36
  37     def _state_get(self, cr, uid, context={}):
  38         """ Get State
  39             @param self: The object pointer
  40             @param cr: the current row, from the database cursor,
  41             @param uid: the current user’s ID for security checks,
  42             @param context: A standard dictionary for contextual values """
  43
  44         return self.state_get(cr, uid, context=context)
  45
  46
  47     def state_get(self, cr, uid, context={}):
  48         """ Get State
  49             @param self: The object pointer
  50             @param cr: the current row, from the database cursor,
  51             @param uid: the current user’s ID for security checks,
  52             @param context: A standard dictionary for contextual values """
  53
  54         return [('','')]
  55
  56     _columns = {
  57         'name': fields.many2one('ir.model', 'Model', required=True),
  58         'max_level': fields.integer('Max Level', help='Specifies maximum level.'),
  59         'create_date': fields.datetime('Create Date', readonly=1),
  60         'active': fields.boolean('Active', help="If the active field is set to true,\
  61                      it will allow you to hide the rule without removing it."),
  62         'sequence': fields.integer('Sequence', help="Gives the sequence order when\
  63                      displaying a list of rules."),
  64         'trg_date_type':  fields.selection([
  65             ('none','None'),
  66             ('create','Creation Date'),
  67             ('action_last','Last Action Date'),
  68             ('date','Date'),
  69             ('deadline', 'Deadline'),
  70             ], 'Trigger Date', size=16),
  71         'trg_date_range': fields.integer('Delay after trigger date',help="Delay After Trigger Date,\
  72                              specifies you can put a negative number " \
  73                              "if you need a delay before the trigger date, like sending a reminder 15 minutes before a meeting."),
  74         'trg_date_range_type': fields.selection([('minutes', 'Minutes'),('hour','Hours'),\
  75                                 ('day','Days'),('month','Months')], 'Delay type'),
  76
  77
  78         'trg_user_id':  fields.many2one('res.users', 'Responsible'),
  79
  80         'trg_partner_id': fields.many2one('res.partner', 'Partner'),
  81         'trg_partner_categ_id': fields.many2one('res.partner.category', 'Partner Category'),
  82         'trg_state_from': fields.selection(_state_get, 'State', size=16),
  83         'trg_state_to': fields.selection(_state_get, 'Button Pressed', size=16),
  84
  85         'act_method': fields.char('Call Object Method', size=64),
  86         'act_user_id': fields.many2one('res.users', 'Set responsible to'),
  87         'act_state': fields.selection(_state_get, 'Set state to', size=16),
  88         'act_email_cc': fields.char('Add watchers (Cc)', size=250, help="These people\
  89                          will receive a copy of the future communication between partner and users by email"),
  90
  91         'act_remind_partner': fields.boolean('Remind Partner', help="Check this if\
  92                          you want the rule to send a reminder by email to the partner."),
  93         'act_remind_user': fields.boolean('Remind responsible', help="Check this if \
  94                         you want the rule to send a reminder by email to the user."),
  95         'act_reply_to': fields.char('Reply-To', size=64),
  96         'act_remind_attach': fields.boolean('Remind with attachment', help="Check this if\
  97                          you want that all documents attached to the object be attached \
  98                         to the reminder email sent."),
  99
 100         'act_mail_to_user': fields.boolean('Mail to responsible',help="Check this if \
 101                             you want the rule to send an email to the responsible person."),
 102         'act_mail_to_watchers': fields.boolean('Mail to watchers (CC)',help="Check this\
 103                                  if you want the rule to mark CC(mail to any other person\
 104                                   defined in actions)."),
 105         'act_mail_to_email': fields.char('Mail to these emails', size=128,help="Email-id \
 106                                 of the persons whom mail is to be sent"),
 107         'act_mail_body': fields.text('Mail body',help="Content of mail"),
 108         'regex_name': fields.char('Regular Expression on Model Name', size=128),
 109         'server_action_id': fields.many2one('ir.actions.server','Server Action',help="Describes the\
 110                                  action name." \
 111                                 "eg:on which object which action to be taken on basis of which condition"),
 112         'domain':fields.char('Domain', size=124, required=False, readonly=False),
 113     }
 114
 115     _defaults = {
 116         'active': lambda *a: True,
 117         'max_level': lambda *a: 15,
 118         'trg_date_type': lambda *a: 'none',
 119         'trg_date_range_type': lambda *a: 'day',
 120         'act_mail_to_user': lambda *a: 0,
 121         'act_remind_partner': lambda *a: 0,
 122         'act_remind_user': lambda *a: 0,
 123         'act_mail_to_watchers': lambda *a: 0,
 124         'domain': lambda *a: '[]'
 125     }
 126
 127     _order = 'sequence'
 128
 129     def format_body(self, body):
 130         """ Foramat Action rule's body
 131             @param self: The object pointer """
 132
 133         return body and tools.ustr(body) or ''
 134
 135     def format_mail(self, obj, body):
 136         """ Foramat Mail
 137             @param self: The object pointer """
 138         data = {
 139             'object_id': obj.id,
 140             'object_subject': hasattr(obj, 'name') and obj.name or False,
 141             'object_date': hasattr(obj, 'date') and obj.date or False,
 142             'object_description': hasattr(obj, 'description') and obj.description or False,
 143             'object_user': hasattr(obj, 'user_id') and (obj.user_id and obj.user_id.name) or '/',
 144             'object_user_email': hasattr(obj, 'user_id') and (obj.user_id and \
 145                                     obj.user_id.address_id and obj.user_id.address_id.email) or '/',
 146             'object_user_phone': hasattr(obj, 'user_id') and (obj.user_id and\
 147                                      obj.user_id.address_id and obj.user_id.address_id.phone) or '/',
 148             'partner': hasattr(obj, 'partner_id') and (obj.partner_id and obj.partner_id.name) or '/',
 149             'partner_email': hasattr(obj, 'partner_address_id') and (obj.partner_address_id and\
 150                                          obj.partner_address_id.email) or '/',
 151         }
 152         return self.format_body(body % data)
 153
 154     def email_send(self, cr, uid, obj, emails, body, emailfrom=tools.config.get('email_from',False), context={}):
 155         """ send email
 156             @param self: The object pointer
 157             @param cr: the current row, from the database cursor,
 158             @param uid: the current user’s ID for security checks,
 159             @param email: pass the emails
 160             @param emailfrom: Pass name the email From else False
 161             @param context: A standard dictionary for contextual values """
 162
 163         body = self.format_mail(obj, body)
 164         if not emailfrom:
 165             if hasattr(obj, 'user_id')  and obj.user_id and obj.user_id.address_id and\
 166                         obj.user_id.address_id.email:
 167                 emailfrom = obj.user_id.address_id.email
 168
 169         name = '[%d] %s' % (obj.id, tools.ustr(obj.name))
 170         emailfrom = tools.ustr(emailfrom)
 171         reply_to = emailfrom
 172         if not emailfrom:
 173             raise osv.except_osv(_('Error!'),
 174                     _("No E-Mail ID Found for your Company address!"))
 175         return tools.email_send(emailfrom, emails, name, body, reply_to=reply_to, openobject_id=str(obj.id))
 176
 177
 178     def do_check(self, cr, uid, action, obj, context={}):
 179         """ check Action
 180             @param self: The object pointer
 181             @param cr: the current row, from the database cursor,
 182             @param uid: the current user’s ID for security checks,
 183             @param context: A standard dictionary for contextual values """
 184
 185         ok = True
 186         if eval(action.domain):
 187             obj_ids = obj._table.search(cr, uid, eval(action.domain), context=context)
 188             if not obj.id in obj_ids:
 189                 ok = False
 190         if hasattr(obj, 'user_id'):
 191             ok = ok and (not action.trg_user_id.id or action.trg_user_id.id==obj.user_id.id)
 192         if hasattr(obj, 'partner_id'):
 193             ok = ok and (not action.trg_partner_id.id or action.trg_partner_id.id==obj.partner_id.id)
 194             ok = ok and (
 195                 not action.trg_partner_categ_id.id or
 196                 (
 197                     obj.partner_id.id and
 198                     (action.trg_partner_categ_id.id in map(lambda x: x.id, obj.partner_id.category_id or []))
 199                 )
 200             )
 201         state_to = context.get('state_to', False)
 202         if hasattr(obj, 'state'):
 203             ok = ok and (not action.trg_state_from or action.trg_state_from==obj.state)
 204         if state_to:
 205             ok = ok and (not action.trg_state_to or action.trg_state_to==state_to)
 206
 207         reg_name = action.regex_name
 208         result_name = True
 209         if reg_name:
 210             ptrn = re.compile(str(reg_name))
 211             _result = ptrn.search(str(obj.name))
 212             if not _result:
 213                 result_name = False
 214         regex_n = not reg_name or result_name
 215         ok = ok and regex_n
 216         return ok
 217
 218     def do_action(self, cr, uid, action, model_obj, obj, context={}):
 219         """ Do Action
 220             @param self: The object pointer
 221             @param cr: the current row, from the database cursor,
 222             @param uid: the current user’s ID for security checks,
 223             @param action: pass action
 224             @param model_obj: pass Model object
 225             @param context: A standard dictionary for contextual values """
 226
 227         if action.server_action_id:
 228             context.update({'active_id':obj.id,'active_ids':[obj.id]})
 229             self.pool.get('ir.actions.server').run(cr, uid, [action.server_action_id.id], context)
 230         write = {}
 231         if hasattr(obj, 'user_id') and action.act_user_id:
 232             obj.user_id = action.act_user_id
 233             write['user_id'] = action.act_user_id.id
 234         if hasattr(obj, 'date_action_last'):
 235             write['date_action_last'] = time.strftime('%Y-%m-%d %H:%M:%S')
 236         if hasattr(obj, 'state') and action.act_state:
 237             obj.state = action.act_state
 238             write['state'] = action.act_state
 239
 240         if hasattr(obj, 'categ_id') and action.act_categ_id:
 241             obj.categ_id = action.act_categ_id
 242             write['categ_id'] = action.act_categ_id.id
 243
 244         model_obj.write(cr, uid, [obj.id], write, context)
 245
 246         if hasattr(model_obj, 'remind_user') and action.act_remind_user:
 247             model_obj.remind_user(cr, uid, [obj.id], context, attach=action.act_remind_attach)
 248         if hasattr(model_obj, 'remind_partner') and action.act_remind_partner:
 249             model_obj.remind_partner(cr, uid, [obj.id], context, attach=action.act_remind_attach)
 250         if action.act_method:
 251             getattr(model_obj, 'act_method')(cr, uid, [obj.id], action, context)
 252         emails = []
 253         if hasattr(obj, 'user_id') and action.act_mail_to_user:
 254             if obj.user_id and obj.user_id.address_id:
 255                 emails.append(obj.user_id.address_id.email)
 256
 257         if action.act_mail_to_watchers:
 258             emails += (action.act_email_cc or '').split(',')
 259         if action.act_mail_to_email:
 260             emails += (action.act_mail_to_email or '').split(',')
 261         emails = filter(None, emails)
 262         if len(emails) and action.act_mail_body:
 263             emails = list(set(emails))
 264             self.email_send(cr, uid, obj, emails, action.act_mail_body)
 265         return True
 266
 267     def _action(self, cr, uid, ids, objects, scrit=None, context={}):
 268         """ Do Action
 269             @param self: The object pointer
 270             @param cr: the current row, from the database cursor,
 271             @param uid: the current user’s ID for security checks,
 272             @param ids: List of Basic Action Rule’s IDs,
 273             @param objects: pass objects
 274             @param context: A standard dictionary for contextual values """
 275         if not scrit:
 276             scrit = []
 277         cr.execute("select id from base_action_rule order by sequence")
 278         rule_ids = map(lambda x: x[0], cr.fetchall())
 279         for action in self.browse(cr, uid, rule_ids):
 280             level = action.max_level
 281             if not level:
 282                 break
 283             model_obj = self.pool.get(action.name.model)
 284             for obj in objects:
 285                 ok = self.do_check(cr, uid, action, obj, context=context)
 286                 if not ok:
 287                     continue
 288
 289                 base = False
 290                 if hasattr(obj, 'create_date') and action.trg_date_type=='create':
 291                     base = mx.DateTime.strptime(obj.create_date[:19], '%Y-%m-%d %H:%M:%S')
 292                 elif hasattr(obj, 'create_date') and action.trg_date_type=='action_last':
 293                     if hasattr(obj, 'date_action_last') and obj.date_action_last:
 294                         base = mx.DateTime.strptime(obj.date_action_last, '%Y-%m-%d %H:%M:%S')
 295                     else:
 296                         base = mx.DateTime.strptime(obj.create_date[:19], '%Y-%m-%d %H:%M:%S')
 297                 elif hasattr(obj, 'date_deadline') and action.trg_date_type=='deadline' \
 298                                 and obj.date_deadline:
 299                     base = mx.DateTime.strptime(obj.date_deadline, '%Y-%m-%d %H:%M:%S')
 300                 elif hasattr(obj, 'date') and action.trg_date_type=='date' and obj.date:
 301                     base = mx.DateTime.strptime(obj.date, '%Y-%m-%d %H:%M:%S')
 302                 if base:
 303                     fnct = {
 304                         'minutes': lambda interval: mx.DateTime.RelativeDateTime(minutes=interval),
 305                         'day': lambda interval: mx.DateTime.RelativeDateTime(days=interval),
 306                         'hour': lambda interval: mx.DateTime.RelativeDateTime(hours=interval),
 307                         'month': lambda interval: mx.DateTime.RelativeDateTime(months=interval),
 308                     }
 309                     d = base + fnct[action.trg_date_range_type](action.trg_date_range)
 310                     dt = d.strftime('%Y-%m-%d %H:%M:%S')
 311                     ok = False
 312                     if hasattr(obj, 'date_action_last') and hasattr(obj, 'date_action_next'):
 313                         ok = (dt <= time.strftime('%Y-%m-%d %H:%M:%S')) and \
 314                                 ((not obj.date_action_next) or \
 315                                 (dt >= obj.date_action_next and \
 316                                 obj.date_action_last < obj.date_action_next))
 317                         if not ok:
 318                             if not obj.date_action_next or dt < obj.date_action_next:
 319                                 obj.date_action_next = dt
 320                                 model_obj.write(cr, uid, [obj.id], {'date_action_next': dt}, context)
 321                 else:
 322                     ok = action.trg_date_type=='none'
 323                 if ok:
 324                     self.do_action(cr, uid, action, model_obj, obj, context)
 325                     break
 326             level -= 1
 327         return True
 328
 329     def _check_mail(self, cr, uid, ids, context=None):
 330         """ Check Mail
 331             @param self: The object pointer
 332             @param cr: the current row, from the database cursor,
 333             @param uid: the current user’s ID for security checks,
 334             @param ids: List of Action Rule’s IDs
 335             @param context: A standard dictionary for contextual values """
 336
 337         empty = orm.browse_null()
 338         rule_obj = self.pool.get('base.action.rule')
 339         for rule in self.browse(cr, uid, ids):
 340             if rule.act_mail_body:
 341                 try:
 342                     rule_obj.format_mail(empty, rule.act_mail_body)
 343                 except (ValueError, KeyError, TypeError):
 344                     return False
 345         return True
 346
 347     _constraints = [
 348         (_check_mail, 'Error: The mail is not well formated', ['act_mail_body']),
 349     ]
 350
 351 base_action_rule()
 352
 353 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: