addons/base_action_rule/base_action_rule.py

   1 import time
   2 import mx.DateTime
   3 import re
   4
   5 import tools
   6 from osv import fields, osv, orm
   7 from osv.orm import except_orm
   8
   9 AVAILABLE_STATES = [
  10     ('draft','Draft'),
  11     ('open','Open'),
  12     ('cancel', 'Cancelled'),
  13     ('done', 'Closed'),
  14     ('pending','Pending')
  15 ]
  16
  17 AVAILABLE_PRIORITIES = [
  18     ('5','Lowest'),
  19     ('4','Low'),
  20     ('3','Normal'),
  21     ('2','High'),
  22     ('1','Highest')
  23 ]
  24
  25 class base_action_rule(osv.osv):
  26     _name = 'base.action.rule'
  27     _description = 'Action Rules'
  28     _columns = {
  29         'name': fields.many2one('ir.model', 'Model', required=True),
  30         'max_level': fields.integer('Max Level'),
  31         'rule_lines': fields.one2many('base.action.rule.line','rule_id','Rule Lines'),
  32         'create_date': fields.datetime('Create Date', readonly=1)
  33     }
  34
  35     def _check(self, cr, uid, ids=False, context={}):
  36         '''
  37         Function called by the scheduler to process models
  38         '''
  39         ruleobj = self.pool.get('base.action.rule')
  40         ids = ruleobj.search(cr, uid, [])
  41         rules = ruleobj.browse(cr, uid, ids, context)
  42         return ruleobj._action(cr, uid, rules, False, context=context)
  43
  44     def _action(self, cr, uid, rules, state_to, scrit=None, context={}):
  45         if not scrit:
  46             scrit = []
  47         history = []
  48         history_obj = self.pool.get('base.action.rule.history')
  49         cr.execute("select nextcall from ir_cron where model='base.action.rule'")
  50         action_next = cr.fetchone()[0]
  51         if rules:
  52             cr.execute('select id, rule_id, res_id, date_action_last, date_action_next' \
  53                        ' from base_action_rule_history where rule_id in (%s)' %(','.join(map(lambda x: "'"+str(x.id)+"'",rules))))
  54             history = cr.fetchall()
  55             checkids = map(lambda x: x[1], history or [])
  56             if not len(history) or len(history) < len(rules):
  57                 for rule in rules:
  58                     if rule.id not in checkids:
  59                         lastDate = mx.DateTime.strptime(rule.create_date[:19], '%Y-%m-%d %H:%M:%S')
  60                         history_obj.create(cr, uid, {'rule_id': rule.id, 'res_id': rule.name.id, 'date_action_last': lastDate, 'date_action_next': action_next})
  61         for rule in rules:
  62             obj = self.pool.get(rule.name.model)
  63             rec_ids = obj.search(cr, uid, [])
  64             for action in rule.rule_lines:
  65                 for data in obj.browse(cr, uid, rec_ids):
  66                     ok = True
  67                     ok = ok and (not action.trg_state_from or action.trg_state_from==data.state)
  68                     ok = ok and (not action.trg_state_to or action.trg_state_to==state_to)
  69                     ok = ok and (not action.trg_user_id.id or action.trg_user_id.id==data.user_id.id)
  70                     ok = ok and (not action.trg_partner_id.id or action.trg_partner_id.id==data.partner_id.id)
  71                     ok = ok and (
  72                         not action.trg_partner_categ_id.id or
  73                         (
  74                             data.partner_id.id and
  75                             (action.trg_partner_categ_id.id in map(lambda x: x.id, data.partner_id.category_id or []))
  76                         )
  77                     )
  78                     ok = ok and (not action.trg_priority_from or action.trg_priority_from>=data.priority)
  79                     ok = ok and (not action.trg_priority_to or action.trg_priority_to<=data.priority)
  80
  81                     reg_name = action.regex_name
  82                     result_name = True
  83                     if reg_name:
  84                         ptrn = re.compile(str(reg_name))
  85                         _result = ptrn.search(str(data.name))
  86                         if not _result:
  87                             result_name = False
  88                     regex_n = not reg_name or result_name
  89                     ok = ok and regex_n
  90
  91                     if not ok:
  92                         continue
  93
  94                     base = False
  95                     if action.trg_date_type=='create':
  96                         base = mx.DateTime.strptime(data.create_date[:19], '%Y-%m-%d %H:%M:%S')
  97                     elif action.trg_date_type=='action_last':
  98                         for hist in history:
  99                             if hist[3]:
 100                                 base = hist[4]
 101                             else:
 102                                 base = mx.DateTime.strptime(data.create_date[:19], '%Y-%m-%d %H:%M:%S')
 103                     elif action.trg_date_type=='date' and data.date:
 104                         base = mx.DateTime.strptime(data.date, '%Y-%m-%d %H:%M:%S')
 105                     if base:
 106                         fnct = {
 107                             'minutes': lambda interval: mx.DateTime.RelativeDateTime(minutes=interval),
 108                             'day': lambda interval: mx.DateTime.RelativeDateTime(days=interval),
 109                             'hour': lambda interval: mx.DateTime.RelativeDateTime(hours=interval),
 110                             'month': lambda interval: mx.DateTime.RelativeDateTime(months=interval),
 111                         }
 112                         d = base + fnct[action.trg_date_range_type](action.trg_date_range)
 113                         dt = d.strftime('%Y-%m-%d %H:%M:%S')
 114                         for hist in history:
 115                             ok = (dt <= time.strftime('%Y-%m-%d %H:%M:%S')) and \
 116                                     ((not hist[4]) or \
 117                                     (dt >= hist[4] and \
 118                                     hist[3] < hist[4]))
 119                             if not ok:
 120                                 if not hist[4] or dt < hist[4]:
 121                                     history_obj.write(cr, uid, [hist[0]], {'date_action_next': dt}, context)
 122
 123                     else:
 124                         ok = action.trg_date_type=='none'
 125
 126                     if ok:
 127                         if action.server_action_id:
 128                             context.update({'active_id': data.id,'active_ids': [data.id]})
 129                             self.pool.get('ir.actions.server').run(cr, uid, [action.server_action_id.id], context)
 130                         write = {}
 131                         if action.act_state:
 132                             data.state = action.act_state
 133                             write['state'] = action.act_state
 134                         if action.act_user_id:
 135                             data.user_id = action.act_user_id
 136                             write['user_id'] = action.act_user_id.id
 137                         if action.act_priority:
 138                             data.priority = action.act_priority
 139                             write['priority'] = action.act_priority
 140                         if action.act_email_cc:
 141                             if '@' in (data.email_cc or ''):
 142                                 emails = data.email_cc.split(",")
 143                                 if  action.act_email_cc not in emails:# and '<'+str(action.act_email_cc)+">" not in emails:
 144                                     write['email_cc'] = data.email_cc+','+action.act_email_cc
 145                             else:
 146                                 write['email_cc'] = action.act_email_cc
 147                         obj.write(cr, uid, [data.id], write, context)
 148                         if action.act_remind_user:
 149                             obj.remind_user(cr, uid, [data.id], context, attach=action.act_remind_attach)
 150                         if action.act_remind_partner:
 151                             obj.remind_partner(cr, uid, [data.id], context, attach=action.act_remind_attach)
 152                         if action.act_method:
 153                             getattr(caseobj, 'act_method')(cr, uid, [data.id], action, context)
 154                         emails = []
 155                         if action.act_mail_to_user:
 156                             if data.user_id and data.user_id.address_id:
 157                                 emails.append(data.user_id.address_id.email)
 158                         if action.act_mail_to_partner:
 159                             emails.append(data.email_from)
 160                         if action.act_mail_to_watchers:
 161                             emails += (action.act_email_cc or '').split(',')
 162                         if action.act_mail_to_email:
 163                             emails += (action.act_mail_to_email or '').split(',')
 164                         emails = filter(None, emails)
 165                         if len(emails) and action.act_mail_body:
 166                             emails = list(set(emails))
 167                             obj.email_send(cr, uid, data, emails, action.act_mail_body)
 168                 for hist in history:
 169                     if hist[3]:
 170                         base = hist[4]
 171                     history_obj.write(cr, uid, [hist[0]], {'date_action_last': base, 'date_action_next': action_next})
 172         return True
 173
 174 base_action_rule()
 175
 176 class base_action_rule_line(osv.osv):
 177     _name = 'base.action.rule.line'
 178     _description = 'Action Rule Lines'
 179     _columns = {
 180         'name': fields.char('Rule Name',size=64, required=True),
 181         'rule_id': fields.many2one('base.action.rule','Rule'),
 182         'active': fields.boolean('Active', help="If the active field is set to true, it will allow you to hide the case rule without removing it."),
 183         'sequence': fields.integer('Sequence', help="Gives the sequence order when displaying a list of case rules."),
 184
 185         'trg_state_from': fields.selection([('',''),('escalate','Escalate')]+AVAILABLE_STATES, 'State', size=16),
 186         'trg_state_to': fields.selection([('',''),('escalate','Escalate')]+AVAILABLE_STATES, 'Button Pressed', size=16),
 187
 188         'trg_date_type':  fields.selection([
 189             ('none','None'),
 190             ('create','Creation Date'),
 191             ('action_last','Last Action Date'),
 192             ('date','Date'),
 193             ], 'Trigger Date', size=16),
 194         'trg_date_range': fields.integer('Delay after trigger date',help="Delay After Trigger Date, specifies you can put a negative number " \
 195                                                              "if you need a delay before the trigger date, like sending a reminder 15 minutes before a meeting."),
 196         'trg_date_range_type': fields.selection([('minutes', 'Minutes'),('hour','Hours'),('day','Days'),('month','Months')], 'Delay type'),
 197
 198
 199         'trg_user_id':  fields.many2one('res.users', 'Responsible'),
 200
 201         'trg_partner_id': fields.many2one('res.partner', 'Partner'),
 202         'trg_partner_categ_id': fields.many2one('res.partner.category', 'Partner Category'),
 203
 204         'trg_priority_from': fields.selection([('','')] + AVAILABLE_PRIORITIES, 'Minimum Priority'),
 205         'trg_priority_to': fields.selection([('','')] + AVAILABLE_PRIORITIES, 'Maximum Priority'),
 206
 207
 208         'act_method': fields.char('Call Object Method', size=64),
 209         'act_state': fields.selection([('','')]+AVAILABLE_STATES, 'Set state to', size=16),
 210         'act_user_id': fields.many2one('res.users', 'Set responsible to'),
 211         'act_priority': fields.selection([('','')] + AVAILABLE_PRIORITIES, 'Set priority to'),
 212         'act_email_cc': fields.char('Add watchers (Cc)', size=250, help="These people will receive a copy of the future communication between partner and users by email"),
 213
 214         'act_remind_partner': fields.boolean('Remind Partner', help="Check this if you want the rule to send a reminder by email to the partner."),
 215         'act_remind_user': fields.boolean('Remind responsible', help="Check this if you want the rule to send a reminder by email to the user."),
 216         'act_remind_attach': fields.boolean('Remind with attachment', help="Check this if you want that all documents attached to the case be attached to the reminder email sent."),
 217
 218         'act_mail_to_user': fields.boolean('Mail to responsible',help="Check this if you want the rule to send an email to the responsible person."),
 219         'act_mail_to_partner': fields.boolean('Mail to partner',help="Check this if you want the rule to send an email to the partner."),
 220         'act_mail_to_watchers': fields.boolean('Mail to watchers (CC)',help="Check this if you want the rule to mark CC(mail to any other person defined in actions)."),
 221         'act_mail_to_email': fields.char('Mail to these emails', size=128,help="Email-id of the persons whom mail is to be sent"),
 222         'act_mail_body': fields.text('Mail body',help="Content of mail"),
 223         'regex_name': fields.char('Regular Expression on Model Name', size=128),
 224         'server_action_id': fields.many2one('ir.actions.server','Server Action',help="Describes the action name." \
 225                                                     "eg:on which object which action to be taken on basis of which condition"),
 226     }
 227
 228     _defaults = {
 229         'active': lambda *a: 1,
 230         'trg_date_type': lambda *a: 'none',
 231         'trg_date_range_type': lambda *a: 'day',
 232         'act_mail_to_user': lambda *a: 0,
 233         'act_remind_partner': lambda *a: 0,
 234         'act_remind_user': lambda *a: 0,
 235         'act_mail_to_partner': lambda *a: 0,
 236         'act_mail_to_watchers': lambda *a: 0,
 237     }
 238
 239     _order = 'sequence'
 240
 241     def format_body(self, body):
 242         return body and tools.ustr(body.encode('ascii', 'replace')) or ''
 243
 244     def format_mail(self, case, body):
 245         data = {
 246             'case_id': case.id,
 247             'case_subject': case.name,
 248             'case_date': case.date,
 249             'case_description': case.description,
 250
 251             'case_user': (case.user_id and case.user_id.name) or '/',
 252             'case_user_email': (case.user_id and case.user_id.address_id and case.user_id.address_id.email) or '/',
 253             'case_user_phone': (case.user_id and case.user_id.address_id and case.user_id.address_id.phone) or '/',
 254
 255             'email_from': case.email_from,
 256             'partner': (case.partner_id and case.partner_id.name) or '/',
 257             'partner_email': (case.partner_address_id and case.partner_address_id.email) or '/',
 258         }
 259         return self.format_body(body % data)
 260
 261     def _check_mail(self, cr, uid, ids, context=None):
 262         emptycase = orm.browse_null()
 263         for rule in self.browse(cr, uid, ids):
 264             if rule.act_mail_body:
 265                 try:
 266                     self.format_mail(emptycase, rule.act_mail_body)
 267                 except (ValueError, KeyError, TypeError):
 268                     return False
 269         return True
 270
 271     _constraints = [
 272         (_check_mail, 'Error: The mail is not well formated', ['act_mail_body']),
 273     ]
 274
 275 base_action_rule_line()
 276
 277 class base_action_rule_history(osv.osv):
 278     _name = 'base.action.rule.history'
 279     _description = 'Action Rule History'
 280     _rec_name = 'rule_id'
 281     _columns = {
 282         'rule_id': fields.many2one('base.action.rule','Rule', required=True, readonly=1),
 283         'res_id': fields.integer('Resource ID', readonly=1),
 284         'date_action_last': fields.datetime('Last Action', readonly=1),
 285         'date_action_next': fields.datetime('Next Action', readonly=1),
 286     }
 287
 288 base_action_rule_history()
 289
 290 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: