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] or False
 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         data = {'value': {'email_from': False, 'phone':False}}
 240         if add:
 241             address = self.pool.get('res.partner.address').browse(cr, uid, add)
 242             data['value'] = {'email_from': address and address.email or False ,
 243                              'phone':  address and address.phone or False}
 244         if 'phone' not in self._columns:
 245             del data['value']['phone']
 246         return data
 247
 248     def onchange_partner_id(self, cr, uid, ids, part, email=False):
 249         """This function returns value of partner address based on partner
 250         :param ids: List of case IDs
 251         :param part: Partner's id
 252         :param email: Partner's email ID
 253         """
 254         data={}
 255         if  part:
 256             addr = self.pool.get('res.partner').address_get(cr, uid, [part], ['contact'])
 257             data = {'partner_address_id': addr['contact']}
 258             data.update(self.onchange_partner_address_id(cr, uid, ids, addr['contact'])['value'])
 259         return {'value': data}
 260
 261     def case_open(self, cr, uid, ids, *args):
 262         """Opens Case
 263         :param ids: List of case Ids
 264         """
 265         cases = self.browse(cr, uid, ids)
 266         for case in cases:
 267             data = {'state': 'open', 'active': True}
 268             if not case.user_id:
 269                 data['user_id'] = uid
 270             self.write(cr, uid, case.id, data)
 271
 272         self._action(cr, uid, cases, 'open')
 273         return True
 274
 275     def case_close(self, cr, uid, ids, *args):
 276         """Closes Case
 277         :param ids: List of case Ids
 278         """
 279         cases = self.browse(cr, uid, ids)
 280         cases[0].state # to fill the browse record cache
 281         self.write(cr, uid, ids, {'state': 'done', 'date_closed': time.strftime('%Y-%m-%d %H:%M:%S'), })
 282         # We use the cache of cases to keep the old case state
 283         self._action(cr, uid, cases, 'done')
 284         return True
 285
 286     def case_cancel(self, cr, uid, ids, *args):
 287         """Cancels Case
 288         :param ids: List of case Ids
 289         """
 290         cases = self.browse(cr, uid, ids)
 291         cases[0].state # to fill the browse record cache
 292         self.write(cr, uid, ids, {'state': 'cancel', 'active': True})
 293         # We use the cache of cases to keep the old case state
 294         self._action(cr, uid, cases, 'cancel')
 295         return True
 296
 297     def case_pending(self, cr, uid, ids, *args):
 298         """Marks case as pending
 299         :param ids: List of case Ids
 300         """
 301         cases = self.browse(cr, uid, ids)
 302         cases[0].state # to fill the browse record cache
 303         self.write(cr, uid, ids, {'state': 'pending', 'active': True})
 304         self._action(cr, uid, cases, 'pending')
 305         return True
 306
 307     def case_reset(self, cr, uid, ids, *args):
 308         """Resets case as draft
 309         :param ids: List of case Ids
 310         """
 311         cases = self.browse(cr, uid, ids)
 312         cases[0].state # to fill the browse record cache
 313         self.write(cr, uid, ids, {'state': 'draft', 'active': True})
 314         self._action(cr, uid, cases, 'draft')
 315         return True
 316
 317     def _action(self, cr, uid, cases, state_to, scrit=None, context=None):
 318         if context is None:
 319             context = {}
 320         context['state_to'] = state_to
 321         rule_obj = self.pool.get('base.action.rule')
 322         model_obj = self.pool.get('ir.model')
 323         model_ids = model_obj.search(cr, uid, [('model','=',self._name)])
 324         rule_ids = rule_obj.search(cr, uid, [('model_id','=',model_ids[0])])
 325         return rule_obj._action(cr, uid, rule_ids, cases, scrit=scrit, context=context)
 326
 327 class crm_case(crm_base):
 328     """ A simple python class to be used for common functions
 329     Object that inherit from this class should inherit from mailgate.thread
 330     And need a stage_id field
 331     And object that inherit (orm inheritance) from a class the overwrite copy
 332     """
 333
 334     def stage_find(self, cr, uid, section_id, domain=[], order='sequence'):
 335         domain = list(domain)
 336         if section_id:
 337             domain.append(('section_ids', '=', section_id))
 338         stage_ids = self.pool.get('crm.case.stage').search(cr, uid, domain, order=order)
 339         if stage_ids:
 340             return stage_ids[0]
 341         return False
 342
 343     def stage_set(self, cr, uid, ids, stage_id, context=None):
 344         value = {}
 345         if hasattr(self,'onchange_stage_id'):
 346             value = self.onchange_stage_id(cr, uid, ids, stage_id)['value']
 347         value['stage_id'] = stage_id
 348         return self.write(cr, uid, ids, value, context=context)
 349
 350     def stage_change(self, cr, uid, ids, op, order, context=None):
 351         if context is None:
 352             context = {}
 353         for case in self.browse(cr, uid, ids, context=context):
 354             seq = 0
 355             if case.stage_id:
 356                 seq = case.stage_id.sequence
 357             section_id = None
 358             if case.section_id:
 359                 section_id = case.section_id.id
 360             next_stage_id = self.stage_find(cr, uid, section_id, [('sequence',op,seq)],order)
 361             if next_stage_id:
 362                 return self.stage_set(cr, uid, [case.id], next_stage_id, context=context)
 363         return False
 364
 365     def stage_next(self, cr, uid, ids, context=None):
 366         """This function computes next stage for case from its current stage
 367         using available stage for that case type
 368         """
 369         return self.stage_change(cr, uid, ids, '>','sequence', context)
 370
 371     def stage_previous(self, cr, uid, ids, context=None):
 372         """This function computes previous stage for case from its current
 373         stage using available stage for that case type
 374         """
 375         return self.stage_change(cr, uid, ids, '<', 'sequence desc', context)
 376
 377     def copy(self, cr, uid, id, default=None, context=None):
 378         """Overrides orm copy method to avoid copying messages,
 379            as well as date_closed and date_open columns if they
 380            exist."""
 381         if default is None:
 382             default = {}
 383
 384         default.update({ 'message_ids': [], })
 385         if hasattr(self, '_columns'):
 386             if self._columns.get('date_closed'):
 387                 default.update({ 'date_closed': False, })
 388             if self._columns.get('date_open'):
 389                 default.update({ 'date_open': False })
 390         return super(crm_case, self).copy(cr, uid, id, default, context=context)
 391
 392
 393     def case_open(self, cr, uid, ids, *args):
 394         """Opens Case"""
 395         cases = self.browse(cr, uid, ids)
 396         self.message_append(cr, uid, cases, _('Open'))
 397         for case in cases:
 398             data = {'state': 'open', 'active': True }
 399             if not case.user_id:
 400                 data['user_id'] = uid
 401             self.write(cr, uid, case.id, data)
 402         self._action(cr, uid, cases, 'open')
 403         return True
 404
 405     def case_close(self, cr, uid, ids, *args):
 406         """Closes Case"""
 407         cases = self.browse(cr, uid, ids)
 408         cases[0].state # to fill the browse record cache
 409         self.message_append(cr, uid, cases, _('Close'))
 410         self.write(cr, uid, ids, {'state': 'done',
 411                                   'date_closed': time.strftime('%Y-%m-%d %H:%M:%S'),
 412                                   })
 413         #
 414         # We use the cache of cases to keep the old case state
 415         #
 416         self._action(cr, uid, cases, 'done')
 417         return True
 418
 419     def case_escalate(self, cr, uid, ids, *args):
 420         """Escalates case to parent level"""
 421         cases = self.browse(cr, uid, ids)
 422         for case in cases:
 423             data = {'active': True}
 424             if case.section_id.parent_id:
 425                 data['section_id'] = case.section_id.parent_id.id
 426                 if case.section_id.parent_id.change_responsible:
 427                     if case.section_id.parent_id.user_id:
 428                         data['user_id'] = case.section_id.parent_id.user_id.id
 429             else:
 430                 raise osv.except_osv(_('Error !'), _('You can not escalate, You are already at the top level regarding your sales-team category.'))
 431             self.write(cr, uid, [case.id], data)
 432         cases = self.browse(cr, uid, ids)
 433         self.message_append(cr, uid, cases, _('Escalate'))
 434         self._action(cr, uid, cases, 'escalate')
 435         return True
 436
 437     def case_cancel(self, cr, uid, ids, *args):
 438         """Cancels Case"""
 439         cases = self.browse(cr, uid, ids)
 440         cases[0].state # to fill the browse record cache
 441         self.message_append(cr, uid, cases, _('Cancel'))
 442         self.write(cr, uid, ids, {'state': 'cancel',
 443                                   'active': True})
 444         self._action(cr, uid, cases, 'cancel')
 445         for case in cases:
 446             message = _("The case '%s' has been cancelled.") % (case.name,)
 447             self.log(cr, uid, case.id, message)
 448         return True
 449
 450     def case_pending(self, cr, uid, ids, *args):
 451         """Marks case as pending"""
 452         cases = self.browse(cr, uid, ids)
 453         cases[0].state # to fill the browse record cache
 454         self.message_append(cr, uid, cases, _('Pending'))
 455         self.write(cr, uid, ids, {'state': 'pending', 'active': True})
 456         self._action(cr, uid, cases, 'pending')
 457         return True
 458
 459     def case_reset(self, cr, uid, ids, *args):
 460         """Resets case as draft"""
 461         state = 'draft'
 462         if 'crm.phonecall' in args:
 463             state = 'open'
 464         cases = self.browse(cr, uid, ids)
 465         cases[0].state # to fill the browse record cache
 466         self.message_append(cr, uid, cases, _('Draft'))
 467         self.write(cr, uid, ids, {'state': state, 'active': True})
 468         self._action(cr, uid, cases, state)
 469         return True
 470
 471     #DEAD Code
 472     def remind_partner(self, cr, uid, ids, context=None, attach=False):
 473         return self.remind_user(cr, uid, ids, context, attach,
 474                 destination=False)
 475
 476     #DEAD Code
 477     def remind_user(self, cr, uid, ids, context=None, attach=False, destination=True):
 478         mail_message = self.pool.get('mail.message')
 479         for case in self.browse(cr, uid, ids, context=context):
 480             if not destination and not case.email_from:
 481                 return False
 482             if not case.user_id.user_email:
 483                 return False
 484             if destination and case.section_id.user_id:
 485                 case_email = case.section_id.user_id.user_email
 486             else:
 487                 case_email = case.user_id.user_email
 488
 489             src = case_email
 490             dest = case.user_id.user_email or ""
 491             body = case.description or ""
 492             for message in case.message_ids:
 493                 if message.email_from:
 494                     body = message.description
 495                     break
 496
 497             if not destination:
 498                 src, dest = dest, case.email_from
 499                 if body and case.user_id.signature:
 500                     if body:
 501                         body += '\n\n%s' % (case.user_id.signature)
 502                     else:
 503                         body = '\n\n%s' % (case.user_id.signature)
 504
 505             body = self.format_body(body)
 506
 507             attach_to_send = {}
 508
 509             if attach:
 510                 attach_ids = self.pool.get('ir.attachment').search(cr, uid, [('res_model', '=', self._name), ('res_id', '=', case.id)])
 511                 attach_to_send = self.pool.get('ir.attachment').read(cr, uid, attach_ids, ['datas_fname', 'datas'])
 512                 attach_to_send = dict(map(lambda x: (x['datas_fname'], base64.decodestring(x['datas'])), attach_to_send))
 513
 514             # Send an email
 515             subject = "Reminder: [%s] %s" % (str(case.id), case.name, )
 516             mail_message.schedule_with_attach(cr, uid,
 517                 src,
 518                 [dest],
 519                 subject,
 520                 body,
 521                 model='crm.case',
 522                 reply_to=case.section_id.reply_to,
 523                 res_id=case.id,
 524                 attachments=attach_to_send,
 525                 context=context
 526             )
 527         return True
 528
 529     def _check(self, cr, uid, ids=False, context=None):
 530         """Function called by the scheduler to process cases for date actions
 531            Only works on not done and cancelled cases
 532         """
 533         cr.execute('select * from crm_case \
 534                 where (date_action_last<%s or date_action_last is null) \
 535                 and (date_action_next<=%s or date_action_next is null) \
 536                 and state not in (\'cancel\',\'done\')',
 537                 (time.strftime("%Y-%m-%d %H:%M:%S"),
 538                     time.strftime('%Y-%m-%d %H:%M:%S')))
 539
 540         ids2 = map(lambda x: x[0], cr.fetchall() or [])
 541         cases = self.browse(cr, uid, ids2, context=context)
 542         return self._action(cr, uid, cases, False, context=context)
 543
 544     def format_body(self, body):
 545         return self.pool.get('base.action.rule').format_body(body)
 546
 547     def format_mail(self, obj, body):
 548         return self.pool.get('base.action.rule').format_mail(obj, body)
 549
 550     def message_thread_followers(self, cr, uid, ids, context=None):
 551         res = {}
 552         for case in self.browse(cr, uid, ids, context=context):
 553             l=[]
 554             if case.email_cc:
 555                 l.append(case.email_cc)
 556             if case.user_id and case.user_id.user_email:
 557                 l.append(case.user_id.user_email)
 558             res[case.id] = l
 559         return res
 560
 561 def _links_get(self, cr, uid, context=None):
 562     """Gets links value for reference field"""
 563     obj = self.pool.get('res.request.link')
 564     ids = obj.search(cr, uid, [])
 565     res = obj.read(cr, uid, ids, ['object', 'name'], context)
 566     return [(r['object'], r['name']) for r in res]
 567
 568 class users(osv.osv):
 569     _inherit = 'res.users'
 570     _description = "Users"
 571     _columns = {
 572         'context_section_id': fields.many2one('crm.case.section', 'Sales Team'),
 573     }
 574
 575     def create(self, cr, uid, vals, context=None):
 576         res = super(users, self).create(cr, uid, vals, context=context)
 577         section_obj=self.pool.get('crm.case.section')
 578         if vals.get('context_section_id'):
 579             section_obj.write(cr, uid, [vals['context_section_id']], {'member_ids':[(4, res)]}, context)
 580         return res
 581
 582 users()