addons/crm/crm_lead.py

   1 # -*- coding: utf-8 -*-
   2 ##############################################################################
   3 #
   4 #    OpenERP, Open Source Management Solution
   5 #    Copyright (C) 2004-today OpenERP SA (<http://www.openerp.com>)
   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 from openerp.addons.base_status.base_stage import base_stage
  23 import crm
  24 from datetime import datetime
  25 from operator import itemgetter
  26 from openerp.osv import fields, osv
  27 import time
  28 from openerp import tools
  29 from openerp.tools.translate import _
  30 from openerp.tools import html2plaintext
  31
  32 from base.res.res_partner import format_address
  33
  34 CRM_LEAD_FIELDS_TO_MERGE = ['name',
  35     'partner_id',
  36     'channel_id',
  37     'company_id',
  38     'country_id',
  39     'section_id',
  40     'state_id',
  41     'stage_id',
  42     'type_id',
  43     'user_id',
  44     'title',
  45     'city',
  46     'contact_name',
  47     'description',
  48     'email',
  49     'fax',
  50     'mobile',
  51     'partner_name',
  52     'phone',
  53     'probability',
  54     'planned_revenue',
  55     'street',
  56     'street2',
  57     'zip',
  58     'create_date',
  59     'date_action_last',
  60     'date_action_next',
  61     'email_from',
  62     'email_cc',
  63     'partner_name']
  64 CRM_LEAD_PENDING_STATES = (
  65     crm.AVAILABLE_STATES[2][0], # Cancelled
  66     crm.AVAILABLE_STATES[3][0], # Done
  67     crm.AVAILABLE_STATES[4][0], # Pending
  68 )
  69
  70 class crm_lead(base_stage, format_address, osv.osv):
  71     """ CRM Lead Case """
  72     _name = "crm.lead"
  73     _description = "Lead/Opportunity"
  74     _order = "priority,date_action,id desc"
  75     _inherit = ['mail.thread', 'ir.needaction_mixin']
  76
  77     _track = {
  78         'state': {
  79             'crm.mt_lead_create': lambda self, cr, uid, obj, ctx=None: obj['state'] == 'new',
  80             'crm.mt_lead_won': lambda self, cr, uid, obj, ctx=None: obj['state'] == 'done',
  81             'crm.mt_lead_lost': lambda self, cr, uid, obj, ctx=None: obj['state'] == 'cancel',
  82         },
  83         'stage_id': {
  84             'crm.mt_lead_stage': lambda self, cr, uid, obj, ctx=None: obj['state'] not in ['new', 'cancel', 'done'],
  85         },
  86     }
  87
  88     def create(self, cr, uid, vals, context=None):
  89         if context is None:
  90             context = {}
  91         if not vals.get('stage_id'):
  92             ctx = context.copy()
  93             if vals.get('section_id'):
  94                 ctx['default_section_id'] = vals['section_id']
  95             if vals.get('type'):
  96                 ctx['default_type'] = vals['type']
  97             vals['stage_id'] = self._get_default_stage_id(cr, uid, context=ctx)
  98         return super(crm_lead, self).create(cr, uid, vals, context=context)
  99
 100     def _get_default_section_id(self, cr, uid, context=None):
 101         """ Gives default section by checking if present in the context """
 102         return self._resolve_section_id_from_context(cr, uid, context=context) or False
 103
 104     def _get_default_stage_id(self, cr, uid, context=None):
 105         """ Gives default stage_id """
 106         section_id = self._get_default_section_id(cr, uid, context=context)
 107         return self.stage_find(cr, uid, [], section_id, [('state', '=', 'draft')], context=context)
 108
 109     def _resolve_section_id_from_context(self, cr, uid, context=None):
 110         """ Returns ID of section based on the value of 'section_id'
 111             context key, or None if it cannot be resolved to a single
 112             Sales Team.
 113         """
 114         if context is None:
 115             context = {}
 116         if type(context.get('default_section_id')) in (int, long):
 117             return context.get('default_section_id')
 118         if isinstance(context.get('default_section_id'), basestring):
 119             section_name = context['default_section_id']
 120             section_ids = self.pool.get('crm.case.section').name_search(cr, uid, name=section_name, context=context)
 121             if len(section_ids) == 1:
 122                 return int(section_ids[0][0])
 123         return None
 124
 125     def _resolve_type_from_context(self, cr, uid, context=None):
 126         """ Returns the type (lead or opportunity) from the type context
 127             key. Returns None if it cannot be resolved.
 128         """
 129         if context is None:
 130             context = {}
 131         return context.get('default_type')
 132
 133     def _read_group_stage_ids(self, cr, uid, ids, domain, read_group_order=None, access_rights_uid=None, context=None):
 134         access_rights_uid = access_rights_uid or uid
 135         stage_obj = self.pool.get('crm.case.stage')
 136         order = stage_obj._order
 137         # lame hack to allow reverting search, should just work in the trivial case
 138         if read_group_order == 'stage_id desc':
 139             order = "%s desc" % order
 140         # retrieve section_id from the context and write the domain
 141         # - ('id', 'in', 'ids'): add columns that should be present
 142         # - OR ('case_default', '=', True), ('fold', '=', False): add default columns that are not folded
 143         # - OR ('section_ids', '=', section_id), ('fold', '=', False) if section_id: add section columns that are not folded
 144         search_domain = []
 145         section_id = self._resolve_section_id_from_context(cr, uid, context=context)
 146         if section_id:
 147             search_domain += ['|', ('section_ids', '=', section_id)]
 148             search_domain += [('id', 'in', ids)]
 149         else:
 150             search_domain += ['|', ('id', 'in', ids), ('case_default', '=', True)]
 151         # retrieve type from the context (if set: choose 'type' or 'both')
 152         type = self._resolve_type_from_context(cr, uid, context=context)
 153         if type:
 154             search_domain += ['|', ('type', '=', type), ('type', '=', 'both')]
 155         # perform search
 156         stage_ids = stage_obj._search(cr, uid, search_domain, order=order, access_rights_uid=access_rights_uid, context=context)
 157         result = stage_obj.name_get(cr, access_rights_uid, stage_ids, context=context)
 158         # restore order of the search
 159         result.sort(lambda x,y: cmp(stage_ids.index(x[0]), stage_ids.index(y[0])))
 160
 161         fold = {}
 162         for stage in stage_obj.browse(cr, access_rights_uid, stage_ids, context=context):
 163             fold[stage.id] = stage.fold or False
 164         return result, fold
 165
 166     def fields_view_get(self, cr, user, view_id=None, view_type='form', context=None, toolbar=False, submenu=False):
 167         res = super(crm_lead,self).fields_view_get(cr, user, view_id, view_type, context, toolbar=toolbar, submenu=submenu)
 168         if view_type == 'form':
 169             res['arch'] = self.fields_view_get_address(cr, user, res['arch'], context=context)
 170         return res
 171
 172     _group_by_full = {
 173         'stage_id': _read_group_stage_ids
 174     }
 175
 176     def _compute_day(self, cr, uid, ids, fields, args, context=None):
 177         """
 178         :return dict: difference between current date and log date
 179         """
 180         cal_obj = self.pool.get('resource.calendar')
 181         res_obj = self.pool.get('resource.resource')
 182
 183         res = {}
 184         for lead in self.browse(cr, uid, ids, context=context):
 185             for field in fields:
 186                 res[lead.id] = {}
 187                 duration = 0
 188                 ans = False
 189                 if field == 'day_open':
 190                     if lead.date_open:
 191                         date_create = datetime.strptime(lead.create_date, "%Y-%m-%d %H:%M:%S")
 192                         date_open = datetime.strptime(lead.date_open, "%Y-%m-%d %H:%M:%S")
 193                         ans = date_open - date_create
 194                         date_until = lead.date_open
 195                 elif field == 'day_close':
 196                     if lead.date_closed:
 197                         date_create = datetime.strptime(lead.create_date, "%Y-%m-%d %H:%M:%S")
 198                         date_close = datetime.strptime(lead.date_closed, "%Y-%m-%d %H:%M:%S")
 199                         date_until = lead.date_closed
 200                         ans = date_close - date_create
 201                 if ans:
 202                     resource_id = False
 203                     if lead.user_id:
 204                         resource_ids = res_obj.search(cr, uid, [('user_id','=',lead.user_id.id)])
 205                         if len(resource_ids):
 206                             resource_id = resource_ids[0]
 207
 208                     duration = float(ans.days)
 209                     if lead.section_id and lead.section_id.resource_calendar_id:
 210                         duration =  float(ans.days) * 24
 211                         new_dates = cal_obj.interval_get(cr,
 212                             uid,
 213                             lead.section_id.resource_calendar_id and lead.section_id.resource_calendar_id.id or False,
 214                             datetime.strptime(lead.create_date, '%Y-%m-%d %H:%M:%S'),
 215                             duration,
 216                             resource=resource_id
 217                         )
 218                         no_days = []
 219                         date_until = datetime.strptime(date_until, '%Y-%m-%d %H:%M:%S')
 220                         for in_time, out_time in new_dates:
 221                             if in_time.date not in no_days:
 222                                 no_days.append(in_time.date)
 223                             if out_time > date_until:
 224                                 break
 225                         duration =  len(no_days)
 226                 res[lead.id][field] = abs(int(duration))
 227         return res
 228
 229     def _history_search(self, cr, uid, obj, name, args, context=None):
 230         res = []
 231         msg_obj = self.pool.get('mail.message')
 232         message_ids = msg_obj.search(cr, uid, [('email_from','!=',False), ('subject', args[0][1], args[0][2])], context=context)
 233         lead_ids = self.search(cr, uid, [('message_ids', 'in', message_ids)], context=context)
 234
 235         if lead_ids:
 236             return [('id', 'in', lead_ids)]
 237         else:
 238             return [('id', '=', '0')]
 239
 240     _columns = {
 241         'partner_id': fields.many2one('res.partner', 'Partner', ondelete='set null', track_visibility='onchange',
 242             select=True, help="Linked partner (optional). Usually created when converting the lead."),
 243
 244         'id': fields.integer('ID', readonly=True),
 245         'name': fields.char('Subject', size=64, required=True, select=1),
 246         'active': fields.boolean('Active', required=False),
 247         'date_action_last': fields.datetime('Last Action', readonly=1),
 248         'date_action_next': fields.datetime('Next Action', readonly=1),
 249         'email_from': fields.char('Email', size=128, help="Email address of the contact", select=1),
 250         'section_id': fields.many2one('crm.case.section', 'Sales Team',
 251                         select=True, track_visibility='onchange', help='When sending mails, the default email address is taken from the sales team.'),
 252         'create_date': fields.datetime('Creation Date' , readonly=True),
 253         'email_cc': fields.text('Global CC', size=252 , help="These email addresses will be added to the CC field of all inbound and outbound emails for this record before being sent. Separate multiple email addresses with a comma"),
 254         'description': fields.text('Notes'),
 255         'write_date': fields.datetime('Update Date' , readonly=True),
 256         'categ_ids': fields.many2many('crm.case.categ', 'crm_lead_category_rel', 'lead_id', 'category_id', 'Categories', \
 257             domain="['|',('section_id','=',section_id),('section_id','=',False), ('object_id.model', '=', 'crm.lead')]"),
 258         'type_id': fields.many2one('crm.case.resource.type', 'Campaign', \
 259             domain="['|',('section_id','=',section_id),('section_id','=',False)]", help="From which campaign (seminar, marketing campaign, mass mailing, ...) did this contact come from?"),
 260         'channel_id': fields.many2one('crm.case.channel', 'Channel', help="Communication channel (mail, direct, phone, ...)"),
 261         'contact_name': fields.char('Contact Name', size=64),
 262         'partner_name': fields.char("Customer Name", size=64,help='The name of the future partner company that will be created while converting the lead into opportunity', select=1),
 263         'opt_out': fields.boolean('Opt-Out', oldname='optout',
 264             help="If opt-out is checked, this contact has refused to receive emails for mass mailing and marketing campaign. "
 265                     "Filter 'Available for Mass Mailing' allows users to filter the leads when performing mass mailing."),
 266         'type':fields.selection([ ('lead','Lead'), ('opportunity','Opportunity'), ],'Type', help="Type is used to separate Leads and Opportunities"),
 267         'priority': fields.selection(crm.AVAILABLE_PRIORITIES, 'Priority', select=True),
 268         'date_closed': fields.datetime('Closed', readonly=True),
 269         'stage_id': fields.many2one('crm.case.stage', 'Stage', track_visibility='onchange',
 270                         domain="['&', '&', ('fold', '=', False), ('section_ids', '=', section_id), '|', ('type', '=', type), ('type', '=', 'both')]"),
 271         'user_id': fields.many2one('res.users', 'Salesperson', select=True, track_visibility='onchange'),
 272         'referred': fields.char('Referred By', size=64),
 273         'date_open': fields.datetime('Opened', readonly=True),
 274         'day_open': fields.function(_compute_day, string='Days to Open', \
 275                                 multi='day_open', type="float", store=True),
 276         'day_close': fields.function(_compute_day, string='Days to Close', \
 277                                 multi='day_close', type="float", store=True),
 278         'state': fields.related('stage_id', 'state', type="selection", store=True,
 279                 selection=crm.AVAILABLE_STATES, string="Status", readonly=True,
 280                 help='The Status is set to \'Draft\', when a case is created. If the case is in progress the Status is set to \'Open\'. When the case is over, the Status is set to \'Done\'. If the case needs to be reviewed then the Status is  set to \'Pending\'.'),
 281
 282         # Only used for type opportunity
 283         'probability': fields.float('Success Rate (%)',group_operator="avg"),
 284         'planned_revenue': fields.float('Expected Revenue', track_visibility='always'),
 285         'ref': fields.reference('Reference', selection=crm._links_get, size=128),
 286         'ref2': fields.reference('Reference 2', selection=crm._links_get, size=128),
 287         'phone': fields.char("Phone", size=64),
 288         'date_deadline': fields.date('Expected Closing', help="Estimate of the date on which the opportunity will be won."),
 289         'date_action': fields.date('Next Action Date', select=True),
 290         'title_action': fields.char('Next Action', size=64),
 291         'color': fields.integer('Color Index'),
 292         'partner_address_name': fields.related('partner_id', 'name', type='char', string='Partner Contact Name', readonly=True),
 293         'partner_address_email': fields.related('partner_id', 'email', type='char', string='Partner Contact Email', readonly=True),
 294         'company_currency': fields.related('company_id', 'currency_id', type='many2one', string='Currency', readonly=True, relation="res.currency"),
 295         'user_email': fields.related('user_id', 'email', type='char', string='User Email', readonly=True),
 296         'user_login': fields.related('user_id', 'login', type='char', string='User Login', readonly=True),
 297
 298         # Fields for address, due to separation from crm and res.partner
 299         'street': fields.char('Street', size=128),
 300         'street2': fields.char('Street2', size=128),
 301         'zip': fields.char('Zip', change_default=True, size=24),
 302         'city': fields.char('City', size=128),
 303         'state_id': fields.many2one("res.country.state", 'State'),
 304         'country_id': fields.many2one('res.country', 'Country'),
 305         'phone': fields.char('Phone', size=64),
 306         'fax': fields.char('Fax', size=64),
 307         'mobile': fields.char('Mobile', size=64),
 308         'function': fields.char('Function', size=128),
 309         'title': fields.many2one('res.partner.title', 'Title'),
 310         'company_id': fields.many2one('res.company', 'Company', select=1),
 311         'payment_mode': fields.many2one('crm.payment.mode', 'Payment Mode', \
 312                             domain="[('section_id','=',section_id)]"),
 313         'planned_cost': fields.float('Planned Costs'),
 314     }
 315
 316     _defaults = {
 317         'active': 1,
 318         'type': 'lead',
 319         'user_id': lambda s, cr, uid, c: s._get_default_user(cr, uid, c),
 320         'email_from': lambda s, cr, uid, c: s._get_default_email(cr, uid, c),
 321         'stage_id': lambda s, cr, uid, c: s._get_default_stage_id(cr, uid, c),
 322         'section_id': lambda s, cr, uid, c: s._get_default_section_id(cr, uid, c),
 323         'company_id': lambda s, cr, uid, c: s.pool.get('res.company')._company_default_get(cr, uid, 'crm.lead', context=c),
 324         'priority': lambda *a: crm.AVAILABLE_PRIORITIES[2][0],
 325         'color': 0,
 326     }
 327
 328     _sql_constraints = [
 329         ('check_probability', 'check(probability >= 0 and probability <= 100)', 'The probability of closing the deal should be between 0% and 100%!')
 330     ]
 331
 332     def onchange_stage_id(self, cr, uid, ids, stage_id, context=None):
 333         if not stage_id:
 334             return {'value':{}}
 335         stage = self.pool.get('crm.case.stage').browse(cr, uid, stage_id, context)
 336         if not stage.on_change:
 337             return {'value':{}}
 338         return {'value':{'probability': stage.probability}}
 339
 340     def on_change_partner(self, cr, uid, ids, partner_id, context=None):
 341         result = {}
 342         values = {}
 343         if partner_id:
 344             partner = self.pool.get('res.partner').browse(cr, uid, partner_id, context=context)
 345             values = {
 346                 'partner_name' : partner.name,
 347                 'street' : partner.street,
 348                 'street2' : partner.street2,
 349                 'city' : partner.city,
 350                 'state_id' : partner.state_id and partner.state_id.id or False,
 351                 'country_id' : partner.country_id and partner.country_id.id or False,
 352                 'email_from' : partner.email,
 353                 'phone' : partner.phone,
 354                 'mobile' : partner.mobile,
 355                 'fax' : partner.fax,
 356             }
 357         return {'value' : values}
 358
 359     def _check(self, cr, uid, ids=False, context=None):
 360         """ Override of the base.stage method.
 361             Function called by the scheduler to process cases for date actions
 362             Only works on not done and cancelled cases
 363         """
 364         cr.execute('select * from crm_case \
 365                 where (date_action_last<%s or date_action_last is null) \
 366                 and (date_action_next<=%s or date_action_next is null) \
 367                 and state not in (\'cancel\',\'done\')',
 368                 (time.strftime("%Y-%m-%d %H:%M:%S"),
 369                     time.strftime('%Y-%m-%d %H:%M:%S')))
 370
 371         ids2 = map(lambda x: x[0], cr.fetchall() or [])
 372         cases = self.browse(cr, uid, ids2, context=context)
 373         return self._action(cr, uid, cases, False, context=context)
 374
 375     def stage_find(self, cr, uid, cases, section_id, domain=None, order='sequence', context=None):
 376         """ Override of the base.stage method
 377             Parameter of the stage search taken from the lead:
 378             - type: stage type must be the same or 'both'
 379             - section_id: if set, stages must belong to this section or
 380               be a default stage; if not set, stages must be default
 381               stages
 382         """
 383         if isinstance(cases, (int, long)):
 384             cases = self.browse(cr, uid, cases, context=context)
 385         # collect all section_ids
 386         section_ids = []
 387         types = ['both']
 388         if not cases :
 389             type = context.get('default_type')
 390             types += [type]
 391         if section_id:
 392             section_ids.append(section_id)
 393         for lead in cases:
 394             if lead.section_id:
 395                 section_ids.append(lead.section_id.id)
 396             if lead.type not in types:
 397                 types.append(lead.type)
 398         # OR all section_ids and OR with case_default
 399         search_domain = []
 400         if section_ids:
 401             search_domain += [('|')] * len(section_ids)
 402             for section_id in section_ids:
 403                 search_domain.append(('section_ids', '=', section_id))
 404         else:
 405             search_domain.append(('case_default', '=', True))
 406         # AND with cases types
 407         search_domain.append(('type', 'in', types))
 408         # AND with the domain in parameter
 409         search_domain += list(domain)
 410         # perform search, return the first found
 411         stage_ids = self.pool.get('crm.case.stage').search(cr, uid, search_domain, order=order, context=context)
 412         if stage_ids:
 413             return stage_ids[0]
 414         return False
 415
 416     def case_cancel(self, cr, uid, ids, context=None):
 417         """ Overrides case_cancel from base_stage to set probability """
 418         res = super(crm_lead, self).case_cancel(cr, uid, ids, context=context)
 419         self.write(cr, uid, ids, {'probability' : 0.0}, context=context)
 420         return res
 421
 422     def case_reset(self, cr, uid, ids, context=None):
 423         """ Overrides case_reset from base_stage to set probability """
 424         res = super(crm_lead, self).case_reset(cr, uid, ids, context=context)
 425         self.write(cr, uid, ids, {'probability': 0.0}, context=context)
 426         return res
 427
 428     def case_mark_lost(self, cr, uid, ids, context=None):
 429         """ Mark the case as lost: state=cancel and probability=0 """
 430         for lead in self.browse(cr, uid, ids):
 431             stage_id = self.stage_find(cr, uid, [lead], lead.section_id.id or False, [('probability', '=', 0.0),('on_change','=',True)], context=context)
 432             if stage_id:
 433                 self.case_set(cr, uid, [lead.id], values_to_update={'probability': 0.0}, new_stage_id=stage_id, context=context)
 434         return True
 435
 436     def case_mark_won(self, cr, uid, ids, context=None):
 437         """ Mark the case as won: state=done and probability=100 """
 438         for lead in self.browse(cr, uid, ids):
 439             stage_id = self.stage_find(cr, uid, [lead], lead.section_id.id or False, [('probability', '=', 100.0),('on_change','=',True)], context=context)
 440             if stage_id:
 441                 self.case_set(cr, uid, [lead.id], values_to_update={'probability': 100.0}, new_stage_id=stage_id, context=context)
 442         return True
 443
 444     def set_priority(self, cr, uid, ids, priority):
 445         """ Set lead priority
 446         """
 447         return self.write(cr, uid, ids, {'priority' : priority})
 448
 449     def set_high_priority(self, cr, uid, ids, context=None):
 450         """ Set lead priority to high
 451         """
 452         return self.set_priority(cr, uid, ids, '1')
 453
 454     def set_normal_priority(self, cr, uid, ids, context=None):
 455         """ Set lead priority to normal
 456         """
 457         return self.set_priority(cr, uid, ids, '3')
 458
 459     def _merge_get_result_type(self, cr, uid, opps, context=None):
 460         """
 461         Define the type of the result of the merge.  If at least one of the
 462         element to merge is an opp, the resulting new element will be an opp.
 463         Otherwise it will be a lead.
 464
 465         We'll directly use a list of browse records instead of a list of ids
 466         for performances' sake: it will spare a second browse of the
 467         leads/opps.
 468
 469         :param list opps: list of browse records containing the leads/opps to process
 470         :return string type: the type of the final element
 471         """
 472         for opp in opps:
 473             if (opp.type == 'opportunity'):
 474                 return 'opportunity'
 475
 476         return 'lead'
 477
 478     def _merge_data(self, cr, uid, ids, oldest, fields, context=None):
 479         """
 480         Prepare lead/opp data into a dictionary for merging.  Different types
 481         of fields are processed in different ways:
 482         - text: all the values are concatenated
 483         - m2m and o2m: those fields aren't processed
 484         - m2o: the first not null value prevails (the other are dropped)
 485         - any other type of field: same as m2o
 486
 487         :param list ids: list of ids of the leads to process
 488         :param list fields: list of leads' fields to process
 489         :return dict data: contains the merged values
 490         """
 491         opportunities = self.browse(cr, uid, ids, context=context)
 492
 493         def _get_first_not_null(attr):
 494             for opp in opportunities:
 495                 if hasattr(opp, attr) and bool(getattr(opp, attr)):
 496                     return getattr(opp, attr)
 497             return False
 498
 499         def _get_first_not_null_id(attr):
 500             res = _get_first_not_null(attr)
 501             return res and res.id or False
 502
 503         def _concat_all(attr):
 504             return '\n\n'.join(filter(lambda x: x, [getattr(opp, attr) or '' for opp in opportunities if hasattr(opp, attr)]))
 505
 506         # Process the fields' values
 507         data = {}
 508         for field_name in fields:
 509             field_info = self._all_columns.get(field_name)
 510             if field_info is None:
 511                 continue
 512             field = field_info.column
 513             if field._type in ('many2many', 'one2many'):
 514                 continue
 515             elif field._type == 'many2one':
 516                 data[field_name] = _get_first_not_null_id(field_name)  # !!
 517             elif field._type == 'text':
 518                 data[field_name] = _concat_all(field_name)  #not lost
 519             else:
 520                 data[field_name] = _get_first_not_null(field_name)  #not lost
 521
 522         # Define the resulting type ('lead' or 'opportunity')
 523         data['type'] = self._merge_get_result_type(cr, uid, opportunities, context)
 524         return data
 525
 526     def _mail_body(self, cr, uid, lead, fields, title=False, context=None):
 527         body = []
 528         if title:
 529             body.append("%s\n" % (title))
 530
 531         for field_name in fields:
 532             field_info = self._all_columns.get(field_name)
 533             if field_info is None:
 534                 continue
 535             field = field_info.column
 536             value = ''
 537
 538             if field._type == 'selection':
 539                 if hasattr(field.selection, '__call__'):
 540                     key = field.selection(self, cr, uid, context=context)
 541                 else:
 542                     key = field.selection
 543                 value = dict(key).get(lead[field_name], lead[field_name])
 544             elif field._type == 'many2one':
 545                 if lead[field_name]:
 546                     value = lead[field_name].name_get()[0][1]
 547             elif field._type == 'many2many':
 548                 if lead[field_name]:
 549                     for val in lead[field_name]:
 550                         field_value = val.name_get()[0][1]
 551                         value += field_value + ","
 552             else:
 553                 value = lead[field_name]
 554
 555             body.append("%s: %s" % (field.string, value or ''))
 556         return "<br/>".join(body + ['<br/>'])
 557
 558     def _merge_notify(self, cr, uid, opportunity_id, opportunities, context=None):
 559         """
 560         Create a message gathering merged leads/opps information.
 561         """
 562         #TOFIX: mail template should be used instead of fix body, subject text
 563         details = []
 564         result_type = self._merge_get_result_type(cr, uid, opportunities, context)
 565         if result_type == 'lead':
 566             merge_message = _('Merged leads')
 567         else:
 568             merge_message = _('Merged opportunities')
 569         subject = [merge_message]
 570         for opportunity in opportunities:
 571             subject.append(opportunity.name)
 572             title = "%s : %s" % (opportunity.type == 'opportunity' and _('Merged opportunity') or _('Merged lead'), opportunity.name)
 573             fields = list(CRM_LEAD_FIELDS_TO_MERGE)
 574             details.append(self._mail_body(cr, uid, opportunity, fields, title=title, context=context))
 575
 576         # Chatter message's subject
 577         subject = subject[0] + ": " + ", ".join(subject[1:])
 578         details = "\n\n".join(details)
 579         return self.message_post(cr, uid, [opportunity_id], body=details, subject=subject, context=context)
 580
 581     def _merge_opportunity_history(self, cr, uid, opportunity_id, opportunities, context=None):
 582         message = self.pool.get('mail.message')
 583         for opportunity in opportunities:
 584             for history in opportunity.message_ids:
 585                 message.write(cr, uid, history.id, {
 586                         'res_id': opportunity_id,
 587                         'subject' : _("From %s : %s") % (opportunity.name, history.subject)
 588                 }, context=context)
 589
 590         return True
 591
 592     def _merge_opportunity_attachments(self, cr, uid, opportunity_id, opportunities, context=None):
 593         attach_obj = self.pool.get('ir.attachment')
 594
 595         # return attachments of opportunity
 596         def _get_attachments(opportunity_id):
 597             attachment_ids = attach_obj.search(cr, uid, [('res_model', '=', self._name), ('res_id', '=', opportunity_id)], context=context)
 598             return attach_obj.browse(cr, uid, attachment_ids, context=context)
 599
 600         first_attachments = _get_attachments(opportunity_id)
 601         #counter of all attachments to move. Used to make sure the name is different for all attachments
 602         count = 1
 603         for opportunity in opportunities:
 604             attachments = _get_attachments(opportunity.id)
 605             for attachment in attachments:
 606                 values = {'res_id': opportunity_id,}
 607                 for attachment_in_first in first_attachments:
 608                     if attachment.name == attachment_in_first.name:
 609                         name = "%s (%s)" % (attachment.name, count,),
 610                 count+=1
 611                 attachment.write(values)
 612         return True
 613
 614     def merge_opportunity(self, cr, uid, ids, context=None):
 615         """
 616         Different cases of merge:
 617         - merge leads together = 1 new lead
 618         - merge at least 1 opp with anything else (lead or opp) = 1 new opp
 619
 620         :param list ids: leads/opportunities ids to merge
 621         :return int id: id of the resulting lead/opp
 622         """
 623         if context is None:
 624             context = {}
 625
 626         if len(ids) <= 1:
 627             raise osv.except_osv(_('Warning!'), _('Please select more than one element (lead or opportunity) from the list view.'))
 628
 629         opportunities = self.browse(cr, uid, ids, context=context)
 630         sequenced_opps = []
 631         for opportunity in opportunities:
 632             sequence = -1
 633             if opportunity.stage_id and opportunity.stage_id.state != 'cancel':
 634                 sequence = opportunity.stage_id.sequence
 635             sequenced_opps.append(((int(sequence != 1 and opportunity.type == 'opportunity'), sequence, -opportunity.id), opportunity))
 636
 637         sequenced_opps.sort(reverse=True)
 638         opportunities = map(itemgetter(1), sequenced_opps)
 639         ids = [opportunity.id for opportunity in opportunities]
 640         highest = opportunities[0]
 641         opportunities_rest = opportunities[1:]
 642
 643         tail_opportunities = opportunities_rest
 644
 645         fields = list(CRM_LEAD_FIELDS_TO_MERGE)
 646         merged_data = self._merge_data(cr, uid, ids, highest, fields, context=context)
 647
 648         # Merge messages and attachements into the first opportunity
 649         self._merge_opportunity_history(cr, uid, highest.id, tail_opportunities, context=context)
 650         self._merge_opportunity_attachments(cr, uid, highest.id, tail_opportunities, context=context)
 651
 652         # Merge notifications about loss of information
 653         opportunities = [highest]
 654         opportunities.extend(opportunities_rest)
 655         self._merge_notify(cr, uid, highest, opportunities, context=context)
 656         # Check if the stage is in the stages of the sales team. If not, assign the stage with the lowest sequence
 657         if merged_data.get('section_id'):
 658             section_stage_ids = self.pool.get('crm.case.stage').search(cr, uid, [('section_ids', 'in', merged_data['section_id']), ('type', '=', merged_data.get('type'))], order='sequence', context=context)
 659             if merged_data.get('stage_id') not in section_stage_ids:
 660                 merged_data['stage_id'] = section_stage_ids and section_stage_ids[0] or False
 661         # Write merged data into first opportunity
 662         self.write(cr, uid, [highest.id], merged_data, context=context)
 663         # Delete tail opportunities
 664         self.unlink(cr, uid, [x.id for x in tail_opportunities], context=context)
 665
 666         return highest.id
 667
 668     def _convert_opportunity_data(self, cr, uid, lead, customer, section_id=False, context=None):
 669         crm_stage = self.pool.get('crm.case.stage')
 670         contact_id = False
 671         if customer:
 672             contact_id = self.pool.get('res.partner').address_get(cr, uid, [customer.id])['default']
 673         if not section_id:
 674             section_id = lead.section_id and lead.section_id.id or False
 675         val = {
 676             'planned_revenue': lead.planned_revenue,
 677             'probability': lead.probability,
 678             'name': lead.name,
 679             'partner_id': customer and customer.id or False,
 680             'user_id': (lead.user_id and lead.user_id.id),
 681             'type': 'opportunity',
 682             'date_action': fields.datetime.now(),
 683             'date_open': fields.datetime.now(),
 684             'email_from': customer and customer.email or lead.email_from,
 685             'phone': customer and customer.phone or lead.phone,
 686         }
 687         if not lead.stage_id or lead.stage_id.type=='lead':
 688             val['stage_id'] = self.stage_find(cr, uid, [lead], section_id, [('state', '=', 'draft'),('type', 'in', ('opportunity','both'))], context=context)
 689         return val
 690
 691     def convert_opportunity(self, cr, uid, ids, partner_id, user_ids=False, section_id=False, context=None):
 692         customer = False
 693         if partner_id:
 694             partner = self.pool.get('res.partner')
 695             customer = partner.browse(cr, uid, partner_id, context=context)
 696         for lead in self.browse(cr, uid, ids, context=context):
 697             if lead.state in ('done', 'cancel'):
 698                 continue
 699             vals = self._convert_opportunity_data(cr, uid, lead, customer, section_id, context=context)
 700             self.write(cr, uid, [lead.id], vals, context=context)
 701         self.message_post(cr, uid, ids, body=_("Lead <b>converted into an Opportunity</b>"), subtype="crm.mt_lead_convert_to_opportunity", context=context)
 702
 703         if user_ids or section_id:
 704             self.allocate_salesman(cr, uid, ids, user_ids, section_id, context=context)
 705
 706         return True
 707
 708     def _lead_create_contact(self, cr, uid, lead, name, is_company, parent_id=False, context=None):
 709         partner = self.pool.get('res.partner')
 710         vals = {'name': name,
 711             'user_id': lead.user_id.id,
 712             'comment': lead.description,
 713             'section_id': lead.section_id.id or False,
 714             'parent_id': parent_id,
 715             'phone': lead.phone,
 716             'mobile': lead.mobile,
 717             'email': tools.email_split(lead.email_from) and tools.email_split(lead.email_from)[0] or False,
 718             'fax': lead.fax,
 719             'title': lead.title and lead.title.id or False,
 720             'function': lead.function,
 721             'street': lead.street,
 722             'street2': lead.street2,
 723             'zip': lead.zip,
 724             'city': lead.city,
 725             'country_id': lead.country_id and lead.country_id.id or False,
 726             'state_id': lead.state_id and lead.state_id.id or False,
 727             'is_company': is_company,
 728             'type': 'contact'
 729         }
 730         partner = partner.create(cr, uid, vals, context=context)
 731         return partner
 732
 733     def _create_lead_partner(self, cr, uid, lead, context=None):
 734         partner_id = False
 735         if lead.partner_name and lead.contact_name:
 736             partner_id = self._lead_create_contact(cr, uid, lead, lead.partner_name, True, context=context)
 737             partner_id = self._lead_create_contact(cr, uid, lead, lead.contact_name, False, partner_id, context=context)
 738         elif lead.partner_name and not lead.contact_name:
 739             partner_id = self._lead_create_contact(cr, uid, lead, lead.partner_name, True, context=context)
 740         elif not lead.partner_name and lead.contact_name:
 741             partner_id = self._lead_create_contact(cr, uid, lead, lead.contact_name, False, context=context)
 742         elif lead.email_from and self.pool.get('res.partner')._parse_partner_name(lead.email_from, context=context)[0]:
 743             contact_name = self.pool.get('res.partner')._parse_partner_name(lead.email_from, context=context)[0]
 744             partner_id = self._lead_create_contact(cr, uid, lead, contact_name, False, context=context)
 745         else:
 746             raise osv.except_osv(
 747                 _('Warning!'),
 748                 _('No customer name defined. Please fill one of the following fields: Company Name, Contact Name or Email ("Name <email@address>")')
 749             )
 750         return partner_id
 751
 752     def _lead_set_partner(self, cr, uid, lead, partner_id, context=None):
 753         """
 754         Assign a partner to a lead.
 755
 756         :param object lead: browse record of the lead to process
 757         :param int partner_id: identifier of the partner to assign
 758         :return bool: True if the partner has properly been assigned
 759         """
 760         res = False
 761         res_partner = self.pool.get('res.partner')
 762         if partner_id:
 763             res_partner.write(cr, uid, partner_id, {'section_id': lead.section_id and lead.section_id.id or False})
 764             contact_id = res_partner.address_get(cr, uid, [partner_id])['default']
 765             res = lead.write({'partner_id': partner_id}, context=context)
 766             message = _("<b>Partner</b> set to <em>%s</em>." % (lead.partner_id.name))
 767             self.message_post(cr, uid, [lead.id], body=message, context=context)
 768         return res
 769
 770     def handle_partner_assignation(self, cr, uid, ids, action='create', partner_id=False, context=None):
 771         """
 772         Handle partner assignation during a lead conversion.
 773         if action is 'create', create new partner with contact and assign lead to new partner_id.
 774         otherwise assign lead to the specified partner_id
 775
 776         :param list ids: leads/opportunities ids to process
 777         :param string action: what has to be done regarding partners (create it, assign an existing one, or nothing)
 778         :param int partner_id: partner to assign if any
 779         :return dict: dictionary organized as followed: {lead_id: partner_assigned_id}
 780         """
 781         #TODO this is a duplication of the handle_partner_assignation method of crm_phonecall
 782         partner_ids = {}
 783         # If a partner_id is given, force this partner for all elements
 784         force_partner_id = partner_id
 785         for lead in self.browse(cr, uid, ids, context=context):
 786             # If the action is set to 'create' and no partner_id is set, create a new one
 787             if action == 'create':
 788                 partner_id = force_partner_id or self._create_lead_partner(cr, uid, lead, context)
 789             self._lead_set_partner(cr, uid, lead, partner_id, context=context)
 790             partner_ids[lead.id] = partner_id
 791         return partner_ids
 792
 793     def allocate_salesman(self, cr, uid, ids, user_ids=None, team_id=False, context=None):
 794         """
 795         Assign salesmen and salesteam to a batch of leads.  If there are more
 796         leads than salesmen, these salesmen will be assigned in round-robin.
 797         E.g.: 4 salesmen (S1, S2, S3, S4) for 6 leads (L1, L2, ... L6).  They
 798         will be assigned as followed: L1 - S1, L2 - S2, L3 - S3, L4 - S4,
 799         L5 - S1, L6 - S2.
 800
 801         :param list ids: leads/opportunities ids to process
 802         :param list user_ids: salesmen to assign
 803         :param int team_id: salesteam to assign
 804         :return bool
 805         """
 806         index = 0
 807
 808         for lead_id in ids:
 809             value = {}
 810             if team_id:
 811                 value['section_id'] = team_id
 812             if user_ids:
 813                 value['user_id'] = user_ids[index]
 814                 # Cycle through user_ids
 815                 index = (index + 1) % len(user_ids)
 816             if value:
 817                 self.write(cr, uid, [lead_id], value, context=context)
 818         return True
 819
 820     def schedule_phonecall(self, cr, uid, ids, schedule_time, call_summary, desc, phone, contact_name, user_id=False, section_id=False, categ_id=False, action='schedule', context=None):
 821         """
 822         :param string action: ('schedule','Schedule a call'), ('log','Log a call')
 823         """
 824         phonecall = self.pool.get('crm.phonecall')
 825         model_data = self.pool.get('ir.model.data')
 826         phonecall_dict = {}
 827         if not categ_id:
 828             res_id = model_data._get_id(cr, uid, 'crm', 'categ_phone2')
 829             if res_id:
 830                 categ_id = model_data.browse(cr, uid, res_id, context=context).res_id
 831         for lead in self.browse(cr, uid, ids, context=context):
 832             if not section_id:
 833                 section_id = lead.section_id and lead.section_id.id or False
 834             if not user_id:
 835                 user_id = lead.user_id and lead.user_id.id or False
 836             vals = {
 837                 'name': call_summary,
 838                 'opportunity_id': lead.id,
 839                 'user_id': user_id or False,
 840                 'categ_id': categ_id or False,
 841                 'description': desc or '',
 842                 'date': schedule_time,
 843                 'section_id': section_id or False,
 844                 'partner_id': lead.partner_id and lead.partner_id.id or False,
 845                 'partner_phone': phone or lead.phone or (lead.partner_id and lead.partner_id.phone or False),
 846                 'partner_mobile': lead.partner_id and lead.partner_id.mobile or False,
 847                 'priority': lead.priority,
 848             }
 849             new_id = phonecall.create(cr, uid, vals, context=context)
 850             phonecall.case_open(cr, uid, [new_id], context=context)
 851             if action == 'log':
 852                 phonecall.case_close(cr, uid, [new_id], context=context)
 853             phonecall_dict[lead.id] = new_id
 854             self.schedule_phonecall_send_note(cr, uid, [lead.id], new_id, action, context=context)
 855         return phonecall_dict
 856
 857     def redirect_opportunity_view(self, cr, uid, opportunity_id, context=None):
 858         models_data = self.pool.get('ir.model.data')
 859
 860         # Get opportunity views
 861         dummy, form_view = models_data.get_object_reference(cr, uid, 'crm', 'crm_case_form_view_oppor')
 862         dummy, tree_view = models_data.get_object_reference(cr, uid, 'crm', 'crm_case_tree_view_oppor')
 863         return {
 864             'name': _('Opportunity'),
 865             'view_type': 'form',
 866             'view_mode': 'tree, form',
 867             'res_model': 'crm.lead',
 868             'domain': [('type', '=', 'opportunity')],
 869             'res_id': int(opportunity_id),
 870             'view_id': False,
 871             'views': [(form_view or False, 'form'),
 872                     (tree_view or False, 'tree'),
 873                     (False, 'calendar'), (False, 'graph')],
 874             'type': 'ir.actions.act_window',
 875         }
 876
 877     def redirect_lead_view(self, cr, uid, lead_id, context=None):
 878         models_data = self.pool.get('ir.model.data')
 879
 880         # Get lead views
 881         dummy, form_view = models_data.get_object_reference(cr, uid, 'crm', 'crm_case_form_view_leads')
 882         dummy, tree_view = models_data.get_object_reference(cr, uid, 'crm', 'crm_case_tree_view_leads')
 883         return {
 884             'name': _('Lead'),
 885             'view_type': 'form',
 886             'view_mode': 'tree, form',
 887             'res_model': 'crm.lead',
 888             'domain': [('type', '=', 'lead')],
 889             'res_id': int(lead_id),
 890             'view_id': False,
 891             'views': [(form_view or False, 'form'),
 892                       (tree_view or False, 'tree'),
 893                       (False, 'calendar'), (False, 'graph')],
 894             'type': 'ir.actions.act_window',
 895         }
 896
 897     def action_makeMeeting(self, cr, uid, ids, context=None):
 898         """
 899         Open meeting's calendar view to schedule meeting on current opportunity.
 900         :return dict: dictionary value for created Meeting view
 901         """
 902         opportunity = self.browse(cr, uid, ids[0], context)
 903         res = self.pool.get('ir.actions.act_window').for_xml_id(cr, uid, 'base_calendar', 'action_crm_meeting', context)
 904         res['context'] = {
 905             'default_opportunity_id': opportunity.id,
 906             'default_partner_id': opportunity.partner_id and opportunity.partner_id.id or False,
 907             'default_partner_ids' : opportunity.partner_id and [opportunity.partner_id.id] or False,
 908             'default_user_id': uid,
 909             'default_section_id': opportunity.section_id and opportunity.section_id.id or False,
 910             'default_email_from': opportunity.email_from,
 911             'default_name': opportunity.name,
 912         }
 913         return res
 914
 915     def write(self, cr, uid, ids, vals, context=None):
 916         if vals.get('stage_id') and not vals.get('probability'):
 917             # change probability of lead(s) if required by stage
 918             stage = self.pool.get('crm.case.stage').browse(cr, uid, vals['stage_id'], context=context)
 919             if stage.on_change:
 920                 vals['probability'] = stage.probability
 921         return super(crm_lead, self).write(cr, uid, ids, vals, context=context)
 922
 923     def new_mail_send(self, cr, uid, ids, context=None):
 924         '''
 925         This function opens a window to compose an email, with the edi sale template message loaded by default
 926         '''
 927         assert len(ids) == 1, 'This option should only be used for a single id at a time.'
 928         ir_model_data = self.pool.get('ir.model.data')
 929         try:
 930             template_id = ir_model_data.get_object_reference(cr, uid, 'crm', 'email_template_opportunity_mail')[1]
 931         except ValueError:
 932             template_id = False
 933         try:
 934             compose_form_id = ir_model_data.get_object_reference(cr, uid, 'mail', 'email_compose_message_wizard_form')[1]
 935         except ValueError:
 936             compose_form_id = False
 937         if context is None:
 938             context = {}
 939         ctx = context.copy()
 940         ctx.update({
 941             'default_model': 'crm.lead',
 942             'default_res_id': ids[0],
 943             'default_use_template': bool(template_id),
 944             'default_template_id': template_id,
 945             'default_composition_mode': 'comment',
 946         })
 947         return {
 948             'type': 'ir.actions.act_window',
 949             'view_type': 'form',
 950             'view_mode': 'form',
 951             'res_model': 'mail.compose.message',
 952             'views': [(compose_form_id, 'form')],
 953             'view_id': compose_form_id,
 954             'target': 'new',
 955             'context': ctx,
 956         }
 957
 958     # ----------------------------------------
 959     # Mail Gateway
 960     # ----------------------------------------
 961
 962     def message_get_reply_to(self, cr, uid, ids, context=None):
 963         """ Override to get the reply_to of the parent project. """
 964         return [lead.section_id.message_get_reply_to()[0] if lead.section_id else False
 965                     for lead in self.browse(cr, uid, ids, context=context)]
 966
 967     def message_get_suggested_recipients(self, cr, uid, ids, context=None):
 968         recipients = super(crm_lead, self).message_get_suggested_recipients(cr, uid, ids, context=context)
 969         for lead in self.browse(cr, uid, ids, context=context):
 970             if lead.partner_id:
 971                 self._message_add_suggested_recipient(cr, uid, recipients, lead, partner=lead.partner_id, reason=_('Customer'))
 972             elif lead.email_from:
 973                 self._message_add_suggested_recipient(cr, uid, recipients, lead, email=lead.email_from, reason=_('Customer Email'))
 974         return recipients
 975
 976     def message_new(self, cr, uid, msg, custom_values=None, context=None):
 977         """ Overrides mail_thread message_new that is called by the mailgateway
 978             through message_process.
 979             This override updates the document according to the email.
 980         """
 981         if custom_values is None:
 982             custom_values = {}
 983         desc = html2plaintext(msg.get('body')) if msg.get('body') else ''
 984         defaults = {
 985             'name':  msg.get('subject') or _("No Subject"),
 986             'description': desc,
 987             'email_from': msg.get('from'),
 988             'email_cc': msg.get('cc'),
 989             'partner_id': msg.get('author_id', False),
 990             'user_id': False,
 991         }
 992         if msg.get('author_id'):
 993             defaults.update(self.on_change_partner(cr, uid, None, msg.get('author_id'), context=context)['value'])
 994         if msg.get('priority') in dict(crm.AVAILABLE_PRIORITIES):
 995             defaults['priority'] = msg.get('priority')
 996         defaults.update(custom_values)
 997         return super(crm_lead, self).message_new(cr, uid, msg, custom_values=defaults, context=context)
 998
 999     def message_update(self, cr, uid, ids, msg, update_vals=None, context=None):
1000         """ Overrides mail_thread message_update that is called by the mailgateway
1001             through message_process.
1002             This method updates the document according to the email.
1003         """
1004         if isinstance(ids, (str, int, long)):
1005             ids = [ids]
1006         if update_vals is None: update_vals = {}
1007
1008         if msg.get('priority') in dict(crm.AVAILABLE_PRIORITIES):
1009             update_vals['priority'] = msg.get('priority')
1010         maps = {
1011             'cost':'planned_cost',
1012             'revenue': 'planned_revenue',
1013             'probability':'probability',
1014         }
1015         for line in msg.get('body', '').split('\n'):
1016             line = line.strip()
1017             res = tools.command_re.match(line)
1018             if res and maps.get(res.group(1).lower()):
1019                 key = maps.get(res.group(1).lower())
1020                 update_vals[key] = res.group(2).lower()
1021
1022         return super(crm_lead, self).message_update(cr, uid, ids, msg, update_vals=update_vals, context=context)
1023
1024     # ----------------------------------------
1025     # OpenChatter methods and notifications
1026     # ----------------------------------------
1027
1028     def schedule_phonecall_send_note(self, cr, uid, ids, phonecall_id, action, context=None):
1029         phonecall = self.pool.get('crm.phonecall').browse(cr, uid, [phonecall_id], context=context)[0]
1030         if action == 'log':
1031             prefix = 'Logged'
1032         else:
1033             prefix = 'Scheduled'
1034         suffix = ' %s' % phonecall.description
1035         message = _("%s a call for %s.%s") % (prefix, phonecall.date, suffix)
1036         return self.message_post(cr, uid, ids, body=message, context=context)
1037
1038     def onchange_state(self, cr, uid, ids, state_id, context=None):
1039         if state_id:
1040             country_id=self.pool.get('res.country.state').browse(cr, uid, state_id, context).country_id.id
1041             return {'value':{'country_id':country_id}}
1042         return {}
1043
1044 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: