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