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',
65 CRM_LEAD_PENDING_STATES = (
66 crm.AVAILABLE_STATES[2][0], # Cancelled
67 crm.AVAILABLE_STATES[3][0], # Done
68 crm.AVAILABLE_STATES[4][0], # Pending
71 class crm_lead(base_stage, format_address, osv.osv):
74 _description = "Lead/Opportunity"
75 _order = "priority,date_action,id desc"
76 _inherit = ['mail.thread', 'ir.needaction_mixin']
80 'crm.mt_lead_create': lambda self, cr, uid, obj, ctx=None: obj['state'] == 'new',
81 'crm.mt_lead_won': lambda self, cr, uid, obj, ctx=None: obj['state'] == 'done',
82 'crm.mt_lead_lost': lambda self, cr, uid, obj, ctx=None: obj['state'] == 'cancel',
85 'crm.mt_lead_stage': lambda self, cr, uid, obj, ctx=None: obj['state'] not in ['new', 'cancel', 'done'],
89 def get_empty_list_help(self, cr, uid, help, context=None):
90 if context.get('default_type') == 'lead':
91 context['empty_list_help_model'] = 'crm.case.section'
92 context['empty_list_help_id'] = context.get('default_section_id')
93 context['empty_list_help_document_name'] = _("leads")
94 return super(crm_lead, self).get_empty_list_help(cr, uid, help, context=context)
96 def create(self, cr, uid, vals, context=None):
99 if not vals.get('stage_id'):
101 if vals.get('section_id'):
102 ctx['default_section_id'] = vals['section_id']
104 ctx['default_type'] = vals['type']
105 vals['stage_id'] = self._get_default_stage_id(cr, uid, context=ctx)
106 return super(crm_lead, self).create(cr, uid, vals, context=context)
108 def _get_default_section_id(self, cr, uid, context=None):
109 """ Gives default section by checking if present in the context """
110 return self._resolve_section_id_from_context(cr, uid, context=context) or False
112 def _get_default_stage_id(self, cr, uid, context=None):
113 """ Gives default stage_id """
114 section_id = self._get_default_section_id(cr, uid, context=context)
115 return self.stage_find(cr, uid, [], section_id, [('state', '=', 'draft')], context=context)
117 def _resolve_section_id_from_context(self, cr, uid, context=None):
118 """ Returns ID of section based on the value of 'section_id'
119 context key, or None if it cannot be resolved to a single
124 if type(context.get('default_section_id')) in (int, long):
125 return context.get('default_section_id')
126 if isinstance(context.get('default_section_id'), basestring):
127 section_name = context['default_section_id']
128 section_ids = self.pool.get('crm.case.section').name_search(cr, uid, name=section_name, context=context)
129 if len(section_ids) == 1:
130 return int(section_ids[0][0])
133 def _resolve_type_from_context(self, cr, uid, context=None):
134 """ Returns the type (lead or opportunity) from the type context
135 key. Returns None if it cannot be resolved.
139 return context.get('default_type')
141 def _read_group_stage_ids(self, cr, uid, ids, domain, read_group_order=None, access_rights_uid=None, context=None):
142 access_rights_uid = access_rights_uid or uid
143 stage_obj = self.pool.get('crm.case.stage')
144 order = stage_obj._order
145 # lame hack to allow reverting search, should just work in the trivial case
146 if read_group_order == 'stage_id desc':
147 order = "%s desc" % order
148 # retrieve section_id from the context and write the domain
149 # - ('id', 'in', 'ids'): add columns that should be present
150 # - OR ('case_default', '=', True), ('fold', '=', False): add default columns that are not folded
151 # - OR ('section_ids', '=', section_id), ('fold', '=', False) if section_id: add section columns that are not folded
153 section_id = self._resolve_section_id_from_context(cr, uid, context=context)
155 search_domain += ['|', ('section_ids', '=', section_id)]
156 search_domain += [('id', 'in', ids)]
158 search_domain += ['|', ('id', 'in', ids), ('case_default', '=', True)]
159 # retrieve type from the context (if set: choose 'type' or 'both')
160 type = self._resolve_type_from_context(cr, uid, context=context)
162 search_domain += ['|', ('type', '=', type), ('type', '=', 'both')]
164 stage_ids = stage_obj._search(cr, uid, search_domain, order=order, access_rights_uid=access_rights_uid, context=context)
165 result = stage_obj.name_get(cr, access_rights_uid, stage_ids, context=context)
166 # restore order of the search
167 result.sort(lambda x,y: cmp(stage_ids.index(x[0]), stage_ids.index(y[0])))
170 for stage in stage_obj.browse(cr, access_rights_uid, stage_ids, context=context):
171 fold[stage.id] = stage.fold or False
174 def fields_view_get(self, cr, user, view_id=None, view_type='form', context=None, toolbar=False, submenu=False):
175 res = super(crm_lead,self).fields_view_get(cr, user, view_id, view_type, context, toolbar=toolbar, submenu=submenu)
176 if view_type == 'form':
177 res['arch'] = self.fields_view_get_address(cr, user, res['arch'], context=context)
181 'stage_id': _read_group_stage_ids
184 def _compute_day(self, cr, uid, ids, fields, args, context=None):
186 :return dict: difference between current date and log date
188 cal_obj = self.pool.get('resource.calendar')
189 res_obj = self.pool.get('resource.resource')
192 for lead in self.browse(cr, uid, ids, context=context):
197 if field == 'day_open':
199 date_create = datetime.strptime(lead.create_date, "%Y-%m-%d %H:%M:%S")
200 date_open = datetime.strptime(lead.date_open, "%Y-%m-%d %H:%M:%S")
201 ans = date_open - date_create
202 date_until = lead.date_open
203 elif field == 'day_close':
205 date_create = datetime.strptime(lead.create_date, "%Y-%m-%d %H:%M:%S")
206 date_close = datetime.strptime(lead.date_closed, "%Y-%m-%d %H:%M:%S")
207 date_until = lead.date_closed
208 ans = date_close - date_create
212 resource_ids = res_obj.search(cr, uid, [('user_id','=',lead.user_id.id)])
213 if len(resource_ids):
214 resource_id = resource_ids[0]
216 duration = float(ans.days)
217 if lead.section_id and lead.section_id.resource_calendar_id:
218 duration = float(ans.days) * 24
219 new_dates = cal_obj.interval_get(cr,
221 lead.section_id.resource_calendar_id and lead.section_id.resource_calendar_id.id or False,
222 datetime.strptime(lead.create_date, '%Y-%m-%d %H:%M:%S'),
227 date_until = datetime.strptime(date_until, '%Y-%m-%d %H:%M:%S')
228 for in_time, out_time in new_dates:
229 if in_time.date not in no_days:
230 no_days.append(in_time.date)
231 if out_time > date_until:
233 duration = len(no_days)
234 res[lead.id][field] = abs(int(duration))
237 def _history_search(self, cr, uid, obj, name, args, context=None):
239 msg_obj = self.pool.get('mail.message')
240 message_ids = msg_obj.search(cr, uid, [('email_from','!=',False), ('subject', args[0][1], args[0][2])], context=context)
241 lead_ids = self.search(cr, uid, [('message_ids', 'in', message_ids)], context=context)
244 return [('id', 'in', lead_ids)]
246 return [('id', '=', '0')]
249 'partner_id': fields.many2one('res.partner', 'Partner', ondelete='set null', track_visibility='onchange',
250 select=True, help="Linked partner (optional). Usually created when converting the lead."),
252 'id': fields.integer('ID', readonly=True),
253 'name': fields.char('Subject', size=64, required=True, select=1),
254 'active': fields.boolean('Active', required=False),
255 'date_action_last': fields.datetime('Last Action', readonly=1),
256 'date_action_next': fields.datetime('Next Action', readonly=1),
257 'email_from': fields.char('Email', size=128, help="Email address of the contact", select=1),
258 'section_id': fields.many2one('crm.case.section', 'Sales Team',
259 select=True, track_visibility='onchange', help='When sending mails, the default email address is taken from the sales team.'),
260 'create_date': fields.datetime('Creation Date' , readonly=True),
261 '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"),
262 'description': fields.text('Notes'),
263 'write_date': fields.datetime('Update Date' , readonly=True),
264 'categ_ids': fields.many2many('crm.case.categ', 'crm_lead_category_rel', 'lead_id', 'category_id', 'Categories', \
265 domain="['|',('section_id','=',section_id),('section_id','=',False), ('object_id.model', '=', 'crm.lead')]"),
266 'type_id': fields.many2one('crm.case.resource.type', 'Campaign', \
267 domain="['|',('section_id','=',section_id),('section_id','=',False)]", help="From which campaign (seminar, marketing campaign, mass mailing, ...) did this contact come from?"),
268 'channel_id': fields.many2one('crm.case.channel', 'Channel', help="Communication channel (mail, direct, phone, ...)"),
269 'contact_name': fields.char('Contact Name', size=64),
270 '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),
271 'opt_out': fields.boolean('Opt-Out', oldname='optout',
272 help="If opt-out is checked, this contact has refused to receive emails for mass mailing and marketing campaign. "
273 "Filter 'Available for Mass Mailing' allows users to filter the leads when performing mass mailing."),
274 'type':fields.selection([ ('lead','Lead'), ('opportunity','Opportunity'), ],'Type', help="Type is used to separate Leads and Opportunities"),
275 'priority': fields.selection(crm.AVAILABLE_PRIORITIES, 'Priority', select=True),
276 'date_closed': fields.datetime('Closed', readonly=True),
277 'stage_id': fields.many2one('crm.case.stage', 'Stage', track_visibility='onchange',
278 domain="['&', ('section_ids', '=', section_id), '|', ('type', '=', type), ('type', '=', 'both')]"),
279 'user_id': fields.many2one('res.users', 'Salesperson', select=True, track_visibility='onchange'),
280 'referred': fields.char('Referred By', size=64),
281 'date_open': fields.datetime('Opened', readonly=True),
282 'day_open': fields.function(_compute_day, string='Days to Open', \
283 multi='day_open', type="float", store=True),
284 'day_close': fields.function(_compute_day, string='Days to Close', \
285 multi='day_close', type="float", store=True),
286 'state': fields.related('stage_id', 'state', type="selection", store=True,
287 selection=crm.AVAILABLE_STATES, string="Status", readonly=True,
288 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\'.'),
290 # Only used for type opportunity
291 'probability': fields.float('Success Rate (%)',group_operator="avg"),
292 'planned_revenue': fields.float('Expected Revenue', track_visibility='always'),
293 'ref': fields.reference('Reference', selection=crm._links_get, size=128),
294 'ref2': fields.reference('Reference 2', selection=crm._links_get, size=128),
295 'phone': fields.char("Phone", size=64),
296 'date_deadline': fields.date('Expected Closing', help="Estimate of the date on which the opportunity will be won."),
297 'date_action': fields.date('Next Action Date', select=True),
298 'title_action': fields.char('Next Action', size=64),
299 'color': fields.integer('Color Index'),
300 'partner_address_name': fields.related('partner_id', 'name', type='char', string='Partner Contact Name', readonly=True),
301 'partner_address_email': fields.related('partner_id', 'email', type='char', string='Partner Contact Email', readonly=True),
302 'company_currency': fields.related('company_id', 'currency_id', type='many2one', string='Currency', readonly=True, relation="res.currency"),
303 'user_email': fields.related('user_id', 'email', type='char', string='User Email', readonly=True),
304 'user_login': fields.related('user_id', 'login', type='char', string='User Login', readonly=True),
306 # Fields for address, due to separation from crm and res.partner
307 'street': fields.char('Street', size=128),
308 'street2': fields.char('Street2', size=128),
309 'zip': fields.char('Zip', change_default=True, size=24),
310 'city': fields.char('City', size=128),
311 'state_id': fields.many2one("res.country.state", 'State'),
312 'country_id': fields.many2one('res.country', 'Country'),
313 'phone': fields.char('Phone', size=64),
314 'fax': fields.char('Fax', size=64),
315 'mobile': fields.char('Mobile', size=64),
316 'function': fields.char('Function', size=128),
317 'title': fields.many2one('res.partner.title', 'Title'),
318 'company_id': fields.many2one('res.company', 'Company', select=1),
319 'payment_mode': fields.many2one('crm.payment.mode', 'Payment Mode', \
320 domain="[('section_id','=',section_id)]"),
321 'planned_cost': fields.float('Planned Costs'),
327 'user_id': lambda s, cr, uid, c: s._get_default_user(cr, uid, c),
328 'email_from': lambda s, cr, uid, c: s._get_default_email(cr, uid, c),
329 'stage_id': lambda s, cr, uid, c: s._get_default_stage_id(cr, uid, c),
330 'section_id': lambda s, cr, uid, c: s._get_default_section_id(cr, uid, c),
331 'company_id': lambda s, cr, uid, c: s.pool.get('res.company')._company_default_get(cr, uid, 'crm.lead', context=c),
332 'priority': lambda *a: crm.AVAILABLE_PRIORITIES[2][0],
337 ('check_probability', 'check(probability >= 0 and probability <= 100)', 'The probability of closing the deal should be between 0% and 100%!')
340 def onchange_stage_id(self, cr, uid, ids, stage_id, context=None):
343 stage = self.pool.get('crm.case.stage').browse(cr, uid, stage_id, context)
344 if not stage.on_change:
346 return {'value':{'probability': stage.probability}}
348 def on_change_partner(self, cr, uid, ids, partner_id, context=None):
352 partner = self.pool.get('res.partner').browse(cr, uid, partner_id, context=context)
354 'partner_name' : partner.name,
355 'street' : partner.street,
356 'street2' : partner.street2,
357 'city' : partner.city,
358 'state_id' : partner.state_id and partner.state_id.id or False,
359 'country_id' : partner.country_id and partner.country_id.id or False,
360 'email_from' : partner.email,
361 'phone' : partner.phone,
362 'mobile' : partner.mobile,
365 return {'value' : values}
367 def on_change_user(self, cr, uid, ids, user_id, context=None):
368 """ When changing the user, also set a section_id or restrict section id
369 to the ones user_id is member of. """
372 section_ids = self.pool.get('crm.case.section').search(cr, uid, ['|', ('user_id', '=', user_id), ('member_ids', '=', user_id)], context=context)
374 section_id = section_ids[0]
375 return {'value': {'section_id': section_id}}
377 def _check(self, cr, uid, ids=False, context=None):
378 """ Override of the base.stage method.
379 Function called by the scheduler to process cases for date actions
380 Only works on not done and cancelled cases
382 cr.execute('select * from crm_case \
383 where (date_action_last<%s or date_action_last is null) \
384 and (date_action_next<=%s or date_action_next is null) \
385 and state not in (\'cancel\',\'done\')',
386 (time.strftime("%Y-%m-%d %H:%M:%S"),
387 time.strftime('%Y-%m-%d %H:%M:%S')))
389 ids2 = map(lambda x: x[0], cr.fetchall() or [])
390 cases = self.browse(cr, uid, ids2, context=context)
391 return self._action(cr, uid, cases, False, context=context)
393 def stage_find(self, cr, uid, cases, section_id, domain=None, order='sequence', context=None):
394 """ Override of the base.stage method
395 Parameter of the stage search taken from the lead:
396 - type: stage type must be the same or 'both'
397 - section_id: if set, stages must belong to this section or
398 be a default stage; if not set, stages must be default
401 if isinstance(cases, (int, long)):
402 cases = self.browse(cr, uid, cases, context=context)
403 # collect all section_ids
407 type = context.get('default_type')
410 section_ids.append(section_id)
413 section_ids.append(lead.section_id.id)
414 if lead.type not in types:
415 types.append(lead.type)
416 # OR all section_ids and OR with case_default
419 search_domain += [('|')] * len(section_ids)
420 for section_id in section_ids:
421 search_domain.append(('section_ids', '=', section_id))
423 search_domain.append(('case_default', '=', True))
424 # AND with cases types
425 search_domain.append(('type', 'in', types))
426 # AND with the domain in parameter
427 search_domain += list(domain)
428 # perform search, return the first found
429 stage_ids = self.pool.get('crm.case.stage').search(cr, uid, search_domain, order=order, context=context)
434 def case_cancel(self, cr, uid, ids, context=None):
435 """ Overrides case_cancel from base_stage to set probability """
436 res = super(crm_lead, self).case_cancel(cr, uid, ids, context=context)
437 self.write(cr, uid, ids, {'probability' : 0.0}, context=context)
440 def case_reset(self, cr, uid, ids, context=None):
441 """ Overrides case_reset from base_stage to set probability """
442 res = super(crm_lead, self).case_reset(cr, uid, ids, context=context)
443 self.write(cr, uid, ids, {'probability': 0.0}, context=context)
446 def case_mark_lost(self, cr, uid, ids, context=None):
447 """ Mark the case as lost: state=cancel and probability=0 """
448 for lead in self.browse(cr, uid, ids):
449 stage_id = self.stage_find(cr, uid, [lead], lead.section_id.id or False, [('probability', '=', 0.0),('on_change','=',True)], context=context)
451 self.case_set(cr, uid, [lead.id], values_to_update={'probability': 0.0}, new_stage_id=stage_id, context=context)
454 def case_mark_won(self, cr, uid, ids, context=None):
455 """ Mark the case as won: state=done and probability=100 """
456 for lead in self.browse(cr, uid, ids):
457 stage_id = self.stage_find(cr, uid, [lead], lead.section_id.id or False, [('probability', '=', 100.0),('on_change','=',True)], context=context)
459 self.case_set(cr, uid, [lead.id], values_to_update={'probability': 100.0}, new_stage_id=stage_id, context=context)
462 def set_priority(self, cr, uid, ids, priority):
463 """ Set lead priority
465 return self.write(cr, uid, ids, {'priority' : priority})
467 def set_high_priority(self, cr, uid, ids, context=None):
468 """ Set lead priority to high
470 return self.set_priority(cr, uid, ids, '1')
472 def set_normal_priority(self, cr, uid, ids, context=None):
473 """ Set lead priority to normal
475 return self.set_priority(cr, uid, ids, '3')
477 def _merge_get_result_type(self, cr, uid, opps, context=None):
479 Define the type of the result of the merge. If at least one of the
480 element to merge is an opp, the resulting new element will be an opp.
481 Otherwise it will be a lead.
483 We'll directly use a list of browse records instead of a list of ids
484 for performances' sake: it will spare a second browse of the
487 :param list opps: list of browse records containing the leads/opps to process
488 :return string type: the type of the final element
491 if (opp.type == 'opportunity'):
496 def _merge_data(self, cr, uid, ids, oldest, fields, context=None):
498 Prepare lead/opp data into a dictionary for merging. Different types
499 of fields are processed in different ways:
500 - text: all the values are concatenated
501 - m2m and o2m: those fields aren't processed
502 - m2o: the first not null value prevails (the other are dropped)
503 - any other type of field: same as m2o
505 :param list ids: list of ids of the leads to process
506 :param list fields: list of leads' fields to process
507 :return dict data: contains the merged values
509 opportunities = self.browse(cr, uid, ids, context=context)
511 def _get_first_not_null(attr):
512 for opp in opportunities:
513 if hasattr(opp, attr) and bool(getattr(opp, attr)):
514 return getattr(opp, attr)
517 def _get_first_not_null_id(attr):
518 res = _get_first_not_null(attr)
519 return res and res.id or False
521 def _concat_all(attr):
522 return '\n\n'.join(filter(lambda x: x, [getattr(opp, attr) or '' for opp in opportunities if hasattr(opp, attr)]))
524 # Process the fields' values
526 for field_name in fields:
527 field_info = self._all_columns.get(field_name)
528 if field_info is None:
530 field = field_info.column
531 if field._type in ('many2many', 'one2many'):
533 elif field._type == 'many2one':
534 data[field_name] = _get_first_not_null_id(field_name) # !!
535 elif field._type == 'text':
536 data[field_name] = _concat_all(field_name) #not lost
538 data[field_name] = _get_first_not_null(field_name) #not lost
540 # Define the resulting type ('lead' or 'opportunity')
541 data['type'] = self._merge_get_result_type(cr, uid, opportunities, context)
544 def _mail_body(self, cr, uid, lead, fields, title=False, context=None):
547 body.append("%s\n" % (title))
549 for field_name in fields:
550 field_info = self._all_columns.get(field_name)
551 if field_info is None:
553 field = field_info.column
556 if field._type == 'selection':
557 if hasattr(field.selection, '__call__'):
558 key = field.selection(self, cr, uid, context=context)
560 key = field.selection
561 value = dict(key).get(lead[field_name], lead[field_name])
562 elif field._type == 'many2one':
564 value = lead[field_name].name_get()[0][1]
565 elif field._type == 'many2many':
567 for val in lead[field_name]:
568 field_value = val.name_get()[0][1]
569 value += field_value + ","
571 value = lead[field_name]
573 body.append("%s: %s" % (field.string, value or ''))
574 return "<br/>".join(body + ['<br/>'])
576 def _merge_notify(self, cr, uid, opportunity_id, opportunities, context=None):
578 Create a message gathering merged leads/opps information.
580 #TOFIX: mail template should be used instead of fix body, subject text
582 result_type = self._merge_get_result_type(cr, uid, opportunities, context)
583 if result_type == 'lead':
584 merge_message = _('Merged leads')
586 merge_message = _('Merged opportunities')
587 subject = [merge_message]
588 for opportunity in opportunities:
589 subject.append(opportunity.name)
590 title = "%s : %s" % (opportunity.type == 'opportunity' and _('Merged opportunity') or _('Merged lead'), opportunity.name)
591 fields = list(CRM_LEAD_FIELDS_TO_MERGE)
592 details.append(self._mail_body(cr, uid, opportunity, fields, title=title, context=context))
594 # Chatter message's subject
595 subject = subject[0] + ": " + ", ".join(subject[1:])
596 details = "\n\n".join(details)
597 return self.message_post(cr, uid, [opportunity_id], body=details, subject=subject, context=context)
599 def _merge_opportunity_history(self, cr, uid, opportunity_id, opportunities, context=None):
600 message = self.pool.get('mail.message')
601 for opportunity in opportunities:
602 for history in opportunity.message_ids:
603 message.write(cr, uid, history.id, {
604 'res_id': opportunity_id,
605 'subject' : _("From %s : %s") % (opportunity.name, history.subject)
610 def _merge_opportunity_attachments(self, cr, uid, opportunity_id, opportunities, context=None):
611 attach_obj = self.pool.get('ir.attachment')
613 # return attachments of opportunity
614 def _get_attachments(opportunity_id):
615 attachment_ids = attach_obj.search(cr, uid, [('res_model', '=', self._name), ('res_id', '=', opportunity_id)], context=context)
616 return attach_obj.browse(cr, uid, attachment_ids, context=context)
618 first_attachments = _get_attachments(opportunity_id)
619 #counter of all attachments to move. Used to make sure the name is different for all attachments
621 for opportunity in opportunities:
622 attachments = _get_attachments(opportunity.id)
623 for attachment in attachments:
624 values = {'res_id': opportunity_id,}
625 for attachment_in_first in first_attachments:
626 if attachment.name == attachment_in_first.name:
627 name = "%s (%s)" % (attachment.name, count,),
629 attachment.write(values)
632 def merge_opportunity(self, cr, uid, ids, context=None):
634 Different cases of merge:
635 - merge leads together = 1 new lead
636 - merge at least 1 opp with anything else (lead or opp) = 1 new opp
638 :param list ids: leads/opportunities ids to merge
639 :return int id: id of the resulting lead/opp
645 raise osv.except_osv(_('Warning!'), _('Please select more than one element (lead or opportunity) from the list view.'))
647 opportunities = self.browse(cr, uid, ids, context=context)
649 for opportunity in opportunities:
651 if opportunity.stage_id and opportunity.stage_id.state != 'cancel':
652 sequence = opportunity.stage_id.sequence
653 sequenced_opps.append(((int(sequence != -1 and opportunity.type == 'opportunity'), sequence, -opportunity.id), opportunity))
655 sequenced_opps.sort(reverse=True)
656 opportunities = map(itemgetter(1), sequenced_opps)
657 ids = [opportunity.id for opportunity in opportunities]
658 highest = opportunities[0]
659 opportunities_rest = opportunities[1:]
661 tail_opportunities = opportunities_rest
663 fields = list(CRM_LEAD_FIELDS_TO_MERGE)
664 merged_data = self._merge_data(cr, uid, ids, highest, fields, context=context)
666 # Merge messages and attachements into the first opportunity
667 self._merge_opportunity_history(cr, uid, highest.id, tail_opportunities, context=context)
668 self._merge_opportunity_attachments(cr, uid, highest.id, tail_opportunities, context=context)
670 # Merge notifications about loss of information
671 opportunities = [highest]
672 opportunities.extend(opportunities_rest)
673 self._merge_notify(cr, uid, highest, opportunities, context=context)
674 # Check if the stage is in the stages of the sales team. If not, assign the stage with the lowest sequence
675 if merged_data.get('section_id'):
676 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)
677 if merged_data.get('stage_id') not in section_stage_ids:
678 merged_data['stage_id'] = section_stage_ids and section_stage_ids[0] or False
679 # Write merged data into first opportunity
680 self.write(cr, uid, [highest.id], merged_data, context=context)
681 # Delete tail opportunities
682 self.unlink(cr, uid, [x.id for x in tail_opportunities], context=context)
686 def _convert_opportunity_data(self, cr, uid, lead, customer, section_id=False, context=None):
687 crm_stage = self.pool.get('crm.case.stage')
690 contact_id = self.pool.get('res.partner').address_get(cr, uid, [customer.id])['default']
692 section_id = lead.section_id and lead.section_id.id or False
694 'planned_revenue': lead.planned_revenue,
695 'probability': lead.probability,
697 'partner_id': customer and customer.id or False,
698 'user_id': (lead.user_id and lead.user_id.id),
699 'type': 'opportunity',
700 'date_action': fields.datetime.now(),
701 'date_open': fields.datetime.now(),
702 'email_from': customer and customer.email or lead.email_from,
703 'phone': customer and customer.phone or lead.phone,
705 if not lead.stage_id or lead.stage_id.type=='lead':
706 val['stage_id'] = self.stage_find(cr, uid, [lead], section_id, [('state', '=', 'draft'),('type', 'in', ('opportunity','both'))], context=context)
709 def convert_opportunity(self, cr, uid, ids, partner_id, user_ids=False, section_id=False, context=None):
712 partner = self.pool.get('res.partner')
713 customer = partner.browse(cr, uid, partner_id, context=context)
714 for lead in self.browse(cr, uid, ids, context=context):
715 if lead.state in ('done', 'cancel'):
717 vals = self._convert_opportunity_data(cr, uid, lead, customer, section_id, context=context)
718 self.write(cr, uid, [lead.id], vals, context=context)
719 self.message_post(cr, uid, ids, body=_("Lead <b>converted into an Opportunity</b>"), subtype="crm.mt_lead_convert_to_opportunity", context=context)
721 if user_ids or section_id:
722 self.allocate_salesman(cr, uid, ids, user_ids, section_id, context=context)
726 def _lead_create_contact(self, cr, uid, lead, name, is_company, parent_id=False, context=None):
727 partner = self.pool.get('res.partner')
728 vals = {'name': name,
729 'user_id': lead.user_id.id,
730 'comment': lead.description,
731 'section_id': lead.section_id.id or False,
732 'parent_id': parent_id,
734 'mobile': lead.mobile,
735 'email': tools.email_split(lead.email_from) and tools.email_split(lead.email_from)[0] or False,
737 'title': lead.title and lead.title.id or False,
738 'function': lead.function,
739 'street': lead.street,
740 'street2': lead.street2,
743 'country_id': lead.country_id and lead.country_id.id or False,
744 'state_id': lead.state_id and lead.state_id.id or False,
745 'is_company': is_company,
748 partner = partner.create(cr, uid, vals, context=context)
751 def _create_lead_partner(self, cr, uid, lead, context=None):
753 if lead.partner_name and lead.contact_name:
754 partner_id = self._lead_create_contact(cr, uid, lead, lead.partner_name, True, context=context)
755 partner_id = self._lead_create_contact(cr, uid, lead, lead.contact_name, False, partner_id, context=context)
756 elif lead.partner_name and not lead.contact_name:
757 partner_id = self._lead_create_contact(cr, uid, lead, lead.partner_name, True, context=context)
758 elif not lead.partner_name and lead.contact_name:
759 partner_id = self._lead_create_contact(cr, uid, lead, lead.contact_name, False, context=context)
760 elif lead.email_from and self.pool.get('res.partner')._parse_partner_name(lead.email_from, context=context)[0]:
761 contact_name = self.pool.get('res.partner')._parse_partner_name(lead.email_from, context=context)[0]
762 partner_id = self._lead_create_contact(cr, uid, lead, contact_name, False, context=context)
764 raise osv.except_osv(
766 _('No customer name defined. Please fill one of the following fields: Company Name, Contact Name or Email ("Name <email@address>")')
770 def _lead_set_partner(self, cr, uid, lead, partner_id, context=None):
772 Assign a partner to a lead.
774 :param object lead: browse record of the lead to process
775 :param int partner_id: identifier of the partner to assign
776 :return bool: True if the partner has properly been assigned
779 res_partner = self.pool.get('res.partner')
781 res_partner.write(cr, uid, partner_id, {'section_id': lead.section_id and lead.section_id.id or False})
782 contact_id = res_partner.address_get(cr, uid, [partner_id])['default']
783 res = lead.write({'partner_id': partner_id}, context=context)
784 message = _("<b>Partner</b> set to <em>%s</em>." % (lead.partner_id.name))
785 self.message_post(cr, uid, [lead.id], body=message, context=context)
788 def handle_partner_assignation(self, cr, uid, ids, action='create', partner_id=False, context=None):
790 Handle partner assignation during a lead conversion.
791 if action is 'create', create new partner with contact and assign lead to new partner_id.
792 otherwise assign lead to the specified partner_id
794 :param list ids: leads/opportunities ids to process
795 :param string action: what has to be done regarding partners (create it, assign an existing one, or nothing)
796 :param int partner_id: partner to assign if any
797 :return dict: dictionary organized as followed: {lead_id: partner_assigned_id}
799 #TODO this is a duplication of the handle_partner_assignation method of crm_phonecall
801 # If a partner_id is given, force this partner for all elements
802 force_partner_id = partner_id
803 for lead in self.browse(cr, uid, ids, context=context):
804 # If the action is set to 'create' and no partner_id is set, create a new one
805 if action == 'create':
806 partner_id = force_partner_id or self._create_lead_partner(cr, uid, lead, context)
807 self._lead_set_partner(cr, uid, lead, partner_id, context=context)
808 partner_ids[lead.id] = partner_id
811 def allocate_salesman(self, cr, uid, ids, user_ids=None, team_id=False, context=None):
813 Assign salesmen and salesteam to a batch of leads. If there are more
814 leads than salesmen, these salesmen will be assigned in round-robin.
815 E.g.: 4 salesmen (S1, S2, S3, S4) for 6 leads (L1, L2, ... L6). They
816 will be assigned as followed: L1 - S1, L2 - S2, L3 - S3, L4 - S4,
819 :param list ids: leads/opportunities ids to process
820 :param list user_ids: salesmen to assign
821 :param int team_id: salesteam to assign
829 value['section_id'] = team_id
831 value['user_id'] = user_ids[index]
832 # Cycle through user_ids
833 index = (index + 1) % len(user_ids)
835 self.write(cr, uid, [lead_id], value, context=context)
838 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):
840 :param string action: ('schedule','Schedule a call'), ('log','Log a call')
842 phonecall = self.pool.get('crm.phonecall')
843 model_data = self.pool.get('ir.model.data')
846 res_id = model_data._get_id(cr, uid, 'crm', 'categ_phone2')
848 categ_id = model_data.browse(cr, uid, res_id, context=context).res_id
849 for lead in self.browse(cr, uid, ids, context=context):
851 section_id = lead.section_id and lead.section_id.id or False
853 user_id = lead.user_id and lead.user_id.id or False
855 'name': call_summary,
856 'opportunity_id': lead.id,
857 'user_id': user_id or False,
858 'categ_id': categ_id or False,
859 'description': desc or '',
860 'date': schedule_time,
861 'section_id': section_id or False,
862 'partner_id': lead.partner_id and lead.partner_id.id or False,
863 'partner_phone': phone or lead.phone or (lead.partner_id and lead.partner_id.phone or False),
864 'partner_mobile': lead.partner_id and lead.partner_id.mobile or False,
865 'priority': lead.priority,
867 new_id = phonecall.create(cr, uid, vals, context=context)
868 phonecall.case_open(cr, uid, [new_id], context=context)
870 phonecall.case_close(cr, uid, [new_id], context=context)
871 phonecall_dict[lead.id] = new_id
872 self.schedule_phonecall_send_note(cr, uid, [lead.id], new_id, action, context=context)
873 return phonecall_dict
875 def redirect_opportunity_view(self, cr, uid, opportunity_id, context=None):
876 models_data = self.pool.get('ir.model.data')
878 # Get opportunity views
879 dummy, form_view = models_data.get_object_reference(cr, uid, 'crm', 'crm_case_form_view_oppor')
880 dummy, tree_view = models_data.get_object_reference(cr, uid, 'crm', 'crm_case_tree_view_oppor')
882 'name': _('Opportunity'),
884 'view_mode': 'tree, form',
885 'res_model': 'crm.lead',
886 'domain': [('type', '=', 'opportunity')],
887 'res_id': int(opportunity_id),
889 'views': [(form_view or False, 'form'),
890 (tree_view or False, 'tree'),
891 (False, 'calendar'), (False, 'graph')],
892 'type': 'ir.actions.act_window',
895 def redirect_lead_view(self, cr, uid, lead_id, context=None):
896 models_data = self.pool.get('ir.model.data')
899 dummy, form_view = models_data.get_object_reference(cr, uid, 'crm', 'crm_case_form_view_leads')
900 dummy, tree_view = models_data.get_object_reference(cr, uid, 'crm', 'crm_case_tree_view_leads')
904 'view_mode': 'tree, form',
905 'res_model': 'crm.lead',
906 'domain': [('type', '=', 'lead')],
907 'res_id': int(lead_id),
909 'views': [(form_view or False, 'form'),
910 (tree_view or False, 'tree'),
911 (False, 'calendar'), (False, 'graph')],
912 'type': 'ir.actions.act_window',
915 def action_makeMeeting(self, cr, uid, ids, context=None):
917 Open meeting's calendar view to schedule meeting on current opportunity.
918 :return dict: dictionary value for created Meeting view
920 opportunity = self.browse(cr, uid, ids[0], context)
921 res = self.pool.get('ir.actions.act_window').for_xml_id(cr, uid, 'base_calendar', 'action_crm_meeting', context)
923 'default_opportunity_id': opportunity.id,
924 'default_partner_id': opportunity.partner_id and opportunity.partner_id.id or False,
925 'default_partner_ids' : opportunity.partner_id and [opportunity.partner_id.id] or False,
926 'default_user_id': uid,
927 'default_section_id': opportunity.section_id and opportunity.section_id.id or False,
928 'default_email_from': opportunity.email_from,
929 'default_name': opportunity.name,
933 def write(self, cr, uid, ids, vals, context=None):
934 if vals.get('stage_id') and not vals.get('probability'):
935 # change probability of lead(s) if required by stage
936 stage = self.pool.get('crm.case.stage').browse(cr, uid, vals['stage_id'], context=context)
938 vals['probability'] = stage.probability
939 return super(crm_lead, self).write(cr, uid, ids, vals, context=context)
941 def new_mail_send(self, cr, uid, ids, context=None):
943 This function opens a window to compose an email, with the edi sale template message loaded by default
945 assert len(ids) == 1, 'This option should only be used for a single id at a time.'
946 ir_model_data = self.pool.get('ir.model.data')
948 template_id = ir_model_data.get_object_reference(cr, uid, 'crm', 'email_template_opportunity_mail')[1]
952 compose_form_id = ir_model_data.get_object_reference(cr, uid, 'mail', 'email_compose_message_wizard_form')[1]
954 compose_form_id = False
959 'default_model': 'crm.lead',
960 'default_res_id': ids[0],
961 'default_use_template': bool(template_id),
962 'default_template_id': template_id,
963 'default_composition_mode': 'comment',
966 'name': _('Compose Email'),
967 'type': 'ir.actions.act_window',
970 'res_model': 'mail.compose.message',
971 'views': [(compose_form_id, 'form')],
972 'view_id': compose_form_id,
977 # ----------------------------------------
979 # ----------------------------------------
981 def message_get_reply_to(self, cr, uid, ids, context=None):
982 """ Override to get the reply_to of the parent project. """
983 return [lead.section_id.message_get_reply_to()[0] if lead.section_id else False
984 for lead in self.browse(cr, SUPERUSER_ID, ids, context=context)]
986 def _get_formview_action(self, cr, uid, id, context=None):
987 action = super(crm_lead, self)._get_formview_action(cr, uid, id, context=context)
988 obj = self.browse(cr, uid, id, context=context)
989 if obj.type == 'opportunity':
990 model, view_id = self.pool.get('ir.model.data').get_object_reference(cr, uid, 'crm', 'crm_case_form_view_oppor')
992 'views': [(view_id, 'form')],
996 def message_get_suggested_recipients(self, cr, uid, ids, context=None):
997 recipients = super(crm_lead, self).message_get_suggested_recipients(cr, uid, ids, context=context)
999 for lead in self.browse(cr, uid, ids, context=context):
1001 self._message_add_suggested_recipient(cr, uid, recipients, lead, partner=lead.partner_id, reason=_('Customer'))
1002 elif lead.email_from:
1003 self._message_add_suggested_recipient(cr, uid, recipients, lead, email=lead.email_from, reason=_('Customer Email'))
1004 except (osv.except_osv, orm.except_orm): # no read access rights -> just ignore suggested recipients because this imply modifying followers
1008 def message_new(self, cr, uid, msg, custom_values=None, context=None):
1009 """ Overrides mail_thread message_new that is called by the mailgateway
1010 through message_process.
1011 This override updates the document according to the email.
1013 if custom_values is None:
1015 desc = html2plaintext(msg.get('body')) if msg.get('body') else ''
1017 'name': msg.get('subject') or _("No Subject"),
1018 'description': desc,
1019 'email_from': msg.get('from'),
1020 'email_cc': msg.get('cc'),
1021 'partner_id': msg.get('author_id', False),
1024 if msg.get('author_id'):
1025 defaults.update(self.on_change_partner(cr, uid, None, msg.get('author_id'), context=context)['value'])
1026 if msg.get('priority') in dict(crm.AVAILABLE_PRIORITIES):
1027 defaults['priority'] = msg.get('priority')
1028 defaults.update(custom_values)
1029 return super(crm_lead, self).message_new(cr, uid, msg, custom_values=defaults, context=context)
1031 def message_update(self, cr, uid, ids, msg, update_vals=None, context=None):
1032 """ Overrides mail_thread message_update that is called by the mailgateway
1033 through message_process.
1034 This method updates the document according to the email.
1036 if isinstance(ids, (str, int, long)):
1038 if update_vals is None: update_vals = {}
1040 if msg.get('priority') in dict(crm.AVAILABLE_PRIORITIES):
1041 update_vals['priority'] = msg.get('priority')
1043 'cost':'planned_cost',
1044 'revenue': 'planned_revenue',
1045 'probability':'probability',
1047 for line in msg.get('body', '').split('\n'):
1049 res = tools.command_re.match(line)
1050 if res and maps.get(res.group(1).lower()):
1051 key = maps.get(res.group(1).lower())
1052 update_vals[key] = res.group(2).lower()
1054 return super(crm_lead, self).message_update(cr, uid, ids, msg, update_vals=update_vals, context=context)
1056 # ----------------------------------------
1057 # OpenChatter methods and notifications
1058 # ----------------------------------------
1060 def schedule_phonecall_send_note(self, cr, uid, ids, phonecall_id, action, context=None):
1061 phonecall = self.pool.get('crm.phonecall').browse(cr, uid, [phonecall_id], context=context)[0]
1065 prefix = 'Scheduled'
1066 suffix = ' %s' % phonecall.description
1067 message = _("%s a call for %s.%s") % (prefix, phonecall.date, suffix)
1068 return self.message_post(cr, uid, ids, body=message, context=context)
1070 def log_meeting(self, cr, uid, ids, meeting_subject, meeting_date, duration, context=None):
1072 duration = _('unknown')
1074 duration = str(duration)
1075 message = _("Meeting scheduled at '%s'<br> Subject: %s <br> Duration: %s hour(s)") % (meeting_date, meeting_subject, duration)
1076 return self.message_post(cr, uid, ids, body=message, context=context)
1078 def onchange_state(self, cr, uid, ids, state_id, context=None):
1080 country_id=self.pool.get('res.country.state').browse(cr, uid, state_id, context).country_id.id
1081 return {'value':{'country_id':country_id}}
1084 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: