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