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