1 # -*- coding: utf-8 -*-
2 ##############################################################################
4 # OpenERP, Open Source Management Solution
5 # Copyright (C) 2004-today OpenERP SA (<http://www.openerp.com>)
7 # This program is free software: you can redistribute it and/or modify
8 # it under the terms of the GNU Affero General Public License as
9 # published by the Free Software Foundation, either version 3 of the
10 # License, or (at your option) any later version.
12 # This program is distributed in the hope that it will be useful,
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU Affero General Public License for more details.
17 # You should have received a copy of the GNU Affero General Public License
18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
20 ##############################################################################
23 from datetime import datetime
24 from operator import itemgetter
25 from openerp.osv import fields, osv, orm
27 from openerp import SUPERUSER_ID
28 from openerp import tools
29 from openerp.tools.translate import _
30 from openerp.tools import html2plaintext
32 from openerp.addons.base.res.res_partner import format_address
34 CRM_LEAD_FIELDS_TO_MERGE = ['name',
64 CRM_LEAD_PENDING_STATES = (
65 crm.AVAILABLE_STATES[2][0], # Cancelled
66 crm.AVAILABLE_STATES[3][0], # Done
67 crm.AVAILABLE_STATES[4][0], # Pending
70 class crm_lead(format_address, osv.osv):
73 _description = "Lead/Opportunity"
74 _order = "priority,date_action,id desc"
75 _inherit = ['mail.thread', 'ir.needaction_mixin']
79 'crm.mt_lead_create': lambda self, cr, uid, obj, ctx=None: obj.state in ['new', 'draft'],
80 'crm.mt_lead_won': lambda self, cr, uid, obj, ctx=None: obj.state == 'done',
81 'crm.mt_lead_lost': lambda self, cr, uid, obj, ctx=None: obj.state == 'cancel',
84 'crm.mt_lead_stage': lambda self, cr, uid, obj, ctx=None: obj.state not in ['new', 'draft', 'cancel', 'done'],
88 def get_empty_list_help(self, cr, uid, help, context=None):
89 if context.get('default_type') == 'lead':
90 context['empty_list_help_model'] = 'crm.case.section'
91 context['empty_list_help_id'] = context.get('default_section_id')
92 context['empty_list_help_document_name'] = _("leads")
93 return super(crm_lead, self).get_empty_list_help(cr, uid, help, context=context)
95 def _get_default_section_id(self, cr, uid, context=None):
96 """ Gives default section by checking if present in the context """
97 return self._resolve_section_id_from_context(cr, uid, context=context) or False
99 def _get_default_stage_id(self, cr, uid, context=None):
100 """ Gives default stage_id """
101 section_id = self._get_default_section_id(cr, uid, context=context)
102 return self.stage_find(cr, uid, [], section_id, [('state', '=', 'draft')], context=context)
104 def _resolve_section_id_from_context(self, cr, uid, context=None):
105 """ Returns ID of section based on the value of 'section_id'
106 context key, or None if it cannot be resolved to a single
111 if type(context.get('default_section_id')) in (int, long):
112 return context.get('default_section_id')
113 if isinstance(context.get('default_section_id'), basestring):
114 section_ids = self.pool.get('crm.case.section').name_search(cr, uid, name=context['default_section_id'], context=context)
115 if len(section_ids) == 1:
116 return int(section_ids[0][0])
119 def _resolve_type_from_context(self, cr, uid, context=None):
120 """ Returns the type (lead or opportunity) from the type context
121 key. Returns None if it cannot be resolved.
125 return context.get('default_type')
127 def _read_group_stage_ids(self, cr, uid, ids, domain, read_group_order=None, access_rights_uid=None, context=None):
128 access_rights_uid = access_rights_uid or uid
129 stage_obj = self.pool.get('crm.case.stage')
130 order = stage_obj._order
131 # lame hack to allow reverting search, should just work in the trivial case
132 if read_group_order == 'stage_id desc':
133 order = "%s desc" % order
134 # retrieve section_id from the context and write the domain
135 # - ('id', 'in', 'ids'): add columns that should be present
136 # - OR ('case_default', '=', True), ('fold', '=', False): add default columns that are not folded
137 # - OR ('section_ids', '=', section_id), ('fold', '=', False) if section_id: add section columns that are not folded
139 section_id = self._resolve_section_id_from_context(cr, uid, context=context)
141 search_domain += ['|', ('section_ids', '=', section_id)]
142 search_domain += [('id', 'in', ids)]
144 search_domain += ['|', ('id', 'in', ids), ('case_default', '=', True)]
145 # retrieve type from the context (if set: choose 'type' or 'both')
146 type = self._resolve_type_from_context(cr, uid, context=context)
148 search_domain += ['|', ('type', '=', type), ('type', '=', 'both')]
150 stage_ids = stage_obj._search(cr, uid, search_domain, order=order, access_rights_uid=access_rights_uid, context=context)
151 result = stage_obj.name_get(cr, access_rights_uid, stage_ids, context=context)
152 # restore order of the search
153 result.sort(lambda x,y: cmp(stage_ids.index(x[0]), stage_ids.index(y[0])))
156 for stage in stage_obj.browse(cr, access_rights_uid, stage_ids, context=context):
157 fold[stage.id] = stage.fold or False
160 def fields_view_get(self, cr, user, view_id=None, view_type='form', context=None, toolbar=False, submenu=False):
161 res = super(crm_lead,self).fields_view_get(cr, user, view_id, view_type, context, toolbar=toolbar, submenu=submenu)
162 if view_type == 'form':
163 res['arch'] = self.fields_view_get_address(cr, user, res['arch'], context=context)
167 'stage_id': _read_group_stage_ids
170 def _compute_day(self, cr, uid, ids, fields, args, context=None):
172 :return dict: difference between current date and log date
174 cal_obj = self.pool.get('resource.calendar')
175 res_obj = self.pool.get('resource.resource')
178 for lead in self.browse(cr, uid, ids, context=context):
183 if field == 'day_open':
185 date_create = datetime.strptime(lead.create_date, "%Y-%m-%d %H:%M:%S")
186 date_open = datetime.strptime(lead.date_open, "%Y-%m-%d %H:%M:%S")
187 ans = date_open - date_create
188 date_until = lead.date_open
189 elif field == 'day_close':
191 date_create = datetime.strptime(lead.create_date, "%Y-%m-%d %H:%M:%S")
192 date_close = datetime.strptime(lead.date_closed, "%Y-%m-%d %H:%M:%S")
193 date_until = lead.date_closed
194 ans = date_close - date_create
198 resource_ids = res_obj.search(cr, uid, [('user_id','=',lead.user_id.id)])
199 if len(resource_ids):
200 resource_id = resource_ids[0]
202 duration = float(ans.days)
203 if lead.section_id and lead.section_id.resource_calendar_id:
204 duration = float(ans.days) * 24
205 new_dates = cal_obj.interval_get(cr,
207 lead.section_id.resource_calendar_id and lead.section_id.resource_calendar_id.id or False,
208 datetime.strptime(lead.create_date, '%Y-%m-%d %H:%M:%S'),
213 date_until = datetime.strptime(date_until, '%Y-%m-%d %H:%M:%S')
214 for in_time, out_time in new_dates:
215 if in_time.date not in no_days:
216 no_days.append(in_time.date)
217 if out_time > date_until:
219 duration = len(no_days)
220 res[lead.id][field] = abs(int(duration))
223 def _history_search(self, cr, uid, obj, name, args, context=None):
225 msg_obj = self.pool.get('mail.message')
226 message_ids = msg_obj.search(cr, uid, [('email_from','!=',False), ('subject', args[0][1], args[0][2])], context=context)
227 lead_ids = self.search(cr, uid, [('message_ids', 'in', message_ids)], context=context)
230 return [('id', 'in', lead_ids)]
232 return [('id', '=', '0')]
235 'partner_id': fields.many2one('res.partner', 'Partner', ondelete='set null', track_visibility='onchange',
236 select=True, help="Linked partner (optional). Usually created when converting the lead."),
238 'id': fields.integer('ID', readonly=True),
239 'name': fields.char('Subject', size=64, required=True, select=1),
240 'active': fields.boolean('Active', required=False),
241 'date_action_last': fields.datetime('Last Action', readonly=1),
242 'date_action_next': fields.datetime('Next Action', readonly=1),
243 'email_from': fields.char('Email', size=128, help="Email address of the contact", select=1),
244 'section_id': fields.many2one('crm.case.section', 'Sales Team',
245 select=True, track_visibility='onchange', help='When sending mails, the default email address is taken from the sales team.'),
246 'create_date': fields.datetime('Creation Date' , readonly=True),
247 '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"),
248 'description': fields.text('Notes'),
249 'write_date': fields.datetime('Update Date' , readonly=True),
250 'categ_ids': fields.many2many('crm.case.categ', 'crm_lead_category_rel', 'lead_id', 'category_id', 'Categories', \
251 domain="['|',('section_id','=',section_id),('section_id','=',False), ('object_id.model', '=', 'crm.lead')]"),
252 'type_id': fields.many2one('crm.case.resource.type', 'Campaign', \
253 domain="['|',('section_id','=',section_id),('section_id','=',False)]", help="From which campaign (seminar, marketing campaign, mass mailing, ...) did this contact come from?"),
254 'channel_id': fields.many2one('crm.case.channel', 'Channel', help="Communication channel (mail, direct, phone, ...)"),
255 'contact_name': fields.char('Contact Name', size=64),
256 '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),
257 'opt_out': fields.boolean('Opt-Out', oldname='optout',
258 help="If opt-out is checked, this contact has refused to receive emails for mass mailing and marketing campaign. "
259 "Filter 'Available for Mass Mailing' allows users to filter the leads when performing mass mailing."),
260 'type':fields.selection([ ('lead','Lead'), ('opportunity','Opportunity'), ],'Type', help="Type is used to separate Leads and Opportunities"),
261 'priority': fields.selection(crm.AVAILABLE_PRIORITIES, 'Priority', select=True),
262 'date_closed': fields.datetime('Closed', readonly=True),
263 'stage_id': fields.many2one('crm.case.stage', 'Stage', track_visibility='onchange',
264 domain="['&', ('section_ids', '=', section_id), '|', ('type', '=', type), ('type', '=', 'both')]"),
265 'user_id': fields.many2one('res.users', 'Salesperson', select=True, track_visibility='onchange'),
266 'referred': fields.char('Referred By', size=64),
267 'date_open': fields.datetime('Opened', readonly=True),
268 'day_open': fields.function(_compute_day, string='Days to Open', \
269 multi='day_open', type="float", store=True),
270 'day_close': fields.function(_compute_day, string='Days to Close', \
271 multi='day_close', type="float", store=True),
272 'state': fields.related('stage_id', 'state', type="selection", store=True,
273 selection=crm.AVAILABLE_STATES, string="Status", readonly=True,
274 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\'.'),
276 # Messaging and marketing
277 'message_bounce': fields.integer('Bounce'),
278 # Only used for type opportunity
279 'probability': fields.float('Success Rate (%)',group_operator="avg"),
280 'planned_revenue': fields.float('Expected Revenue', track_visibility='always'),
281 'ref': fields.reference('Reference', selection=crm._links_get, size=128),
282 'ref2': fields.reference('Reference 2', selection=crm._links_get, size=128),
283 'phone': fields.char("Phone", size=64),
284 'date_deadline': fields.date('Expected Closing', help="Estimate of the date on which the opportunity will be won."),
285 'date_action': fields.date('Next Action Date', select=True),
286 'title_action': fields.char('Next Action', size=64),
287 'color': fields.integer('Color Index'),
288 'partner_address_name': fields.related('partner_id', 'name', type='char', string='Partner Contact Name', readonly=True),
289 'partner_address_email': fields.related('partner_id', 'email', type='char', string='Partner Contact Email', readonly=True),
290 'company_currency': fields.related('company_id', 'currency_id', type='many2one', string='Currency', readonly=True, relation="res.currency"),
291 'user_email': fields.related('user_id', 'email', type='char', string='User Email', readonly=True),
292 'user_login': fields.related('user_id', 'login', type='char', string='User Login', readonly=True),
294 # Fields for address, due to separation from crm and res.partner
295 'street': fields.char('Street', size=128),
296 'street2': fields.char('Street2', size=128),
297 'zip': fields.char('Zip', change_default=True, size=24),
298 'city': fields.char('City', size=128),
299 'state_id': fields.many2one("res.country.state", 'State'),
300 'country_id': fields.many2one('res.country', 'Country'),
301 'phone': fields.char('Phone', size=64),
302 'fax': fields.char('Fax', size=64),
303 'mobile': fields.char('Mobile', size=64),
304 'function': fields.char('Function', size=128),
305 'title': fields.many2one('res.partner.title', 'Title'),
306 'company_id': fields.many2one('res.company', 'Company', select=1),
307 'payment_mode': fields.many2one('crm.payment.mode', 'Payment Mode', \
308 domain="[('section_id','=',section_id)]"),
309 'planned_cost': fields.float('Planned Costs'),
315 'user_id': lambda s, cr, uid, c: uid,
316 'stage_id': lambda s, cr, uid, c: s._get_default_stage_id(cr, uid, c),
317 'section_id': lambda s, cr, uid, c: s._get_default_section_id(cr, uid, c),
318 'company_id': lambda s, cr, uid, c: s.pool.get('res.company')._company_default_get(cr, uid, 'crm.lead', context=c),
319 'priority': lambda *a: crm.AVAILABLE_PRIORITIES[2][0],
324 ('check_probability', 'check(probability >= 0 and probability <= 100)', 'The probability of closing the deal should be between 0% and 100%!')
327 def onchange_stage_id(self, cr, uid, ids, stage_id, context=None):
330 stage = self.pool.get('crm.case.stage').browse(cr, uid, stage_id, context)
331 if not stage.on_change:
333 return {'value': {'probability': stage.probability}}
335 def on_change_partner_id(self, cr, uid, ids, partner_id, context=None):
338 partner = self.pool.get('res.partner').browse(cr, uid, partner_id, context=context)
340 'partner_name': partner.name,
341 'street': partner.street,
342 'street2': partner.street2,
343 'city': partner.city,
344 'state_id': partner.state_id and partner.state_id.id or False,
345 'country_id': partner.country_id and partner.country_id.id or False,
346 'email_from': partner.email,
347 'phone': partner.phone,
348 'mobile': partner.mobile,
351 return {'value': values}
353 def on_change_user(self, cr, uid, ids, user_id, context=None):
354 """ When changing the user, also set a section_id or restrict section id
355 to the ones user_id is member of. """
356 section_id = self._get_default_section_id(cr, uid, context=context) or False
357 if user_id and not section_id:
358 section_ids = self.pool.get('crm.case.section').search(cr, uid, ['|', ('user_id', '=', user_id), ('member_ids', '=', user_id)], context=context)
360 section_id = section_ids[0]
361 return {'value': {'section_id': section_id}}
363 def _check(self, cr, uid, ids=False, context=None):
364 """ Override of the base.stage method.
365 Function called by the scheduler to process cases for date actions
366 Only works on not done and cancelled cases
368 cr.execute('select * from crm_case \
369 where (date_action_last<%s or date_action_last is null) \
370 and (date_action_next<=%s or date_action_next is null) \
371 and state not in (\'cancel\',\'done\')',
372 (time.strftime("%Y-%m-%d %H:%M:%S"),
373 time.strftime('%Y-%m-%d %H:%M:%S')))
375 ids2 = map(lambda x: x[0], cr.fetchall() or [])
376 cases = self.browse(cr, uid, ids2, context=context)
377 return self._action(cr, uid, cases, False, context=context)
379 def stage_find(self, cr, uid, cases, section_id, domain=None, order='sequence', context=None):
380 """ Override of the base.stage method
381 Parameter of the stage search taken from the lead:
382 - type: stage type must be the same or 'both'
383 - section_id: if set, stages must belong to this section or
384 be a default stage; if not set, stages must be default
387 if isinstance(cases, (int, long)):
388 cases = self.browse(cr, uid, cases, context=context)
389 # collect all section_ids
393 type = context.get('default_type')
396 section_ids.append(section_id)
399 section_ids.append(lead.section_id.id)
400 if lead.type not in types:
401 types.append(lead.type)
402 # OR all section_ids and OR with case_default
405 search_domain += [('|')] * len(section_ids)
406 for section_id in section_ids:
407 search_domain.append(('section_ids', '=', section_id))
409 search_domain.append(('case_default', '=', True))
410 # AND with cases types
411 search_domain.append(('type', 'in', types))
412 # AND with the domain in parameter
413 search_domain += list(domain)
414 # perform search, return the first found
415 stage_ids = self.pool.get('crm.case.stage').search(cr, uid, search_domain, order=order, context=context)
420 def stage_set(self, cr, uid, ids, stage_id, context=None):
421 """ Set the new stage. Now just writes the stage.
422 TDE TODO: remove me when removing state
424 return self.write(cr, uid, ids, {'stage_id': stage_id}, context=context)
426 def case_mark_lost(self, cr, uid, ids, context=None):
427 """ Mark the case as lost: state=cancel and probability=0 """
428 for lead in self.browse(cr, uid, ids):
429 stage_id = self.stage_find(cr, uid, [lead], lead.section_id.id or False, [('probability', '=', 0.0),('on_change','=',True)], context=context)
431 self.stage_set(cr, uid, [lead.id], stage_id, context=context)
434 def case_mark_won(self, cr, uid, ids, context=None):
435 """ Mark the case as won: state=done and probability=100 """
436 for lead in self.browse(cr, uid, ids):
437 stage_id = self.stage_find(cr, uid, [lead], lead.section_id.id or False, [('probability', '=', 100.0),('on_change','=',True)], context=context)
439 self.stage_set(cr, uid, [lead.id], stage_id, context=context)
442 def case_escalate(self, cr, uid, ids, context=None):
443 """ Escalates case to parent level """
444 for case in self.browse(cr, uid, ids, context=context):
445 data = {'active': True}
446 if case.section_id.parent_id:
447 data['section_id'] = case.section_id.parent_id.id
448 if case.section_id.parent_id.change_responsible:
449 if case.section_id.parent_id.user_id:
450 data['user_id'] = case.section_id.parent_id.user_id.id
452 raise osv.except_osv(_('Error!'), _("You are already at the top level of your sales-team category.\nTherefore you cannot escalate furthermore."))
453 self.write(cr, uid, [case.id], data, context=context)
456 def set_priority(self, cr, uid, ids, priority):
457 """ Set lead priority
459 return self.write(cr, uid, ids, {'priority' : priority})
461 def set_high_priority(self, cr, uid, ids, context=None):
462 """ Set lead priority to high
464 return self.set_priority(cr, uid, ids, '1')
466 def set_normal_priority(self, cr, uid, ids, context=None):
467 """ Set lead priority to normal
469 return self.set_priority(cr, uid, ids, '3')
471 def _merge_get_result_type(self, cr, uid, opps, context=None):
473 Define the type of the result of the merge. If at least one of the
474 element to merge is an opp, the resulting new element will be an opp.
475 Otherwise it will be a lead.
477 We'll directly use a list of browse records instead of a list of ids
478 for performances' sake: it will spare a second browse of the
481 :param list opps: list of browse records containing the leads/opps to process
482 :return string type: the type of the final element
485 if (opp.type == 'opportunity'):
490 def _merge_data(self, cr, uid, ids, oldest, fields, context=None):
492 Prepare lead/opp data into a dictionary for merging. Different types
493 of fields are processed in different ways:
494 - text: all the values are concatenated
495 - m2m and o2m: those fields aren't processed
496 - m2o: the first not null value prevails (the other are dropped)
497 - any other type of field: same as m2o
499 :param list ids: list of ids of the leads to process
500 :param list fields: list of leads' fields to process
501 :return dict data: contains the merged values
503 opportunities = self.browse(cr, uid, ids, context=context)
505 def _get_first_not_null(attr):
506 for opp in opportunities:
507 if hasattr(opp, attr) and bool(getattr(opp, attr)):
508 return getattr(opp, attr)
511 def _get_first_not_null_id(attr):
512 res = _get_first_not_null(attr)
513 return res and res.id or False
515 def _concat_all(attr):
516 return '\n\n'.join(filter(lambda x: x, [getattr(opp, attr) or '' for opp in opportunities if hasattr(opp, attr)]))
518 # Process the fields' values
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
525 if field._type in ('many2many', 'one2many'):
527 elif field._type == 'many2one':
528 data[field_name] = _get_first_not_null_id(field_name) # !!
529 elif field._type == 'text':
530 data[field_name] = _concat_all(field_name) #not lost
532 data[field_name] = _get_first_not_null(field_name) #not lost
534 # Define the resulting type ('lead' or 'opportunity')
535 data['type'] = self._merge_get_result_type(cr, uid, opportunities, context)
538 def _mail_body(self, cr, uid, lead, fields, title=False, context=None):
541 body.append("%s\n" % (title))
543 for field_name in fields:
544 field_info = self._all_columns.get(field_name)
545 if field_info is None:
547 field = field_info.column
550 if field._type == 'selection':
551 if hasattr(field.selection, '__call__'):
552 key = field.selection(self, cr, uid, context=context)
554 key = field.selection
555 value = dict(key).get(lead[field_name], lead[field_name])
556 elif field._type == 'many2one':
558 value = lead[field_name].name_get()[0][1]
559 elif field._type == 'many2many':
561 for val in lead[field_name]:
562 field_value = val.name_get()[0][1]
563 value += field_value + ","
565 value = lead[field_name]
567 body.append("%s: %s" % (field.string, value or ''))
568 return "<br/>".join(body + ['<br/>'])
570 def _merge_notify(self, cr, uid, opportunity_id, opportunities, context=None):
572 Create a message gathering merged leads/opps information.
574 #TOFIX: mail template should be used instead of fix body, subject text
576 result_type = self._merge_get_result_type(cr, uid, opportunities, context)
577 if result_type == 'lead':
578 merge_message = _('Merged leads')
580 merge_message = _('Merged opportunities')
581 subject = [merge_message]
582 for opportunity in opportunities:
583 subject.append(opportunity.name)
584 title = "%s : %s" % (opportunity.type == 'opportunity' and _('Merged opportunity') or _('Merged lead'), opportunity.name)
585 fields = list(CRM_LEAD_FIELDS_TO_MERGE)
586 details.append(self._mail_body(cr, uid, opportunity, fields, title=title, context=context))
588 # Chatter message's subject
589 subject = subject[0] + ": " + ", ".join(subject[1:])
590 details = "\n\n".join(details)
591 return self.message_post(cr, uid, [opportunity_id], body=details, subject=subject, context=context)
593 def _merge_opportunity_history(self, cr, uid, opportunity_id, opportunities, context=None):
594 message = self.pool.get('mail.message')
595 for opportunity in opportunities:
596 for history in opportunity.message_ids:
597 message.write(cr, uid, history.id, {
598 'res_id': opportunity_id,
599 'subject' : _("From %s : %s") % (opportunity.name, history.subject)
604 def _merge_opportunity_attachments(self, cr, uid, opportunity_id, opportunities, context=None):
605 attach_obj = self.pool.get('ir.attachment')
607 # return attachments of opportunity
608 def _get_attachments(opportunity_id):
609 attachment_ids = attach_obj.search(cr, uid, [('res_model', '=', self._name), ('res_id', '=', opportunity_id)], context=context)
610 return attach_obj.browse(cr, uid, attachment_ids, context=context)
612 first_attachments = _get_attachments(opportunity_id)
613 #counter of all attachments to move. Used to make sure the name is different for all attachments
615 for opportunity in opportunities:
616 attachments = _get_attachments(opportunity.id)
617 for attachment in attachments:
618 values = {'res_id': opportunity_id,}
619 for attachment_in_first in first_attachments:
620 if attachment.name == attachment_in_first.name:
621 name = "%s (%s)" % (attachment.name, count,),
623 attachment.write(values)
626 def merge_opportunity(self, cr, uid, ids, user_id=False, section_id=False, context=None):
628 Different cases of merge:
629 - merge leads together = 1 new lead
630 - merge at least 1 opp with anything else (lead or opp) = 1 new opp
632 :param list ids: leads/opportunities ids to merge
633 :return int id: id of the resulting lead/opp
639 raise osv.except_osv(_('Warning!'), _('Please select more than one element (lead or opportunity) from the list view.'))
641 opportunities = self.browse(cr, uid, ids, context=context)
643 for opportunity in opportunities:
645 if opportunity.stage_id and opportunity.stage_id.state != 'cancel':
646 sequence = opportunity.stage_id.sequence
647 sequenced_opps.append(((int(sequence != -1 and opportunity.type == 'opportunity'), sequence, -opportunity.id), opportunity))
649 sequenced_opps.sort(reverse=True)
650 opportunities = map(itemgetter(1), sequenced_opps)
651 ids = [opportunity.id for opportunity in opportunities]
652 highest = opportunities[0]
653 opportunities_rest = opportunities[1:]
655 tail_opportunities = opportunities_rest
657 fields = list(CRM_LEAD_FIELDS_TO_MERGE)
658 merged_data = self._merge_data(cr, uid, ids, highest, fields, context=context)
661 merged_data['user_id'] = user_id
663 merged_data['section_id'] = section_id
665 # Merge messages and attachements into the first opportunity
666 self._merge_opportunity_history(cr, uid, highest.id, tail_opportunities, context=context)
667 self._merge_opportunity_attachments(cr, uid, highest.id, tail_opportunities, context=context)
669 # Merge notifications about loss of information
670 opportunities = [highest]
671 opportunities.extend(opportunities_rest)
672 self._merge_notify(cr, uid, highest, opportunities, context=context)
673 # Check if the stage is in the stages of the sales team. If not, assign the stage with the lowest sequence
674 if merged_data.get('section_id'):
675 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)
676 if merged_data.get('stage_id') not in section_stage_ids:
677 merged_data['stage_id'] = section_stage_ids and section_stage_ids[0] or False
678 # Write merged data into first opportunity
679 self.write(cr, uid, [highest.id], merged_data, context=context)
680 # Delete tail opportunities
681 # 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
682 self.unlink(cr, SUPERUSER_ID, [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)
720 if user_ids or section_id:
721 self.allocate_salesman(cr, uid, ids, user_ids, section_id, context=context)
725 def _lead_create_contact(self, cr, uid, lead, name, is_company, parent_id=False, context=None):
726 partner = self.pool.get('res.partner')
727 vals = {'name': name,
728 'user_id': lead.user_id.id,
729 'comment': lead.description,
730 'section_id': lead.section_id.id or False,
731 'parent_id': parent_id,
733 'mobile': lead.mobile,
734 'email': tools.email_split(lead.email_from) and tools.email_split(lead.email_from)[0] or False,
736 'title': lead.title and lead.title.id or False,
737 'function': lead.function,
738 'street': lead.street,
739 'street2': lead.street2,
742 'country_id': lead.country_id and lead.country_id.id or False,
743 'state_id': lead.state_id and lead.state_id.id or False,
744 'is_company': is_company,
747 partner = partner.create(cr, uid, vals, context=context)
750 def _create_lead_partner(self, cr, uid, lead, context=None):
752 if lead.partner_name and lead.contact_name:
753 partner_id = self._lead_create_contact(cr, uid, lead, lead.partner_name, True, context=context)
754 partner_id = self._lead_create_contact(cr, uid, lead, lead.contact_name, False, partner_id, context=context)
755 elif lead.partner_name and not lead.contact_name:
756 partner_id = self._lead_create_contact(cr, uid, lead, lead.partner_name, True, context=context)
757 elif not lead.partner_name and lead.contact_name:
758 partner_id = self._lead_create_contact(cr, uid, lead, lead.contact_name, False, context=context)
759 elif lead.email_from and self.pool.get('res.partner')._parse_partner_name(lead.email_from, context=context)[0]:
760 contact_name = self.pool.get('res.partner')._parse_partner_name(lead.email_from, context=context)[0]
761 partner_id = self._lead_create_contact(cr, uid, lead, contact_name, False, context=context)
763 raise osv.except_osv(
765 _('No customer name defined. Please fill one of the following fields: Company Name, Contact Name or Email ("Name <email@address>")')
769 def _lead_set_partner(self, cr, uid, lead, partner_id, context=None):
771 Assign a partner to a lead.
773 :param object lead: browse record of the lead to process
774 :param int partner_id: identifier of the partner to assign
775 :return bool: True if the partner has properly been assigned
778 res_partner = self.pool.get('res.partner')
780 res_partner.write(cr, uid, partner_id, {'section_id': lead.section_id and lead.section_id.id or False})
781 contact_id = res_partner.address_get(cr, uid, [partner_id])['default']
782 res = lead.write({'partner_id': partner_id}, context=context)
783 message = _("<b>Partner</b> set to <em>%s</em>." % (lead.partner_id.name))
784 self.message_post(cr, uid, [lead.id], body=message, context=context)
787 def handle_partner_assignation(self, cr, uid, ids, action='create', partner_id=False, context=None):
789 Handle partner assignation during a lead conversion.
790 if action is 'create', create new partner with contact and assign lead to new partner_id.
791 otherwise assign lead to the specified partner_id
793 :param list ids: leads/opportunities ids to process
794 :param string action: what has to be done regarding partners (create it, assign an existing one, or nothing)
795 :param int partner_id: partner to assign if any
796 :return dict: dictionary organized as followed: {lead_id: partner_assigned_id}
798 #TODO this is a duplication of the handle_partner_assignation method of crm_phonecall
800 # If a partner_id is given, force this partner for all elements
801 force_partner_id = partner_id
802 for lead in self.browse(cr, uid, ids, context=context):
803 # If the action is set to 'create' and no partner_id is set, create a new one
804 if action == 'create':
805 partner_id = force_partner_id or self._create_lead_partner(cr, uid, lead, context)
806 self._lead_set_partner(cr, uid, lead, partner_id, context=context)
807 partner_ids[lead.id] = partner_id
810 def allocate_salesman(self, cr, uid, ids, user_ids=None, team_id=False, context=None):
812 Assign salesmen and salesteam to a batch of leads. If there are more
813 leads than salesmen, these salesmen will be assigned in round-robin.
814 E.g.: 4 salesmen (S1, S2, S3, S4) for 6 leads (L1, L2, ... L6). They
815 will be assigned as followed: L1 - S1, L2 - S2, L3 - S3, L4 - S4,
818 :param list ids: leads/opportunities ids to process
819 :param list user_ids: salesmen to assign
820 :param int team_id: salesteam to assign
828 value['section_id'] = team_id
830 value['user_id'] = user_ids[index]
831 # Cycle through user_ids
832 index = (index + 1) % len(user_ids)
834 self.write(cr, uid, [lead_id], value, context=context)
837 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):
839 :param string action: ('schedule','Schedule a call'), ('log','Log a call')
841 phonecall = self.pool.get('crm.phonecall')
842 model_data = self.pool.get('ir.model.data')
845 res_id = model_data._get_id(cr, uid, 'crm', 'categ_phone2')
847 categ_id = model_data.browse(cr, uid, res_id, context=context).res_id
848 for lead in self.browse(cr, uid, ids, context=context):
850 section_id = lead.section_id and lead.section_id.id or False
852 user_id = lead.user_id and lead.user_id.id or False
854 'name': call_summary,
855 'opportunity_id': lead.id,
856 'user_id': user_id or False,
857 'categ_id': categ_id or False,
858 'description': desc or '',
859 'date': schedule_time,
860 'section_id': section_id or False,
861 'partner_id': lead.partner_id and lead.partner_id.id or False,
862 'partner_phone': phone or lead.phone or (lead.partner_id and lead.partner_id.phone or False),
863 'partner_mobile': lead.partner_id and lead.partner_id.mobile or False,
864 'priority': lead.priority,
866 new_id = phonecall.create(cr, uid, vals, context=context)
867 phonecall.case_open(cr, uid, [new_id], context=context)
869 phonecall.case_close(cr, uid, [new_id], context=context)
870 phonecall_dict[lead.id] = new_id
871 self.schedule_phonecall_send_note(cr, uid, [lead.id], new_id, action, context=context)
872 return phonecall_dict
874 def redirect_opportunity_view(self, cr, uid, opportunity_id, context=None):
875 models_data = self.pool.get('ir.model.data')
877 # Get opportunity views
878 dummy, form_view = models_data.get_object_reference(cr, uid, 'crm', 'crm_case_form_view_oppor')
879 dummy, tree_view = models_data.get_object_reference(cr, uid, 'crm', 'crm_case_tree_view_oppor')
881 'name': _('Opportunity'),
883 'view_mode': 'tree, form',
884 'res_model': 'crm.lead',
885 'domain': [('type', '=', 'opportunity')],
886 'res_id': int(opportunity_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 redirect_lead_view(self, cr, uid, lead_id, context=None):
895 models_data = self.pool.get('ir.model.data')
898 dummy, form_view = models_data.get_object_reference(cr, uid, 'crm', 'crm_case_form_view_leads')
899 dummy, tree_view = models_data.get_object_reference(cr, uid, 'crm', 'crm_case_tree_view_leads')
903 'view_mode': 'tree, form',
904 'res_model': 'crm.lead',
905 'domain': [('type', '=', 'lead')],
906 'res_id': int(lead_id),
908 'views': [(form_view or False, 'form'),
909 (tree_view or False, 'tree'),
910 (False, 'calendar'), (False, 'graph')],
911 'type': 'ir.actions.act_window',
914 def action_makeMeeting(self, cr, uid, ids, context=None):
916 Open meeting's calendar view to schedule meeting on current opportunity.
917 :return dict: dictionary value for created Meeting view
919 opportunity = self.browse(cr, uid, ids[0], context)
920 res = self.pool.get('ir.actions.act_window').for_xml_id(cr, uid, 'base_calendar', 'action_crm_meeting', context)
922 'default_opportunity_id': opportunity.id,
923 'default_partner_id': opportunity.partner_id and opportunity.partner_id.id or False,
924 'default_partner_ids' : opportunity.partner_id and [opportunity.partner_id.id] or False,
925 'default_user_id': uid,
926 'default_section_id': opportunity.section_id and opportunity.section_id.id or False,
927 'default_email_from': opportunity.email_from,
928 'default_name': opportunity.name,
932 def create(self, cr, uid, vals, context=None):
935 if vals.get('type') and not context.get('default_type'):
936 context['default_type'] = vals.get('type')
937 if vals.get('section_id') and not context.get('default_section_id'):
938 context['default_section_id'] = vals.get('section_id')
940 # context: no_log, because subtype already handle this
941 create_context = dict(context, mail_create_nolog=True)
942 return super(crm_lead, self).create(cr, uid, vals, context=create_context)
944 def write(self, cr, uid, ids, vals, context=None):
945 if vals.get('stage_id') and not vals.get('probability'):
946 onchange_stage_values = self.onchange_stage_id(cr, uid, ids, vals.get('stage_id'), context=context)['value']
947 vals.update(onchange_stage_values)
948 return super(crm_lead, self).write(cr, uid, ids, vals, context=context)
950 # ----------------------------------------
952 # ----------------------------------------
954 def message_get_reply_to(self, cr, uid, ids, context=None):
955 """ Override to get the reply_to of the parent project. """
956 return [lead.section_id.message_get_reply_to()[0] if lead.section_id else False
957 for lead in self.browse(cr, SUPERUSER_ID, ids, context=context)]
959 def _get_formview_action(self, cr, uid, id, context=None):
960 action = super(crm_lead, self)._get_formview_action(cr, uid, id, context=context)
961 obj = self.browse(cr, uid, id, context=context)
962 if obj.type == 'opportunity':
963 model, view_id = self.pool.get('ir.model.data').get_object_reference(cr, uid, 'crm', 'crm_case_form_view_oppor')
965 'views': [(view_id, 'form')],
969 def message_get_suggested_recipients(self, cr, uid, ids, context=None):
970 recipients = super(crm_lead, self).message_get_suggested_recipients(cr, uid, ids, context=context)
972 for lead in self.browse(cr, uid, ids, context=context):
974 self._message_add_suggested_recipient(cr, uid, recipients, lead, partner=lead.partner_id, reason=_('Customer'))
975 elif lead.email_from:
976 self._message_add_suggested_recipient(cr, uid, recipients, lead, email=lead.email_from, reason=_('Customer Email'))
977 except (osv.except_osv, orm.except_orm): # no read access rights -> just ignore suggested recipients because this imply modifying followers
981 def message_new(self, cr, uid, msg, custom_values=None, context=None):
982 """ Overrides mail_thread message_new that is called by the mailgateway
983 through message_process.
984 This override updates the document according to the email.
986 if custom_values is None:
988 desc = html2plaintext(msg.get('body')) if msg.get('body') else ''
990 'name': msg.get('subject') or _("No Subject"),
992 'email_from': msg.get('from'),
993 'email_cc': msg.get('cc'),
994 'partner_id': msg.get('author_id', False),
997 if msg.get('author_id'):
998 defaults.update(self.on_change_partner_id(cr, uid, None, msg.get('author_id'), context=context)['value'])
999 if msg.get('priority') in dict(crm.AVAILABLE_PRIORITIES):
1000 defaults['priority'] = msg.get('priority')
1001 defaults.update(custom_values)
1002 return super(crm_lead, self).message_new(cr, uid, msg, custom_values=defaults, context=context)
1004 def message_update(self, cr, uid, ids, msg, update_vals=None, context=None):
1005 """ Overrides mail_thread message_update that is called by the mailgateway
1006 through message_process.
1007 This method updates the document according to the email.
1009 if isinstance(ids, (str, int, long)):
1011 if update_vals is None: update_vals = {}
1013 if msg.get('priority') in dict(crm.AVAILABLE_PRIORITIES):
1014 update_vals['priority'] = msg.get('priority')
1016 'cost':'planned_cost',
1017 'revenue': 'planned_revenue',
1018 'probability':'probability',
1020 for line in msg.get('body', '').split('\n'):
1022 res = tools.command_re.match(line)
1023 if res and maps.get(res.group(1).lower()):
1024 key = maps.get(res.group(1).lower())
1025 update_vals[key] = res.group(2).lower()
1027 return super(crm_lead, self).message_update(cr, uid, ids, msg, update_vals=update_vals, context=context)
1029 # ----------------------------------------
1030 # OpenChatter methods and notifications
1031 # ----------------------------------------
1033 def schedule_phonecall_send_note(self, cr, uid, ids, phonecall_id, action, context=None):
1034 phonecall = self.pool.get('crm.phonecall').browse(cr, uid, [phonecall_id], context=context)[0]
1038 prefix = 'Scheduled'
1039 suffix = ' %s' % phonecall.description
1040 message = _("%s a call for %s.%s") % (prefix, phonecall.date, suffix)
1041 return self.message_post(cr, uid, ids, body=message, context=context)
1043 def log_meeting(self, cr, uid, ids, meeting_subject, meeting_date, duration, context=None):
1045 duration = _('unknown')
1047 duration = str(duration)
1048 message = _("Meeting scheduled at '%s'<br> Subject: %s <br> Duration: %s hour(s)") % (meeting_date, meeting_subject, duration)
1049 return self.message_post(cr, uid, ids, body=message, context=context)
1051 def onchange_state(self, cr, uid, ids, state_id, context=None):
1053 country_id=self.pool.get('res.country.state').browse(cr, uid, state_id, context).country_id.id
1054 return {'value':{'country_id':country_id}}
1057 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: