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