addons/crm/crm.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 base64
  24 import tools
  25
  26 from osv import fields
  27 from osv import osv
  28 from tools.translate import _
  29
  30 MAX_LEVEL = 15
  31 AVAILABLE_STATES = [
  32     ('draft', 'New'),
  33     ('open', 'In Progress'),
  34     ('cancel', 'Cancelled'),
  35     ('done', 'Closed'),
  36     ('pending', 'Pending'),
  37 ]
  38
  39 AVAILABLE_PRIORITIES = [
  40     ('1', 'Highest'),
  41     ('2', 'High'),
  42     ('3', 'Normal'),
  43     ('4', 'Low'),
  44     ('5', 'Lowest'),
  45 ]
  46
  47 class crm_case_channel(osv.osv):
  48     _name = "crm.case.channel"
  49     _description = "Channels"
  50     _order = 'name'
  51     _columns = {
  52         'name': fields.char('Channel Name', size=64, required=True),
  53         'active': fields.boolean('Active'),
  54     }
  55     _defaults = {
  56         'active': lambda *a: 1,
  57     }
  58
  59 class crm_case_stage(osv.osv):
  60     """ Stage of case """
  61
  62     _name = "crm.case.stage"
  63     _description = "Stage of case"
  64     _rec_name = 'name'
  65     _order = "sequence"
  66
  67     _columns = {
  68         'name': fields.char('Stage Name', size=64, required=True, translate=True),
  69         'sequence': fields.integer('Sequence', help="Used to order stages."),
  70         'probability': fields.float('Probability (%)', required=True, help="This percentage depicts the default/average probability of the Case for this stage to be a success"),
  71         'on_change': fields.boolean('Change Probability Automatically', help="Setting this stage will change the probability automatically on the opportunity."),
  72         'requirements': fields.text('Requirements'),
  73         'section_ids':fields.many2many('crm.case.section', 'section_stage_rel', 'stage_id', 'section_id', 'Sections'),
  74         'case_default': fields.boolean('Common to All Teams', help="If you check this field, this stage will be proposed by default on each sales team. It will not assign this stage to existing teams."),
  75     }
  76
  77     _defaults = {
  78         'sequence': lambda *args: 1,
  79         'probability': lambda *args: 0.0,
  80     }
  81
  82 class crm_case_section(osv.osv):
  83     """Sales Team"""
  84
  85     _name = "crm.case.section"
  86     _description = "Sales Teams"
  87     _order = "complete_name"
  88
  89     def get_full_name(self, cr, uid, ids, field_name, arg, context=None):
  90         return  dict(self.name_get(cr, uid, ids, context=context))
  91
  92     _columns = {
  93         'name': fields.char('Sales Team', size=64, required=True, translate=True),
  94         'complete_name': fields.function(get_full_name, type='char', size=256, readonly=True, store=True),
  95         'code': fields.char('Code', size=8),
  96         'active': fields.boolean('Active', help="If the active field is set to "\
  97                         "true, it will allow you to hide the sales team without removing it."),
  98         'allow_unlink': fields.boolean('Allow Delete', help="Allows to delete non draft cases"),
  99         'change_responsible': fields.boolean('Reassign Escalated', help="When escalating to this team override the saleman with the team leader."),
 100         'user_id': fields.many2one('res.users', 'Team Leader'),
 101         'member_ids':fields.many2many('res.users', 'sale_member_rel', 'section_id', 'member_id', 'Team Members'),
 102         'reply_to': fields.char('Reply-To', size=64, help="The email address put in the 'Reply-To' of all emails sent by OpenERP about cases in this sales team"),
 103         'parent_id': fields.many2one('crm.case.section', 'Parent Team'),
 104         'child_ids': fields.one2many('crm.case.section', 'parent_id', 'Child Teams'),
 105         'resource_calendar_id': fields.many2one('resource.calendar', "Working Time", help="Used to compute open days"),
 106         'note': fields.text('Description'),
 107         'working_hours': fields.float('Working Hours', digits=(16,2 )),
 108         'stage_ids': fields.many2many('crm.case.stage', 'section_stage_rel', 'section_id', 'stage_id', 'Stages'),
 109     }
 110     def _get_stage_common(self, cr, uid, context):
 111         ids = self.pool.get('crm.case.stage').search(cr, uid, [('case_default','=',1)], context=context)
 112         return ids
 113
 114     _defaults = {
 115         'active': lambda *a: 1,
 116         'allow_unlink': lambda *a: 1,
 117         'stage_ids': _get_stage_common
 118     }
 119
 120     _sql_constraints = [
 121         ('code_uniq', 'unique (code)', 'The code of the sales team must be unique !')
 122     ]
 123
 124     _constraints = [
 125         (osv.osv._check_recursion, 'Error ! You cannot create recursive Sales team.', ['parent_id'])
 126     ]
 127
 128     def name_get(self, cr, uid, ids, context=None):
 129         """Overrides orm name_get method"""
 130         if not isinstance(ids, list) :
 131             ids = [ids]
 132         res = []
 133         if not ids:
 134             return res
 135         reads = self.read(cr, uid, ids, ['name', 'parent_id'], context)
 136
 137         for record in reads:
 138             name = record['name']
 139             if record['parent_id']:
 140                 name = record['parent_id'][1] + ' / ' + name
 141             res.append((record['id'], name))
 142         return res
 143
 144 class crm_case_categ(osv.osv):
 145     """ Category of Case """
 146     _name = "crm.case.categ"
 147     _description = "Category of Case"
 148     _columns = {
 149         'name': fields.char('Name', size=64, required=True, translate=True),
 150         'section_id': fields.many2one('crm.case.section', 'Sales Team'),
 151         'object_id': fields.many2one('ir.model', 'Object Name'),
 152     }
 153
 154     def _find_object_id(self, cr, uid, context=None):
 155         """Finds id for case object"""
 156         object_id = context and context.get('object_id', False) or False
 157         ids = self.pool.get('ir.model').search(cr, uid, [('model', '=', object_id)])
 158         return ids and ids[0]
 159
 160     _defaults = {
 161         'object_id' : _find_object_id
 162     }
 163
 164 class crm_case_resource_type(osv.osv):
 165     """ Resource Type of case """
 166     _name = "crm.case.resource.type"
 167     _description = "Campaign"
 168     _rec_name = "name"
 169     _columns = {
 170         'name': fields.char('Campaign Name', size=64, required=True, translate=True),
 171         'section_id': fields.many2one('crm.case.section', 'Sales Team'),
 172     }
 173
 174 class crm_base(object):
 175     """ Base utility mixin class for crm objects,
 176     Object subclassing this should define colums:
 177         date_open
 178         date_closed
 179         user_id
 180         partner_id
 181         partner_address_id
 182     """
 183     def _get_default_partner_address(self, cr, uid, context=None):
 184         """Gives id of default address for current user
 185         :param context: if portal in context is false return false anyway
 186         """
 187         if context is None:
 188             context = {}
 189         if not context.get('portal'):
 190             return False
 191         # was user.address_id.id, but address_id has been removed
 192         user = self.pool.get('res.users').browse(cr, uid, uid, context=context)
 193         if hasattr(user, 'partner_address_id') and user.partner_address_id:
 194             return user.partner_address_id
 195         return False
 196
 197     def _get_default_partner(self, cr, uid, context=None):
 198         """Gives id of partner for current user
 199         :param context: if portal in context is false return false anyway
 200         """
 201         if context is None:
 202             context = {}
 203         if not context.get('portal', False):
 204             return False
 205         user = self.pool.get('res.users').browse(cr, uid, uid, context=context)
 206         if hasattr(user, 'partner_address_id') and user.partner_address_id:
 207             return user.partner_address_id
 208         return user.company_id.partner_id.id
 209
 210     def _get_default_email(self, cr, uid, context=None):
 211         """Gives default email address for current user
 212         :param context: if portal in context is false return false anyway
 213         """
 214         if not context.get('portal', False):
 215             return False
 216         user = self.pool.get('res.users').browse(cr, uid, uid, context=context)
 217         return user.user_email
 218
 219     def _get_default_user(self, cr, uid, context=None):
 220         """Gives current user id
 221        :param context: if portal in context is false return false anyway
 222         """
 223         if context and context.get('portal', False):
 224             return False
 225         return uid
 226
 227     def _get_section(self, cr, uid, context=None):
 228         """Gives section id for current User
 229         """
 230         user = self.pool.get('res.users').browse(cr, uid, uid, context=context)
 231         return user.context_section_id.id or False
 232
 233     def onchange_partner_address_id(self, cr, uid, ids, add, email=False):
 234         """This function returns value of partner email based on Partner Address
 235         :param ids: List of case IDs
 236         :param add: Id of Partner's address
 237         :param email: Partner's email ID
 238         """
 239         if not add:
 240             return {'value': {'email_from': False}}
 241         address = self.pool.get('res.partner.address').browse(cr, uid, add)
 242         if address.email:
 243             return {'value': {'email_from': address.email, 'phone': address.phone}}
 244         else:
 245             return {'value': {'phone': address.phone}}
 246
 247     def onchange_partner_id(self, cr, uid, ids, part, email=False):
 248         """This function returns value of partner address based on partner
 249         :param ids: List of case IDs
 250         :param part: Partner's id
 251         :param email: Partner's email ID
 252         """
 253         data={}
 254         if  part:
 255             addr = self.pool.get('res.partner').address_get(cr, uid, [part], ['contact'])
 256             data = {'partner_address_id': addr['contact']}
 257             data.update(self.onchange_partner_address_id(cr, uid, ids, addr['contact'])['value'])
 258         return {'value': data}
 259
 260     def case_open(self, cr, uid, ids, *args):
 261         """Opens Case
 262         :param ids: List of case Ids
 263         """
 264         cases = self.browse(cr, uid, ids)
 265         for case in cases:
 266             data = {'state': 'open', 'active': True}
 267             if not case.user_id:
 268                 data['user_id'] = uid
 269             self.write(cr, uid, case.id, data)
 270
 271         self._action(cr, uid, cases, 'open')
 272         return True
 273
 274     def case_close(self, cr, uid, ids, *args):
 275         """Closes Case
 276         :param ids: List of case Ids
 277         """
 278         cases = self.browse(cr, uid, ids)
 279         cases[0].state # to fill the browse record cache
 280         self.write(cr, uid, ids, {'state': 'done', 'date_closed': time.strftime('%Y-%m-%d %H:%M:%S'), })
 281         # We use the cache of cases to keep the old case state
 282         self._action(cr, uid, cases, 'done')
 283         return True
 284
 285     def case_cancel(self, cr, uid, ids, *args):
 286         """Cancels Case
 287         :param ids: List of case Ids
 288         """
 289         cases = self.browse(cr, uid, ids)
 290         cases[0].state # to fill the browse record cache
 291         self.write(cr, uid, ids, {'state': 'cancel', 'active': True})
 292         # We use the cache of cases to keep the old case state
 293         self._action(cr, uid, cases, 'cancel')
 294         return True
 295
 296     def case_pending(self, cr, uid, ids, *args):
 297         """Marks case as pending
 298         :param ids: List of case Ids
 299         """
 300         cases = self.browse(cr, uid, ids)
 301         cases[0].state # to fill the browse record cache
 302         self.write(cr, uid, ids, {'state': 'pending', 'active': True})
 303         self._action(cr, uid, cases, 'pending')
 304         return True
 305
 306     def case_reset(self, cr, uid, ids, *args):
 307         """Resets case as draft
 308         :param ids: List of case Ids
 309         """
 310         cases = self.browse(cr, uid, ids)
 311         cases[0].state # to fill the browse record cache
 312         self.write(cr, uid, ids, {'state': 'draft', 'active': True})
 313         self._action(cr, uid, cases, 'draft')
 314         return True
 315
 316     def _action(self, cr, uid, cases, state_to, scrit=None, context=None):
 317         if context is None:
 318             context = {}
 319         context['state_to'] = state_to
 320         rule_obj = self.pool.get('base.action.rule')
 321         model_obj = self.pool.get('ir.model')
 322         model_ids = model_obj.search(cr, uid, [('model','=',self._name)])
 323         rule_ids = rule_obj.search(cr, uid, [('model_id','=',model_ids[0])])
 324         return rule_obj._action(cr, uid, rule_ids, cases, scrit=scrit, context=context)
 325
 326 class crm_case(crm_base):
 327     """ A simple python class to be used for common functions
 328     Object that inherit from this class should inherit from mailgate.thread
 329     And need a stage_id field
 330     And object that inherit (orm inheritance) from a class the overwrite copy
 331     """
 332
 333     def stage_find(self, cr, uid, section_id, domain=[], order='sequence'):
 334         domain = list(domain)
 335         if section_id:
 336             domain.append(('section_ids', '=', section_id))
 337         stage_ids = self.pool.get('crm.case.stage').search(cr, uid, domain, order=order)
 338         if stage_ids:
 339             return stage_ids[0]
 340         return False
 341
 342     def stage_set(self, cr, uid, ids, stage_id, context=None):
 343         value = {}
 344         if hasattr(self,'onchange_stage_id'):
 345             value = self.onchange_stage_id(cr, uid, ids, stage_id)['value']
 346         value['stage_id'] = stage_id
 347         return self.write(cr, uid, ids, value, context=context)
 348
 349     def stage_change(self, cr, uid, ids, op, order, context=None):
 350         if context is None:
 351             context = {}
 352         for case in self.browse(cr, uid, ids, context=context):
 353             seq = 0
 354             if case.stage_id:
 355                 seq = case.stage_id.sequence
 356             section_id = None
 357             if case.section_id:
 358                 section_id = case.section_id.id
 359             next_stage_id = self.stage_find(cr, uid, section_id, [('sequence',op,seq)],order)
 360             if next_stage_id:
 361                 return self.stage_set(cr, uid, [case.id], next_stage_id, context=context)
 362         return False
 363
 364     def stage_next(self, cr, uid, ids, context=None):
 365         """This function computes next stage for case from its current stage
 366         using available stage for that case type
 367         """
 368         return self.stage_change(cr, uid, ids, '>','sequence', context)
 369
 370     def stage_previous(self, cr, uid, ids, context=None):
 371         """This function computes previous stage for case from its current
 372         stage using available stage for that case type
 373         """
 374         return self.stage_change(cr, uid, ids, '<', 'sequence desc', context)
 375
 376     def copy(self, cr, uid, id, default=None, context=None):
 377         """Overrides orm copy method to avoid copying messages,
 378            as well as date_closed and date_open columns if they
 379            exist."""
 380         if default is None:
 381             default = {}
 382
 383         default.update({ 'message_ids': [], })
 384         if hasattr(self, '_columns'):
 385             if self._columns.get('date_closed'):
 386                 default.update({ 'date_closed': False, })
 387             if self._columns.get('date_open'):
 388                 default.update({ 'date_open': False })
 389         return super(crm_case, self).copy(cr, uid, id, default, context=context)
 390
 391
 392     def case_open(self, cr, uid, ids, *args):
 393         """Opens Case"""
 394         cases = self.browse(cr, uid, ids)
 395         self.message_append(cr, uid, cases, _('Open'))
 396         for case in cases:
 397             data = {'state': 'open', 'active': True }
 398             if not case.user_id:
 399                 data['user_id'] = uid
 400             self.write(cr, uid, case.id, data)
 401         self._action(cr, uid, cases, 'open')
 402         return True
 403
 404     def case_close(self, cr, uid, ids, *args):
 405         """Closes Case"""
 406         cases = self.browse(cr, uid, ids)
 407         cases[0].state # to fill the browse record cache
 408         self.message_append(cr, uid, cases, _('Close'))
 409         self.write(cr, uid, ids, {'state': 'done',
 410                                   'date_closed': time.strftime('%Y-%m-%d %H:%M:%S'),
 411                                   })
 412         #
 413         # We use the cache of cases to keep the old case state
 414         #
 415         self._action(cr, uid, cases, 'done')
 416         return True
 417
 418     def case_escalate(self, cr, uid, ids, *args):
 419         """Escalates case to parent level"""
 420         cases = self.browse(cr, uid, ids)
 421         for case in cases:
 422             data = {'active': True}
 423             if case.section_id.parent_id:
 424                 data['section_id'] = case.section_id.parent_id.id
 425                 if case.section_id.parent_id.change_responsible:
 426                     if case.section_id.parent_id.user_id:
 427                         data['user_id'] = case.section_id.parent_id.user_id.id
 428             else:
 429                 raise osv.except_osv(_('Error !'), _('You can not escalate, You are already at the top level regarding your sales-team category.'))
 430             self.write(cr, uid, [case.id], data)
 431         cases = self.browse(cr, uid, ids)
 432         self.message_append(cr, uid, cases, _('Escalate'))
 433         self._action(cr, uid, cases, 'escalate')
 434         return True
 435
 436     def case_cancel(self, cr, uid, ids, *args):
 437         """Cancels Case"""
 438         cases = self.browse(cr, uid, ids)
 439         cases[0].state # to fill the browse record cache
 440         self.message_append(cr, uid, cases, _('Cancel'))
 441         self.write(cr, uid, ids, {'state': 'cancel',
 442                                   'active': True})
 443         self._action(cr, uid, cases, 'cancel')
 444         for case in cases:
 445             message = _("The case '%s' has been cancelled.") % (case.name,)
 446             self.log(cr, uid, case.id, message)
 447         return True
 448
 449     def case_pending(self, cr, uid, ids, *args):
 450         """Marks case as pending"""
 451         cases = self.browse(cr, uid, ids)
 452         cases[0].state # to fill the browse record cache
 453         self.message_append(cr, uid, cases, _('Pending'))
 454         self.write(cr, uid, ids, {'state': 'pending', 'active': True})
 455         self._action(cr, uid, cases, 'pending')
 456         return True
 457
 458     def case_reset(self, cr, uid, ids, *args):
 459         """Resets case as draft"""
 460         state = 'draft'
 461         if 'crm.phonecall' in args:
 462             state = 'open'
 463         cases = self.browse(cr, uid, ids)
 464         cases[0].state # to fill the browse record cache
 465         self.message_append(cr, uid, cases, _('Draft'))
 466         self.write(cr, uid, ids, {'state': state, 'active': True})
 467         self._action(cr, uid, cases, state)
 468         return True
 469
 470     def remind_partner(self, cr, uid, ids, context=None, attach=False):
 471         return self.remind_user(cr, uid, ids, context, attach,
 472                 destination=False)
 473
 474     def remind_user(self, cr, uid, ids, context=None, attach=False, destination=True):
 475         mail_message = self.pool.get('mail.message')
 476         for case in self.browse(cr, uid, ids, context=context):
 477             if not destination and not case.email_from:
 478                 return False
 479             if not case.user_id.user_email:
 480                 return False
 481             if destination and case.section_id.user_id:
 482                 case_email = case.section_id.user_id.user_email
 483             else:
 484                 case_email = case.user_id.user_email
 485
 486             src = case_email
 487             dest = case.user_id
 488             body = case.description or ""
 489             if case.message_ids:
 490                 body = case.message_ids[0].description or ""
 491             if not destination:
 492                 src, dest = dest, case.email_from
 493                 if body and case.user_id.signature:
 494                     if body:
 495                         body += '\n\n%s' % (case.user_id.signature)
 496                     else:
 497                         body = '\n\n%s' % (case.user_id.signature)
 498
 499             body = self.format_body(body)
 500
 501             attach_to_send = {}
 502
 503             if attach:
 504                 attach_ids = self.pool.get('ir.attachment').search(cr, uid, [('res_model', '=', self._name), ('res_id', '=', case.id)])
 505                 attach_to_send = self.pool.get('ir.attachment').read(cr, uid, attach_ids, ['datas_fname', 'datas'])
 506                 attach_to_send = dict(map(lambda x: (x['datas_fname'], base64.decodestring(x['datas'])), attach_to_send))
 507
 508             # Send an email
 509             subject = "Reminder: [%s] %s" % (str(case.id), case.name, )
 510             mail_message.schedule_with_attach(cr, uid,
 511                 src,
 512                 [dest],
 513                 subject,
 514                 body,
 515                 model='crm.case',
 516                 reply_to=case.section_id.reply_to,
 517                 res_id=case.id,
 518                 attachments=attach_to_send,
 519                 context=context
 520             )
 521         return True
 522
 523     def _check(self, cr, uid, ids=False, context=None):
 524         """Function called by the scheduler to process cases for date actions
 525            Only works on not done and cancelled cases
 526         """
 527         cr.execute('select * from crm_case \
 528                 where (date_action_last<%s or date_action_last is null) \
 529                 and (date_action_next<=%s or date_action_next is null) \
 530                 and state not in (\'cancel\',\'done\')',
 531                 (time.strftime("%Y-%m-%d %H:%M:%S"),
 532                     time.strftime('%Y-%m-%d %H:%M:%S')))
 533
 534         ids2 = map(lambda x: x[0], cr.fetchall() or [])
 535         cases = self.browse(cr, uid, ids2, context=context)
 536         return self._action(cr, uid, cases, False, context=context)
 537
 538     def format_body(self, body):
 539         return self.pool.get('base.action.rule').format_body(body)
 540
 541     def format_mail(self, obj, body):
 542         return self.pool.get('base.action.rule').format_mail(obj, body)
 543
 544     def message_thread_followers(self, cr, uid, ids, context=None):
 545         res = {}
 546         for case in self.browse(cr, uid, ids, context=context):
 547             l=[]
 548             if case.email_cc:
 549                 l.append(case.email_cc)
 550             if case.user_id and case.user_id.user_email:
 551                 l.append(case.user_id.user_email)
 552             res[case.id] = l
 553         return res
 554
 555 def _links_get(self, cr, uid, context=None):
 556     """Gets links value for reference field"""
 557     obj = self.pool.get('res.request.link')
 558     ids = obj.search(cr, uid, [])
 559     res = obj.read(cr, uid, ids, ['object', 'name'], context)
 560     return [(r['object'], r['name']) for r in res]
 561
 562 class users(osv.osv):
 563     _inherit = 'res.users'
 564     _description = "Users"
 565     _columns = {
 566         'context_section_id': fields.many2one('crm.case.section', 'Sales Team'),
 567     }
 568
 569     def create(self, cr, uid, vals, context=None):
 570         res = super(users, self).create(cr, uid, vals, context=context)
 571         section_obj=self.pool.get('crm.case.section')
 572         if vals.get('context_section_id'):
 573             section_obj.write(cr, uid, [vals['context_section_id']], {'member_ids':[(4, res)]}, context)
 574         return res
 575
 576 users()