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 ##############################################################################
22 from openerp.addons.base_status.base_stage import base_stage
24 from datetime import datetime
25 from operator import itemgetter
26 from openerp.osv import fields, osv, orm
28 from openerp import SUPERUSER_ID
29 from openerp import tools
30 from openerp.tools.translate import _
31 from openerp.tools import html2plaintext
33 from openerp.addons.base.res.res_partner import format_address
35 CRM_LEAD_FIELDS_TO_MERGE = ['name',
67 class crm_lead(base_stage, format_address, osv.osv):
70 _description = "Lead/Opportunity"
71 _order = "priority,date_action,id desc"
72 _inherit = ['mail.thread', 'ir.needaction_mixin']
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.probability > 0 and obj.probability < 100,
78 'crm.mt_lead_won': lambda self, cr, uid, obj, ctx=None: obj.probability == 100,
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,
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 create(self, cr, uid, vals, context=None):
93 if not vals.get('stage_id'):
95 if vals.get('section_id'):
96 ctx['default_section_id'] = vals['section_id']
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)
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
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
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])
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.
130 return context.get('default_type')
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
144 section_id = self._resolve_section_id_from_context(cr, uid, context=context)
146 search_domain += ['|', ('section_ids', '=', section_id)]
147 search_domain += [('id', 'in', ids)]
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)
153 search_domain += ['|', ('type', '=', type), ('type', '=', 'both')]
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])))
161 for stage in stage_obj.browse(cr, access_rights_uid, stage_ids, context=context):
162 fold[stage.id] = stage.fold or False
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)
172 'stage_id': _read_group_stage_ids
175 def _compute_day(self, cr, uid, ids, fields, args, context=None):
177 :return dict: difference between current date and log date
179 cal_obj = self.pool.get('resource.calendar')
180 res_obj = self.pool.get('resource.resource')
183 for lead in self.browse(cr, uid, ids, context=context):
188 if field == 'day_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':
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
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]
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,
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'),
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:
224 duration = len(no_days)
225 res[lead.id][field] = abs(int(duration))
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."),
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),
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),
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'),
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],
313 ('check_probability', 'check(probability >= 0 and probability <= 100)', 'The probability of closing the deal should be between 0% and 100%!')
316 def onchange_stage_id(self, cr, uid, ids, stage_id, context=None):
319 stage = self.pool.get('crm.case.stage').browse(cr, uid, stage_id, context=context)
320 if not stage.on_change:
322 return {'value': {'probability': stage.probability}}
324 def on_change_partner(self, cr, uid, ids, partner_id, context=None):
328 partner = self.pool.get('res.partner').browse(cr, uid, partner_id, context=context)
330 'partner_name' : partner.name,
331 'street' : partner.street,
332 'street2' : partner.street2,
333 'city' : partner.city,
334 'state_id' : partner.state_id and partner.state_id.id or False,
335 'country_id' : partner.country_id and partner.country_id.id or False,
336 'email_from' : partner.email,
337 'phone' : partner.phone,
338 'mobile' : partner.mobile,
341 return {'value' : values}
343 def on_change_user(self, cr, uid, ids, user_id, context=None):
344 """ When changing the user, also set a section_id or restrict section id
345 to the ones user_id is member of. """
346 section_id = self._get_default_section_id(cr, uid, context=context) or False
347 if user_id and not section_id:
348 section_ids = self.pool.get('crm.case.section').search(cr, uid, ['|', ('user_id', '=', user_id), ('member_ids', '=', user_id)], context=context)
350 section_id = section_ids[0]
351 return {'value': {'section_id': section_id}}
353 def _check(self, cr, uid, ids=False, context=None):
354 """ Override of the base.stage method.
355 Function called by the scheduler to process cases for date actions
356 Only works on not won and lost cases.
358 cr.execute('select * from crm_case \
359 where (date_action_last<%s or date_action_last is null) \
360 and (date_action_next<=%s or date_action_next is null) \
361 and probability not in (0,100)',
362 (time.strftime("%Y-%m-%d %H:%M:%S"),
363 time.strftime('%Y-%m-%d %H:%M:%S')))
365 ids2 = map(lambda x: x[0], cr.fetchall() or [])
366 cases = self.browse(cr, uid, ids2, context=context)
367 return self._action(cr, uid, cases, False, context=context)
369 def stage_find(self, cr, uid, cases, section_id, domain=None, order='sequence', context=None):
370 """ Override of the base.stage method
371 Parameter of the stage search taken from the lead:
372 - type: stage type must be the same or 'both'
373 - section_id: if set, stages must belong to this section or
374 be a default stage; if not set, stages must be default
377 if isinstance(cases, (int, long)):
378 cases = self.browse(cr, uid, cases, context=context)
379 # collect all section_ids
383 ctx_type = context.get('default_type')
386 section_ids.add(section_id)
389 section_ids.add(lead.section_id.id)
390 if lead.type not in types:
391 types.append(lead.type)
392 # OR all section_ids and OR with case_default
395 search_domain += [('|')] * len(section_ids)
396 for section_id in section_ids:
397 search_domain.append(('section_ids', '=', section_id))
398 search_domain.append(('case_default', '=', True))
399 # AND with cases types
400 search_domain.append(('type', 'in', types))
401 # AND with the domain in parameter
402 search_domain += list(domain)
403 # perform search, return the first found
404 stage_ids = self.pool.get('crm.case.stage').search(cr, uid, search_domain, order=order, context=context)
409 def case_mark_lost(self, cr, uid, ids, context=None):
410 """ Mark the case as lost: stage with probability=0, on_change=True """
411 for lead in self.browse(cr, uid, ids):
412 stage_id = self.stage_find(cr, uid, [lead], lead.section_id.id or False, [('probability', '=', 0.0), ('on_change', '=', True), ('sequence', '>', 1)], context=context)
414 self.case_set(cr, uid, [lead.id], new_stage_id=stage_id, context=context)
416 raise osv.except_osv(_('Warning!'), _('To relieve your sales pipe and group all Lost opportunities, configure one of your sales stage as follow:\n'
417 'probability = 0 %, select "Change Probability Automatically".\n'
418 'Create a specific stage or edit an existing one by editing columns of your opportunity pipe.'))
421 def case_mark_won(self, cr, uid, ids, context=None):
422 """ Mark the case as won: stage with probability=100, , on_change=True """
423 for lead in self.browse(cr, uid, ids):
424 stage_id = self.stage_find(cr, uid, [lead], lead.section_id.id or False, [('probability', '=', 100.0), ('on_change', '=', True)], context=context)
426 self.case_set(cr, uid, [lead.id], new_stage_id=stage_id, context=context)
428 raise osv.except_osv(_('Warning!'), _('To relieve your sales pipe and group all Won opportunities, configure one of your sales stage as follow:\n'
429 'probability = 100 % and select "Change Probability Automatically".\n'
430 'Create a specific stage or edit an existing one by editing columns of your opportunity pipe.'))
433 def set_priority(self, cr, uid, ids, priority):
434 """ Set lead priority
436 return self.write(cr, uid, ids, {'priority': priority})
438 def set_high_priority(self, cr, uid, ids, context=None):
439 """ Set lead priority to high
441 return self.set_priority(cr, uid, ids, '1')
443 def set_normal_priority(self, cr, uid, ids, context=None):
444 """ Set lead priority to normal
446 return self.set_priority(cr, uid, ids, '3')
448 def _merge_get_result_type(self, cr, uid, opps, context=None):
450 Define the type of the result of the merge. If at least one of the
451 element to merge is an opp, the resulting new element will be an opp.
452 Otherwise it will be a lead.
454 We'll directly use a list of browse records instead of a list of ids
455 for performances' sake: it will spare a second browse of the
458 :param list opps: list of browse records containing the leads/opps to process
459 :return string type: the type of the final element
462 if (opp.type == 'opportunity'):
467 def _merge_data(self, cr, uid, ids, oldest, fields, context=None):
469 Prepare lead/opp data into a dictionary for merging. Different types
470 of fields are processed in different ways:
471 - text: all the values are concatenated
472 - m2m and o2m: those fields aren't processed
473 - m2o: the first not null value prevails (the other are dropped)
474 - any other type of field: same as m2o
476 :param list ids: list of ids of the leads to process
477 :param list fields: list of leads' fields to process
478 :return dict data: contains the merged values
480 opportunities = self.browse(cr, uid, ids, context=context)
482 def _get_first_not_null(attr):
483 for opp in opportunities:
484 if hasattr(opp, attr) and bool(getattr(opp, attr)):
485 return getattr(opp, attr)
488 def _get_first_not_null_id(attr):
489 res = _get_first_not_null(attr)
490 return res and res.id or False
492 def _concat_all(attr):
493 return '\n\n'.join(filter(lambda x: x, [getattr(opp, attr) or '' for opp in opportunities if hasattr(opp, attr)]))
495 # Process the fields' values
497 for field_name in fields:
498 field_info = self._all_columns.get(field_name)
499 if field_info is None:
501 field = field_info.column
502 if field._type in ('many2many', 'one2many'):
504 elif field._type == 'many2one':
505 data[field_name] = _get_first_not_null_id(field_name) # !!
506 elif field._type == 'text':
507 data[field_name] = _concat_all(field_name) #not lost
509 data[field_name] = _get_first_not_null(field_name) #not lost
511 # Define the resulting type ('lead' or 'opportunity')
512 data['type'] = self._merge_get_result_type(cr, uid, opportunities, context)
515 def _mail_body(self, cr, uid, lead, fields, title=False, context=None):
518 body.append("%s\n" % (title))
520 for field_name in fields:
521 field_info = self._all_columns.get(field_name)
522 if field_info is None:
524 field = field_info.column
527 if field._type == 'selection':
528 if hasattr(field.selection, '__call__'):
529 key = field.selection(self, cr, uid, context=context)
531 key = field.selection
532 value = dict(key).get(lead[field_name], lead[field_name])
533 elif field._type == 'many2one':
535 value = lead[field_name].name_get()[0][1]
536 elif field._type == 'many2many':
538 for val in lead[field_name]:
539 field_value = val.name_get()[0][1]
540 value += field_value + ","
542 value = lead[field_name]
544 body.append("%s: %s" % (field.string, value or ''))
545 return "<br/>".join(body + ['<br/>'])
547 def _merge_notify(self, cr, uid, opportunity_id, opportunities, context=None):
549 Create a message gathering merged leads/opps information.
551 #TOFIX: mail template should be used instead of fix body, subject text
553 result_type = self._merge_get_result_type(cr, uid, opportunities, context)
554 if result_type == 'lead':
555 merge_message = _('Merged leads')
557 merge_message = _('Merged opportunities')
558 subject = [merge_message]
559 for opportunity in opportunities:
560 subject.append(opportunity.name)
561 title = "%s : %s" % (opportunity.type == 'opportunity' and _('Merged opportunity') or _('Merged lead'), opportunity.name)
562 fields = list(CRM_LEAD_FIELDS_TO_MERGE)
563 details.append(self._mail_body(cr, uid, opportunity, fields, title=title, context=context))
565 # Chatter message's subject
566 subject = subject[0] + ": " + ", ".join(subject[1:])
567 details = "\n\n".join(details)
568 return self.message_post(cr, uid, [opportunity_id], body=details, subject=subject, context=context)
570 def _merge_opportunity_history(self, cr, uid, opportunity_id, opportunities, context=None):
571 message = self.pool.get('mail.message')
572 for opportunity in opportunities:
573 for history in opportunity.message_ids:
574 message.write(cr, uid, history.id, {
575 'res_id': opportunity_id,
576 'subject' : _("From %s : %s") % (opportunity.name, history.subject)
581 def _merge_opportunity_attachments(self, cr, uid, opportunity_id, opportunities, context=None):
582 attach_obj = self.pool.get('ir.attachment')
584 # return attachments of opportunity
585 def _get_attachments(opportunity_id):
586 attachment_ids = attach_obj.search(cr, uid, [('res_model', '=', self._name), ('res_id', '=', opportunity_id)], context=context)
587 return attach_obj.browse(cr, uid, attachment_ids, context=context)
589 first_attachments = _get_attachments(opportunity_id)
590 #counter of all attachments to move. Used to make sure the name is different for all attachments
592 for opportunity in opportunities:
593 attachments = _get_attachments(opportunity.id)
594 for attachment in attachments:
595 values = {'res_id': opportunity_id,}
596 for attachment_in_first in first_attachments:
597 if attachment.name == attachment_in_first.name:
598 name = "%s (%s)" % (attachment.name, count,),
600 attachment.write(values)
603 def merge_opportunity(self, cr, uid, ids, context=None):
605 Different cases of merge:
606 - merge leads together = 1 new lead
607 - merge at least 1 opp with anything else (lead or opp) = 1 new opp
609 :param list ids: leads/opportunities ids to merge
610 :return int id: id of the resulting lead/opp
616 raise osv.except_osv(_('Warning!'), _('Please select more than one element (lead or opportunity) from the list view.'))
618 opportunities = self.browse(cr, uid, ids, context=context)
620 for opportunity in opportunities:
622 if opportunity.stage_id and (opportunity.probability == 0 and opportunity.stage_id and opportunity.stage_id.sequence != 1):
623 sequence = opportunity.stage_id.sequence
624 sequenced_opps.append(((int(sequence != -1 and opportunity.type == 'opportunity'), sequence, -opportunity.id), opportunity))
626 sequenced_opps.sort(reverse=True)
627 opportunities = map(itemgetter(1), sequenced_opps)
628 ids = [opportunity.id for opportunity in opportunities]
629 highest = opportunities[0]
630 opportunities_rest = opportunities[1:]
632 tail_opportunities = opportunities_rest
634 fields = list(CRM_LEAD_FIELDS_TO_MERGE)
635 merged_data = self._merge_data(cr, uid, ids, highest, fields, context=context)
637 # Merge messages and attachements into the first opportunity
638 self._merge_opportunity_history(cr, uid, highest.id, tail_opportunities, context=context)
639 self._merge_opportunity_attachments(cr, uid, highest.id, tail_opportunities, context=context)
641 # Merge notifications about loss of information
642 opportunities = [highest]
643 opportunities.extend(opportunities_rest)
644 self._merge_notify(cr, uid, highest, opportunities, context=context)
645 # Check if the stage is in the stages of the sales team. If not, assign the stage with the lowest sequence
646 if merged_data.get('section_id'):
647 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)
648 if merged_data.get('stage_id') not in section_stage_ids:
649 merged_data['stage_id'] = section_stage_ids and section_stage_ids[0] or False
650 # Write merged data into first opportunity
651 self.write(cr, uid, [highest.id], merged_data, context=context)
652 # Delete tail opportunities
653 # 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
654 self.unlink(cr, SUPERUSER_ID, [x.id for x in tail_opportunities], context=context)
658 def _convert_opportunity_data(self, cr, uid, lead, customer, section_id=False, context=None):
659 crm_stage = self.pool.get('crm.case.stage')
662 contact_id = self.pool.get('res.partner').address_get(cr, uid, [customer.id])['default']
664 section_id = lead.section_id and lead.section_id.id or False
666 'planned_revenue': lead.planned_revenue,
667 'probability': lead.probability,
669 'partner_id': customer and customer.id or False,
670 'user_id': (lead.user_id and lead.user_id.id),
671 'type': 'opportunity',
672 'date_action': fields.datetime.now(),
673 'date_open': fields.datetime.now(),
674 'email_from': customer and customer.email or lead.email_from,
675 'phone': customer and customer.phone or lead.phone,
677 if not lead.stage_id or lead.stage_id.type == 'lead':
678 val['stage_id'] = self.stage_find(cr, uid, [lead], section_id, ['&', ('sequence', '=', '1'), ('type', 'in', ('opportunity', 'both'))], context=context)
681 def convert_opportunity(self, cr, uid, ids, partner_id, user_ids=False, section_id=False, context=None):
684 partner = self.pool.get('res.partner')
685 customer = partner.browse(cr, uid, partner_id, context=context)
686 for lead in self.browse(cr, uid, ids, context=context):
687 # avoid done / cancelled leads
688 if lead.probability == 100 or (lead.probability == 0 and lead.stage_id and lead.stage_id.sequence == 1):
690 vals = self._convert_opportunity_data(cr, uid, lead, customer, section_id, context=context)
691 self.write(cr, uid, [lead.id], vals, context=context)
692 self.message_post(cr, uid, ids, body=_("Lead <b>converted into an Opportunity</b>"), subtype="crm.mt_lead_convert_to_opportunity", context=context)
694 if user_ids or section_id:
695 self.allocate_salesman(cr, uid, ids, user_ids, section_id, context=context)
699 def _lead_create_contact(self, cr, uid, lead, name, is_company, parent_id=False, context=None):
700 partner = self.pool.get('res.partner')
701 vals = {'name': name,
702 'user_id': lead.user_id.id,
703 'comment': lead.description,
704 'section_id': lead.section_id.id or False,
705 'parent_id': parent_id,
707 'mobile': lead.mobile,
708 'email': tools.email_split(lead.email_from) and tools.email_split(lead.email_from)[0] or False,
710 'title': lead.title and lead.title.id or False,
711 'function': lead.function,
712 'street': lead.street,
713 'street2': lead.street2,
716 'country_id': lead.country_id and lead.country_id.id or False,
717 'state_id': lead.state_id and lead.state_id.id or False,
718 'is_company': is_company,
721 partner = partner.create(cr, uid, vals, context=context)
724 def _create_lead_partner(self, cr, uid, lead, context=None):
726 if lead.partner_name and lead.contact_name:
727 partner_id = self._lead_create_contact(cr, uid, lead, lead.partner_name, True, context=context)
728 partner_id = self._lead_create_contact(cr, uid, lead, lead.contact_name, False, partner_id, context=context)
729 elif lead.partner_name and not lead.contact_name:
730 partner_id = self._lead_create_contact(cr, uid, lead, lead.partner_name, True, context=context)
731 elif not lead.partner_name and lead.contact_name:
732 partner_id = self._lead_create_contact(cr, uid, lead, lead.contact_name, False, context=context)
733 elif lead.email_from and self.pool.get('res.partner')._parse_partner_name(lead.email_from, context=context)[0]:
734 contact_name = self.pool.get('res.partner')._parse_partner_name(lead.email_from, context=context)[0]
735 partner_id = self._lead_create_contact(cr, uid, lead, contact_name, False, context=context)
737 raise osv.except_osv(
739 _('No customer name defined. Please fill one of the following fields: Company Name, Contact Name or Email ("Name <email@address>")')
743 def _lead_set_partner(self, cr, uid, lead, partner_id, context=None):
745 Assign a partner to a lead.
747 :param object lead: browse record of the lead to process
748 :param int partner_id: identifier of the partner to assign
749 :return bool: True if the partner has properly been assigned
752 res_partner = self.pool.get('res.partner')
754 res_partner.write(cr, uid, partner_id, {'section_id': lead.section_id and lead.section_id.id or False})
755 contact_id = res_partner.address_get(cr, uid, [partner_id])['default']
756 res = lead.write({'partner_id': partner_id}, context=context)
757 message = _("<b>Partner</b> set to <em>%s</em>." % (lead.partner_id.name))
758 self.message_post(cr, uid, [lead.id], body=message, context=context)
761 def handle_partner_assignation(self, cr, uid, ids, action='create', partner_id=False, context=None):
763 Handle partner assignation during a lead conversion.
764 if action is 'create', create new partner with contact and assign lead to new partner_id.
765 otherwise assign lead to the specified partner_id
767 :param list ids: leads/opportunities ids to process
768 :param string action: what has to be done regarding partners (create it, assign an existing one, or nothing)
769 :param int partner_id: partner to assign if any
770 :return dict: dictionary organized as followed: {lead_id: partner_assigned_id}
772 #TODO this is a duplication of the handle_partner_assignation method of crm_phonecall
774 # If a partner_id is given, force this partner for all elements
775 force_partner_id = partner_id
776 for lead in self.browse(cr, uid, ids, context=context):
777 # If the action is set to 'create' and no partner_id is set, create a new one
778 if action == 'create':
779 partner_id = force_partner_id or self._create_lead_partner(cr, uid, lead, context)
780 self._lead_set_partner(cr, uid, lead, partner_id, context=context)
781 partner_ids[lead.id] = partner_id
784 def allocate_salesman(self, cr, uid, ids, user_ids=None, team_id=False, context=None):
786 Assign salesmen and salesteam to a batch of leads. If there are more
787 leads than salesmen, these salesmen will be assigned in round-robin.
788 E.g.: 4 salesmen (S1, S2, S3, S4) for 6 leads (L1, L2, ... L6). They
789 will be assigned as followed: L1 - S1, L2 - S2, L3 - S3, L4 - S4,
792 :param list ids: leads/opportunities ids to process
793 :param list user_ids: salesmen to assign
794 :param int team_id: salesteam to assign
802 value['section_id'] = team_id
804 value['user_id'] = user_ids[index]
805 # Cycle through user_ids
806 index = (index + 1) % len(user_ids)
808 self.write(cr, uid, [lead_id], value, context=context)
811 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):
813 :param string action: ('schedule','Schedule a call'), ('log','Log a call')
815 phonecall = self.pool.get('crm.phonecall')
816 model_data = self.pool.get('ir.model.data')
819 res_id = model_data._get_id(cr, uid, 'crm', 'categ_phone2')
821 categ_id = model_data.browse(cr, uid, res_id, context=context).res_id
822 for lead in self.browse(cr, uid, ids, context=context):
824 section_id = lead.section_id and lead.section_id.id or False
826 user_id = lead.user_id and lead.user_id.id or False
828 'name': call_summary,
829 'opportunity_id': lead.id,
830 'user_id': user_id or False,
831 'categ_id': categ_id or False,
832 'description': desc or '',
833 'date': schedule_time,
834 'section_id': section_id or False,
835 'partner_id': lead.partner_id and lead.partner_id.id or False,
836 'partner_phone': phone or lead.phone or (lead.partner_id and lead.partner_id.phone or False),
837 'partner_mobile': lead.partner_id and lead.partner_id.mobile or False,
838 'priority': lead.priority,
840 new_id = phonecall.create(cr, uid, vals, context=context)
841 phonecall.case_open(cr, uid, [new_id], context=context)
843 phonecall.case_close(cr, uid, [new_id], context=context)
844 phonecall_dict[lead.id] = new_id
845 self.schedule_phonecall_send_note(cr, uid, [lead.id], new_id, action, context=context)
846 return phonecall_dict
848 def redirect_opportunity_view(self, cr, uid, opportunity_id, context=None):
849 models_data = self.pool.get('ir.model.data')
851 # Get opportunity views
852 dummy, form_view = models_data.get_object_reference(cr, uid, 'crm', 'crm_case_form_view_oppor')
853 dummy, tree_view = models_data.get_object_reference(cr, uid, 'crm', 'crm_case_tree_view_oppor')
855 'name': _('Opportunity'),
857 'view_mode': 'tree, form',
858 'res_model': 'crm.lead',
859 'domain': [('type', '=', 'opportunity')],
860 'res_id': int(opportunity_id),
862 'views': [(form_view or False, 'form'),
863 (tree_view or False, 'tree'),
864 (False, 'calendar'), (False, 'graph')],
865 'type': 'ir.actions.act_window',
868 def redirect_lead_view(self, cr, uid, lead_id, context=None):
869 models_data = self.pool.get('ir.model.data')
872 dummy, form_view = models_data.get_object_reference(cr, uid, 'crm', 'crm_case_form_view_leads')
873 dummy, tree_view = models_data.get_object_reference(cr, uid, 'crm', 'crm_case_tree_view_leads')
877 'view_mode': 'tree, form',
878 'res_model': 'crm.lead',
879 'domain': [('type', '=', 'lead')],
880 'res_id': int(lead_id),
882 'views': [(form_view or False, 'form'),
883 (tree_view or False, 'tree'),
884 (False, 'calendar'), (False, 'graph')],
885 'type': 'ir.actions.act_window',
888 def action_makeMeeting(self, cr, uid, ids, context=None):
890 Open meeting's calendar view to schedule meeting on current opportunity.
891 :return dict: dictionary value for created Meeting view
893 opportunity = self.browse(cr, uid, ids[0], context)
894 res = self.pool.get('ir.actions.act_window').for_xml_id(cr, uid, 'base_calendar', 'action_crm_meeting', context)
896 'default_opportunity_id': opportunity.id,
897 'default_partner_id': opportunity.partner_id and opportunity.partner_id.id or False,
898 'default_partner_ids' : opportunity.partner_id and [opportunity.partner_id.id] or False,
899 'default_user_id': uid,
900 'default_section_id': opportunity.section_id and opportunity.section_id.id or False,
901 'default_email_from': opportunity.email_from,
902 'default_name': opportunity.name,
906 def write(self, cr, uid, ids, vals, context=None):
907 stage_pool=self.pool.get('crm.case.stage')
908 if vals.get('stage_id') and not vals.get('probability'):
909 # change probability of lead(s) if required by stage
910 stage = stage_pool.browse(cr, uid, vals['stage_id'], context=context)
912 vals['probability'] = stage.probability
913 if vals.get('probability') == 100:
914 vals['stage_id'] = stage_pool.search(cr, uid, [('probability','=',100.0)],order='sequence')[0]
915 return super(crm_lead, self).write(cr, uid, ids, vals, context=context)
917 def new_mail_send(self, cr, uid, ids, context=None):
919 This function opens a window to compose an email, with the edi sale template message loaded by default
921 assert len(ids) == 1, 'This option should only be used for a single id at a time.'
922 ir_model_data = self.pool.get('ir.model.data')
924 template_id = ir_model_data.get_object_reference(cr, uid, 'crm', 'email_template_opportunity_mail')[1]
928 compose_form_id = ir_model_data.get_object_reference(cr, uid, 'mail', 'email_compose_message_wizard_form')[1]
930 compose_form_id = False
935 'default_model': 'crm.lead',
936 'default_res_id': ids[0],
937 'default_use_template': bool(template_id),
938 'default_template_id': template_id,
939 'default_composition_mode': 'comment',
942 'name': _('Compose Email'),
943 'type': 'ir.actions.act_window',
946 'res_model': 'mail.compose.message',
947 'views': [(compose_form_id, 'form')],
948 'view_id': compose_form_id,
953 # ----------------------------------------
955 # ----------------------------------------
957 def message_get_reply_to(self, cr, uid, ids, context=None):
958 """ Override to get the reply_to of the parent project. """
959 return [lead.section_id.message_get_reply_to()[0] if lead.section_id else False
960 for lead in self.browse(cr, SUPERUSER_ID, ids, context=context)]
962 def _get_formview_action(self, cr, uid, id, context=None):
963 action = super(crm_lead, self)._get_formview_action(cr, uid, id, context=context)
964 obj = self.browse(cr, uid, id, context=context)
965 if obj.type == 'opportunity':
966 model, view_id = self.pool.get('ir.model.data').get_object_reference(cr, uid, 'crm', 'crm_case_form_view_oppor')
968 'views': [(view_id, 'form')],
972 def message_get_suggested_recipients(self, cr, uid, ids, context=None):
973 recipients = super(crm_lead, self).message_get_suggested_recipients(cr, uid, ids, context=context)
975 for lead in self.browse(cr, uid, ids, context=context):
977 self._message_add_suggested_recipient(cr, uid, recipients, lead, partner=lead.partner_id, reason=_('Customer'))
978 elif lead.email_from:
979 self._message_add_suggested_recipient(cr, uid, recipients, lead, email=lead.email_from, reason=_('Customer Email'))
980 except (osv.except_osv, orm.except_orm): # no read access rights -> just ignore suggested recipients because this imply modifying followers
984 def message_new(self, cr, uid, msg, custom_values=None, context=None):
985 """ Overrides mail_thread message_new that is called by the mailgateway
986 through message_process.
987 This override updates the document according to the email.
989 if custom_values is None:
991 desc = html2plaintext(msg.get('body')) if msg.get('body') else ''
993 'name': msg.get('subject') or _("No Subject"),
995 'email_from': msg.get('from'),
996 'email_cc': msg.get('cc'),
997 'partner_id': msg.get('author_id', False),
1000 if msg.get('author_id'):
1001 defaults.update(self.onchange_partner_id(cr, uid, None, msg.get('author_id'), context=context)['value'])
1002 if msg.get('priority') in dict(crm.AVAILABLE_PRIORITIES):
1003 defaults['priority'] = msg.get('priority')
1004 defaults.update(custom_values)
1005 return super(crm_lead, self).message_new(cr, uid, msg, custom_values=defaults, context=context)
1007 def message_update(self, cr, uid, ids, msg, update_vals=None, context=None):
1008 """ Overrides mail_thread message_update that is called by the mailgateway
1009 through message_process.
1010 This method updates the document according to the email.
1012 if isinstance(ids, (str, int, long)):
1014 if update_vals is None:
1016 if msg.get('priority') in dict(crm.AVAILABLE_PRIORITIES):
1017 update_vals['priority'] = msg.get('priority')
1019 'cost': 'planned_cost',
1020 'revenue': 'planned_revenue',
1021 'probability': 'probability',
1023 for line in msg.get('body', '').split('\n'):
1025 res = tools.command_re.match(line)
1026 if res and maps.get(res.group(1).lower()):
1027 key = maps.get(res.group(1).lower())
1028 update_vals[key] = res.group(2).lower()
1030 return super(crm_lead, self).message_update(cr, uid, ids, msg, update_vals=update_vals, context=context)
1032 # ----------------------------------------
1033 # OpenChatter methods and notifications
1034 # ----------------------------------------
1036 def schedule_phonecall_send_note(self, cr, uid, ids, phonecall_id, action, context=None):
1037 phonecall = self.pool.get('crm.phonecall').browse(cr, uid, [phonecall_id], context=context)[0]
1041 prefix = 'Scheduled'
1042 suffix = ' %s' % phonecall.description
1043 message = _("%s a call for %s.%s") % (prefix, phonecall.date, suffix)
1044 return self.message_post(cr, uid, ids, body=message, context=context)
1046 def log_meeting(self, cr, uid, ids, meeting_subject, meeting_date, duration, context=None):
1048 duration = _('unknown')
1050 duration = str(duration)
1051 message = _("Meeting scheduled at '%s'<br> Subject: %s <br> Duration: %s hour(s)") % (meeting_date, meeting_subject, duration)
1052 return self.message_post(cr, uid, ids, body=message, context=context)
1054 def onchange_state(self, cr, uid, ids, state_id, context=None):
1056 country_id=self.pool.get('res.country.state').browse(cr, uid, state_id, context).country_id.id
1057 return {'value':{'country_id':country_id}}
1060 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: