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