1 # -*- coding: utf-8 -*-
2 ##############################################################################
4 # OpenERP, Open Source Management Solution
5 # Copyright (C) 2004-today OpenERP SA (<http://www.openerp.com>)
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.
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.
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/>.
20 ##############################################################################
23 from datetime import datetime
24 from operator import itemgetter
26 from openerp import SUPERUSER_ID
27 from openerp import tools
28 from openerp.addons.base.res.res_partner import format_address
29 from openerp.osv import fields, osv, orm
30 from openerp.tools import html2plaintext
31 from openerp.tools.translate import _
33 CRM_LEAD_FIELDS_TO_MERGE = ['name',
65 class crm_lead(format_address, osv.osv):
68 _description = "Lead/Opportunity"
69 _order = "priority,date_action,id desc"
70 _inherit = ['mail.thread', 'ir.needaction_mixin']
74 # this is only an heuristics; depending on your particular stage configuration it may not match all 'new' stages
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.fold,
78 'crm.mt_lead_lost': lambda self, cr, uid, obj, ctx=None: obj.probability == 0 and obj.stage_id and obj.stage_id.fold and obj.stage_id.sequence > 1,
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)
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
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, [('fold', '=', False)], context=context)
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
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])
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.
119 return context.get('default_type')
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
133 section_id = self._resolve_section_id_from_context(cr, uid, context=context)
135 search_domain += ['|', ('section_ids', '=', section_id)]
136 search_domain += [('id', 'in', ids)]
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)
142 search_domain += ['|', ('type', '=', type), ('type', '=', 'both')]
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])))
150 for stage in stage_obj.browse(cr, access_rights_uid, stage_ids, context=context):
151 fold[stage.id] = stage.fold or False
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)
161 'stage_id': _read_group_stage_ids
164 def _compute_day(self, cr, uid, ids, fields, args, context=None):
166 :return dict: difference between current date and log date
168 cal_obj = self.pool.get('resource.calendar')
169 res_obj = self.pool.get('resource.resource')
172 for lead in self.browse(cr, uid, ids, context=context):
177 if field == 'day_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':
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
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]
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,
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'),
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:
213 duration = len(no_days)
214 res[lead.id][field] = abs(int(duration))
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."),
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),
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=crm._links_get, size=128),
263 'ref2': fields.reference('Reference 2', selection=crm._links_get, size=128),
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),
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'),
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],
302 'date_last_stage_update': fields.datetime.now,
306 ('check_probability', 'check(probability >= 0 and probability <= 100)', 'The probability of closing the deal should be between 0% and 100%!')
309 def onchange_stage_id(self, cr, uid, ids, stage_id, context=None):
312 stage = self.pool.get('crm.case.stage').browse(cr, uid, stage_id, context=context)
313 if not stage.on_change:
315 return {'value': {'probability': stage.probability}}
317 def on_change_partner_id(self, cr, uid, ids, partner_id, context=None):
320 partner = self.pool.get('res.partner').browse(cr, uid, partner_id, context=context)
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,
333 return {'value': values}
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)
342 section_id = section_ids[0]
343 return {'value': {'section_id': section_id}}
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
353 if isinstance(cases, (int, long)):
354 cases = self.browse(cr, uid, cases, context=context)
357 # check whether we should try to add a condition on type
358 avoid_add_type_term = any([term for term in domain if len(term) == 3 if term[0] == 'type'])
359 # collect all section_ids
362 if not cases and context.get('default_type'):
363 ctx_type = context.get('default_type')
366 section_ids.add(section_id)
369 section_ids.add(lead.section_id.id)
370 if lead.type not in types:
371 types.append(lead.type)
372 # OR all section_ids and OR with case_default
375 search_domain += [('|')] * len(section_ids)
376 for section_id in section_ids:
377 search_domain.append(('section_ids', '=', section_id))
378 search_domain.append(('case_default', '=', True))
379 # AND with cases types
380 if not avoid_add_type_term:
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, limit=1, context=context)
390 def case_mark_lost(self, cr, uid, ids, context=None):
391 """ Mark the case as lost: state=cancel and probability=0
392 :deprecated: this method will be removed in OpenERP v8.
395 for lead in self.browse(cr, uid, ids, context=context):
396 stage_id = self.stage_find(cr, uid, [lead], lead.section_id.id or False, [('probability', '=', 0.0), ('fold', '=', True), ('sequence', '>', 1)], context=context)
398 if stages_leads.get(stage_id):
399 stages_leads[stage_id].append(lead.id)
401 stages_leads[stage_id] = [lead.id]
403 raise osv.except_osv(_('Warning!'),
404 _('To relieve your sales pipe and group all Lost opportunities, configure one of your sales stage as follow:\n'
405 'probability = 0 %, select "Change Probability Automatically".\n'
406 'Create a specific stage or edit an existing one by editing columns of your opportunity pipe.'))
407 for stage_id, lead_ids in stages_leads.items():
408 self.write(cr, uid, lead_ids, {'stage_id': stage_id}, context=context)
411 def case_mark_won(self, cr, uid, ids, context=None):
412 """ Mark the case as won: state=done and probability=100
413 :deprecated: this method will be removed in OpenERP v8.
416 for lead in self.browse(cr, uid, ids, context=context):
417 stage_id = self.stage_find(cr, uid, [lead], lead.section_id.id or False, [('probability', '=', 100.0), ('fold', '=', True)], context=context)
419 if stages_leads.get(stage_id):
420 stages_leads[stage_id].append(lead.id)
422 stages_leads[stage_id] = [lead.id]
424 raise osv.except_osv(_('Warning!'),
425 _('To relieve your sales pipe and group all Won opportunities, configure one of your sales stage as follow:\n'
426 'probability = 100 % and select "Change Probability Automatically".\n'
427 'Create a specific stage or edit an existing one by editing columns of your opportunity pipe.'))
428 for stage_id, lead_ids in stages_leads.items():
429 self.write(cr, uid, lead_ids, {'stage_id': stage_id}, context=context)
432 def case_escalate(self, cr, uid, ids, context=None):
433 """ Escalates case to parent level """
434 for case in self.browse(cr, uid, ids, context=context):
435 data = {'active': True}
436 if case.section_id.parent_id:
437 data['section_id'] = case.section_id.parent_id.id
438 if case.section_id.parent_id.change_responsible:
439 if case.section_id.parent_id.user_id:
440 data['user_id'] = case.section_id.parent_id.user_id.id
442 raise osv.except_osv(_('Error!'), _("You are already at the top level of your sales-team category.\nTherefore you cannot escalate furthermore."))
443 self.write(cr, uid, [case.id], data, context=context)
446 def set_priority(self, cr, uid, ids, priority, context=None):
447 """ Set lead priority
449 return self.write(cr, uid, ids, {'priority': priority}, context=context)
451 def set_high_priority(self, cr, uid, ids, context=None):
452 """ Set lead priority to high
454 return self.set_priority(cr, uid, ids, '1', context=context)
456 def set_normal_priority(self, cr, uid, ids, context=None):
457 """ Set lead priority to normal
459 return self.set_priority(cr, uid, ids, '3', context=context)
461 def _merge_get_result_type(self, cr, uid, opps, context=None):
463 Define the type of the result of the merge. If at least one of the
464 element to merge is an opp, the resulting new element will be an opp.
465 Otherwise it will be a lead.
467 We'll directly use a list of browse records instead of a list of ids
468 for performances' sake: it will spare a second browse of the
471 :param list opps: list of browse records containing the leads/opps to process
472 :return string type: the type of the final element
475 if (opp.type == 'opportunity'):
480 def _merge_data(self, cr, uid, ids, oldest, fields, context=None):
482 Prepare lead/opp data into a dictionary for merging. Different types
483 of fields are processed in different ways:
484 - text: all the values are concatenated
485 - m2m and o2m: those fields aren't processed
486 - m2o: the first not null value prevails (the other are dropped)
487 - any other type of field: same as m2o
489 :param list ids: list of ids of the leads to process
490 :param list fields: list of leads' fields to process
491 :return dict data: contains the merged values
493 opportunities = self.browse(cr, uid, ids, context=context)
495 def _get_first_not_null(attr):
496 for opp in opportunities:
497 if hasattr(opp, attr) and bool(getattr(opp, attr)):
498 return getattr(opp, attr)
501 def _get_first_not_null_id(attr):
502 res = _get_first_not_null(attr)
503 return res and res.id or False
505 def _concat_all(attr):
506 return '\n\n'.join(filter(lambda x: x, [getattr(opp, attr) or '' for opp in opportunities if hasattr(opp, attr)]))
508 # Process the fields' values
510 for field_name in fields:
511 field_info = self._all_columns.get(field_name)
512 if field_info is None:
514 field = field_info.column
515 if field._type in ('many2many', 'one2many'):
517 elif field._type == 'many2one':
518 data[field_name] = _get_first_not_null_id(field_name) # !!
519 elif field._type == 'text':
520 data[field_name] = _concat_all(field_name) #not lost
522 data[field_name] = _get_first_not_null(field_name) #not lost
524 # Define the resulting type ('lead' or 'opportunity')
525 data['type'] = self._merge_get_result_type(cr, uid, opportunities, context)
528 def _mail_body(self, cr, uid, lead, fields, title=False, context=None):
531 body.append("%s\n" % (title))
533 for field_name in fields:
534 field_info = self._all_columns.get(field_name)
535 if field_info is None:
537 field = field_info.column
540 if field._type == 'selection':
541 if hasattr(field.selection, '__call__'):
542 key = field.selection(self, cr, uid, context=context)
544 key = field.selection
545 value = dict(key).get(lead[field_name], lead[field_name])
546 elif field._type == 'many2one':
548 value = lead[field_name].name_get()[0][1]
549 elif field._type == 'many2many':
551 for val in lead[field_name]:
552 field_value = val.name_get()[0][1]
553 value += field_value + ","
555 value = lead[field_name]
557 body.append("%s: %s" % (field.string, value or ''))
558 return "<br/>".join(body + ['<br/>'])
560 def _merge_notify(self, cr, uid, opportunity_id, opportunities, context=None):
562 Create a message gathering merged leads/opps information.
564 #TOFIX: mail template should be used instead of fix body, subject text
566 result_type = self._merge_get_result_type(cr, uid, opportunities, context)
567 if result_type == 'lead':
568 merge_message = _('Merged leads')
570 merge_message = _('Merged opportunities')
571 subject = [merge_message]
572 for opportunity in opportunities:
573 subject.append(opportunity.name)
574 title = "%s : %s" % (opportunity.type == 'opportunity' and _('Merged opportunity') or _('Merged lead'), opportunity.name)
575 fields = list(CRM_LEAD_FIELDS_TO_MERGE)
576 details.append(self._mail_body(cr, uid, opportunity, fields, title=title, context=context))
578 # Chatter message's subject
579 subject = subject[0] + ": " + ", ".join(subject[1:])
580 details = "\n\n".join(details)
581 return self.message_post(cr, uid, [opportunity_id], body=details, subject=subject, context=context)
583 def _merge_opportunity_history(self, cr, uid, opportunity_id, opportunities, context=None):
584 message = self.pool.get('mail.message')
585 for opportunity in opportunities:
586 for history in opportunity.message_ids:
587 message.write(cr, uid, history.id, {
588 'res_id': opportunity_id,
589 'subject' : _("From %s : %s") % (opportunity.name, history.subject)
594 def _merge_opportunity_attachments(self, cr, uid, opportunity_id, opportunities, context=None):
595 attach_obj = self.pool.get('ir.attachment')
597 # return attachments of opportunity
598 def _get_attachments(opportunity_id):
599 attachment_ids = attach_obj.search(cr, uid, [('res_model', '=', self._name), ('res_id', '=', opportunity_id)], context=context)
600 return attach_obj.browse(cr, uid, attachment_ids, context=context)
602 first_attachments = _get_attachments(opportunity_id)
603 #counter of all attachments to move. Used to make sure the name is different for all attachments
605 for opportunity in opportunities:
606 attachments = _get_attachments(opportunity.id)
607 for attachment in attachments:
608 values = {'res_id': opportunity_id,}
609 for attachment_in_first in first_attachments:
610 if attachment.name == attachment_in_first.name:
611 name = "%s (%s)" % (attachment.name, count,),
613 attachment.write(values)
616 def merge_opportunity(self, cr, uid, ids, user_id=False, section_id=False, context=None):
618 Different cases of merge:
619 - merge leads together = 1 new lead
620 - merge at least 1 opp with anything else (lead or opp) = 1 new opp
622 :param list ids: leads/opportunities ids to merge
623 :return int id: id of the resulting lead/opp
629 raise osv.except_osv(_('Warning!'), _('Please select more than one element (lead or opportunity) from the list view.'))
631 opportunities = self.browse(cr, uid, ids, context=context)
633 # Sorting the leads/opps according to the confidence level of its stage, which relates to the probability of winning it
634 # The confidence level increases with the stage sequence, except when the stage probability is 0.0 (Lost cases)
635 # An Opportunity always has higher confidence level than a lead, unless its stage probability is 0.0
636 for opportunity in opportunities:
638 if opportunity.stage_id and not opportunity.stage_id.fold:
639 sequence = opportunity.stage_id.sequence
640 sequenced_opps.append(((int(sequence != -1 and opportunity.type == 'opportunity'), sequence, -opportunity.id), opportunity))
642 sequenced_opps.sort(reverse=True)
643 opportunities = map(itemgetter(1), sequenced_opps)
644 ids = [opportunity.id for opportunity in opportunities]
645 highest = opportunities[0]
646 opportunities_rest = opportunities[1:]
648 tail_opportunities = opportunities_rest
650 fields = list(CRM_LEAD_FIELDS_TO_MERGE)
651 merged_data = self._merge_data(cr, uid, ids, highest, fields, context=context)
654 merged_data['user_id'] = user_id
656 merged_data['section_id'] = section_id
658 # Merge messages and attachements into the first opportunity
659 self._merge_opportunity_history(cr, uid, highest.id, tail_opportunities, context=context)
660 self._merge_opportunity_attachments(cr, uid, highest.id, tail_opportunities, context=context)
662 # Merge notifications about loss of information
663 opportunities = [highest]
664 opportunities.extend(opportunities_rest)
665 self._merge_notify(cr, uid, highest.id, opportunities, context=context)
666 # Check if the stage is in the stages of the sales team. If not, assign the stage with the lowest sequence
667 if merged_data.get('section_id'):
668 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)
669 if merged_data.get('stage_id') not in section_stage_ids:
670 merged_data['stage_id'] = section_stage_ids and section_stage_ids[0] or False
671 # Write merged data into first opportunity
672 self.write(cr, uid, [highest.id], merged_data, context=context)
673 # Delete tail opportunities
674 # 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
675 self.unlink(cr, SUPERUSER_ID, [x.id for x in tail_opportunities], context=context)
679 def _convert_opportunity_data(self, cr, uid, lead, customer, section_id=False, context=None):
680 crm_stage = self.pool.get('crm.case.stage')
683 contact_id = self.pool.get('res.partner').address_get(cr, uid, [customer.id])['default']
685 section_id = lead.section_id and lead.section_id.id or False
687 'planned_revenue': lead.planned_revenue,
688 'probability': lead.probability,
690 'partner_id': customer and customer.id or False,
691 'user_id': (lead.user_id and lead.user_id.id),
692 'type': 'opportunity',
693 'date_action': fields.datetime.now(),
694 'date_open': fields.datetime.now(),
695 'email_from': customer and customer.email or lead.email_from,
696 'phone': customer and customer.phone or lead.phone,
698 if not lead.stage_id or lead.stage_id.type=='lead':
699 val['stage_id'] = self.stage_find(cr, uid, [lead], section_id, [('type', 'in', ('opportunity', 'both'))], context=context)
702 def convert_opportunity(self, cr, uid, ids, partner_id, user_ids=False, section_id=False, context=None):
705 partner = self.pool.get('res.partner')
706 customer = partner.browse(cr, uid, partner_id, context=context)
707 for lead in self.browse(cr, uid, ids, context=context):
708 # TDE: was if lead.state in ('done', 'cancel'):
709 if lead.probability == 100 or (lead.probability == 0 and lead.stage_id.fold):
711 vals = self._convert_opportunity_data(cr, uid, lead, customer, section_id, context=context)
712 self.write(cr, uid, [lead.id], vals, context=context)
714 if user_ids or section_id:
715 self.allocate_salesman(cr, uid, ids, user_ids, section_id, context=context)
719 def _lead_create_contact(self, cr, uid, lead, name, is_company, parent_id=False, context=None):
720 partner = self.pool.get('res.partner')
721 vals = {'name': name,
722 'user_id': lead.user_id.id,
723 'comment': lead.description,
724 'section_id': lead.section_id.id or False,
725 'parent_id': parent_id,
727 'mobile': lead.mobile,
728 'email': tools.email_split(lead.email_from) and tools.email_split(lead.email_from)[0] or False,
730 'title': lead.title and lead.title.id or False,
731 'function': lead.function,
732 'street': lead.street,
733 'street2': lead.street2,
736 'country_id': lead.country_id and lead.country_id.id or False,
737 'state_id': lead.state_id and lead.state_id.id or False,
738 'is_company': is_company,
741 partner = partner.create(cr, uid, vals, context=context)
744 def _create_lead_partner(self, cr, uid, lead, context=None):
746 if lead.partner_name and lead.contact_name:
747 partner_id = self._lead_create_contact(cr, uid, lead, lead.partner_name, True, context=context)
748 partner_id = self._lead_create_contact(cr, uid, lead, lead.contact_name, False, partner_id, context=context)
749 elif lead.partner_name and not lead.contact_name:
750 partner_id = self._lead_create_contact(cr, uid, lead, lead.partner_name, True, context=context)
751 elif not lead.partner_name and lead.contact_name:
752 partner_id = self._lead_create_contact(cr, uid, lead, lead.contact_name, False, context=context)
753 elif lead.email_from and self.pool.get('res.partner')._parse_partner_name(lead.email_from, context=context)[0]:
754 contact_name = self.pool.get('res.partner')._parse_partner_name(lead.email_from, context=context)[0]
755 partner_id = self._lead_create_contact(cr, uid, lead, contact_name, False, context=context)
757 raise osv.except_osv(
759 _('No customer name defined. Please fill one of the following fields: Company Name, Contact Name or Email ("Name <email@address>")')
763 def _lead_set_partner(self, cr, uid, lead, partner_id, context=None):
765 Assign a partner to a lead.
767 :param object lead: browse record of the lead to process
768 :param int partner_id: identifier of the partner to assign
769 :return bool: True if the partner has properly been assigned
772 res_partner = self.pool.get('res.partner')
774 res_partner.write(cr, uid, partner_id, {'section_id': lead.section_id and lead.section_id.id or False})
775 contact_id = res_partner.address_get(cr, uid, [partner_id])['default']
776 res = lead.write({'partner_id': partner_id}, context=context)
777 message = _("<b>Partner</b> set to <em>%s</em>." % (lead.partner_id.name))
778 self.message_post(cr, uid, [lead.id], body=message, context=context)
781 def handle_partner_assignation(self, cr, uid, ids, action='create', partner_id=False, context=None):
783 Handle partner assignation during a lead conversion.
784 if action is 'create', create new partner with contact and assign lead to new partner_id.
785 otherwise assign lead to the specified partner_id
787 :param list ids: leads/opportunities ids to process
788 :param string action: what has to be done regarding partners (create it, assign an existing one, or nothing)
789 :param int partner_id: partner to assign if any
790 :return dict: dictionary organized as followed: {lead_id: partner_assigned_id}
792 #TODO this is a duplication of the handle_partner_assignation method of crm_phonecall
794 # If a partner_id is given, force this partner for all elements
795 force_partner_id = partner_id
796 for lead in self.browse(cr, uid, ids, context=context):
797 # If the action is set to 'create' and no partner_id is set, create a new one
798 if action == 'create':
799 partner_id = force_partner_id or self._create_lead_partner(cr, uid, lead, context)
800 self._lead_set_partner(cr, uid, lead, partner_id, context=context)
801 partner_ids[lead.id] = partner_id
804 def allocate_salesman(self, cr, uid, ids, user_ids=None, team_id=False, context=None):
806 Assign salesmen and salesteam to a batch of leads. If there are more
807 leads than salesmen, these salesmen will be assigned in round-robin.
808 E.g.: 4 salesmen (S1, S2, S3, S4) for 6 leads (L1, L2, ... L6). They
809 will be assigned as followed: L1 - S1, L2 - S2, L3 - S3, L4 - S4,
812 :param list ids: leads/opportunities ids to process
813 :param list user_ids: salesmen to assign
814 :param int team_id: salesteam to assign
822 value['section_id'] = team_id
824 value['user_id'] = user_ids[index]
825 # Cycle through user_ids
826 index = (index + 1) % len(user_ids)
828 self.write(cr, uid, [lead_id], value, context=context)
831 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):
833 :param string action: ('schedule','Schedule a call'), ('log','Log a call')
835 phonecall = self.pool.get('crm.phonecall')
836 model_data = self.pool.get('ir.model.data')
840 res_id = model_data._get_id(cr, uid, 'crm', 'categ_phone2')
841 categ_id = model_data.browse(cr, uid, res_id, context=context).res_id
844 for lead in self.browse(cr, uid, ids, context=context):
846 section_id = lead.section_id and lead.section_id.id or False
848 user_id = lead.user_id and lead.user_id.id or False
850 'name': call_summary,
851 'opportunity_id': lead.id,
852 'user_id': user_id or False,
853 'categ_id': categ_id or False,
854 'description': desc or '',
855 'date': schedule_time,
856 'section_id': section_id or False,
857 'partner_id': lead.partner_id and lead.partner_id.id or False,
858 'partner_phone': phone or lead.phone or (lead.partner_id and lead.partner_id.phone or False),
859 'partner_mobile': lead.partner_id and lead.partner_id.mobile or False,
860 'priority': lead.priority,
862 new_id = phonecall.create(cr, uid, vals, context=context)
863 phonecall.write(cr, uid, [new_id], {'state': 'open'}, context=context)
865 phonecall.write(cr, uid, [new_id], {'state': 'done'}, context=context)
866 phonecall_dict[lead.id] = new_id
867 self.schedule_phonecall_send_note(cr, uid, [lead.id], new_id, action, context=context)
868 return phonecall_dict
870 def redirect_opportunity_view(self, cr, uid, opportunity_id, context=None):
871 models_data = self.pool.get('ir.model.data')
873 # Get opportunity views
874 dummy, form_view = models_data.get_object_reference(cr, uid, 'crm', 'crm_case_form_view_oppor')
875 dummy, tree_view = models_data.get_object_reference(cr, uid, 'crm', 'crm_case_tree_view_oppor')
877 'name': _('Opportunity'),
879 'view_mode': 'tree, form',
880 'res_model': 'crm.lead',
881 'domain': [('type', '=', 'opportunity')],
882 'res_id': int(opportunity_id),
884 'views': [(form_view or False, 'form'),
885 (tree_view or False, 'tree'),
886 (False, 'calendar'), (False, 'graph')],
887 'type': 'ir.actions.act_window',
890 def redirect_lead_view(self, cr, uid, lead_id, context=None):
891 models_data = self.pool.get('ir.model.data')
894 dummy, form_view = models_data.get_object_reference(cr, uid, 'crm', 'crm_case_form_view_leads')
895 dummy, tree_view = models_data.get_object_reference(cr, uid, 'crm', 'crm_case_tree_view_leads')
899 'view_mode': 'tree, form',
900 'res_model': 'crm.lead',
901 'domain': [('type', '=', 'lead')],
902 'res_id': int(lead_id),
904 'views': [(form_view or False, 'form'),
905 (tree_view or False, 'tree'),
906 (False, 'calendar'), (False, 'graph')],
907 'type': 'ir.actions.act_window',
910 def action_makeMeeting(self, cr, uid, ids, context=None):
912 Open meeting's calendar view to schedule meeting on current opportunity.
913 :return dict: dictionary value for created Meeting view
915 opportunity = self.browse(cr, uid, ids[0], context)
916 res = self.pool.get('ir.actions.act_window').for_xml_id(cr, uid, 'base_calendar', 'action_crm_meeting', context)
918 'default_opportunity_id': opportunity.id,
919 'default_partner_id': opportunity.partner_id and opportunity.partner_id.id or False,
920 'default_partner_ids' : opportunity.partner_id and [opportunity.partner_id.id] or False,
921 'default_user_id': uid,
922 'default_section_id': opportunity.section_id and opportunity.section_id.id or False,
923 'default_email_from': opportunity.email_from,
924 'default_name': opportunity.name,
928 def create(self, cr, uid, vals, context=None):
931 if vals.get('type') and not context.get('default_type'):
932 context['default_type'] = vals.get('type')
933 if vals.get('section_id') and not context.get('default_section_id'):
934 context['default_section_id'] = vals.get('section_id')
936 # context: no_log, because subtype already handle this
937 create_context = dict(context, mail_create_nolog=True)
938 return super(crm_lead, self).create(cr, uid, vals, context=create_context)
940 def write(self, cr, uid, ids, vals, context=None):
941 # stage change: update date_last_stage_update
942 if 'stage_id' in vals:
943 vals['date_last_stage_update'] = fields.datetime.now()
944 # stage change with new stage: update probability
945 if vals.get('stage_id') and not vals.get('probability'):
946 onchange_stage_values = self.onchange_stage_id(cr, uid, ids, vals.get('stage_id'), context=context)['value']
947 vals.update(onchange_stage_values)
948 return super(crm_lead, self).write(cr, uid, ids, vals, context=context)
950 def copy(self, cr, uid, id, default=None, context=None):
955 lead = self.browse(cr, uid, id, context=context)
956 local_context = dict(context)
957 local_context.setdefault('default_type', lead.type)
958 local_context.setdefault('default_section_id', lead.section_id)
959 if lead.type == 'opportunity':
960 default['date_open'] = fields.datetime.now()
962 default['date_open'] = False
963 default['date_closed'] = False
964 default['stage_id'] = self._get_default_stage_id(cr, uid, local_context)
965 return super(crm_lead, self).copy(cr, uid, id, default, context=context)
967 # ----------------------------------------
969 # ----------------------------------------
971 def message_get_reply_to(self, cr, uid, ids, context=None):
972 """ Override to get the reply_to of the parent project. """
973 return [lead.section_id.message_get_reply_to()[0] if lead.section_id else False
974 for lead in self.browse(cr, SUPERUSER_ID, ids, context=context)]
976 def _get_formview_action(self, cr, uid, id, context=None):
977 action = super(crm_lead, self)._get_formview_action(cr, uid, id, context=context)
978 obj = self.browse(cr, uid, id, context=context)
979 if obj.type == 'opportunity':
980 model, view_id = self.pool.get('ir.model.data').get_object_reference(cr, uid, 'crm', 'crm_case_form_view_oppor')
982 'views': [(view_id, 'form')],
986 def message_get_suggested_recipients(self, cr, uid, ids, context=None):
987 recipients = super(crm_lead, self).message_get_suggested_recipients(cr, uid, ids, context=context)
989 for lead in self.browse(cr, uid, ids, context=context):
991 self._message_add_suggested_recipient(cr, uid, recipients, lead, partner=lead.partner_id, reason=_('Customer'))
992 elif lead.email_from:
993 self._message_add_suggested_recipient(cr, uid, recipients, lead, email=lead.email_from, reason=_('Customer Email'))
994 except (osv.except_osv, orm.except_orm): # no read access rights -> just ignore suggested recipients because this imply modifying followers
998 def message_new(self, cr, uid, msg, custom_values=None, context=None):
999 """ Overrides mail_thread message_new that is called by the mailgateway
1000 through message_process.
1001 This override updates the document according to the email.
1003 if custom_values is None:
1006 'name': msg.get('subject') or _("No Subject"),
1007 'email_from': msg.get('from'),
1008 'email_cc': msg.get('cc'),
1009 'partner_id': msg.get('author_id', False),
1012 if msg.get('author_id'):
1013 defaults.update(self.on_change_partner_id(cr, uid, None, msg.get('author_id'), context=context)['value'])
1014 if msg.get('priority') in dict(crm.AVAILABLE_PRIORITIES):
1015 defaults['priority'] = msg.get('priority')
1016 defaults.update(custom_values)
1017 return super(crm_lead, self).message_new(cr, uid, msg, custom_values=defaults, context=context)
1019 def message_update(self, cr, uid, ids, msg, update_vals=None, context=None):
1020 """ Overrides mail_thread message_update that is called by the mailgateway
1021 through message_process.
1022 This method updates the document according to the email.
1024 if isinstance(ids, (str, int, long)):
1026 if update_vals is None: update_vals = {}
1028 if msg.get('priority') in dict(crm.AVAILABLE_PRIORITIES):
1029 update_vals['priority'] = msg.get('priority')
1031 'cost':'planned_cost',
1032 'revenue': 'planned_revenue',
1033 'probability':'probability',
1035 for line in msg.get('body', '').split('\n'):
1037 res = tools.command_re.match(line)
1038 if res and maps.get(res.group(1).lower()):
1039 key = maps.get(res.group(1).lower())
1040 update_vals[key] = res.group(2).lower()
1042 return super(crm_lead, self).message_update(cr, uid, ids, msg, update_vals=update_vals, context=context)
1044 # ----------------------------------------
1045 # OpenChatter methods and notifications
1046 # ----------------------------------------
1048 def schedule_phonecall_send_note(self, cr, uid, ids, phonecall_id, action, context=None):
1049 phonecall = self.pool.get('crm.phonecall').browse(cr, uid, [phonecall_id], context=context)[0]
1051 message = _('Logged a call for %(date)s. %(description)s')
1053 message = _('Scheduled a call for %(date)s. %(description)s')
1054 phonecall_date = datetime.strptime(phonecall.date, tools.DEFAULT_SERVER_DATETIME_FORMAT)
1055 phonecall_usertime = fields.datetime.context_timestamp(cr, uid, phonecall_date, context=context).strftime(tools.DEFAULT_SERVER_DATETIME_FORMAT)
1056 html_time = "<time datetime='%s+00:00'>%s</time>" % (phonecall.date, phonecall_usertime)
1057 message = message % dict(date=html_time, description=phonecall.description)
1058 return self.message_post(cr, uid, ids, body=message, context=context)
1060 def log_meeting(self, cr, uid, ids, meeting_subject, meeting_date, duration, context=None):
1062 duration = _('unknown')
1064 duration = str(duration)
1065 message = _("Meeting scheduled at '%s'<br> Subject: %s <br> Duration: %s hour(s)") % (meeting_date, meeting_subject, duration)
1066 return self.message_post(cr, uid, ids, body=message, context=context)
1068 def onchange_state(self, cr, uid, ids, state_id, context=None):
1070 country_id=self.pool.get('res.country.state').browse(cr, uid, state_id, context).country_id.id
1071 return {'value':{'country_id':country_id}}
1074 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: