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
27 from openerp import SUPERUSER_ID
28 from openerp import tools
29 from openerp.addons.base.res.res_partner import format_address
30 from openerp.osv import fields, osv, orm
31 from openerp.tools import html2plaintext
32 from openerp.tools.translate import _
34 CRM_LEAD_FIELDS_TO_MERGE = ['name',
66 class crm_lead(format_address, osv.osv):
69 _description = "Lead/Opportunity"
70 _order = "priority,date_action,id desc"
71 _inherit = ['mail.thread', 'ir.needaction_mixin']
75 # this is only an heuristics; depending on your particular stage configuration it may not match all 'new' stages
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.fold,
79 '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,
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)
90 def _get_default_section_id(self, cr, uid, context=None):
91 """ Gives default section by checking if present in the context """
92 return self._resolve_section_id_from_context(cr, uid, context=context) or False
94 def _get_default_stage_id(self, cr, uid, context=None):
95 """ Gives default stage_id """
96 section_id = self._get_default_section_id(cr, uid, context=context)
97 return self.stage_find(cr, uid, [], section_id, [('fold', '=', False)], context=context)
99 def _resolve_section_id_from_context(self, cr, uid, context=None):
100 """ Returns ID of section based on the value of 'section_id'
101 context key, or None if it cannot be resolved to a single
106 if type(context.get('default_section_id')) in (int, long):
107 return context.get('default_section_id')
108 if isinstance(context.get('default_section_id'), basestring):
109 section_ids = self.pool.get('crm.case.section').name_search(cr, uid, name=context['default_section_id'], context=context)
110 if len(section_ids) == 1:
111 return int(section_ids[0][0])
114 def _resolve_type_from_context(self, cr, uid, context=None):
115 """ Returns the type (lead or opportunity) from the type context
116 key. Returns None if it cannot be resolved.
120 return context.get('default_type')
122 def _read_group_stage_ids(self, cr, uid, ids, domain, read_group_order=None, access_rights_uid=None, context=None):
123 access_rights_uid = access_rights_uid or uid
124 stage_obj = self.pool.get('crm.case.stage')
125 order = stage_obj._order
126 # lame hack to allow reverting search, should just work in the trivial case
127 if read_group_order == 'stage_id desc':
128 order = "%s desc" % order
129 # retrieve section_id from the context and write the domain
130 # - ('id', 'in', 'ids'): add columns that should be present
131 # - OR ('case_default', '=', True), ('fold', '=', False): add default columns that are not folded
132 # - OR ('section_ids', '=', section_id), ('fold', '=', False) if section_id: add section columns that are not folded
134 section_id = self._resolve_section_id_from_context(cr, uid, context=context)
136 search_domain += ['|', ('section_ids', '=', section_id)]
137 search_domain += [('id', 'in', ids)]
139 search_domain += ['|', ('id', 'in', ids), ('case_default', '=', True)]
140 # retrieve type from the context (if set: choose 'type' or 'both')
141 type = self._resolve_type_from_context(cr, uid, context=context)
143 search_domain += ['|', ('type', '=', type), ('type', '=', 'both')]
145 stage_ids = stage_obj._search(cr, uid, search_domain, order=order, access_rights_uid=access_rights_uid, context=context)
146 result = stage_obj.name_get(cr, access_rights_uid, stage_ids, context=context)
147 # restore order of the search
148 result.sort(lambda x, y: cmp(stage_ids.index(x[0]), stage_ids.index(y[0])))
151 for stage in stage_obj.browse(cr, access_rights_uid, stage_ids, context=context):
152 fold[stage.id] = stage.fold or False
155 def fields_view_get(self, cr, user, view_id=None, view_type='form', context=None, toolbar=False, submenu=False):
156 res = super(crm_lead, self).fields_view_get(cr, user, view_id, view_type, context, toolbar=toolbar, submenu=submenu)
157 if view_type == 'form':
158 res['arch'] = self.fields_view_get_address(cr, user, res['arch'], context=context)
162 'stage_id': _read_group_stage_ids
165 def _compute_day(self, cr, uid, ids, fields, args, context=None):
167 :return dict: difference between current date and log date
169 cal_obj = self.pool.get('resource.calendar')
170 res_obj = self.pool.get('resource.resource')
173 for lead in self.browse(cr, uid, ids, context=context):
178 if field == 'day_open':
180 date_create = datetime.strptime(lead.create_date, "%Y-%m-%d %H:%M:%S")
181 date_open = datetime.strptime(lead.date_open, "%Y-%m-%d %H:%M:%S")
182 ans = date_open - date_create
183 date_until = lead.date_open
184 elif field == 'day_close':
186 date_create = datetime.strptime(lead.create_date, "%Y-%m-%d %H:%M:%S")
187 date_close = datetime.strptime(lead.date_closed, "%Y-%m-%d %H:%M:%S")
188 date_until = lead.date_closed
189 ans = date_close - date_create
193 resource_ids = res_obj.search(cr, uid, [('user_id','=',lead.user_id.id)])
194 if len(resource_ids):
195 resource_id = resource_ids[0]
197 duration = float(ans.days)
198 if lead.section_id and lead.section_id.resource_calendar_id:
199 duration = float(ans.days) * 24
200 new_dates = cal_obj.interval_get(cr,
202 lead.section_id.resource_calendar_id and lead.section_id.resource_calendar_id.id or False,
203 datetime.strptime(lead.create_date, '%Y-%m-%d %H:%M:%S'),
208 date_until = datetime.strptime(date_until, '%Y-%m-%d %H:%M:%S')
209 for in_time, out_time in new_dates:
210 if in_time.date not in no_days:
211 no_days.append(in_time.date)
212 if out_time > date_until:
214 duration = len(no_days)
215 res[lead.id][field] = abs(int(duration))
219 'partner_id': fields.many2one('res.partner', 'Partner', ondelete='set null', track_visibility='onchange',
220 select=True, help="Linked partner (optional). Usually created when converting the lead."),
222 'id': fields.integer('ID', readonly=True),
223 'name': fields.char('Subject', size=64, required=True, select=1),
224 'active': fields.boolean('Active', required=False),
225 'date_action_last': fields.datetime('Last Action', readonly=1),
226 'date_action_next': fields.datetime('Next Action', readonly=1),
227 'email_from': fields.char('Email', size=128, help="Email address of the contact", select=1),
228 'section_id': fields.many2one('crm.case.section', 'Sales Team',
229 select=True, track_visibility='onchange', help='When sending mails, the default email address is taken from the sales team.'),
230 'create_date': fields.datetime('Creation Date', readonly=True),
231 '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"),
232 'description': fields.text('Notes'),
233 'write_date': fields.datetime('Update Date', readonly=True),
234 'categ_ids': fields.many2many('crm.case.categ', 'crm_lead_category_rel', 'lead_id', 'category_id', 'Categories', \
235 domain="['|',('section_id','=',section_id),('section_id','=',False), ('object_id.model', '=', 'crm.lead')]"),
236 'type_id': fields.many2one('crm.case.resource.type', 'Campaign', \
237 domain="['|',('section_id','=',section_id),('section_id','=',False)]", help="From which campaign (seminar, marketing campaign, mass mailing, ...) did this contact come from?"),
238 'channel_id': fields.many2one('crm.case.channel', 'Channel', help="Communication channel (mail, direct, phone, ...)"),
239 'contact_name': fields.char('Contact Name', size=64),
240 '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),
241 'opt_out': fields.boolean('Opt-Out', oldname='optout',
242 help="If opt-out is checked, this contact has refused to receive emails for mass mailing and marketing campaign. "
243 "Filter 'Available for Mass Mailing' allows users to filter the leads when performing mass mailing."),
244 'type':fields.selection([ ('lead','Lead'), ('opportunity','Opportunity'), ],'Type', help="Type is used to separate Leads and Opportunities"),
245 'priority': fields.selection(crm.AVAILABLE_PRIORITIES, 'Priority', select=True),
246 'date_closed': fields.datetime('Closed', readonly=True),
247 'stage_id': fields.many2one('crm.case.stage', 'Stage', track_visibility='onchange',
248 domain="['&', ('section_ids', '=', section_id), '|', ('type', '=', type), ('type', '=', 'both')]"),
249 'user_id': fields.many2one('res.users', 'Salesperson', select=True, track_visibility='onchange'),
250 'referred': fields.char('Referred By', size=64),
251 'date_open': fields.datetime('Assigned', readonly=True),
252 'day_open': fields.function(_compute_day, string='Days to Open', \
253 multi='day_open', type="float", store=True),
254 'day_close': fields.function(_compute_day, string='Days to Close', \
255 multi='day_close', type="float", store=True),
256 'date_last_stage_update': fields.datetime('Last Stage Update', select=True),
258 # Messaging and marketing
259 'message_bounce': fields.integer('Bounce'),
260 # Only used for type opportunity
261 'probability': fields.float('Success Rate (%)', group_operator="avg"),
262 'planned_revenue': fields.float('Expected Revenue', track_visibility='always'),
263 'ref': fields.reference('Reference', selection=openerp.addons.base.res.res_request.referencable_models),
264 'ref2': fields.reference('Reference 2', selection=openerp.addons.base.res.res_request.referencable_models),
265 'phone': fields.char("Phone", size=64),
266 'date_deadline': fields.date('Expected Closing', help="Estimate of the date on which the opportunity will be won."),
267 'date_action': fields.date('Next Action Date', select=True),
268 'title_action': fields.char('Next Action', size=64),
269 'color': fields.integer('Color Index'),
270 'partner_address_name': fields.related('partner_id', 'name', type='char', string='Partner Contact Name', readonly=True),
271 'partner_address_email': fields.related('partner_id', 'email', type='char', string='Partner Contact Email', readonly=True),
272 'company_currency': fields.related('company_id', 'currency_id', type='many2one', string='Currency', readonly=True, relation="res.currency"),
273 'user_email': fields.related('user_id', 'email', type='char', string='User Email', readonly=True),
274 'user_login': fields.related('user_id', 'login', type='char', string='User Login', readonly=True),
276 # Fields for address, due to separation from crm and res.partner
277 'street': fields.char('Street', size=128),
278 'street2': fields.char('Street2', size=128),
279 'zip': fields.char('Zip', change_default=True, size=24),
280 'city': fields.char('City', size=128),
281 'state_id': fields.many2one("res.country.state", 'State'),
282 'country_id': fields.many2one('res.country', 'Country'),
283 'phone': fields.char('Phone', size=64),
284 'fax': fields.char('Fax', size=64),
285 'mobile': fields.char('Mobile', size=64),
286 'function': fields.char('Function', size=128),
287 'title': fields.many2one('res.partner.title', 'Title'),
288 'company_id': fields.many2one('res.company', 'Company', select=1),
289 'payment_mode': fields.many2one('crm.payment.mode', 'Payment Mode', \
290 domain="[('section_id','=',section_id)]"),
291 'planned_cost': fields.float('Planned Costs'),
297 'user_id': lambda s, cr, uid, c: uid,
298 'stage_id': lambda s, cr, uid, c: s._get_default_stage_id(cr, uid, c),
299 'section_id': lambda s, cr, uid, c: s._get_default_section_id(cr, uid, c),
300 'company_id': lambda s, cr, uid, c: s.pool.get('res.company')._company_default_get(cr, uid, 'crm.lead', context=c),
301 'priority': lambda *a: crm.AVAILABLE_PRIORITIES[2][0],
303 'date_last_stage_update': fields.datetime.now,
307 ('check_probability', 'check(probability >= 0 and probability <= 100)', 'The probability of closing the deal should be between 0% and 100%!')
310 def onchange_stage_id(self, cr, uid, ids, stage_id, context=None):
313 stage = self.pool.get('crm.case.stage').browse(cr, uid, stage_id, context=context)
314 if not stage.on_change:
316 return {'value': {'probability': stage.probability}}
318 def on_change_partner_id(self, cr, uid, ids, partner_id, context=None):
321 partner = self.pool.get('res.partner').browse(cr, uid, partner_id, context=context)
323 'partner_name': partner.name,
324 'street': partner.street,
325 'street2': partner.street2,
326 'city': partner.city,
327 'state_id': partner.state_id and partner.state_id.id or False,
328 'country_id': partner.country_id and partner.country_id.id or False,
329 'email_from': partner.email,
330 'phone': partner.phone,
331 'mobile': partner.mobile,
335 return {'value': values}
337 def on_change_user(self, cr, uid, ids, user_id, context=None):
338 """ When changing the user, also set a section_id or restrict section id
339 to the ones user_id is member of. """
340 section_id = self._get_default_section_id(cr, uid, context=context) or False
341 if user_id and not section_id:
342 section_ids = self.pool.get('crm.case.section').search(cr, uid, ['|', ('user_id', '=', user_id), ('member_ids', '=', user_id)], context=context)
344 section_id = section_ids[0]
345 return {'value': {'section_id': section_id}}
347 def stage_find(self, cr, uid, cases, section_id, domain=None, order='sequence', context=None):
348 """ Override of the base.stage method
349 Parameter of the stage search taken from the lead:
350 - type: stage type must be the same or 'both'
351 - section_id: if set, stages must belong to this section or
352 be a default stage; if not set, stages must be default
355 if isinstance(cases, (int, long)):
356 cases = self.browse(cr, uid, cases, context=context)
359 # check whether we should try to add a condition on type
360 avoid_add_type_term = any([term for term in domain if len(term) == 3 if term[0] == 'type'])
361 # collect all section_ids
364 if not cases and context.get('default_type'):
365 ctx_type = context.get('default_type')
368 section_ids.add(section_id)
371 section_ids.add(lead.section_id.id)
372 if lead.type not in types:
373 types.append(lead.type)
374 # OR all section_ids and OR with case_default
377 search_domain += [('|')] * len(section_ids)
378 for section_id in section_ids:
379 search_domain.append(('section_ids', '=', section_id))
380 search_domain.append(('case_default', '=', True))
381 # AND with cases types
382 if not avoid_add_type_term:
383 search_domain.append(('type', 'in', types))
384 # AND with the domain in parameter
385 search_domain += list(domain)
386 # perform search, return the first found
387 stage_ids = self.pool.get('crm.case.stage').search(cr, uid, search_domain, order=order, limit=1, context=context)
392 def case_mark_lost(self, cr, uid, ids, context=None):
393 """ Mark the case as lost: state=cancel and probability=0
394 :deprecated: this method will be removed in OpenERP v8.
397 for lead in self.browse(cr, uid, ids, context=context):
398 stage_id = self.stage_find(cr, uid, [lead], lead.section_id.id or False, [('probability', '=', 0.0), ('fold', '=', True), ('sequence', '>', 1)], context=context)
400 if stages_leads.get(stage_id):
401 stages_leads[stage_id].append(lead.id)
403 stages_leads[stage_id] = [lead.id]
405 raise osv.except_osv(_('Warning!'),
406 _('To relieve your sales pipe and group all Lost opportunities, configure one of your sales stage as follow:\n'
407 'probability = 0 %, select "Change Probability Automatically".\n'
408 'Create a specific stage or edit an existing one by editing columns of your opportunity pipe.'))
409 for stage_id, lead_ids in stages_leads.items():
410 self.write(cr, uid, lead_ids, {'stage_id': stage_id, 'date_closed': fields.datetime.now()}, context=context)
413 def case_mark_won(self, cr, uid, ids, context=None):
414 """ Mark the case as won: state=done and probability=100
415 :deprecated: this method will be removed in OpenERP v8.
418 for lead in self.browse(cr, uid, ids, context=context):
419 stage_id = self.stage_find(cr, uid, [lead], lead.section_id.id or False, [('probability', '=', 100.0), ('fold', '=', True)], context=context)
421 if stages_leads.get(stage_id):
422 stages_leads[stage_id].append(lead.id)
424 stages_leads[stage_id] = [lead.id]
426 raise osv.except_osv(_('Warning!'),
427 _('To relieve your sales pipe and group all Won opportunities, configure one of your sales stage as follow:\n'
428 'probability = 100 % and select "Change Probability Automatically".\n'
429 'Create a specific stage or edit an existing one by editing columns of your opportunity pipe.'))
430 for stage_id, lead_ids in stages_leads.items():
431 self.write(cr, uid, lead_ids, {'stage_id': stage_id, 'date_closed': fields.datetime.now()}, context=context)
434 def case_escalate(self, cr, uid, ids, context=None):
435 """ Escalates case to parent level """
436 for case in self.browse(cr, uid, ids, context=context):
437 data = {'active': True}
438 if case.section_id.parent_id:
439 data['section_id'] = case.section_id.parent_id.id
440 if case.section_id.parent_id.change_responsible:
441 if case.section_id.parent_id.user_id:
442 data['user_id'] = case.section_id.parent_id.user_id.id
444 raise osv.except_osv(_('Error!'), _("You are already at the top level of your sales-team category.\nTherefore you cannot escalate furthermore."))
445 self.write(cr, uid, [case.id], data, context=context)
448 def set_priority(self, cr, uid, ids, priority, context=None):
449 """ Set lead priority
451 return self.write(cr, uid, ids, {'priority': priority}, context=context)
453 def set_high_priority(self, cr, uid, ids, context=None):
454 """ Set lead priority to high
456 return self.set_priority(cr, uid, ids, '1', context=context)
458 def set_normal_priority(self, cr, uid, ids, context=None):
459 """ Set lead priority to normal
461 return self.set_priority(cr, uid, ids, '3', context=context)
463 def _merge_get_result_type(self, cr, uid, opps, context=None):
465 Define the type of the result of the merge. If at least one of the
466 element to merge is an opp, the resulting new element will be an opp.
467 Otherwise it will be a lead.
469 We'll directly use a list of browse records instead of a list of ids
470 for performances' sake: it will spare a second browse of the
473 :param list opps: list of browse records containing the leads/opps to process
474 :return string type: the type of the final element
477 if (opp.type == 'opportunity'):
482 def _merge_data(self, cr, uid, ids, oldest, fields, context=None):
484 Prepare lead/opp data into a dictionary for merging. Different types
485 of fields are processed in different ways:
486 - text: all the values are concatenated
487 - m2m and o2m: those fields aren't processed
488 - m2o: the first not null value prevails (the other are dropped)
489 - any other type of field: same as m2o
491 :param list ids: list of ids of the leads to process
492 :param list fields: list of leads' fields to process
493 :return dict data: contains the merged values
495 opportunities = self.browse(cr, uid, ids, context=context)
497 def _get_first_not_null(attr):
498 for opp in opportunities:
499 if hasattr(opp, attr) and bool(getattr(opp, attr)):
500 return getattr(opp, attr)
503 def _get_first_not_null_id(attr):
504 res = _get_first_not_null(attr)
505 return res and res.id or False
507 def _concat_all(attr):
508 return '\n\n'.join(filter(lambda x: x, [getattr(opp, attr) or '' for opp in opportunities if hasattr(opp, attr)]))
510 # Process the fields' values
512 for field_name in fields:
513 field_info = self._all_columns.get(field_name)
514 if field_info is None:
516 field = field_info.column
517 if field._type in ('many2many', 'one2many'):
519 elif field._type == 'many2one':
520 data[field_name] = _get_first_not_null_id(field_name) # !!
521 elif field._type == 'text':
522 data[field_name] = _concat_all(field_name) #not lost
524 data[field_name] = _get_first_not_null(field_name) #not lost
526 # Define the resulting type ('lead' or 'opportunity')
527 data['type'] = self._merge_get_result_type(cr, uid, opportunities, context)
530 def _mail_body(self, cr, uid, lead, fields, title=False, context=None):
533 body.append("%s\n" % (title))
535 for field_name in fields:
536 field_info = self._all_columns.get(field_name)
537 if field_info is None:
539 field = field_info.column
542 if field._type == 'selection':
543 if hasattr(field.selection, '__call__'):
544 key = field.selection(self, cr, uid, context=context)
546 key = field.selection
547 value = dict(key).get(lead[field_name], lead[field_name])
548 elif field._type == 'many2one':
550 value = lead[field_name].name_get()[0][1]
551 elif field._type == 'many2many':
553 for val in lead[field_name]:
554 field_value = val.name_get()[0][1]
555 value += field_value + ","
557 value = lead[field_name]
559 body.append("%s: %s" % (field.string, value or ''))
560 return "<br/>".join(body + ['<br/>'])
562 def _merge_notify(self, cr, uid, opportunity_id, opportunities, context=None):
564 Create a message gathering merged leads/opps information.
566 #TOFIX: mail template should be used instead of fix body, subject text
568 result_type = self._merge_get_result_type(cr, uid, opportunities, context)
569 if result_type == 'lead':
570 merge_message = _('Merged leads')
572 merge_message = _('Merged opportunities')
573 subject = [merge_message]
574 for opportunity in opportunities:
575 subject.append(opportunity.name)
576 title = "%s : %s" % (opportunity.type == 'opportunity' and _('Merged opportunity') or _('Merged lead'), opportunity.name)
577 fields = list(CRM_LEAD_FIELDS_TO_MERGE)
578 details.append(self._mail_body(cr, uid, opportunity, fields, title=title, context=context))
580 # Chatter message's subject
581 subject = subject[0] + ": " + ", ".join(subject[1:])
582 details = "\n\n".join(details)
583 return self.message_post(cr, uid, [opportunity_id], body=details, subject=subject, context=context)
585 def _merge_opportunity_history(self, cr, uid, opportunity_id, opportunities, context=None):
586 message = self.pool.get('mail.message')
587 for opportunity in opportunities:
588 for history in opportunity.message_ids:
589 message.write(cr, uid, history.id, {
590 'res_id': opportunity_id,
591 'subject' : _("From %s : %s") % (opportunity.name, history.subject)
596 def _merge_opportunity_attachments(self, cr, uid, opportunity_id, opportunities, context=None):
597 attach_obj = self.pool.get('ir.attachment')
599 # return attachments of opportunity
600 def _get_attachments(opportunity_id):
601 attachment_ids = attach_obj.search(cr, uid, [('res_model', '=', self._name), ('res_id', '=', opportunity_id)], context=context)
602 return attach_obj.browse(cr, uid, attachment_ids, context=context)
604 first_attachments = _get_attachments(opportunity_id)
605 #counter of all attachments to move. Used to make sure the name is different for all attachments
607 for opportunity in opportunities:
608 attachments = _get_attachments(opportunity.id)
609 for attachment in attachments:
610 values = {'res_id': opportunity_id,}
611 for attachment_in_first in first_attachments:
612 if attachment.name == attachment_in_first.name:
613 name = "%s (%s)" % (attachment.name, count,),
615 attachment.write(values)
618 def merge_opportunity(self, cr, uid, ids, user_id=False, section_id=False, context=None):
620 Different cases of merge:
621 - merge leads together = 1 new lead
622 - merge at least 1 opp with anything else (lead or opp) = 1 new opp
624 :param list ids: leads/opportunities ids to merge
625 :return int id: id of the resulting lead/opp
631 raise osv.except_osv(_('Warning!'), _('Please select more than one element (lead or opportunity) from the list view.'))
633 opportunities = self.browse(cr, uid, ids, context=context)
635 # Sorting the leads/opps according to the confidence level of its stage, which relates to the probability of winning it
636 # The confidence level increases with the stage sequence, except when the stage probability is 0.0 (Lost cases)
637 # An Opportunity always has higher confidence level than a lead, unless its stage probability is 0.0
638 for opportunity in opportunities:
640 if opportunity.stage_id and not opportunity.stage_id.fold:
641 sequence = opportunity.stage_id.sequence
642 sequenced_opps.append(((int(sequence != -1 and opportunity.type == 'opportunity'), sequence, -opportunity.id), opportunity))
644 sequenced_opps.sort(reverse=True)
645 opportunities = map(itemgetter(1), sequenced_opps)
646 ids = [opportunity.id for opportunity in opportunities]
647 highest = opportunities[0]
648 opportunities_rest = opportunities[1:]
650 tail_opportunities = opportunities_rest
652 fields = list(CRM_LEAD_FIELDS_TO_MERGE)
653 merged_data = self._merge_data(cr, uid, ids, highest, fields, context=context)
656 merged_data['user_id'] = user_id
658 merged_data['section_id'] = section_id
660 # Merge messages and attachements into the first opportunity
661 self._merge_opportunity_history(cr, uid, highest.id, tail_opportunities, context=context)
662 self._merge_opportunity_attachments(cr, uid, highest.id, tail_opportunities, context=context)
664 # Merge notifications about loss of information
665 opportunities = [highest]
666 opportunities.extend(opportunities_rest)
667 self._merge_notify(cr, uid, highest.id, opportunities, context=context)
668 # Check if the stage is in the stages of the sales team. If not, assign the stage with the lowest sequence
669 if merged_data.get('section_id'):
670 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)
671 if merged_data.get('stage_id') not in section_stage_ids:
672 merged_data['stage_id'] = section_stage_ids and section_stage_ids[0] or False
673 # Write merged data into first opportunity
674 self.write(cr, uid, [highest.id], merged_data, context=context)
675 # Delete tail opportunities
676 # 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
677 self.unlink(cr, SUPERUSER_ID, [x.id for x in tail_opportunities], context=context)
681 def _convert_opportunity_data(self, cr, uid, lead, customer, section_id=False, context=None):
682 crm_stage = self.pool.get('crm.case.stage')
685 contact_id = self.pool.get('res.partner').address_get(cr, uid, [customer.id])['default']
687 section_id = lead.section_id and lead.section_id.id or False
689 'planned_revenue': lead.planned_revenue,
690 'probability': lead.probability,
692 'partner_id': customer and customer.id or False,
693 'user_id': (lead.user_id and lead.user_id.id),
694 'type': 'opportunity',
695 'date_action': fields.datetime.now(),
696 'date_open': fields.datetime.now(),
697 'email_from': customer and customer.email or lead.email_from,
698 'phone': customer and customer.phone or lead.phone,
700 if not lead.stage_id or lead.stage_id.type=='lead':
701 val['stage_id'] = self.stage_find(cr, uid, [lead], section_id, [('type', 'in', ('opportunity', 'both'))], context=context)
704 def convert_opportunity(self, cr, uid, ids, partner_id, user_ids=False, section_id=False, context=None):
707 partner = self.pool.get('res.partner')
708 customer = partner.browse(cr, uid, partner_id, context=context)
709 for lead in self.browse(cr, uid, ids, context=context):
710 # TDE: was if lead.state in ('done', 'cancel'):
711 if lead.probability == 100 or (lead.probability == 0 and lead.stage_id.fold):
713 vals = self._convert_opportunity_data(cr, uid, lead, customer, section_id, context=context)
714 self.write(cr, uid, [lead.id], vals, context=context)
716 if user_ids or section_id:
717 self.allocate_salesman(cr, uid, ids, user_ids, section_id, context=context)
721 def _lead_create_contact(self, cr, uid, lead, name, is_company, parent_id=False, context=None):
722 partner = self.pool.get('res.partner')
723 vals = {'name': name,
724 'user_id': lead.user_id.id,
725 'comment': lead.description,
726 'section_id': lead.section_id.id or False,
727 'parent_id': parent_id,
729 'mobile': lead.mobile,
730 'email': tools.email_split(lead.email_from) and tools.email_split(lead.email_from)[0] or False,
732 'title': lead.title and lead.title.id or False,
733 'function': lead.function,
734 'street': lead.street,
735 'street2': lead.street2,
738 'country_id': lead.country_id and lead.country_id.id or False,
739 'state_id': lead.state_id and lead.state_id.id or False,
740 'is_company': is_company,
743 partner = partner.create(cr, uid, vals, context=context)
746 def _create_lead_partner(self, cr, uid, lead, context=None):
748 if lead.partner_name and lead.contact_name:
749 partner_id = self._lead_create_contact(cr, uid, lead, lead.partner_name, True, context=context)
750 partner_id = self._lead_create_contact(cr, uid, lead, lead.contact_name, False, partner_id, context=context)
751 elif lead.partner_name and not lead.contact_name:
752 partner_id = self._lead_create_contact(cr, uid, lead, lead.partner_name, True, context=context)
753 elif not lead.partner_name and lead.contact_name:
754 partner_id = self._lead_create_contact(cr, uid, lead, lead.contact_name, False, context=context)
755 elif lead.email_from and self.pool.get('res.partner')._parse_partner_name(lead.email_from, context=context)[0]:
756 contact_name = self.pool.get('res.partner')._parse_partner_name(lead.email_from, context=context)[0]
757 partner_id = self._lead_create_contact(cr, uid, lead, contact_name, False, context=context)
759 raise osv.except_osv(
761 _('No customer name defined. Please fill one of the following fields: Company Name, Contact Name or Email ("Name <email@address>")')
765 def handle_partner_assignation(self, cr, uid, ids, action='create', partner_id=False, context=None):
767 Handle partner assignation during a lead conversion.
768 if action is 'create', create new partner with contact and assign lead to new partner_id.
769 otherwise assign lead to the specified partner_id
771 :param list ids: leads/opportunities ids to process
772 :param string action: what has to be done regarding partners (create it, assign an existing one, or nothing)
773 :param int partner_id: partner to assign if any
774 :return dict: dictionary organized as followed: {lead_id: partner_assigned_id}
776 #TODO this is a duplication of the handle_partner_assignation method of crm_phonecall
778 for lead in self.browse(cr, uid, ids, context=context):
779 # If the action is set to 'create' and no partner_id is set, create a new one
781 partner_ids[lead.id] = lead.partner_id.id
783 if not partner_id and action == 'create':
784 partner_id = self._create_lead_partner(cr, uid, lead, context)
785 self.pool['res.partner'].write(cr, uid, partner_id, {'section_id': lead.section_id and lead.section_id.id or False})
787 lead.write({'partner_id': partner_id}, context=context)
788 partner_ids[lead.id] = partner_id
791 def allocate_salesman(self, cr, uid, ids, user_ids=None, team_id=False, context=None):
793 Assign salesmen and salesteam to a batch of leads. If there are more
794 leads than salesmen, these salesmen will be assigned in round-robin.
795 E.g.: 4 salesmen (S1, S2, S3, S4) for 6 leads (L1, L2, ... L6). They
796 will be assigned as followed: L1 - S1, L2 - S2, L3 - S3, L4 - S4,
799 :param list ids: leads/opportunities ids to process
800 :param list user_ids: salesmen to assign
801 :param int team_id: salesteam to assign
809 value['section_id'] = team_id
811 value['user_id'] = user_ids[index]
812 # Cycle through user_ids
813 index = (index + 1) % len(user_ids)
815 self.write(cr, uid, [lead_id], value, context=context)
818 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):
820 :param string action: ('schedule','Schedule a call'), ('log','Log a call')
822 phonecall = self.pool.get('crm.phonecall')
823 model_data = self.pool.get('ir.model.data')
827 res_id = model_data._get_id(cr, uid, 'crm', 'categ_phone2')
828 categ_id = model_data.browse(cr, uid, res_id, context=context).res_id
831 for lead in self.browse(cr, uid, ids, context=context):
833 section_id = lead.section_id and lead.section_id.id or False
835 user_id = lead.user_id and lead.user_id.id or False
837 'name': call_summary,
838 'opportunity_id': lead.id,
839 'user_id': user_id or False,
840 'categ_id': categ_id or False,
841 'description': desc or '',
842 'date': schedule_time,
843 'section_id': section_id or False,
844 'partner_id': lead.partner_id and lead.partner_id.id or False,
845 'partner_phone': phone or lead.phone or (lead.partner_id and lead.partner_id.phone or False),
846 'partner_mobile': lead.partner_id and lead.partner_id.mobile or False,
847 'priority': lead.priority,
849 new_id = phonecall.create(cr, uid, vals, context=context)
850 phonecall.write(cr, uid, [new_id], {'state': 'open'}, context=context)
852 phonecall.write(cr, uid, [new_id], {'state': 'done'}, context=context)
853 phonecall_dict[lead.id] = new_id
854 self.schedule_phonecall_send_note(cr, uid, [lead.id], new_id, action, context=context)
855 return phonecall_dict
857 def redirect_opportunity_view(self, cr, uid, opportunity_id, context=None):
858 models_data = self.pool.get('ir.model.data')
860 # Get opportunity views
861 dummy, form_view = models_data.get_object_reference(cr, uid, 'crm', 'crm_case_form_view_oppor')
862 dummy, tree_view = models_data.get_object_reference(cr, uid, 'crm', 'crm_case_tree_view_oppor')
864 'name': _('Opportunity'),
866 'view_mode': 'tree, form',
867 'res_model': 'crm.lead',
868 'domain': [('type', '=', 'opportunity')],
869 'res_id': int(opportunity_id),
871 'views': [(form_view or False, 'form'),
872 (tree_view or False, 'tree'),
873 (False, 'calendar'), (False, 'graph')],
874 'type': 'ir.actions.act_window',
877 def redirect_lead_view(self, cr, uid, lead_id, context=None):
878 models_data = self.pool.get('ir.model.data')
881 dummy, form_view = models_data.get_object_reference(cr, uid, 'crm', 'crm_case_form_view_leads')
882 dummy, tree_view = models_data.get_object_reference(cr, uid, 'crm', 'crm_case_tree_view_leads')
886 'view_mode': 'tree, form',
887 'res_model': 'crm.lead',
888 'domain': [('type', '=', 'lead')],
889 'res_id': int(lead_id),
891 'views': [(form_view or False, 'form'),
892 (tree_view or False, 'tree'),
893 (False, 'calendar'), (False, 'graph')],
894 'type': 'ir.actions.act_window',
897 def action_makeMeeting(self, cr, uid, ids, context=None):
899 Open meeting's calendar view to schedule meeting on current opportunity.
900 :return dict: dictionary value for created Meeting view
902 opportunity = self.browse(cr, uid, ids[0], context)
903 res = self.pool.get('ir.actions.act_window').for_xml_id(cr, uid, 'calendar', 'action_calendar_event', context)
905 'default_opportunity_id': opportunity.id,
906 'default_partner_id': opportunity.partner_id and opportunity.partner_id.id or False,
907 'default_partner_ids' : opportunity.partner_id and [opportunity.partner_id.id] or False,
908 'default_user_id': uid,
909 'default_section_id': opportunity.section_id and opportunity.section_id.id or False,
910 'default_email_from': opportunity.email_from,
911 'default_name': opportunity.name,
915 def create(self, cr, uid, vals, context=None):
918 if vals.get('type') and not context.get('default_type'):
919 context['default_type'] = vals.get('type')
920 if vals.get('section_id') and not context.get('default_section_id'):
921 context['default_section_id'] = vals.get('section_id')
923 # context: no_log, because subtype already handle this
924 create_context = dict(context, mail_create_nolog=True)
925 return super(crm_lead, self).create(cr, uid, vals, context=create_context)
927 def write(self, cr, uid, ids, vals, context=None):
928 # stage change: update date_last_stage_update
929 if 'stage_id' in vals:
930 vals['date_last_stage_update'] = fields.datetime.now()
931 # stage change with new stage: update probability
932 if vals.get('stage_id') and not vals.get('probability'):
933 onchange_stage_values = self.onchange_stage_id(cr, uid, ids, vals.get('stage_id'), context=context)['value']
934 vals.update(onchange_stage_values)
935 return super(crm_lead, self).write(cr, uid, ids, vals, context=context)
937 def copy(self, cr, uid, id, default=None, context=None):
942 lead = self.browse(cr, uid, id, context=context)
943 local_context = dict(context)
944 local_context.setdefault('default_type', lead.type)
945 local_context.setdefault('default_section_id', lead.section_id)
946 if lead.type == 'opportunity':
947 default['date_open'] = fields.datetime.now()
949 default['date_open'] = False
950 default['date_closed'] = False
951 default['stage_id'] = self._get_default_stage_id(cr, uid, local_context)
952 return super(crm_lead, self).copy(cr, uid, id, default, context=context)
954 # ----------------------------------------
956 # ----------------------------------------
958 def message_get_reply_to(self, cr, uid, ids, context=None):
959 """ Override to get the reply_to of the parent project. """
960 return [lead.section_id.message_get_reply_to()[0] if lead.section_id else False
961 for lead in self.browse(cr, SUPERUSER_ID, ids, context=context)]
963 def _get_formview_action(self, cr, uid, id, context=None):
964 action = super(crm_lead, self)._get_formview_action(cr, uid, id, context=context)
965 obj = self.browse(cr, uid, id, context=context)
966 if obj.type == 'opportunity':
967 model, view_id = self.pool.get('ir.model.data').get_object_reference(cr, uid, 'crm', 'crm_case_form_view_oppor')
969 'views': [(view_id, 'form')],
973 def message_get_suggested_recipients(self, cr, uid, ids, context=None):
974 recipients = super(crm_lead, self).message_get_suggested_recipients(cr, uid, ids, context=context)
976 for lead in self.browse(cr, uid, ids, context=context):
978 self._message_add_suggested_recipient(cr, uid, recipients, lead, partner=lead.partner_id, reason=_('Customer'))
979 elif lead.email_from:
980 self._message_add_suggested_recipient(cr, uid, recipients, lead, email=lead.email_from, reason=_('Customer Email'))
981 except (osv.except_osv, orm.except_orm): # no read access rights -> just ignore suggested recipients because this imply modifying followers
985 def message_new(self, cr, uid, msg, custom_values=None, context=None):
986 """ Overrides mail_thread message_new that is called by the mailgateway
987 through message_process.
988 This override updates the document according to the email.
990 if custom_values is None:
993 'name': msg.get('subject') or _("No Subject"),
994 'email_from': msg.get('from'),
995 'email_cc': msg.get('cc'),
996 'partner_id': msg.get('author_id', False),
999 if msg.get('author_id'):
1000 defaults.update(self.on_change_partner_id(cr, uid, None, msg.get('author_id'), context=context)['value'])
1001 if msg.get('priority') in dict(crm.AVAILABLE_PRIORITIES):
1002 defaults['priority'] = msg.get('priority')
1003 defaults.update(custom_values)
1004 return super(crm_lead, self).message_new(cr, uid, msg, custom_values=defaults, context=context)
1006 def message_update(self, cr, uid, ids, msg, update_vals=None, context=None):
1007 """ Overrides mail_thread message_update that is called by the mailgateway
1008 through message_process.
1009 This method updates the document according to the email.
1011 if isinstance(ids, (str, int, long)):
1013 if update_vals is None: update_vals = {}
1015 if msg.get('priority') in dict(crm.AVAILABLE_PRIORITIES):
1016 update_vals['priority'] = msg.get('priority')
1018 'cost':'planned_cost',
1019 'revenue': 'planned_revenue',
1020 'probability':'probability',
1022 for line in msg.get('body', '').split('\n'):
1024 res = tools.command_re.match(line)
1025 if res and maps.get(res.group(1).lower()):
1026 key = maps.get(res.group(1).lower())
1027 update_vals[key] = res.group(2).lower()
1029 return super(crm_lead, self).message_update(cr, uid, ids, msg, update_vals=update_vals, context=context)
1031 # ----------------------------------------
1032 # OpenChatter methods and notifications
1033 # ----------------------------------------
1035 def schedule_phonecall_send_note(self, cr, uid, ids, phonecall_id, action, context=None):
1036 phonecall = self.pool.get('crm.phonecall').browse(cr, uid, [phonecall_id], context=context)[0]
1038 message = _('Logged a call for %(date)s. %(description)s')
1040 message = _('Scheduled a call for %(date)s. %(description)s')
1041 phonecall_date = datetime.strptime(phonecall.date, tools.DEFAULT_SERVER_DATETIME_FORMAT)
1042 phonecall_usertime = fields.datetime.context_timestamp(cr, uid, phonecall_date, context=context).strftime(tools.DEFAULT_SERVER_DATETIME_FORMAT)
1043 html_time = "<time datetime='%s+00:00'>%s</time>" % (phonecall.date, phonecall_usertime)
1044 message = message % dict(date=html_time, description=phonecall.description)
1045 return self.message_post(cr, uid, ids, body=message, context=context)
1047 def log_meeting(self, cr, uid, ids, meeting_subject, meeting_date, duration, context=None):
1049 duration = _('unknown')
1051 duration = str(duration)
1052 message = _("Meeting scheduled at '%s'<br> Subject: %s <br> Duration: %s hour(s)") % (meeting_date, meeting_subject, duration)
1053 return self.message_post(cr, uid, ids, body=message, context=context)
1055 def onchange_state(self, cr, uid, ids, state_id, context=None):
1057 country_id=self.pool.get('res.country.state').browse(cr, uid, state_id, context).country_id.id
1058 return {'value':{'country_id':country_id}}
1061 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: