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 openerp.osv import fields, osv
27 from openerp import tools
28 from openerp.tools.translate import _
29 from openerp.tools import html2plaintext
31 from base.res.res_partner import format_address
33 CRM_LEAD_FIELDS_TO_MERGE = ['name',
63 CRM_LEAD_PENDING_STATES = (
64 crm.AVAILABLE_STATES[2][0], # Cancelled
65 crm.AVAILABLE_STATES[3][0], # Done
66 crm.AVAILABLE_STATES[4][0], # Pending
69 class crm_lead(base_stage, format_address, osv.osv):
72 _description = "Lead/Opportunity"
73 _order = "priority,date_action,id desc"
74 _inherit = ['mail.thread', 'ir.needaction_mixin']
78 'crm.mt_lead_create': lambda self, cr, uid, obj, ctx=None: obj['state'] == 'new',
79 'crm.mt_lead_won': lambda self, cr, uid, obj, ctx=None: obj['state'] == 'done',
80 'crm.mt_lead_lost': lambda self, cr, uid, obj, ctx=None: obj['state'] == 'cancel',
83 'crm.mt_lead_stage': lambda self, cr, uid, obj, ctx=None: obj['state'] not in ['new', 'cancel', 'done'],
87 def create(self, cr, uid, vals, context=None):
90 if not vals.get('stage_id'):
92 if vals.get('section_id'):
93 ctx['default_section_id'] = vals['section_id']
95 ctx['default_type'] = vals['type']
96 vals['stage_id'] = self._get_default_stage_id(cr, uid, context=ctx)
97 return super(crm_lead, self).create(cr, uid, vals, context=context)
99 def _get_default_section_id(self, cr, uid, context=None):
100 """ Gives default section by checking if present in the context """
101 return self._resolve_section_id_from_context(cr, uid, context=context) or False
103 def _get_default_stage_id(self, cr, uid, context=None):
104 """ Gives default stage_id """
105 section_id = self._get_default_section_id(cr, uid, context=context)
106 return self.stage_find(cr, uid, [], section_id, [('state', '=', 'draft')], context=context)
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))
228 def _history_search(self, cr, uid, obj, name, args, context=None):
230 msg_obj = self.pool.get('mail.message')
231 message_ids = msg_obj.search(cr, uid, [('email_from','!=',False), ('subject', args[0][1], args[0][2])], context=context)
232 lead_ids = self.search(cr, uid, [('message_ids', 'in', message_ids)], context=context)
235 return [('id', 'in', lead_ids)]
237 return [('id', '=', '0')]
240 'partner_id': fields.many2one('res.partner', 'Partner', ondelete='set null', track_visibility='onchange',
241 select=True, help="Linked partner (optional). Usually created when converting the lead."),
243 'id': fields.integer('ID', readonly=True),
244 'name': fields.char('Subject', size=64, required=True, select=1),
245 'active': fields.boolean('Active', required=False),
246 'date_action_last': fields.datetime('Last Action', readonly=1),
247 'date_action_next': fields.datetime('Next Action', readonly=1),
248 'email_from': fields.char('Email', size=128, help="Email address of the contact", select=1),
249 'section_id': fields.many2one('crm.case.section', 'Sales Team',
250 select=True, track_visibility='onchange', help='When sending mails, the default email address is taken from the sales team.'),
251 'create_date': fields.datetime('Creation Date' , readonly=True),
252 '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"),
253 'description': fields.text('Notes'),
254 'write_date': fields.datetime('Update Date' , readonly=True),
255 'categ_ids': fields.many2many('crm.case.categ', 'crm_lead_category_rel', 'lead_id', 'category_id', 'Categories', \
256 domain="['|',('section_id','=',section_id),('section_id','=',False), ('object_id.model', '=', 'crm.lead')]"),
257 'type_id': fields.many2one('crm.case.resource.type', 'Campaign', \
258 domain="['|',('section_id','=',section_id),('section_id','=',False)]", help="From which campaign (seminar, marketing campaign, mass mailing, ...) did this contact come from?"),
259 'channel_id': fields.many2one('crm.case.channel', 'Channel', help="Communication channel (mail, direct, phone, ...)"),
260 'contact_name': fields.char('Contact Name', size=64),
261 '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),
262 'opt_out': fields.boolean('Opt-Out', oldname='optout', help="If opt-out is checked, this contact has refused to receive emails or unsubscribed to a campaign."),
263 'type':fields.selection([ ('lead','Lead'), ('opportunity','Opportunity'), ],'Type', help="Type is used to separate Leads and Opportunities"),
264 'priority': fields.selection(crm.AVAILABLE_PRIORITIES, 'Priority', select=True),
265 'date_closed': fields.datetime('Closed', readonly=True),
266 'stage_id': fields.many2one('crm.case.stage', 'Stage', track_visibility='onchange',
267 domain="['&', '&', ('fold', '=', False), ('section_ids', '=', section_id), '|', ('type', '=', type), ('type', '=', 'both')]"),
268 'user_id': fields.many2one('res.users', 'Salesperson', select=True, track_visibility='onchange'),
269 'referred': fields.char('Referred By', size=64),
270 'date_open': fields.datetime('Opened', readonly=True),
271 'day_open': fields.function(_compute_day, string='Days to Open', \
272 multi='day_open', type="float", store=True),
273 'day_close': fields.function(_compute_day, string='Days to Close', \
274 multi='day_close', type="float", store=True),
275 'state': fields.related('stage_id', 'state', type="selection", store=True,
276 selection=crm.AVAILABLE_STATES, string="Status", readonly=True,
277 help='The Status is set to \'Draft\', when a case is created. If the case is in progress the Status is set to \'Open\'. When the case is over, the Status is set to \'Done\'. If the case needs to be reviewed then the Status is set to \'Pending\'.'),
279 # Only used for type opportunity
280 'probability': fields.float('Success Rate (%)',group_operator="avg"),
281 'planned_revenue': fields.float('Expected Revenue', track_visibility='always'),
282 'ref': fields.reference('Reference', selection=crm._links_get, size=128),
283 'ref2': fields.reference('Reference 2', selection=crm._links_get, size=128),
284 'phone': fields.char("Phone", size=64),
285 'date_deadline': fields.date('Expected Closing', help="Estimate of the date on which the opportunity will be won."),
286 'date_action': fields.date('Next Action Date', select=True),
287 'title_action': fields.char('Next Action', size=64),
288 'color': fields.integer('Color Index'),
289 'partner_address_name': fields.related('partner_id', 'name', type='char', string='Partner Contact Name', readonly=True),
290 'partner_address_email': fields.related('partner_id', 'email', type='char', string='Partner Contact Email', readonly=True),
291 'company_currency': fields.related('company_id', 'currency_id', type='many2one', string='Currency', readonly=True, relation="res.currency"),
292 'user_email': fields.related('user_id', 'email', type='char', string='User Email', readonly=True),
293 'user_login': fields.related('user_id', 'login', type='char', string='User Login', readonly=True),
295 # Fields for address, due to separation from crm and res.partner
296 'street': fields.char('Street', size=128),
297 'street2': fields.char('Street2', size=128),
298 'zip': fields.char('Zip', change_default=True, size=24),
299 'city': fields.char('City', size=128),
300 'state_id': fields.many2one("res.country.state", 'State'),
301 'country_id': fields.many2one('res.country', 'Country'),
302 'phone': fields.char('Phone', size=64),
303 'fax': fields.char('Fax', size=64),
304 'mobile': fields.char('Mobile', size=64),
305 'function': fields.char('Function', size=128),
306 'title': fields.many2one('res.partner.title', 'Title'),
307 'company_id': fields.many2one('res.company', 'Company', select=1),
308 'payment_mode': fields.many2one('crm.payment.mode', 'Payment Mode', \
309 domain="[('section_id','=',section_id)]"),
310 'planned_cost': fields.float('Planned Costs'),
316 'user_id': lambda s, cr, uid, c: s._get_default_user(cr, uid, c),
317 'email_from': lambda s, cr, uid, c: s._get_default_email(cr, uid, c),
318 'stage_id': lambda s, cr, uid, c: s._get_default_stage_id(cr, uid, c),
319 'section_id': lambda s, cr, uid, c: s._get_default_section_id(cr, uid, c),
320 'company_id': lambda s, cr, uid, c: s.pool.get('res.company')._company_default_get(cr, uid, 'crm.lead', context=c),
321 'priority': lambda *a: crm.AVAILABLE_PRIORITIES[2][0],
326 ('check_probability', 'check(probability >= 0 and probability <= 100)', 'The probability of closing the deal should be between 0% and 100%!')
329 def onchange_stage_id(self, cr, uid, ids, stage_id, context=None):
332 stage = self.pool.get('crm.case.stage').browse(cr, uid, stage_id, context)
333 if not stage.on_change:
335 return {'value':{'probability': stage.probability}}
337 def on_change_partner(self, cr, uid, ids, partner_id, context=None):
341 partner = self.pool.get('res.partner').browse(cr, uid, partner_id, context=context)
343 'partner_name' : partner.name,
344 'street' : partner.street,
345 'street2' : partner.street2,
346 'city' : partner.city,
347 'state_id' : partner.state_id and partner.state_id.id or False,
348 'country_id' : partner.country_id and partner.country_id.id or False,
349 'email_from' : partner.email,
350 'phone' : partner.phone,
351 'mobile' : partner.mobile,
354 return {'value' : values}
356 def _check(self, cr, uid, ids=False, context=None):
357 """ Override of the base.stage method.
358 Function called by the scheduler to process cases for date actions
359 Only works on not done and cancelled cases
361 cr.execute('select * from crm_case \
362 where (date_action_last<%s or date_action_last is null) \
363 and (date_action_next<=%s or date_action_next is null) \
364 and state not in (\'cancel\',\'done\')',
365 (time.strftime("%Y-%m-%d %H:%M:%S"),
366 time.strftime('%Y-%m-%d %H:%M:%S')))
368 ids2 = map(lambda x: x[0], cr.fetchall() or [])
369 cases = self.browse(cr, uid, ids2, context=context)
370 return self._action(cr, uid, cases, False, context=context)
372 def stage_find(self, cr, uid, cases, section_id, domain=None, order='sequence', context=None):
373 """ Override of the base.stage method
374 Parameter of the stage search taken from the lead:
375 - type: stage type must be the same or 'both'
376 - section_id: if set, stages must belong to this section or
377 be a default stage; if not set, stages must be default
380 if isinstance(cases, (int, long)):
381 cases = self.browse(cr, uid, cases, context=context)
382 # collect all section_ids
386 type = context.get('default_type')
389 section_ids.append(section_id)
392 section_ids.append(lead.section_id.id)
393 if lead.type not in types:
394 types.append(lead.type)
395 # OR all section_ids and OR with case_default
398 search_domain += [('|')] * len(section_ids)
399 for section_id in section_ids:
400 search_domain.append(('section_ids', '=', section_id))
402 search_domain.append(('case_default', '=', True))
403 # AND with cases types
404 search_domain.append(('type', 'in', types))
405 # AND with the domain in parameter
406 search_domain += list(domain)
407 # perform search, return the first found
408 stage_ids = self.pool.get('crm.case.stage').search(cr, uid, search_domain, order=order, context=context)
413 def case_cancel(self, cr, uid, ids, context=None):
414 """ Overrides case_cancel from base_stage to set probability """
415 res = super(crm_lead, self).case_cancel(cr, uid, ids, context=context)
416 self.write(cr, uid, ids, {'probability' : 0.0}, context=context)
419 def case_reset(self, cr, uid, ids, context=None):
420 """ Overrides case_reset from base_stage to set probability """
421 res = super(crm_lead, self).case_reset(cr, uid, ids, context=context)
422 self.write(cr, uid, ids, {'probability': 0.0}, context=context)
425 def case_mark_lost(self, cr, uid, ids, context=None):
426 """ Mark the case as lost: state=cancel and probability=0 """
427 for lead in self.browse(cr, uid, ids):
428 stage_id = self.stage_find(cr, uid, [lead], lead.section_id.id or False, [('probability', '=', 0.0),('on_change','=',True)], context=context)
430 self.case_set(cr, uid, [lead.id], values_to_update={'probability': 0.0}, new_stage_id=stage_id, context=context)
433 def case_mark_won(self, cr, uid, ids, context=None):
434 """ Mark the case as won: state=done and probability=100 """
435 for lead in self.browse(cr, uid, ids):
436 stage_id = self.stage_find(cr, uid, [lead], lead.section_id.id or False, [('probability', '=', 100.0),('on_change','=',True)], context=context)
438 self.case_set(cr, uid, [lead.id], values_to_update={'probability': 100.0}, new_stage_id=stage_id, context=context)
441 def set_priority(self, cr, uid, ids, priority):
442 """ Set lead priority
444 return self.write(cr, uid, ids, {'priority' : priority})
446 def set_high_priority(self, cr, uid, ids, context=None):
447 """ Set lead priority to high
449 return self.set_priority(cr, uid, ids, '1')
451 def set_normal_priority(self, cr, uid, ids, context=None):
452 """ Set lead priority to normal
454 return self.set_priority(cr, uid, ids, '3')
456 def _merge_get_result_type(self, cr, uid, opps, context=None):
458 Define the type of the result of the merge. If at least one of the
459 element to merge is an opp, the resulting new element will be an opp.
460 Otherwise it will be a lead.
462 We'll directly use a list of browse records instead of a list of ids
463 for performances' sake: it will spare a second browse of the
466 :param list opps: list of browse records containing the leads/opps to process
467 :return string type: the type of the final element
470 if (opp.type == 'opportunity'):
475 def _merge_data(self, cr, uid, ids, oldest, fields, context=None):
477 Prepare lead/opp data into a dictionary for merging. Different types
478 of fields are processed in different ways:
479 - text: all the values are concatenated
480 - m2m and o2m: those fields aren't processed
481 - m2o: the first not null value prevails (the other are dropped)
482 - any other type of field: same as m2o
484 :param list ids: list of ids of the leads to process
485 :param list fields: list of leads' fields to process
486 :return dict data: contains the merged values
488 opportunities = self.browse(cr, uid, ids, context=context)
490 def _get_first_not_null(attr):
491 for opp in opportunities:
492 if hasattr(opp, attr) and bool(getattr(opp, attr)):
493 return getattr(opp, attr)
496 def _get_first_not_null_id(attr):
497 res = _get_first_not_null(attr)
498 return res and res.id or False
500 def _concat_all(attr):
501 return '\n\n'.join(filter(lambda x: x, [getattr(opp, attr) or '' for opp in opportunities if hasattr(opp, attr)]))
503 # Process the fields' values
505 for field_name in fields:
506 field_info = self._all_columns.get(field_name)
507 if field_info is None:
509 field = field_info.column
510 if field._type in ('many2many', 'one2many'):
512 elif field._type == 'many2one':
513 data[field_name] = _get_first_not_null_id(field_name) # !!
514 elif field._type == 'text':
515 data[field_name] = _concat_all(field_name) #not lost
517 data[field_name] = _get_first_not_null(field_name) #not lost
519 # Define the resulting type ('lead' or 'opportunity')
520 data['type'] = self._merge_get_result_type(cr, uid, opportunities, context)
523 def _mail_body(self, cr, uid, lead, fields, title=False, context=None):
526 body.append("%s\n" % (title))
528 for field_name in fields:
529 field_info = self._all_columns.get(field_name)
530 if field_info is None:
532 field = field_info.column
535 if field._type == 'selection':
536 if hasattr(field.selection, '__call__'):
537 key = field.selection(self, cr, uid, context=context)
539 key = field.selection
540 value = dict(key).get(lead[field_name], lead[field_name])
541 elif field._type == 'many2one':
543 value = lead[field_name].name_get()[0][1]
544 elif field._type == 'many2many':
546 for val in lead[field_name]:
547 field_value = val.name_get()[0][1]
548 value += field_value + ","
550 value = lead[field_name]
552 body.append("%s: %s" % (field.string, value or ''))
553 return "<br/>".join(body + ['<br/>'])
555 def _merge_notify(self, cr, uid, opportunity_id, opportunities, context=None):
557 Create a message gathering merged leads/opps information.
559 #TOFIX: mail template should be used instead of fix body, subject text
561 result_type = self._merge_get_result_type(cr, uid, opportunities, context)
562 if result_type == 'lead':
563 merge_message = _('Merged leads')
565 merge_message = _('Merged opportunities')
566 subject = [merge_message]
567 for opportunity in opportunities:
568 subject.append(opportunity.name)
569 title = "%s : %s" % (opportunity.type == 'opportunity' and _('Merged opportunity') or _('Merged lead'), opportunity.name)
570 fields = list(CRM_LEAD_FIELDS_TO_MERGE)
571 details.append(self._mail_body(cr, uid, opportunity, fields, title=title, context=context))
573 # Chatter message's subject
574 subject = subject[0] + ": " + ", ".join(subject[1:])
575 details = "\n\n".join(details)
576 return self.message_post(cr, uid, [opportunity_id], body=details, subject=subject, context=context)
578 def _merge_opportunity_history(self, cr, uid, opportunity_id, opportunities, context=None):
579 message = self.pool.get('mail.message')
580 for opportunity in opportunities:
581 for history in opportunity.message_ids:
582 message.write(cr, uid, history.id, {
583 'res_id': opportunity_id,
584 'subject' : _("From %s : %s") % (opportunity.name, history.subject)
589 def _merge_opportunity_attachments(self, cr, uid, opportunity_id, opportunities, context=None):
590 attach_obj = self.pool.get('ir.attachment')
592 # return attachments of opportunity
593 def _get_attachments(opportunity_id):
594 attachment_ids = attach_obj.search(cr, uid, [('res_model', '=', self._name), ('res_id', '=', opportunity_id)], context=context)
595 return attach_obj.browse(cr, uid, attachment_ids, context=context)
597 first_attachments = _get_attachments(opportunity_id)
598 #counter of all attachments to move. Used to make sure the name is different for all attachments
600 for opportunity in opportunities:
601 attachments = _get_attachments(opportunity.id)
602 for attachment in attachments:
603 values = {'res_id': opportunity_id,}
604 for attachment_in_first in first_attachments:
605 if attachment.name == attachment_in_first.name:
606 name = "%s (%s)" % (attachment.name, count,),
608 attachment.write(values)
611 def merge_opportunity(self, cr, uid, ids, context=None):
613 Different cases of merge:
614 - merge leads together = 1 new lead
615 - merge at least 1 opp with anything else (lead or opp) = 1 new opp
617 :param list ids: leads/opportunities ids to merge
618 :return int id: id of the resulting lead/opp
624 raise osv.except_osv(_('Warning!'), _('Please select more than one element (lead or opportunity) from the list view.'))
626 opportunities = self.browse(cr, uid, ids, context=context)
628 for opportunity in opportunities:
629 if opportunity.stage_id and opportunity.stage_id.state != 'cancel':
630 sequenced_opps.append((opportunity.stage_id.sequence, opportunity))
632 sequenced_opps.append((-1, opportunity))
633 sequenced_opps.sort(key=lambda tup: tup[0], reverse=True)
634 opportunities = [opportunity for sequence, opportunity in sequenced_opps]
635 ids = [opportunity.id for opportunity in opportunities]
636 highest = opportunities[0]
637 opportunities_rest = opportunities[1:]
639 tail_opportunities = opportunities_rest
641 fields = list(CRM_LEAD_FIELDS_TO_MERGE)
642 merged_data = self._merge_data(cr, uid, ids, highest, fields, context=context)
644 # Merge messages and attachements into the first opportunity
645 self._merge_opportunity_history(cr, uid, highest.id, tail_opportunities, context=context)
646 self._merge_opportunity_attachments(cr, uid, highest.id, tail_opportunities, context=context)
648 # Merge notifications about loss of information
649 opportunities = [highest]
650 opportunities.extend(opportunities_rest)
651 self._merge_notify(cr, uid, highest, opportunities, context=context)
652 # Check if the stage is in the stages of the sales team. If not, assign the stage with the lowest sequence
653 if merged_data.get('type') == 'opportunity' and merged_data.get('section_id'):
654 section_stages = self.pool.get('crm.case.section').read(cr, uid, merged_data['section_id'], ['stage_ids'], context=context)
655 if merged_data.get('stage_id') not in section_stages['stage_ids']:
656 stages_sequences = self.pool.get('crm.case.stage').search(cr, uid, [('id','in',section_stages['stage_ids'])], order='sequence', limit=1, context=context)
657 merged_data['stage_id'] = stages_sequences and stages_sequences[0] or False
658 # Write merged data into first opportunity
659 self.write(cr, uid, [highest.id], merged_data, context=context)
660 # Delete tail opportunities
661 self.unlink(cr, uid, [x.id for x in tail_opportunities], context=context)
665 def _convert_opportunity_data(self, cr, uid, lead, customer, section_id=False, context=None):
666 crm_stage = self.pool.get('crm.case.stage')
669 contact_id = self.pool.get('res.partner').address_get(cr, uid, [customer.id])['default']
671 section_id = lead.section_id and lead.section_id.id or False
673 'planned_revenue': lead.planned_revenue,
674 'probability': lead.probability,
676 'partner_id': customer and customer.id or False,
677 'user_id': (lead.user_id and lead.user_id.id),
678 'type': 'opportunity',
679 'date_action': fields.datetime.now(),
680 'date_open': fields.datetime.now(),
681 'email_from': customer and customer.email or lead.email_from,
682 'phone': customer and customer.phone or lead.phone,
684 if not lead.stage_id or lead.stage_id.type=='lead':
685 val['stage_id'] = self.stage_find(cr, uid, [lead], section_id, [('state', '=', 'draft'),('type', 'in', ('opportunity','both'))], context=context)
688 def convert_opportunity(self, cr, uid, ids, partner_id, user_ids=False, section_id=False, context=None):
691 partner = self.pool.get('res.partner')
692 customer = partner.browse(cr, uid, partner_id, context=context)
693 for lead in self.browse(cr, uid, ids, context=context):
694 if lead.state in ('done', 'cancel'):
696 vals = self._convert_opportunity_data(cr, uid, lead, customer, section_id, context=context)
697 self.write(cr, uid, [lead.id], vals, context=context)
698 self.message_post(cr, uid, ids, body=_("Lead <b>converted into an Opportunity</b>"), subtype="crm.mt_lead_convert_to_opportunity", context=context)
700 if user_ids or section_id:
701 self.allocate_salesman(cr, uid, ids, user_ids, section_id, context=context)
705 def _lead_create_contact(self, cr, uid, lead, name, is_company, parent_id=False, context=None):
706 partner = self.pool.get('res.partner')
707 vals = {'name': name,
708 'user_id': lead.user_id.id,
709 'comment': lead.description,
710 'section_id': lead.section_id.id or False,
711 'parent_id': parent_id,
713 'mobile': lead.mobile,
714 'email': lead.email_from and tools.email_split(lead.email_from)[0],
716 'title': lead.title and lead.title.id or False,
717 'function': lead.function,
718 'street': lead.street,
719 'street2': lead.street2,
722 'country_id': lead.country_id and lead.country_id.id or False,
723 'state_id': lead.state_id and lead.state_id.id or False,
724 'is_company': is_company,
727 partner = partner.create(cr, uid, vals, context=context)
730 def _create_lead_partner(self, cr, uid, lead, context=None):
732 if lead.partner_name and lead.contact_name:
733 partner_id = self._lead_create_contact(cr, uid, lead, lead.partner_name, True, context=context)
734 partner_id = self._lead_create_contact(cr, uid, lead, lead.contact_name, False, partner_id, context=context)
735 elif lead.partner_name and not lead.contact_name:
736 partner_id = self._lead_create_contact(cr, uid, lead, lead.partner_name, True, context=context)
737 elif not lead.partner_name and lead.contact_name:
738 partner_id = self._lead_create_contact(cr, uid, lead, lead.contact_name, False, context=context)
739 elif lead.email_from and self.pool.get('res.partner')._parse_partner_name(lead.email_from, context=context)[0]:
740 contact_name = self.pool.get('res.partner')._parse_partner_name(lead.email_from, context=context)[0]
741 partner_id = self._lead_create_contact(cr, uid, lead, contact_name, False, context=context)
743 raise osv.except_osv(
745 _('No customer name defined. Please fill one of the following fields: Company Name, Contact Name or Email ("Name <email@address>")')
749 def _lead_set_partner(self, cr, uid, lead, partner_id, context=None):
751 Assign a partner to a lead.
753 :param object lead: browse record of the lead to process
754 :param int partner_id: identifier of the partner to assign
755 :return bool: True if the partner has properly been assigned
758 res_partner = self.pool.get('res.partner')
760 res_partner.write(cr, uid, partner_id, {'section_id': lead.section_id and lead.section_id.id or False})
761 contact_id = res_partner.address_get(cr, uid, [partner_id])['default']
762 res = lead.write({'partner_id': partner_id}, context=context)
763 message = _("<b>Partner</b> set to <em>%s</em>." % (lead.partner_id.name))
764 self.message_post(cr, uid, [lead.id], body=message, context=context)
767 def handle_partner_assignation(self, cr, uid, ids, action='create', partner_id=False, context=None):
769 Handle partner assignation during a lead conversion.
770 if action is 'create', create new partner with contact and assign lead to new partner_id.
771 otherwise assign lead to the specified partner_id
773 :param list ids: leads/opportunities ids to process
774 :param string action: what has to be done regarding partners (create it, assign an existing one, or nothing)
775 :param int partner_id: partner to assign if any
776 :return dict: dictionary organized as followed: {lead_id: partner_assigned_id}
778 #TODO this is a duplication of the handle_partner_assignation method of crm_phonecall
780 # If a partner_id is given, force this partner for all elements
781 force_partner_id = partner_id
782 for lead in self.browse(cr, uid, ids, context=context):
783 # If the action is set to 'create' and no partner_id is set, create a new one
784 if action == 'create':
785 partner_id = force_partner_id or self._create_lead_partner(cr, uid, lead, context)
786 self._lead_set_partner(cr, uid, lead, partner_id, context=context)
787 partner_ids[lead.id] = partner_id
790 def allocate_salesman(self, cr, uid, ids, user_ids=None, team_id=False, context=None):
792 Assign salesmen and salesteam to a batch of leads. If there are more
793 leads than salesmen, these salesmen will be assigned in round-robin.
794 E.g.: 4 salesmen (S1, S2, S3, S4) for 6 leads (L1, L2, ... L6). They
795 will be assigned as followed: L1 - S1, L2 - S2, L3 - S3, L4 - S4,
798 :param list ids: leads/opportunities ids to process
799 :param list user_ids: salesmen to assign
800 :param int team_id: salesteam to assign
808 value['section_id'] = team_id
810 value['user_id'] = user_ids[index]
811 # Cycle through user_ids
812 index = (index + 1) % len(user_ids)
814 self.write(cr, uid, [lead_id], value, context=context)
817 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):
819 :param string action: ('schedule','Schedule a call'), ('log','Log a call')
821 phonecall = self.pool.get('crm.phonecall')
822 model_data = self.pool.get('ir.model.data')
825 res_id = model_data._get_id(cr, uid, 'crm', 'categ_phone2')
827 categ_id = model_data.browse(cr, uid, res_id, context=context).res_id
828 for lead in self.browse(cr, uid, ids, context=context):
830 section_id = lead.section_id and lead.section_id.id or False
832 user_id = lead.user_id and lead.user_id.id or False
834 'name': call_summary,
835 'opportunity_id': lead.id,
836 'user_id': user_id or False,
837 'categ_id': categ_id or False,
838 'description': desc or '',
839 'date': schedule_time,
840 'section_id': section_id or False,
841 'partner_id': lead.partner_id and lead.partner_id.id or False,
842 'partner_phone': phone or lead.phone or (lead.partner_id and lead.partner_id.phone or False),
843 'partner_mobile': lead.partner_id and lead.partner_id.mobile or False,
844 'priority': lead.priority,
846 new_id = phonecall.create(cr, uid, vals, context=context)
847 phonecall.case_open(cr, uid, [new_id], context=context)
849 phonecall.case_close(cr, uid, [new_id], context=context)
850 phonecall_dict[lead.id] = new_id
851 self.schedule_phonecall_send_note(cr, uid, [lead.id], new_id, action, context=context)
852 return phonecall_dict
854 def redirect_opportunity_view(self, cr, uid, opportunity_id, context=None):
855 models_data = self.pool.get('ir.model.data')
857 # Get opportunity views
858 dummy, form_view = models_data.get_object_reference(cr, uid, 'crm', 'crm_case_form_view_oppor')
859 dummy, tree_view = models_data.get_object_reference(cr, uid, 'crm', 'crm_case_tree_view_oppor')
861 'name': _('Opportunity'),
863 'view_mode': 'tree, form',
864 'res_model': 'crm.lead',
865 'domain': [('type', '=', 'opportunity')],
866 'res_id': int(opportunity_id),
868 'views': [(form_view or False, 'form'),
869 (tree_view or False, 'tree'),
870 (False, 'calendar'), (False, 'graph')],
871 'type': 'ir.actions.act_window',
874 def redirect_lead_view(self, cr, uid, lead_id, context=None):
875 models_data = self.pool.get('ir.model.data')
878 dummy, form_view = models_data.get_object_reference(cr, uid, 'crm', 'crm_case_form_view_leads')
879 dummy, tree_view = models_data.get_object_reference(cr, uid, 'crm', 'crm_case_tree_view_leads')
883 'view_mode': 'tree, form',
884 'res_model': 'crm.lead',
885 'domain': [('type', '=', 'lead')],
886 'res_id': int(lead_id),
888 'views': [(form_view or False, 'form'),
889 (tree_view or False, 'tree'),
890 (False, 'calendar'), (False, 'graph')],
891 'type': 'ir.actions.act_window',
894 def action_makeMeeting(self, cr, uid, ids, context=None):
896 Open meeting's calendar view to schedule meeting on current opportunity.
897 :return dict: dictionary value for created Meeting view
899 opportunity = self.browse(cr, uid, ids[0], context)
900 res = self.pool.get('ir.actions.act_window').for_xml_id(cr, uid, 'base_calendar', 'action_crm_meeting', context)
902 'default_opportunity_id': opportunity.id,
903 'default_partner_id': opportunity.partner_id and opportunity.partner_id.id or False,
904 'default_partner_ids' : opportunity.partner_id and [opportunity.partner_id.id] or False,
905 'default_user_id': uid,
906 'default_section_id': opportunity.section_id and opportunity.section_id.id or False,
907 'default_email_from': opportunity.email_from,
908 'default_name': opportunity.name,
912 def write(self, cr, uid, ids, vals, context=None):
913 if vals.get('stage_id') and not vals.get('probability'):
914 # change probability of lead(s) if required by stage
915 stage = self.pool.get('crm.case.stage').browse(cr, uid, vals['stage_id'], context=context)
917 vals['probability'] = stage.probability
918 return super(crm_lead, self).write(cr, uid, ids, vals, context=context)
920 def new_mail_send(self, cr, uid, ids, context=None):
922 This function opens a window to compose an email, with the edi sale template message loaded by default
924 assert len(ids) == 1, 'This option should only be used for a single id at a time.'
925 ir_model_data = self.pool.get('ir.model.data')
927 template_id = ir_model_data.get_object_reference(cr, uid, 'crm', 'email_template_opportunity_mail')[1]
931 compose_form_id = ir_model_data.get_object_reference(cr, uid, 'mail', 'email_compose_message_wizard_form')[1]
933 compose_form_id = False
938 'default_model': 'crm.lead',
939 'default_res_id': ids[0],
940 'default_use_template': bool(template_id),
941 'default_template_id': template_id,
942 'default_composition_mode': 'comment',
945 'type': 'ir.actions.act_window',
948 'res_model': 'mail.compose.message',
949 'views': [(compose_form_id, 'form')],
950 'view_id': compose_form_id,
955 # ----------------------------------------
957 # ----------------------------------------
959 def message_get_reply_to(self, cr, uid, ids, context=None):
960 """ Override to get the reply_to of the parent project. """
961 return [lead.section_id.message_get_reply_to()[0] if lead.section_id else False
962 for lead in self.browse(cr, uid, ids, context=context)]
964 def message_get_suggested_recipients(self, cr, uid, ids, context=None):
965 recipients = super(crm_lead, self).message_get_suggested_recipients(cr, uid, ids, context=context)
966 for lead in self.browse(cr, uid, ids, context=context):
968 self._message_add_suggested_recipient(recipients, lead, partner=lead.partner_id, reason=_('Customer'))
970 self._message_add_suggested_recipient(recipients, lead, email=lead.email_from, reason=_('Customer Email'))
973 def message_new(self, cr, uid, msg, custom_values=None, context=None):
974 """ Overrides mail_thread message_new that is called by the mailgateway
975 through message_process.
976 This override updates the document according to the email.
978 if custom_values is None: custom_values = {}
980 desc = html2plaintext(msg.get('body')) if msg.get('body') else ''
982 'name': msg.get('subject') or _("No Subject"),
984 'email_from': msg.get('from'),
985 'email_cc': msg.get('cc'),
986 'partner_id': msg.get('author_id', False),
989 if msg.get('author_id'):
990 defaults.update(self.on_change_partner(cr, uid, None, msg.get('author_id'), context=context)['value'])
991 if msg.get('priority') in dict(crm.AVAILABLE_PRIORITIES):
992 defaults['priority'] = msg.get('priority')
993 defaults.update(custom_values)
994 return super(crm_lead, self).message_new(cr, uid, msg, custom_values=defaults, context=context)
996 def message_update(self, cr, uid, ids, msg, update_vals=None, context=None):
997 """ Overrides mail_thread message_update that is called by the mailgateway
998 through message_process.
999 This method updates the document according to the email.
1001 if isinstance(ids, (str, int, long)):
1003 if update_vals is None: update_vals = {}
1005 if msg.get('priority') in dict(crm.AVAILABLE_PRIORITIES):
1006 update_vals['priority'] = msg.get('priority')
1008 'cost':'planned_cost',
1009 'revenue': 'planned_revenue',
1010 'probability':'probability',
1012 for line in msg.get('body', '').split('\n'):
1014 res = tools.command_re.match(line)
1015 if res and maps.get(res.group(1).lower()):
1016 key = maps.get(res.group(1).lower())
1017 update_vals[key] = res.group(2).lower()
1019 return super(crm_lead, self).message_update(cr, uid, ids, msg, update_vals=update_vals, context=context)
1021 # ----------------------------------------
1022 # OpenChatter methods and notifications
1023 # ----------------------------------------
1025 def schedule_phonecall_send_note(self, cr, uid, ids, phonecall_id, action, context=None):
1026 phonecall = self.pool.get('crm.phonecall').browse(cr, uid, [phonecall_id], context=context)[0]
1027 if action == 'log': prefix = 'Logged'
1028 else: prefix = 'Scheduled'
1029 message = _("<b>%s a call</b> for the <em>%s</em>.") % (prefix, phonecall.date)
1030 return self.message_post(cr, uid, ids, body=message, context=context)
1032 def onchange_state(self, cr, uid, ids, state_id, context=None):
1034 country_id=self.pool.get('res.country.state').browse(cr, uid, state_id, context).country_id.id
1035 return {'value':{'country_id':country_id}}
1038 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: