1 # -*- coding: utf-8 -*-
2 ##############################################################################
4 # OpenERP, Open Source Management Solution
5 # Copyright (C) 2004-today OpenERP SA (<http://www.openerp.com>)
7 # This program is free software: you can redistribute it and/or modify
8 # it under the terms of the GNU Affero General Public License as
9 # published by the Free Software Foundation, either version 3 of the
10 # License, or (at your option) any later version.
12 # This program is distributed in the hope that it will be useful,
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU Affero General Public License for more details.
17 # You should have received a copy of the GNU Affero General Public License
18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
20 ##############################################################################
23 from datetime import datetime
24 from operator import itemgetter
27 from openerp import SUPERUSER_ID
28 from openerp import tools
29 from openerp.addons.base.res.res_partner import format_address
30 from openerp.osv import fields, osv, orm
31 from openerp.tools import html2plaintext
32 from openerp.tools.translate import _
34 CRM_LEAD_FIELDS_TO_MERGE = ['name',
66 class crm_lead(format_address, osv.osv):
69 _description = "Lead/Opportunity"
70 _order = "priority,date_action,id desc"
71 _inherit = ['mail.thread', 'ir.needaction_mixin']
75 # this is only an heuristics; depending on your particular stage configuration it may not match all 'new' stages
76 'crm.mt_lead_create': lambda self, cr, uid, obj, ctx=None: obj.probability == 0 and obj.stage_id and obj.stage_id.sequence <= 1,
77 'crm.mt_lead_stage': lambda self, cr, uid, obj, ctx=None: (obj.stage_id and obj.stage_id.sequence > 1) and obj.probability < 100,
78 'crm.mt_lead_won': lambda self, cr, uid, obj, ctx=None: obj.probability == 100 and obj.stage_id and obj.stage_id.fold,
79 'crm.mt_lead_lost': lambda self, cr, uid, obj, ctx=None: obj.probability == 0 and obj.stage_id and obj.stage_id.fold and obj.stage_id.sequence > 1,
83 def get_empty_list_help(self, cr, uid, help, context=None):
84 if context.get('default_type') == 'lead':
85 context['empty_list_help_model'] = 'crm.case.section'
86 context['empty_list_help_id'] = context.get('default_section_id')
87 context['empty_list_help_document_name'] = _("leads")
88 return super(crm_lead, self).get_empty_list_help(cr, uid, help, context=context)
90 def _get_default_section_id(self, cr, uid, context=None):
91 """ Gives default section by checking if present in the context """
92 return self._resolve_section_id_from_context(cr, uid, context=context) or False
94 def _get_default_stage_id(self, cr, uid, context=None):
95 """ Gives default stage_id """
96 section_id = self._get_default_section_id(cr, uid, context=context)
97 return self.stage_find(cr, uid, [], section_id, [('fold', '=', False)], context=context)
99 def _resolve_section_id_from_context(self, cr, uid, context=None):
100 """ Returns ID of section based on the value of 'section_id'
101 context key, or None if it cannot be resolved to a single
106 if type(context.get('default_section_id')) in (int, long):
107 return context.get('default_section_id')
108 if isinstance(context.get('default_section_id'), basestring):
109 section_ids = self.pool.get('crm.case.section').name_search(cr, uid, name=context['default_section_id'], context=context)
110 if len(section_ids) == 1:
111 return int(section_ids[0][0])
114 def _resolve_type_from_context(self, cr, uid, context=None):
115 """ Returns the type (lead or opportunity) from the type context
116 key. Returns None if it cannot be resolved.
120 return context.get('default_type')
122 def _read_group_stage_ids(self, cr, uid, ids, domain, read_group_order=None, access_rights_uid=None, context=None):
123 access_rights_uid = access_rights_uid or uid
124 stage_obj = self.pool.get('crm.case.stage')
125 order = stage_obj._order
126 # lame hack to allow reverting search, should just work in the trivial case
127 if read_group_order == 'stage_id desc':
128 order = "%s desc" % order
129 # retrieve section_id from the context and write the domain
130 # - ('id', 'in', 'ids'): add columns that should be present
131 # - OR ('case_default', '=', True), ('fold', '=', False): add default columns that are not folded
132 # - OR ('section_ids', '=', section_id), ('fold', '=', False) if section_id: add section columns that are not folded
134 section_id = self._resolve_section_id_from_context(cr, uid, context=context)
136 search_domain += ['|', ('section_ids', '=', section_id)]
137 search_domain += [('id', 'in', ids)]
139 search_domain += ['|', ('id', 'in', ids), ('case_default', '=', True)]
140 # retrieve type from the context (if set: choose 'type' or 'both')
141 type = self._resolve_type_from_context(cr, uid, context=context)
143 search_domain += ['|', ('type', '=', type), ('type', '=', 'both')]
145 stage_ids = stage_obj._search(cr, uid, search_domain, order=order, access_rights_uid=access_rights_uid, context=context)
146 result = stage_obj.name_get(cr, access_rights_uid, stage_ids, context=context)
147 # restore order of the search
148 result.sort(lambda x, y: cmp(stage_ids.index(x[0]), stage_ids.index(y[0])))
151 for stage in stage_obj.browse(cr, access_rights_uid, stage_ids, context=context):
152 fold[stage.id] = stage.fold or False
155 def fields_view_get(self, cr, user, view_id=None, view_type='form', context=None, toolbar=False, submenu=False):
156 if view_type == 'form' and context and context.get('opportunity_id'):
157 # TODO: replace by get_formview_action call
158 lead_type = self.browse(cr, user, context['opportunity_id'], context=context).type
159 view_lead_xml_id = 'crm_case_form_view_oppor' if lead_type == 'opportunity' else 'crm_case_form_view_leads'
160 _, view_id = self.pool['ir.model.data'].get_object_reference(cr, user, 'crm', view_lead_xml_id)
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))
224 'partner_id': fields.many2one('res.partner', 'Partner', ondelete='set null', track_visibility='onchange',
225 select=True, help="Linked partner (optional). Usually created when converting the lead."),
227 'id': fields.integer('ID', readonly=True),
228 'name': fields.char('Subject', size=64, required=True, select=1),
229 'active': fields.boolean('Active', required=False),
230 'date_action_last': fields.datetime('Last Action', readonly=1),
231 'date_action_next': fields.datetime('Next Action', readonly=1),
232 'email_from': fields.char('Email', size=128, help="Email address of the contact", select=1),
233 'section_id': fields.many2one('crm.case.section', 'Sales Team',
234 select=True, track_visibility='onchange', help='When sending mails, the default email address is taken from the sales team.'),
235 'create_date': fields.datetime('Creation Date', readonly=True),
236 'email_cc': fields.text('Global CC', help="These email addresses will be added to the CC field of all inbound and outbound emails for this record before being sent. Separate multiple email addresses with a comma"),
237 'description': fields.text('Notes'),
238 'write_date': fields.datetime('Update Date', readonly=True),
239 'categ_ids': fields.many2many('crm.case.categ', 'crm_lead_category_rel', 'lead_id', 'category_id', 'Categories', \
240 domain="['|',('section_id','=',section_id),('section_id','=',False), ('object_id.model', '=', 'crm.lead')]"),
241 'type_id': fields.many2one('crm.case.resource.type', 'Campaign', \
242 domain="['|',('section_id','=',section_id),('section_id','=',False)]", help="From which campaign (seminar, marketing campaign, mass mailing, ...) did this contact come from?"),
243 'channel_id': fields.many2one('crm.case.channel', 'Channel', help="Communication channel (mail, direct, phone, ...)"),
244 'contact_name': fields.char('Contact Name', size=64),
245 '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),
246 'opt_out': fields.boolean('Opt-Out', oldname='optout',
247 help="If opt-out is checked, this contact has refused to receive emails for mass mailing and marketing campaign. "
248 "Filter 'Available for Mass Mailing' allows users to filter the leads when performing mass mailing."),
249 'type': fields.selection([ ('lead','Lead'), ('opportunity','Opportunity'), ],'Type', select=True, help="Type is used to separate Leads and Opportunities"),
250 'priority': fields.selection(crm.AVAILABLE_PRIORITIES, 'Priority', select=True),
251 'date_closed': fields.datetime('Closed', readonly=True),
252 'stage_id': fields.many2one('crm.case.stage', 'Stage', track_visibility='onchange', select=True,
253 domain="['&', ('section_ids', '=', section_id), '|', ('type', '=', type), ('type', '=', 'both')]"),
254 'user_id': fields.many2one('res.users', 'Salesperson', select=True, track_visibility='onchange'),
255 'referred': fields.char('Referred By', size=64),
256 'date_open': fields.datetime('Assigned', readonly=True),
257 'day_open': fields.function(_compute_day, string='Days to Open', \
258 multi='day_open', type="float", store=True),
259 'day_close': fields.function(_compute_day, string='Days to Close', \
260 multi='day_close', type="float", store=True),
261 'date_last_stage_update': fields.datetime('Last Stage Update', select=True),
263 # Messaging and marketing
264 'message_bounce': fields.integer('Bounce'),
265 # Only used for type opportunity
266 'probability': fields.float('Success Rate (%)', group_operator="avg"),
267 'planned_revenue': fields.float('Expected Revenue', track_visibility='always'),
268 'ref': fields.reference('Reference', selection=openerp.addons.base.res.res_request.referencable_models),
269 'ref2': fields.reference('Reference 2', selection=openerp.addons.base.res.res_request.referencable_models),
270 'phone': fields.char("Phone", size=64),
271 'date_deadline': fields.date('Expected Closing', help="Estimate of the date on which the opportunity will be won."),
272 'date_action': fields.date('Next Action Date', select=True),
273 'title_action': fields.char('Next Action', size=64),
274 'color': fields.integer('Color Index'),
275 'partner_address_name': fields.related('partner_id', 'name', type='char', string='Partner Contact Name', readonly=True),
276 'partner_address_email': fields.related('partner_id', 'email', type='char', string='Partner Contact Email', readonly=True),
277 'company_currency': fields.related('company_id', 'currency_id', type='many2one', string='Currency', readonly=True, relation="res.currency"),
278 'user_email': fields.related('user_id', 'email', type='char', string='User Email', readonly=True),
279 'user_login': fields.related('user_id', 'login', type='char', string='User Login', readonly=True),
281 # Fields for address, due to separation from crm and res.partner
282 'street': fields.char('Street', size=128),
283 'street2': fields.char('Street2', size=128),
284 'zip': fields.char('Zip', change_default=True, size=24),
285 'city': fields.char('City', size=128),
286 'state_id': fields.many2one("res.country.state", 'State'),
287 'country_id': fields.many2one('res.country', 'Country'),
288 'phone': fields.char('Phone', size=64),
289 'fax': fields.char('Fax', size=64),
290 'mobile': fields.char('Mobile', size=64),
291 'function': fields.char('Function', size=128),
292 'title': fields.many2one('res.partner.title', 'Title'),
293 'company_id': fields.many2one('res.company', 'Company', select=1),
294 'payment_mode': fields.many2one('crm.payment.mode', 'Payment Mode', \
295 domain="[('section_id','=',section_id)]"),
296 'planned_cost': fields.float('Planned Costs'),
302 'user_id': lambda s, cr, uid, c: uid,
303 'stage_id': lambda s, cr, uid, c: s._get_default_stage_id(cr, uid, c),
304 'section_id': lambda s, cr, uid, c: s._get_default_section_id(cr, uid, c),
305 'company_id': lambda s, cr, uid, c: s.pool.get('res.company')._company_default_get(cr, uid, 'crm.lead', context=c),
306 'priority': lambda *a: crm.AVAILABLE_PRIORITIES[2][0],
308 'date_last_stage_update': fields.datetime.now,
312 ('check_probability', 'check(probability >= 0 and probability <= 100)', 'The probability of closing the deal should be between 0% and 100%!')
315 def onchange_stage_id(self, cr, uid, ids, stage_id, context=None):
318 stage = self.pool.get('crm.case.stage').browse(cr, uid, stage_id, context=context)
319 if not stage.on_change:
321 vals = {'probability': stage.probability}
322 if stage.probability >= 100 or (stage.probability == 0 and stage.sequence > 1):
323 vals['date_closed'] = fields.datetime.now()
324 return {'value': vals}
326 def on_change_partner_id(self, cr, uid, ids, partner_id, context=None):
329 partner = self.pool.get('res.partner').browse(cr, uid, partner_id, context=context)
331 'partner_name': partner.name,
332 'street': partner.street,
333 'street2': partner.street2,
334 'city': partner.city,
335 'state_id': partner.state_id and partner.state_id.id or False,
336 'country_id': partner.country_id and partner.country_id.id or False,
337 'email_from': partner.email,
338 'phone': partner.phone,
339 'mobile': partner.mobile,
343 return {'value': values}
345 def on_change_user(self, cr, uid, ids, user_id, context=None):
346 """ When changing the user, also set a section_id or restrict section id
347 to the ones user_id is member of. """
348 section_id = self._get_default_section_id(cr, uid, context=context) or False
349 if user_id and not section_id:
350 section_ids = self.pool.get('crm.case.section').search(cr, uid, ['|', ('user_id', '=', user_id), ('member_ids', '=', user_id)], context=context)
352 section_id = section_ids[0]
353 return {'value': {'section_id': section_id}}
355 def stage_find(self, cr, uid, cases, section_id, domain=None, order='sequence', context=None):
356 """ Override of the base.stage method
357 Parameter of the stage search taken from the lead:
358 - type: stage type must be the same or 'both'
359 - section_id: if set, stages must belong to this section or
360 be a default stage; if not set, stages must be default
363 if isinstance(cases, (int, long)):
364 cases = self.browse(cr, uid, cases, context=context)
367 # check whether we should try to add a condition on type
368 avoid_add_type_term = any([term for term in domain if len(term) == 3 if term[0] == 'type'])
369 # collect all section_ids
372 if not cases and context.get('default_type'):
373 ctx_type = context.get('default_type')
376 section_ids.add(section_id)
379 section_ids.add(lead.section_id.id)
380 if lead.type not in types:
381 types.append(lead.type)
382 # OR all section_ids and OR with case_default
385 search_domain += [('|')] * len(section_ids)
386 for section_id in section_ids:
387 search_domain.append(('section_ids', '=', section_id))
388 search_domain.append(('case_default', '=', True))
389 # AND with cases types
390 if not avoid_add_type_term:
391 search_domain.append(('type', 'in', types))
392 # AND with the domain in parameter
393 search_domain += list(domain)
394 # perform search, return the first found
395 stage_ids = self.pool.get('crm.case.stage').search(cr, uid, search_domain, order=order, limit=1, context=context)
400 def case_mark_lost(self, cr, uid, ids, context=None):
401 """ Mark the case as lost: state=cancel and probability=0
402 :deprecated: this method will be removed in OpenERP v8.
405 for lead in self.browse(cr, uid, ids, context=context):
406 stage_id = self.stage_find(cr, uid, [lead], lead.section_id.id or False, [('probability', '=', 0.0), ('fold', '=', True), ('sequence', '>', 1)], context=context)
408 if stages_leads.get(stage_id):
409 stages_leads[stage_id].append(lead.id)
411 stages_leads[stage_id] = [lead.id]
413 raise osv.except_osv(_('Warning!'),
414 _('To relieve your sales pipe and group all Lost opportunities, configure one of your sales stage as follow:\n'
415 'probability = 0 %, select "Change Probability Automatically".\n'
416 'Create a specific stage or edit an existing one by editing columns of your opportunity pipe.'))
417 for stage_id, lead_ids in stages_leads.items():
418 self.write(cr, uid, lead_ids, {'stage_id': stage_id}, context=context)
421 def case_mark_won(self, cr, uid, ids, context=None):
422 """ Mark the case as won: state=done and probability=100
423 :deprecated: this method will be removed in OpenERP v8.
426 for lead in self.browse(cr, uid, ids, context=context):
427 stage_id = self.stage_find(cr, uid, [lead], lead.section_id.id or False, [('probability', '=', 100.0), ('fold', '=', True)], context=context)
429 if stages_leads.get(stage_id):
430 stages_leads[stage_id].append(lead.id)
432 stages_leads[stage_id] = [lead.id]
434 raise osv.except_osv(_('Warning!'),
435 _('To relieve your sales pipe and group all Won opportunities, configure one of your sales stage as follow:\n'
436 'probability = 100 % and select "Change Probability Automatically".\n'
437 'Create a specific stage or edit an existing one by editing columns of your opportunity pipe.'))
438 for stage_id, lead_ids in stages_leads.items():
439 self.write(cr, uid, lead_ids, {'stage_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, context=None):
457 """ Set lead priority
459 return self.write(cr, uid, ids, {'priority': priority}, context=context)
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', context=context)
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', context=context)
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 # Sorting the leads/opps according to the confidence level of its stage, which relates to the probability of winning it
644 # The confidence level increases with the stage sequence, except when the stage probability is 0.0 (Lost cases)
645 # An Opportunity always has higher confidence level than a lead, unless its stage probability is 0.0
646 for opportunity in opportunities:
648 if opportunity.stage_id and not opportunity.stage_id.fold:
649 sequence = opportunity.stage_id.sequence
650 sequenced_opps.append(((int(sequence != -1 and opportunity.type == 'opportunity'), sequence, -opportunity.id), opportunity))
652 sequenced_opps.sort(reverse=True)
653 opportunities = map(itemgetter(1), sequenced_opps)
654 ids = [opportunity.id for opportunity in opportunities]
655 highest = opportunities[0]
656 opportunities_rest = opportunities[1:]
658 tail_opportunities = opportunities_rest
660 fields = list(CRM_LEAD_FIELDS_TO_MERGE)
661 merged_data = self._merge_data(cr, uid, ids, highest, fields, context=context)
664 merged_data['user_id'] = user_id
666 merged_data['section_id'] = section_id
668 # Merge messages and attachements into the first opportunity
669 self._merge_opportunity_history(cr, uid, highest.id, tail_opportunities, context=context)
670 self._merge_opportunity_attachments(cr, uid, highest.id, tail_opportunities, context=context)
672 # Merge notifications about loss of information
673 opportunities = [highest]
674 opportunities.extend(opportunities_rest)
675 self._merge_notify(cr, uid, highest.id, opportunities, context=context)
676 # Check if the stage is in the stages of the sales team. If not, assign the stage with the lowest sequence
677 if merged_data.get('section_id'):
678 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)
679 if merged_data.get('stage_id') not in section_stage_ids:
680 merged_data['stage_id'] = section_stage_ids and section_stage_ids[0] or False
681 # Write merged data into first opportunity
682 self.write(cr, uid, [highest.id], merged_data, context=context)
683 # Delete tail opportunities
684 # 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
685 self.unlink(cr, SUPERUSER_ID, [x.id for x in tail_opportunities], context=context)
689 def _convert_opportunity_data(self, cr, uid, lead, customer, section_id=False, context=None):
690 crm_stage = self.pool.get('crm.case.stage')
693 contact_id = self.pool.get('res.partner').address_get(cr, uid, [customer.id])['default']
695 section_id = lead.section_id and lead.section_id.id or False
697 'planned_revenue': lead.planned_revenue,
698 'probability': lead.probability,
700 'partner_id': customer and customer.id or False,
701 'user_id': (lead.user_id and lead.user_id.id),
702 'type': 'opportunity',
703 'date_action': fields.datetime.now(),
704 'date_open': fields.datetime.now(),
705 'email_from': customer and customer.email or lead.email_from,
706 'phone': customer and customer.phone or lead.phone,
708 if not lead.stage_id or lead.stage_id.type=='lead':
709 val['stage_id'] = self.stage_find(cr, uid, [lead], section_id, [('type', 'in', ('opportunity', 'both'))], context=context)
712 def convert_opportunity(self, cr, uid, ids, partner_id, user_ids=False, section_id=False, context=None):
715 partner = self.pool.get('res.partner')
716 customer = partner.browse(cr, uid, partner_id, context=context)
717 for lead in self.browse(cr, uid, ids, context=context):
718 # TDE: was if lead.state in ('done', 'cancel'):
719 if lead.probability == 100 or (lead.probability == 0 and lead.stage_id.fold):
721 vals = self._convert_opportunity_data(cr, uid, lead, customer, section_id, context=context)
722 self.write(cr, uid, [lead.id], vals, context=context)
724 if user_ids or section_id:
725 self.allocate_salesman(cr, uid, ids, user_ids, section_id, context=context)
729 def _lead_create_contact(self, cr, uid, lead, name, is_company, parent_id=False, context=None):
730 partner = self.pool.get('res.partner')
731 vals = {'name': name,
732 'user_id': lead.user_id.id,
733 'comment': lead.description,
734 'section_id': lead.section_id.id or False,
735 'parent_id': parent_id,
737 'mobile': lead.mobile,
738 'email': tools.email_split(lead.email_from) and tools.email_split(lead.email_from)[0] or False,
740 'title': lead.title and lead.title.id or False,
741 'function': lead.function,
742 'street': lead.street,
743 'street2': lead.street2,
746 'country_id': lead.country_id and lead.country_id.id or False,
747 'state_id': lead.state_id and lead.state_id.id or False,
748 'is_company': is_company,
751 partner = partner.create(cr, uid, vals, context=context)
754 def _create_lead_partner(self, cr, uid, lead, context=None):
756 if lead.partner_name and lead.contact_name:
757 partner_id = self._lead_create_contact(cr, uid, lead, lead.partner_name, True, context=context)
758 partner_id = self._lead_create_contact(cr, uid, lead, lead.contact_name, False, partner_id, context=context)
759 elif lead.partner_name and not lead.contact_name:
760 partner_id = self._lead_create_contact(cr, uid, lead, lead.partner_name, True, context=context)
761 elif not lead.partner_name and lead.contact_name:
762 partner_id = self._lead_create_contact(cr, uid, lead, lead.contact_name, False, context=context)
763 elif lead.email_from and self.pool.get('res.partner')._parse_partner_name(lead.email_from, context=context)[0]:
764 contact_name = self.pool.get('res.partner')._parse_partner_name(lead.email_from, context=context)[0]
765 partner_id = self._lead_create_contact(cr, uid, lead, contact_name, False, context=context)
767 raise osv.except_osv(
769 _('No customer name defined. Please fill one of the following fields: Company Name, Contact Name or Email ("Name <email@address>")')
773 def handle_partner_assignation(self, cr, uid, ids, action='create', partner_id=False, context=None):
775 Handle partner assignation during a lead conversion.
776 if action is 'create', create new partner with contact and assign lead to new partner_id.
777 otherwise assign lead to the specified partner_id
779 :param list ids: leads/opportunities ids to process
780 :param string action: what has to be done regarding partners (create it, assign an existing one, or nothing)
781 :param int partner_id: partner to assign if any
782 :return dict: dictionary organized as followed: {lead_id: partner_assigned_id}
784 #TODO this is a duplication of the handle_partner_assignation method of crm_phonecall
786 for lead in self.browse(cr, uid, ids, context=context):
787 # If the action is set to 'create' and no partner_id is set, create a new one
789 partner_ids[lead.id] = lead.partner_id.id
791 if not partner_id and action == 'create':
792 partner_id = self._create_lead_partner(cr, uid, lead, context)
793 self.pool['res.partner'].write(cr, uid, partner_id, {'section_id': lead.section_id and lead.section_id.id or False})
795 lead.write({'partner_id': partner_id}, context=context)
796 partner_ids[lead.id] = partner_id
799 def allocate_salesman(self, cr, uid, ids, user_ids=None, team_id=False, context=None):
801 Assign salesmen and salesteam to a batch of leads. If there are more
802 leads than salesmen, these salesmen will be assigned in round-robin.
803 E.g.: 4 salesmen (S1, S2, S3, S4) for 6 leads (L1, L2, ... L6). They
804 will be assigned as followed: L1 - S1, L2 - S2, L3 - S3, L4 - S4,
807 :param list ids: leads/opportunities ids to process
808 :param list user_ids: salesmen to assign
809 :param int team_id: salesteam to assign
817 value['section_id'] = team_id
819 value['user_id'] = user_ids[index]
820 # Cycle through user_ids
821 index = (index + 1) % len(user_ids)
823 self.write(cr, uid, [lead_id], value, context=context)
826 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):
828 :param string action: ('schedule','Schedule a call'), ('log','Log a call')
830 phonecall = self.pool.get('crm.phonecall')
831 model_data = self.pool.get('ir.model.data')
835 res_id = model_data._get_id(cr, uid, 'crm', 'categ_phone2')
836 categ_id = model_data.browse(cr, uid, res_id, context=context).res_id
839 for lead in self.browse(cr, uid, ids, context=context):
841 section_id = lead.section_id and lead.section_id.id or False
843 user_id = lead.user_id and lead.user_id.id or False
845 'name': call_summary,
846 'opportunity_id': lead.id,
847 'user_id': user_id or False,
848 'categ_id': categ_id or False,
849 'description': desc or '',
850 'date': schedule_time,
851 'section_id': section_id or False,
852 'partner_id': lead.partner_id and lead.partner_id.id or False,
853 'partner_phone': phone or lead.phone or (lead.partner_id and lead.partner_id.phone or False),
854 'partner_mobile': lead.partner_id and lead.partner_id.mobile or False,
855 'priority': lead.priority,
857 new_id = phonecall.create(cr, uid, vals, context=context)
858 phonecall.write(cr, uid, [new_id], {'state': 'open'}, context=context)
860 phonecall.write(cr, uid, [new_id], {'state': 'done'}, context=context)
861 phonecall_dict[lead.id] = new_id
862 self.schedule_phonecall_send_note(cr, uid, [lead.id], new_id, action, context=context)
863 return phonecall_dict
865 def redirect_opportunity_view(self, cr, uid, opportunity_id, context=None):
866 models_data = self.pool.get('ir.model.data')
868 # Get opportunity views
869 dummy, form_view = models_data.get_object_reference(cr, uid, 'crm', 'crm_case_form_view_oppor')
870 dummy, tree_view = models_data.get_object_reference(cr, uid, 'crm', 'crm_case_tree_view_oppor')
872 'name': _('Opportunity'),
874 'view_mode': 'tree, form',
875 'res_model': 'crm.lead',
876 'domain': [('type', '=', 'opportunity')],
877 'res_id': int(opportunity_id),
879 'views': [(form_view or False, 'form'),
880 (tree_view or False, 'tree'),
881 (False, 'calendar'), (False, 'graph')],
882 'type': 'ir.actions.act_window',
885 def redirect_lead_view(self, cr, uid, lead_id, context=None):
886 models_data = self.pool.get('ir.model.data')
889 dummy, form_view = models_data.get_object_reference(cr, uid, 'crm', 'crm_case_form_view_leads')
890 dummy, tree_view = models_data.get_object_reference(cr, uid, 'crm', 'crm_case_tree_view_leads')
894 'view_mode': 'tree, form',
895 'res_model': 'crm.lead',
896 'domain': [('type', '=', 'lead')],
897 'res_id': int(lead_id),
899 'views': [(form_view or False, 'form'),
900 (tree_view or False, 'tree'),
901 (False, 'calendar'), (False, 'graph')],
902 'type': 'ir.actions.act_window',
905 def action_makeMeeting(self, cr, uid, ids, context=None):
907 Open meeting's calendar view to schedule meeting on current opportunity.
908 :return dict: dictionary value for created Meeting view
910 opportunity = self.browse(cr, uid, ids[0], context)
911 res = self.pool.get('ir.actions.act_window').for_xml_id(cr, uid, 'calendar', 'action_calendar_event', context)
913 'default_opportunity_id': opportunity.id,
914 'default_partner_id': opportunity.partner_id and opportunity.partner_id.id or False,
915 'default_partner_ids' : opportunity.partner_id and [opportunity.partner_id.id] or False,
916 'default_user_id': uid,
917 'default_section_id': opportunity.section_id and opportunity.section_id.id or False,
918 'default_email_from': opportunity.email_from,
919 'default_name': opportunity.name,
923 def create(self, cr, uid, vals, context=None):
926 if vals.get('type') and not context.get('default_type'):
927 context['default_type'] = vals.get('type')
928 if vals.get('section_id') and not context.get('default_section_id'):
929 context['default_section_id'] = vals.get('section_id')
931 # context: no_log, because subtype already handle this
932 create_context = dict(context, mail_create_nolog=True)
933 return super(crm_lead, self).create(cr, uid, vals, context=create_context)
935 def write(self, cr, uid, ids, vals, context=None):
936 # stage change: update date_last_stage_update
937 if 'stage_id' in vals:
938 vals['date_last_stage_update'] = fields.datetime.now()
939 # stage change with new stage: update probability
940 if vals.get('stage_id') and not vals.get('probability'):
941 onchange_stage_values = self.onchange_stage_id(cr, uid, ids, vals.get('stage_id'), context=context)['value']
942 vals.update(onchange_stage_values)
943 return super(crm_lead, self).write(cr, uid, ids, vals, context=context)
945 def copy(self, cr, uid, id, default=None, context=None):
950 lead = self.browse(cr, uid, id, context=context)
951 local_context = dict(context)
952 local_context.setdefault('default_type', lead.type)
953 local_context.setdefault('default_section_id', lead.section_id)
954 if lead.type == 'opportunity':
955 default['date_open'] = fields.datetime.now()
957 default['date_open'] = False
958 default['date_closed'] = False
959 default['stage_id'] = self._get_default_stage_id(cr, uid, local_context)
960 return super(crm_lead, self).copy(cr, uid, id, default, context=context)
962 # ----------------------------------------
964 # ----------------------------------------
966 def message_get_reply_to(self, cr, uid, ids, context=None):
967 """ Override to get the reply_to of the parent project. """
968 return [lead.section_id.message_get_reply_to()[0] if lead.section_id else False
969 for lead in self.browse(cr, SUPERUSER_ID, ids, context=context)]
971 def _get_formview_action(self, cr, uid, id, context=None):
972 action = super(crm_lead, self)._get_formview_action(cr, uid, id, context=context)
973 obj = self.browse(cr, uid, id, context=context)
974 if obj.type == 'opportunity':
975 model, view_id = self.pool.get('ir.model.data').get_object_reference(cr, uid, 'crm', 'crm_case_form_view_oppor')
977 'views': [(view_id, 'form')],
981 def message_get_suggested_recipients(self, cr, uid, ids, context=None):
982 recipients = super(crm_lead, self).message_get_suggested_recipients(cr, uid, ids, context=context)
984 for lead in self.browse(cr, uid, ids, context=context):
986 self._message_add_suggested_recipient(cr, uid, recipients, lead, partner=lead.partner_id, reason=_('Customer'))
987 elif lead.email_from:
988 self._message_add_suggested_recipient(cr, uid, recipients, lead, email=lead.email_from, reason=_('Customer Email'))
989 except (osv.except_osv, orm.except_orm): # no read access rights -> just ignore suggested recipients because this imply modifying followers
993 def message_new(self, cr, uid, msg, custom_values=None, context=None):
994 """ Overrides mail_thread message_new that is called by the mailgateway
995 through message_process.
996 This override updates the document according to the email.
998 if custom_values is None:
1001 'name': msg.get('subject') or _("No Subject"),
1002 'email_from': msg.get('from'),
1003 'email_cc': msg.get('cc'),
1004 'partner_id': msg.get('author_id', False),
1007 if msg.get('author_id'):
1008 defaults.update(self.on_change_partner_id(cr, uid, None, msg.get('author_id'), context=context)['value'])
1009 if msg.get('priority') in dict(crm.AVAILABLE_PRIORITIES):
1010 defaults['priority'] = msg.get('priority')
1011 defaults.update(custom_values)
1012 return super(crm_lead, self).message_new(cr, uid, msg, custom_values=defaults, context=context)
1014 def message_update(self, cr, uid, ids, msg, update_vals=None, context=None):
1015 """ Overrides mail_thread message_update that is called by the mailgateway
1016 through message_process.
1017 This method updates the document according to the email.
1019 if isinstance(ids, (str, int, long)):
1021 if update_vals is None: update_vals = {}
1023 if msg.get('priority') in dict(crm.AVAILABLE_PRIORITIES):
1024 update_vals['priority'] = msg.get('priority')
1026 'cost':'planned_cost',
1027 'revenue': 'planned_revenue',
1028 'probability':'probability',
1030 for line in msg.get('body', '').split('\n'):
1032 res = tools.command_re.match(line)
1033 if res and maps.get(res.group(1).lower()):
1034 key = maps.get(res.group(1).lower())
1035 update_vals[key] = res.group(2).lower()
1037 return super(crm_lead, self).message_update(cr, uid, ids, msg, update_vals=update_vals, context=context)
1039 # ----------------------------------------
1040 # OpenChatter methods and notifications
1041 # ----------------------------------------
1043 def schedule_phonecall_send_note(self, cr, uid, ids, phonecall_id, action, context=None):
1044 phonecall = self.pool.get('crm.phonecall').browse(cr, uid, [phonecall_id], context=context)[0]
1046 message = _('Logged a call for %(date)s. %(description)s')
1048 message = _('Scheduled a call for %(date)s. %(description)s')
1049 phonecall_date = datetime.strptime(phonecall.date, tools.DEFAULT_SERVER_DATETIME_FORMAT)
1050 phonecall_usertime = fields.datetime.context_timestamp(cr, uid, phonecall_date, context=context).strftime(tools.DEFAULT_SERVER_DATETIME_FORMAT)
1051 html_time = "<time datetime='%s+00:00'>%s</time>" % (phonecall.date, phonecall_usertime)
1052 message = message % dict(date=html_time, description=phonecall.description)
1053 return self.message_post(cr, uid, ids, body=message, context=context)
1055 def log_meeting(self, cr, uid, ids, meeting_subject, meeting_date, duration, context=None):
1057 duration = _('unknown')
1059 duration = str(duration)
1060 message = _("Meeting scheduled at '%s'<br> Subject: %s <br> Duration: %s hour(s)") % (meeting_date, meeting_subject, duration)
1061 return self.message_post(cr, uid, ids, body=message, context=context)
1063 def onchange_state(self, cr, uid, ids, state_id, context=None):
1065 country_id=self.pool.get('res.country.state').browse(cr, uid, state_id, context).country_id.id
1066 return {'value':{'country_id':country_id}}
1069 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: