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_data(self, cr, uid, ids, oldest, fields, context=None):
 475         """
 476         Prepare lead/opp data into a dictionary for merging.  Different types
 477         of fields are processed in different ways:
 478         - text: all the values are concatenated
 479         - m2m and o2m: those fields aren't processed
 480         - m2o: the first not null value prevails (the other are dropped)
 481         - any other type of field: same as m2o
 482
 483         :param list ids: list of ids of the leads to process
 484         :param list fields: list of leads' fields to process
 485         :return dict data: contains the merged values
 486         """
 487         opportunities = self.browse(cr, uid, ids, context=context)
 488
 489         def _get_first_not_null(attr):
 490             for opp in opportunities:
 491                 if hasattr(opp, attr) and bool(getattr(opp, attr)):
 492                     return getattr(opp, attr)
 493             return False
 494
 495         def _get_first_not_null_id(attr):
 496             res = _get_first_not_null(attr)
 497             return res and res.id or False
 498
 499         def _concat_all(attr):
 500             return ', '.join(filter(lambda x: x, [getattr(opp, attr) or '' for opp in opportunities if hasattr(opp, attr)]))
 501
 502         # Process the fields' values
 503         data = {}
 504         for field_name in fields:
 505             field_info = self._all_columns.get(field_name)
 506             if field_info is None:
 507                 continue
 508             field = field_info.column
 509             if field._type in ('many2many', 'one2many'):
 510                 continue
 511             elif field._type == 'many2one':
 512                 data[field_name] = _get_first_not_null_id(field_name)  # !!
 513             elif field._type == 'text':
 514                 data[field_name] = _concat_all(field_name)  #not lost
 515             else:
 516                 data[field_name] = _get_first_not_null(field_name)  #not lost
 517
 518         # Define the resulting type ('lead' or 'opportunity')
 519         data['type'] = self._merge_get_result_type(cr, uid, opportunities, context)
 520         return data
 521
 522     def _mail_body(self, cr, uid, lead, fields, title=False, context=None):
 523         body = []
 524         if title:
 525             body.append("%s\n" % (title))
 526
 527         for field_name in fields:
 528             field_info = self._all_columns.get(field_name)
 529             if field_info is None:
 530                 continue
 531             field = field_info.column
 532             value = ''
 533
 534             if field._type == 'selection':
 535                 if hasattr(field.selection, '__call__'):
 536                     key = field.selection(self, cr, uid, context=context)
 537                 else:
 538                     key = field.selection
 539                 value = dict(key).get(lead[field_name], lead[field_name])
 540             elif field._type == 'many2one':
 541                 if lead[field_name]:
 542                     value = lead[field_name].name_get()[0][1]
 543             elif field._type == 'many2many':
 544                 if lead[field_name]:
 545                     for val in lead[field_name]:
 546                         field_value = val.name_get()[0][1]
 547                         value += field_value + ","
 548             else:
 549                 value = lead[field_name]
 550
 551             body.append("%s: %s" % (field.string, value or ''))
 552         return "<br/>".join(body + ['<br/>'])
 553
 554     def _merge_notify(self, cr, uid, opportunity_id, opportunities, context=None):
 555         """
 556         Create a message gathering merged leads/opps information.
 557         """
 558         #TOFIX: mail template should be used instead of fix body, subject text
 559         details = []
 560         result_type = self._merge_get_result_type(cr, uid, opportunities, context)
 561         if result_type == 'lead':
 562             merge_message = _('Merged leads')
 563         else:
 564             merge_message = _('Merged opportunities')
 565         subject = [merge_message]
 566         for opportunity in opportunities:
 567             subject.append(opportunity.name)
 568             title = "%s : %s" % (merge_message, opportunity.name)
 569             details.append(self._mail_body(cr, uid, opportunity, CRM_LEAD_FIELDS_TO_MERGE, title=title, context=context))
 570
 571         # Chatter message's subject
 572         subject = subject[0] + ": " + ", ".join(subject[1:])
 573         details = "\n\n".join(details)
 574         return self.message_post(cr, uid, [opportunity_id], body=details, subject=subject, context=context)
 575
 576     def _merge_opportunity_history(self, cr, uid, opportunity_id, opportunities, context=None):
 577         message = self.pool.get('mail.message')
 578         for opportunity in opportunities:
 579             for history in opportunity.message_ids:
 580                 message.write(cr, uid, history.id, {
 581                         'res_id': opportunity_id,
 582                         'subject' : _("From %s : %s") % (opportunity.name, history.subject)
 583                 }, context=context)
 584
 585         return True
 586
 587     def _merge_opportunity_attachments(self, cr, uid, opportunity_id, opportunities, context=None):
 588         attachment = self.pool.get('ir.attachment')
 589
 590         # return attachments of opportunity
 591         def _get_attachments(opportunity_id):
 592             attachment_ids = attachment.search(cr, uid, [('res_model', '=', self._name), ('res_id', '=', opportunity_id)], context=context)
 593             return attachment.browse(cr, uid, attachment_ids, context=context)
 594
 595         count = 1
 596         first_attachments = _get_attachments(opportunity_id)
 597         for opportunity in opportunities:
 598             attachments = _get_attachments(opportunity.id)
 599             for first in first_attachments:
 600                 for attachment in attachments:
 601                     if attachment.name == first.name:
 602                         values = dict(
 603                             name = "%s (%s)" % (attachment.name, count,),
 604                             res_id = opportunity_id,
 605                         )
 606                         attachment.write(values)
 607                         count+=1
 608
 609         return True
 610
 611     def merge_opportunity(self, cr, uid, ids, context=None):
 612         """
 613         Different cases of merge:
 614         - merge leads together = 1 new lead
 615         - merge at least 1 opp with anything else (lead or opp) = 1 new opp
 616
 617         :param list ids: leads/opportunities ids to merge
 618         :return int id: id of the resulting lead/opp
 619         """
 620         if context is None:
 621             context = {}
 622
 623         if len(ids) <= 1:
 624             raise osv.except_osv(_('Warning!'), _('Please select more than one element (lead or opportunity) from the list view.'))
 625
 626         opportunities = self.browse(cr, uid, ids, context=context)
 627         sequenced_opps = []
 628         for opportunity in opportunities:
 629             sequenced_opps.append((opportunity.stage_id and opportunity.stage_id.state != 'cancel' and opportunity.stage_id.sequence or 0, opportunity))
 630         sequenced_opps.sort(key=lambda tup: tup[0], reverse=True)
 631         opportunities = [opportunity for sequence, opportunity in sequenced_opps]
 632         ids = [opportunity.id for opportunity in opportunities]
 633         highest = opportunities[0]
 634         opportunities_rest = opportunities[1:]
 635
 636         tail_opportunities = opportunities_rest
 637
 638         merged_data = self._merge_data(cr, uid, ids, highest, CRM_LEAD_FIELDS_TO_MERGE, context=context)
 639
 640         # Merge messages and attachements into the first opportunity
 641         self._merge_opportunity_history(cr, uid, highest.id, tail_opportunities, context=context)
 642         self._merge_opportunity_attachments(cr, uid, highest.id, tail_opportunities, context=context)
 643
 644         # Merge notifications about loss of information
 645         opportunities = [highest]
 646         opportunities.extend(opportunities_rest)
 647         self._merge_notify(cr, uid, highest, opportunities, context=context)
 648         # Write merged data into first opportunity
 649         self.write(cr, uid, [highest.id], merged_data, context=context)
 650         # Delete tail opportunities
 651         self.unlink(cr, uid, [x.id for x in tail_opportunities], context=context)
 652
 653         return highest.id
 654
 655     def _convert_opportunity_data(self, cr, uid, lead, customer, section_id=False, context=None):
 656         crm_stage = self.pool.get('crm.case.stage')
 657         contact_id = False
 658         if customer:
 659             contact_id = self.pool.get('res.partner').address_get(cr, uid, [customer.id])['default']
 660         if not section_id:
 661             section_id = lead.section_id and lead.section_id.id or False
 662         val = {
 663             'planned_revenue': lead.planned_revenue,
 664             'probability': lead.probability,
 665             'name': lead.name,
 666             'partner_id': customer and customer.id or False,
 667             'user_id': (lead.user_id and lead.user_id.id),
 668             'type': 'opportunity',
 669             'date_action': fields.datetime.now(),
 670             'date_open': fields.datetime.now(),
 671             'email_from': customer and customer.email or lead.email_from,
 672             'phone': customer and customer.phone or lead.phone,
 673         }
 674         if not lead.stage_id or lead.stage_id.type=='lead':
 675             val['stage_id'] = self.stage_find(cr, uid, [lead], section_id, [('state', '=', 'draft'),('type', 'in', ('opportunity','both'))], context=context)
 676         return val
 677
 678     def convert_opportunity(self, cr, uid, ids, partner_id, user_ids=False, section_id=False, context=None):
 679         customer = False
 680         if partner_id:
 681             partner = self.pool.get('res.partner')
 682             customer = partner.browse(cr, uid, partner_id, context=context)
 683         for lead in self.browse(cr, uid, ids, context=context):
 684             if lead.state in ('done', 'cancel'):
 685                 continue
 686             vals = self._convert_opportunity_data(cr, uid, lead, customer, section_id, context=context)
 687             self.write(cr, uid, [lead.id], vals, context=context)
 688         self.message_post(cr, uid, ids, body=_("Lead <b>converted into an Opportunity</b>"), subtype="crm.mt_lead_convert_to_opportunity", context=context)
 689
 690         if user_ids or section_id:
 691             self.allocate_salesman(cr, uid, ids, user_ids, section_id, context=context)
 692
 693         return True
 694
 695     def _lead_create_contact(self, cr, uid, lead, name, is_company, parent_id=False, context=None):
 696         partner = self.pool.get('res.partner')
 697         vals = {'name': name,
 698             'user_id': lead.user_id.id,
 699             'comment': lead.description,
 700             'section_id': lead.section_id.id or False,
 701             'parent_id': parent_id,
 702             'phone': lead.phone,
 703             'mobile': lead.mobile,
 704             'email': lead.email_from and tools.email_split(lead.email_from)[0],
 705             'fax': lead.fax,
 706             'title': lead.title and lead.title.id or False,
 707             'function': lead.function,
 708             'street': lead.street,
 709             'street2': lead.street2,
 710             'zip': lead.zip,
 711             'city': lead.city,
 712             'country_id': lead.country_id and lead.country_id.id or False,
 713             'state_id': lead.state_id and lead.state_id.id or False,
 714             'is_company': is_company,
 715             'type': 'contact'
 716         }
 717         partner = partner.create(cr, uid, vals, context=context)
 718         return partner
 719
 720     def _create_lead_partner(self, cr, uid, lead, context=None):
 721         partner_id = False
 722         if lead.partner_name and lead.contact_name:
 723             partner_id = self._lead_create_contact(cr, uid, lead, lead.partner_name, True, context=context)
 724             partner_id = self._lead_create_contact(cr, uid, lead, lead.contact_name, False, partner_id, context=context)
 725         elif lead.partner_name and not lead.contact_name:
 726             partner_id = self._lead_create_contact(cr, uid, lead, lead.partner_name, True, context=context)
 727         elif not lead.partner_name and lead.contact_name:
 728             partner_id = self._lead_create_contact(cr, uid, lead, lead.contact_name, False, context=context)
 729         elif lead.email_from and self.pool.get('res.partner')._parse_partner_name(lead.email_from, context=context)[0]:
 730             contact_name = self.pool.get('res.partner')._parse_partner_name(lead.email_from, context=context)[0]
 731             partner_id = self._lead_create_contact(cr, uid, lead, contact_name, False, context=context)
 732         else:
 733             raise osv.except_osv(
 734                 _('Warning!'),
 735                 _('No customer name defined. Please fill one of the following fields: Company Name, Contact Name or Email ("Name <email@address>")')
 736             )
 737         return partner_id
 738
 739     def _lead_set_partner(self, cr, uid, lead, partner_id, context=None):
 740         """
 741         Assign a partner to a lead.
 742
 743         :param object lead: browse record of the lead to process
 744         :param int partner_id: identifier of the partner to assign
 745         :return bool: True if the partner has properly been assigned
 746         """
 747         res = False
 748         res_partner = self.pool.get('res.partner')
 749         if partner_id:
 750             res_partner.write(cr, uid, partner_id, {'section_id': lead.section_id and lead.section_id.id or False})
 751             contact_id = res_partner.address_get(cr, uid, [partner_id])['default']
 752             res = lead.write({'partner_id': partner_id}, context=context)
 753             message = _("<b>Partner</b> set to <em>%s</em>." % (lead.partner_id.name))
 754             self.message_post(cr, uid, [lead.id], body=message, context=context)
 755         return res
 756
 757     def handle_partner_assignation(self, cr, uid, ids, action='create', partner_id=False, context=None):
 758         """
 759         Handle partner assignation during a lead conversion.
 760         if action is 'create', create new partner with contact and assign lead to new partner_id.
 761         otherwise assign lead to the specified partner_id
 762
 763         :param list ids: leads/opportunities ids to process
 764         :param string action: what has to be done regarding partners (create it, assign an existing one, or nothing)
 765         :param int partner_id: partner to assign if any
 766         :return dict: dictionary organized as followed: {lead_id: partner_assigned_id}
 767         """
 768         #TODO this is a duplication of the handle_partner_assignation method of crm_phonecall
 769         partner_ids = {}
 770         # If a partner_id is given, force this partner for all elements
 771         force_partner_id = partner_id
 772         for lead in self.browse(cr, uid, ids, context=context):
 773             # If the action is set to 'create' and no partner_id is set, create a new one
 774             if action == 'create':
 775                 partner_id = force_partner_id or self._create_lead_partner(cr, uid, lead, context)
 776             self._lead_set_partner(cr, uid, lead, partner_id, context=context)
 777             partner_ids[lead.id] = partner_id
 778         return partner_ids
 779
 780     def allocate_salesman(self, cr, uid, ids, user_ids=None, team_id=False, context=None):
 781         """
 782         Assign salesmen and salesteam to a batch of leads.  If there are more
 783         leads than salesmen, these salesmen will be assigned in round-robin.
 784         E.g.: 4 salesmen (S1, S2, S3, S4) for 6 leads (L1, L2, ... L6).  They
 785         will be assigned as followed: L1 - S1, L2 - S2, L3 - S3, L4 - S4,
 786         L5 - S1, L6 - S2.
 787
 788         :param list ids: leads/opportunities ids to process
 789         :param list user_ids: salesmen to assign
 790         :param int team_id: salesteam to assign
 791         :return bool
 792         """
 793         index = 0
 794
 795         for lead_id in ids:
 796             value = {}
 797             if team_id:
 798                 value['section_id'] = team_id
 799             if user_ids:
 800                 value['user_id'] = user_ids[index]
 801                 # Cycle through user_ids
 802                 index = (index + 1) % len(user_ids)
 803             if value:
 804                 self.write(cr, uid, [lead_id], value, context=context)
 805         return True
 806
 807     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):
 808         """
 809         :param string action: ('schedule','Schedule a call'), ('log','Log a call')
 810         """
 811         phonecall = self.pool.get('crm.phonecall')
 812         model_data = self.pool.get('ir.model.data')
 813         phonecall_dict = {}
 814         if not categ_id:
 815             res_id = model_data._get_id(cr, uid, 'crm', 'categ_phone2')
 816             if res_id:
 817                 categ_id = model_data.browse(cr, uid, res_id, context=context).res_id
 818         for lead in self.browse(cr, uid, ids, context=context):
 819             if not section_id:
 820                 section_id = lead.section_id and lead.section_id.id or False
 821             if not user_id:
 822                 user_id = lead.user_id and lead.user_id.id or False
 823             vals = {
 824                 'name': call_summary,
 825                 'opportunity_id': lead.id,
 826                 'user_id': user_id or False,
 827                 'categ_id': categ_id or False,
 828                 'description': desc or '',
 829                 'date': schedule_time,
 830                 'section_id': section_id or False,
 831                 'partner_id': lead.partner_id and lead.partner_id.id or False,
 832                 'partner_phone': phone or lead.phone or (lead.partner_id and lead.partner_id.phone or False),
 833                 'partner_mobile': lead.partner_id and lead.partner_id.mobile or False,
 834                 'priority': lead.priority,
 835             }
 836             new_id = phonecall.create(cr, uid, vals, context=context)
 837             phonecall.case_open(cr, uid, [new_id], context=context)
 838             if action == 'log':
 839                 phonecall.case_close(cr, uid, [new_id], context=context)
 840             phonecall_dict[lead.id] = new_id
 841             self.schedule_phonecall_send_note(cr, uid, [lead.id], new_id, action, context=context)
 842         return phonecall_dict
 843
 844     def redirect_opportunity_view(self, cr, uid, opportunity_id, context=None):
 845         models_data = self.pool.get('ir.model.data')
 846
 847         # Get opportunity views
 848         dummy, form_view = models_data.get_object_reference(cr, uid, 'crm', 'crm_case_form_view_oppor')
 849         dummy, tree_view = models_data.get_object_reference(cr, uid, 'crm', 'crm_case_tree_view_oppor')
 850         return {
 851             'name': _('Opportunity'),
 852             'view_type': 'form',
 853             'view_mode': 'tree, form',
 854             'res_model': 'crm.lead',
 855             'domain': [('type', '=', 'opportunity')],
 856             'res_id': int(opportunity_id),
 857             'view_id': False,
 858             'views': [(form_view or False, 'form'),
 859                     (tree_view or False, 'tree'),
 860                     (False, 'calendar'), (False, 'graph')],
 861             'type': 'ir.actions.act_window',
 862         }
 863
 864     def redirect_lead_view(self, cr, uid, lead_id, context=None):
 865         models_data = self.pool.get('ir.model.data')
 866
 867         # Get lead views
 868         dummy, form_view = models_data.get_object_reference(cr, uid, 'crm', 'crm_case_form_view_leads')
 869         dummy, tree_view = models_data.get_object_reference(cr, uid, 'crm', 'crm_case_tree_view_leads')
 870         return {
 871             'name': _('Lead'),
 872             'view_type': 'form',
 873             'view_mode': 'tree, form',
 874             'res_model': 'crm.lead',
 875             'domain': [('type', '=', 'lead')],
 876             'res_id': int(lead_id),
 877             'view_id': False,
 878             'views': [(form_view or False, 'form'),
 879                       (tree_view or False, 'tree'),
 880                       (False, 'calendar'), (False, 'graph')],
 881             'type': 'ir.actions.act_window',
 882         }
 883
 884     def action_makeMeeting(self, cr, uid, ids, context=None):
 885         """
 886         Open meeting's calendar view to schedule meeting on current opportunity.
 887         :return dict: dictionary value for created Meeting view
 888         """
 889         opportunity = self.browse(cr, uid, ids[0], context)
 890         res = self.pool.get('ir.actions.act_window').for_xml_id(cr, uid, 'base_calendar', 'action_crm_meeting', context)
 891         res['context'] = {
 892             'default_opportunity_id': opportunity.id,
 893             'default_partner_id': opportunity.partner_id and opportunity.partner_id.id or False,
 894             'default_partner_ids' : opportunity.partner_id and [opportunity.partner_id.id] or False,
 895             'default_user_id': uid,
 896             'default_section_id': opportunity.section_id and opportunity.section_id.id or False,
 897             'default_email_from': opportunity.email_from,
 898             'default_name': opportunity.name,
 899         }
 900         return res
 901
 902     def write(self, cr, uid, ids, vals, context=None):
 903         if vals.get('stage_id') and not vals.get('probability'):
 904             # change probability of lead(s) if required by stage
 905             stage = self.pool.get('crm.case.stage').browse(cr, uid, vals['stage_id'], context=context)
 906             if stage.on_change:
 907                 vals['probability'] = stage.probability
 908         return super(crm_lead, self).write(cr, uid, ids, vals, context=context)
 909
 910     def new_mail_send(self, cr, uid, ids, context=None):
 911         '''
 912         This function opens a window to compose an email, with the edi sale template message loaded by default
 913         '''
 914         assert len(ids) == 1, 'This option should only be used for a single id at a time.'
 915         ir_model_data = self.pool.get('ir.model.data')
 916         try:
 917             template_id = ir_model_data.get_object_reference(cr, uid, 'crm', 'email_template_opportunity_mail')[1]
 918         except ValueError:
 919             template_id = False
 920         try:
 921             compose_form_id = ir_model_data.get_object_reference(cr, uid, 'mail', 'email_compose_message_wizard_form')[1]
 922         except ValueError:
 923             compose_form_id = False
 924         if context is None:
 925             context = {}
 926         ctx = context.copy()
 927         ctx.update({
 928             'default_model': 'crm.lead',
 929             'default_res_id': ids[0],
 930             'default_use_template': bool(template_id),
 931             'default_template_id': template_id,
 932             'default_composition_mode': 'comment',
 933         })
 934         return {
 935             'type': 'ir.actions.act_window',
 936             'view_type': 'form',
 937             'view_mode': 'form',
 938             'res_model': 'mail.compose.message',
 939             'views': [(compose_form_id, 'form')],
 940             'view_id': compose_form_id,
 941             'target': 'new',
 942             'context': ctx,
 943         }
 944
 945     # ----------------------------------------
 946     # Mail Gateway
 947     # ----------------------------------------
 948
 949     def message_get_reply_to(self, cr, uid, ids, context=None):
 950         """ Override to get the reply_to of the parent project. """
 951         return [lead.section_id.message_get_reply_to()[0] if lead.section_id else False
 952                     for lead in self.browse(cr, uid, ids, context=context)]
 953
 954     def message_new(self, cr, uid, msg, custom_values=None, context=None):
 955         """ Overrides mail_thread message_new that is called by the mailgateway
 956             through message_process.
 957             This override updates the document according to the email.
 958         """
 959         if custom_values is None: custom_values = {}
 960
 961         desc = html2plaintext(msg.get('body')) if msg.get('body') else ''
 962         defaults = {
 963             'name':  msg.get('subject') or _("No Subject"),
 964             'description': desc,
 965             'email_from': msg.get('from'),
 966             'email_cc': msg.get('cc'),
 967             'partner_id': msg.get('author_id', False),
 968             'user_id': False,
 969         }
 970         if msg.get('author_id'):
 971             defaults.update(self.on_change_partner(cr, uid, None, msg.get('author_id'), context=context)['value'])
 972         if msg.get('priority') in dict(crm.AVAILABLE_PRIORITIES):
 973             defaults['priority'] = msg.get('priority')
 974         defaults.update(custom_values)
 975         return super(crm_lead, self).message_new(cr, uid, msg, custom_values=defaults, context=context)
 976
 977     def message_update(self, cr, uid, ids, msg, update_vals=None, context=None):
 978         """ Overrides mail_thread message_update that is called by the mailgateway
 979             through message_process.
 980             This method updates the document according to the email.
 981         """
 982         if isinstance(ids, (str, int, long)):
 983             ids = [ids]
 984         if update_vals is None: update_vals = {}
 985
 986         if msg.get('priority') in dict(crm.AVAILABLE_PRIORITIES):
 987             update_vals['priority'] = msg.get('priority')
 988         maps = {
 989             'cost':'planned_cost',
 990             'revenue': 'planned_revenue',
 991             'probability':'probability',
 992         }
 993         for line in msg.get('body', '').split('\n'):
 994             line = line.strip()
 995             res = tools.command_re.match(line)
 996             if res and maps.get(res.group(1).lower()):
 997                 key = maps.get(res.group(1).lower())
 998                 update_vals[key] = res.group(2).lower()
 999
1000         return super(crm_lead, self).message_update(cr, uid, ids, msg, update_vals=update_vals, context=context)
1001
1002     # ----------------------------------------
1003     # OpenChatter methods and notifications
1004     # ----------------------------------------
1005
1006     def schedule_phonecall_send_note(self, cr, uid, ids, phonecall_id, action, context=None):
1007         phonecall = self.pool.get('crm.phonecall').browse(cr, uid, [phonecall_id], context=context)[0]
1008         if action == 'log': prefix = 'Logged'
1009         else: prefix = 'Scheduled'
1010         message = _("<b>%s a call</b> for the <em>%s</em>.") % (prefix, phonecall.date)
1011         return self.message_post(cr, uid, ids, body=message, context=context)
1012
1013     def onchange_state(self, cr, uid, ids, state_id, context=None):
1014         if state_id:
1015             country_id=self.pool.get('res.country.state').browse(cr, uid, state_id, context).country_id.id
1016             return {'value':{'country_id':country_id}}
1017         return {}
1018
1019 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: