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