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 context and context.get('opportunity_id'):
157 action = self._get_formview_action(cr, user, context['opportunity_id'], context=context)
158 if action.get('views') and any(view_id for view_id in action['views'] if view_id[1] == view_type):
159 view_id = next(view_id[0] for view_id in action['views'] if view_id[1] == view_type)
160 res = super(crm_lead, self).fields_view_get(cr, user, view_id, view_type, context, toolbar=toolbar, submenu=submenu)
161 if view_type == 'form':
162 res['arch'] = self.fields_view_get_address(cr, user, res['arch'], context=context)
166 'stage_id': _read_group_stage_ids
169 def _compute_day(self, cr, uid, ids, fields, args, context=None):
171 :return dict: difference between current date and log date
173 cal_obj = self.pool.get('resource.calendar')
174 res_obj = self.pool.get('resource.resource')
177 for lead in self.browse(cr, uid, ids, context=context):
182 if field == 'day_open':
184 date_create = datetime.strptime(lead.create_date, "%Y-%m-%d %H:%M:%S")
185 date_open = datetime.strptime(lead.date_open, "%Y-%m-%d %H:%M:%S")
186 ans = date_open - date_create
187 date_until = lead.date_open
188 elif field == 'day_close':
190 date_create = datetime.strptime(lead.create_date, "%Y-%m-%d %H:%M:%S")
191 date_close = datetime.strptime(lead.date_closed, "%Y-%m-%d %H:%M:%S")
192 date_until = lead.date_closed
193 ans = date_close - date_create
197 resource_ids = res_obj.search(cr, uid, [('user_id','=',lead.user_id.id)])
198 if len(resource_ids):
199 resource_id = resource_ids[0]
201 duration = float(ans.days)
202 if lead.section_id and lead.section_id.resource_calendar_id:
203 duration = float(ans.days) * 24
204 new_dates = cal_obj.interval_get(cr,
206 lead.section_id.resource_calendar_id and lead.section_id.resource_calendar_id.id or False,
207 datetime.strptime(lead.create_date, '%Y-%m-%d %H:%M:%S'),
212 date_until = datetime.strptime(date_until, '%Y-%m-%d %H:%M:%S')
213 for in_time, out_time in new_dates:
214 if in_time.date not in no_days:
215 no_days.append(in_time.date)
216 if out_time > date_until:
218 duration = len(no_days)
219 res[lead.id][field] = abs(int(duration))
223 'partner_id': fields.many2one('res.partner', 'Partner', ondelete='set null', track_visibility='onchange',
224 select=True, help="Linked partner (optional). Usually created when converting the lead."),
226 'id': fields.integer('ID', readonly=True),
227 'name': fields.char('Subject', size=64, required=True, select=1),
228 'active': fields.boolean('Active', required=False),
229 'date_action_last': fields.datetime('Last Action', readonly=1),
230 'date_action_next': fields.datetime('Next Action', readonly=1),
231 'email_from': fields.char('Email', size=128, help="Email address of the contact", select=1),
232 'section_id': fields.many2one('crm.case.section', 'Sales Team',
233 select=True, track_visibility='onchange', help='When sending mails, the default email address is taken from the sales team.'),
234 'create_date': fields.datetime('Creation Date', readonly=True),
235 '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"),
236 'description': fields.text('Notes'),
237 'write_date': fields.datetime('Update Date', readonly=True),
238 'categ_ids': fields.many2many('crm.case.categ', 'crm_lead_category_rel', 'lead_id', 'category_id', 'Categories', \
239 domain="['|',('section_id','=',section_id),('section_id','=',False), ('object_id.model', '=', 'crm.lead')]"),
240 'type_id': fields.many2one('crm.case.resource.type', 'Campaign', \
241 domain="['|',('section_id','=',section_id),('section_id','=',False)]", help="From which campaign (seminar, marketing campaign, mass mailing, ...) did this contact come from?"),
242 'channel_id': fields.many2one('crm.case.channel', 'Channel', help="Communication channel (mail, direct, phone, ...)"),
243 'contact_name': fields.char('Contact Name', size=64),
244 '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),
245 'opt_out': fields.boolean('Opt-Out', oldname='optout',
246 help="If opt-out is checked, this contact has refused to receive emails for mass mailing and marketing campaign. "
247 "Filter 'Available for Mass Mailing' allows users to filter the leads when performing mass mailing."),
248 'type': fields.selection([ ('lead','Lead'), ('opportunity','Opportunity'), ],'Type', select=True, help="Type is used to separate Leads and Opportunities"),
249 'priority': fields.selection(crm.AVAILABLE_PRIORITIES, 'Priority', select=True),
250 'date_closed': fields.datetime('Closed', readonly=True),
251 'stage_id': fields.many2one('crm.case.stage', 'Stage', track_visibility='onchange', select=True,
252 domain="['&', ('section_ids', '=', section_id), '|', ('type', '=', type), ('type', '=', 'both')]"),
253 'user_id': fields.many2one('res.users', 'Salesperson', select=True, track_visibility='onchange'),
254 'referred': fields.char('Referred By', size=64),
255 'date_open': fields.datetime('Assigned', readonly=True),
256 'day_open': fields.function(_compute_day, string='Days to Open', \
257 multi='day_open', type="float", store=True),
258 'day_close': fields.function(_compute_day, string='Days to Close', \
259 multi='day_close', type="float", store=True),
260 'date_last_stage_update': fields.datetime('Last Stage Update', select=True),
262 # Messaging and marketing
263 'message_bounce': fields.integer('Bounce'),
264 # Only used for type opportunity
265 'probability': fields.float('Success Rate (%)', group_operator="avg"),
266 'planned_revenue': fields.float('Expected Revenue', track_visibility='always'),
267 'ref': fields.reference('Reference', selection=openerp.addons.base.res.res_request.referencable_models),
268 'ref2': fields.reference('Reference 2', selection=openerp.addons.base.res.res_request.referencable_models),
269 'phone': fields.char("Phone", size=64),
270 'date_deadline': fields.date('Expected Closing', help="Estimate of the date on which the opportunity will be won."),
271 'date_action': fields.date('Next Action Date', select=True),
272 'title_action': fields.char('Next Action', size=64),
273 'color': fields.integer('Color Index'),
274 'partner_address_name': fields.related('partner_id', 'name', type='char', string='Partner Contact Name', readonly=True),
275 'partner_address_email': fields.related('partner_id', 'email', type='char', string='Partner Contact Email', readonly=True),
276 'company_currency': fields.related('company_id', 'currency_id', type='many2one', string='Currency', readonly=True, relation="res.currency"),
277 'user_email': fields.related('user_id', 'email', type='char', string='User Email', readonly=True),
278 'user_login': fields.related('user_id', 'login', type='char', string='User Login', readonly=True),
280 # Fields for address, due to separation from crm and res.partner
281 'street': fields.char('Street', size=128),
282 'street2': fields.char('Street2', size=128),
283 'zip': fields.char('Zip', change_default=True, size=24),
284 'city': fields.char('City', size=128),
285 'state_id': fields.many2one("res.country.state", 'State'),
286 'country_id': fields.many2one('res.country', 'Country'),
287 'phone': fields.char('Phone', size=64),
288 'fax': fields.char('Fax', size=64),
289 'mobile': fields.char('Mobile', size=64),
290 'function': fields.char('Function', size=128),
291 'title': fields.many2one('res.partner.title', 'Title'),
292 'company_id': fields.many2one('res.company', 'Company', select=1),
293 'payment_mode': fields.many2one('crm.payment.mode', 'Payment Mode', \
294 domain="[('section_id','=',section_id)]"),
295 'planned_cost': fields.float('Planned Costs'),
301 'user_id': lambda s, cr, uid, c: uid,
302 'stage_id': lambda s, cr, uid, c: s._get_default_stage_id(cr, uid, c),
303 'section_id': lambda s, cr, uid, c: s._get_default_section_id(cr, uid, c),
304 'company_id': lambda s, cr, uid, c: s.pool.get('res.company')._company_default_get(cr, uid, 'crm.lead', context=c),
305 'priority': lambda *a: crm.AVAILABLE_PRIORITIES[2][0],
307 'date_last_stage_update': fields.datetime.now,
311 ('check_probability', 'check(probability >= 0 and probability <= 100)', 'The probability of closing the deal should be between 0% and 100%!')
314 def onchange_stage_id(self, cr, uid, ids, stage_id, context=None):
317 stage = self.pool.get('crm.case.stage').browse(cr, uid, stage_id, context=context)
318 if not stage.on_change:
320 vals = {'probability': stage.probability}
321 if stage.probability >= 100 or (stage.probability == 0 and stage.sequence > 1):
322 vals['date_closed'] = fields.datetime.now()
323 return {'value': vals}
325 def on_change_partner_id(self, cr, uid, ids, partner_id, context=None):
328 partner = self.pool.get('res.partner').browse(cr, uid, partner_id, context=context)
330 'partner_name': partner.name,
331 'street': partner.street,
332 'street2': partner.street2,
333 'city': partner.city,
334 'state_id': partner.state_id and partner.state_id.id or False,
335 'country_id': partner.country_id and partner.country_id.id or False,
336 'email_from': partner.email,
337 'phone': partner.phone,
338 'mobile': partner.mobile,
342 return {'value': values}
344 def on_change_user(self, cr, uid, ids, user_id, context=None):
345 """ When changing the user, also set a section_id or restrict section id
346 to the ones user_id is member of. """
347 section_id = self._get_default_section_id(cr, uid, context=context) or False
348 if user_id and not section_id:
349 section_ids = self.pool.get('crm.case.section').search(cr, uid, ['|', ('user_id', '=', user_id), ('member_ids', '=', user_id)], context=context)
351 section_id = section_ids[0]
352 return {'value': {'section_id': section_id}}
354 def stage_find(self, cr, uid, cases, section_id, domain=None, order='sequence', context=None):
355 """ Override of the base.stage method
356 Parameter of the stage search taken from the lead:
357 - type: stage type must be the same or 'both'
358 - section_id: if set, stages must belong to this section or
359 be a default stage; if not set, stages must be default
362 if isinstance(cases, (int, long)):
363 cases = self.browse(cr, uid, cases, context=context)
366 # check whether we should try to add a condition on type
367 avoid_add_type_term = any([term for term in domain if len(term) == 3 if term[0] == 'type'])
368 # collect all section_ids
371 if not cases and context.get('default_type'):
372 ctx_type = context.get('default_type')
375 section_ids.add(section_id)
378 section_ids.add(lead.section_id.id)
379 if lead.type not in types:
380 types.append(lead.type)
381 # OR all section_ids and OR with case_default
384 search_domain += [('|')] * len(section_ids)
385 for section_id in section_ids:
386 search_domain.append(('section_ids', '=', section_id))
387 search_domain.append(('case_default', '=', True))
388 # AND with cases types
389 if not avoid_add_type_term:
390 search_domain.append(('type', 'in', types))
391 # AND with the domain in parameter
392 search_domain += list(domain)
393 # perform search, return the first found
394 stage_ids = self.pool.get('crm.case.stage').search(cr, uid, search_domain, order=order, limit=1, context=context)
399 def case_mark_lost(self, cr, uid, ids, context=None):
400 """ Mark the case as lost: state=cancel and probability=0
401 :deprecated: this method will be removed in OpenERP v8.
404 for lead in self.browse(cr, uid, ids, context=context):
405 stage_id = self.stage_find(cr, uid, [lead], lead.section_id.id or False, [('probability', '=', 0.0), ('fold', '=', True), ('sequence', '>', 1)], context=context)
407 if stages_leads.get(stage_id):
408 stages_leads[stage_id].append(lead.id)
410 stages_leads[stage_id] = [lead.id]
412 raise osv.except_osv(_('Warning!'),
413 _('To relieve your sales pipe and group all Lost opportunities, configure one of your sales stage as follow:\n'
414 'probability = 0 %, select "Change Probability Automatically".\n'
415 'Create a specific stage or edit an existing one by editing columns of your opportunity pipe.'))
416 for stage_id, lead_ids in stages_leads.items():
417 self.write(cr, uid, lead_ids, {'stage_id': stage_id}, context=context)
420 def case_mark_won(self, cr, uid, ids, context=None):
421 """ Mark the case as won: state=done and probability=100
422 :deprecated: this method will be removed in OpenERP v8.
425 for lead in self.browse(cr, uid, ids, context=context):
426 stage_id = self.stage_find(cr, uid, [lead], lead.section_id.id or False, [('probability', '=', 100.0), ('fold', '=', True)], context=context)
428 if stages_leads.get(stage_id):
429 stages_leads[stage_id].append(lead.id)
431 stages_leads[stage_id] = [lead.id]
433 raise osv.except_osv(_('Warning!'),
434 _('To relieve your sales pipe and group all Won opportunities, configure one of your sales stage as follow:\n'
435 'probability = 100 % and select "Change Probability Automatically".\n'
436 'Create a specific stage or edit an existing one by editing columns of your opportunity pipe.'))
437 for stage_id, lead_ids in stages_leads.items():
438 self.write(cr, uid, lead_ids, {'stage_id': stage_id}, context=context)
441 def case_escalate(self, cr, uid, ids, context=None):
442 """ Escalates case to parent level """
443 for case in self.browse(cr, uid, ids, context=context):
444 data = {'active': True}
445 if case.section_id.parent_id:
446 data['section_id'] = case.section_id.parent_id.id
447 if case.section_id.parent_id.change_responsible:
448 if case.section_id.parent_id.user_id:
449 data['user_id'] = case.section_id.parent_id.user_id.id
451 raise osv.except_osv(_('Error!'), _("You are already at the top level of your sales-team category.\nTherefore you cannot escalate furthermore."))
452 self.write(cr, uid, [case.id], data, context=context)
455 def set_priority(self, cr, uid, ids, priority, context=None):
456 """ Set lead priority
458 return self.write(cr, uid, ids, {'priority': priority}, context=context)
460 def set_high_priority(self, cr, uid, ids, context=None):
461 """ Set lead priority to high
463 return self.set_priority(cr, uid, ids, '1', context=context)
465 def set_normal_priority(self, cr, uid, ids, context=None):
466 """ Set lead priority to normal
468 return self.set_priority(cr, uid, ids, '3', context=context)
470 def _merge_get_result_type(self, cr, uid, opps, context=None):
472 Define the type of the result of the merge. If at least one of the
473 element to merge is an opp, the resulting new element will be an opp.
474 Otherwise it will be a lead.
476 We'll directly use a list of browse records instead of a list of ids
477 for performances' sake: it will spare a second browse of the
480 :param list opps: list of browse records containing the leads/opps to process
481 :return string type: the type of the final element
484 if (opp.type == 'opportunity'):
489 def _merge_data(self, cr, uid, ids, oldest, fields, context=None):
491 Prepare lead/opp data into a dictionary for merging. Different types
492 of fields are processed in different ways:
493 - text: all the values are concatenated
494 - m2m and o2m: those fields aren't processed
495 - m2o: the first not null value prevails (the other are dropped)
496 - any other type of field: same as m2o
498 :param list ids: list of ids of the leads to process
499 :param list fields: list of leads' fields to process
500 :return dict data: contains the merged values
502 opportunities = self.browse(cr, uid, ids, context=context)
504 def _get_first_not_null(attr):
505 for opp in opportunities:
506 if hasattr(opp, attr) and bool(getattr(opp, attr)):
507 return getattr(opp, attr)
510 def _get_first_not_null_id(attr):
511 res = _get_first_not_null(attr)
512 return res and res.id or False
514 def _concat_all(attr):
515 return '\n\n'.join(filter(lambda x: x, [getattr(opp, attr) or '' for opp in opportunities if hasattr(opp, attr)]))
517 # Process the fields' values
519 for field_name in fields:
520 field_info = self._all_columns.get(field_name)
521 if field_info is None:
523 field = field_info.column
524 if field._type in ('many2many', 'one2many'):
526 elif field._type == 'many2one':
527 data[field_name] = _get_first_not_null_id(field_name) # !!
528 elif field._type == 'text':
529 data[field_name] = _concat_all(field_name) #not lost
531 data[field_name] = _get_first_not_null(field_name) #not lost
533 # Define the resulting type ('lead' or 'opportunity')
534 data['type'] = self._merge_get_result_type(cr, uid, opportunities, context)
537 def _mail_body(self, cr, uid, lead, fields, title=False, context=None):
540 body.append("%s\n" % (title))
542 for field_name in fields:
543 field_info = self._all_columns.get(field_name)
544 if field_info is None:
546 field = field_info.column
549 if field._type == 'selection':
550 if hasattr(field.selection, '__call__'):
551 key = field.selection(self, cr, uid, context=context)
553 key = field.selection
554 value = dict(key).get(lead[field_name], lead[field_name])
555 elif field._type == 'many2one':
557 value = lead[field_name].name_get()[0][1]
558 elif field._type == 'many2many':
560 for val in lead[field_name]:
561 field_value = val.name_get()[0][1]
562 value += field_value + ","
564 value = lead[field_name]
566 body.append("%s: %s" % (field.string, value or ''))
567 return "<br/>".join(body + ['<br/>'])
569 def _merge_notify(self, cr, uid, opportunity_id, opportunities, context=None):
571 Create a message gathering merged leads/opps information.
573 #TOFIX: mail template should be used instead of fix body, subject text
575 result_type = self._merge_get_result_type(cr, uid, opportunities, context)
576 if result_type == 'lead':
577 merge_message = _('Merged leads')
579 merge_message = _('Merged opportunities')
580 subject = [merge_message]
581 for opportunity in opportunities:
582 subject.append(opportunity.name)
583 title = "%s : %s" % (opportunity.type == 'opportunity' and _('Merged opportunity') or _('Merged lead'), opportunity.name)
584 fields = list(CRM_LEAD_FIELDS_TO_MERGE)
585 details.append(self._mail_body(cr, uid, opportunity, fields, title=title, context=context))
587 # Chatter message's subject
588 subject = subject[0] + ": " + ", ".join(subject[1:])
589 details = "\n\n".join(details)
590 return self.message_post(cr, uid, [opportunity_id], body=details, subject=subject, context=context)
592 def _merge_opportunity_history(self, cr, uid, opportunity_id, opportunities, context=None):
593 message = self.pool.get('mail.message')
594 for opportunity in opportunities:
595 for history in opportunity.message_ids:
596 message.write(cr, uid, history.id, {
597 'res_id': opportunity_id,
598 'subject' : _("From %s : %s") % (opportunity.name, history.subject)
603 def _merge_opportunity_attachments(self, cr, uid, opportunity_id, opportunities, context=None):
604 attach_obj = self.pool.get('ir.attachment')
606 # return attachments of opportunity
607 def _get_attachments(opportunity_id):
608 attachment_ids = attach_obj.search(cr, uid, [('res_model', '=', self._name), ('res_id', '=', opportunity_id)], context=context)
609 return attach_obj.browse(cr, uid, attachment_ids, context=context)
611 first_attachments = _get_attachments(opportunity_id)
612 #counter of all attachments to move. Used to make sure the name is different for all attachments
614 for opportunity in opportunities:
615 attachments = _get_attachments(opportunity.id)
616 for attachment in attachments:
617 values = {'res_id': opportunity_id,}
618 for attachment_in_first in first_attachments:
619 if attachment.name == attachment_in_first.name:
620 name = "%s (%s)" % (attachment.name, count,),
622 attachment.write(values)
625 def merge_opportunity(self, cr, uid, ids, user_id=False, section_id=False, context=None):
627 Different cases of merge:
628 - merge leads together = 1 new lead
629 - merge at least 1 opp with anything else (lead or opp) = 1 new opp
631 :param list ids: leads/opportunities ids to merge
632 :return int id: id of the resulting lead/opp
638 raise osv.except_osv(_('Warning!'), _('Please select more than one element (lead or opportunity) from the list view.'))
640 opportunities = self.browse(cr, uid, ids, context=context)
642 # Sorting the leads/opps according to the confidence level of its stage, which relates to the probability of winning it
643 # The confidence level increases with the stage sequence, except when the stage probability is 0.0 (Lost cases)
644 # An Opportunity always has higher confidence level than a lead, unless its stage probability is 0.0
645 for opportunity in opportunities:
647 if opportunity.stage_id and not opportunity.stage_id.fold:
648 sequence = opportunity.stage_id.sequence
649 sequenced_opps.append(((int(sequence != -1 and opportunity.type == 'opportunity'), sequence, -opportunity.id), opportunity))
651 sequenced_opps.sort(reverse=True)
652 opportunities = map(itemgetter(1), sequenced_opps)
653 ids = [opportunity.id for opportunity in opportunities]
654 highest = opportunities[0]
655 opportunities_rest = opportunities[1:]
657 tail_opportunities = opportunities_rest
659 fields = list(CRM_LEAD_FIELDS_TO_MERGE)
660 merged_data = self._merge_data(cr, uid, ids, highest, fields, context=context)
663 merged_data['user_id'] = user_id
665 merged_data['section_id'] = section_id
667 # Merge messages and attachements into the first opportunity
668 self._merge_opportunity_history(cr, uid, highest.id, tail_opportunities, context=context)
669 self._merge_opportunity_attachments(cr, uid, highest.id, tail_opportunities, context=context)
671 # Merge notifications about loss of information
672 opportunities = [highest]
673 opportunities.extend(opportunities_rest)
674 self._merge_notify(cr, uid, highest.id, opportunities, context=context)
675 # Check if the stage is in the stages of the sales team. If not, assign the stage with the lowest sequence
676 if merged_data.get('section_id'):
677 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)
678 if merged_data.get('stage_id') not in section_stage_ids:
679 merged_data['stage_id'] = section_stage_ids and section_stage_ids[0] or False
680 # Write merged data into first opportunity
681 self.write(cr, uid, [highest.id], merged_data, context=context)
682 # Delete tail opportunities
683 # 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
684 self.unlink(cr, SUPERUSER_ID, [x.id for x in tail_opportunities], context=context)
688 def _convert_opportunity_data(self, cr, uid, lead, customer, section_id=False, context=None):
689 crm_stage = self.pool.get('crm.case.stage')
692 contact_id = self.pool.get('res.partner').address_get(cr, uid, [customer.id])['default']
694 section_id = lead.section_id and lead.section_id.id or False
696 'planned_revenue': lead.planned_revenue,
697 'probability': lead.probability,
699 'partner_id': customer and customer.id or False,
700 'user_id': (lead.user_id and lead.user_id.id),
701 'type': 'opportunity',
702 'date_action': fields.datetime.now(),
703 'date_open': fields.datetime.now(),
704 'email_from': customer and customer.email or lead.email_from,
705 'phone': customer and customer.phone or lead.phone,
707 if not lead.stage_id or lead.stage_id.type=='lead':
708 val['stage_id'] = self.stage_find(cr, uid, [lead], section_id, [('type', 'in', ('opportunity', 'both'))], context=context)
711 def convert_opportunity(self, cr, uid, ids, partner_id, user_ids=False, section_id=False, context=None):
714 partner = self.pool.get('res.partner')
715 customer = partner.browse(cr, uid, partner_id, context=context)
716 for lead in self.browse(cr, uid, ids, context=context):
717 # TDE: was if lead.state in ('done', 'cancel'):
718 if lead.probability == 100 or (lead.probability == 0 and lead.stage_id.fold):
720 vals = self._convert_opportunity_data(cr, uid, lead, customer, section_id, context=context)
721 self.write(cr, uid, [lead.id], vals, context=context)
723 if user_ids or section_id:
724 self.allocate_salesman(cr, uid, ids, user_ids, section_id, context=context)
728 def _lead_create_contact(self, cr, uid, lead, name, is_company, parent_id=False, context=None):
729 partner = self.pool.get('res.partner')
730 vals = {'name': name,
731 'user_id': lead.user_id.id,
732 'comment': lead.description,
733 'section_id': lead.section_id.id or False,
734 'parent_id': parent_id,
736 'mobile': lead.mobile,
737 'email': tools.email_split(lead.email_from) and tools.email_split(lead.email_from)[0] or False,
739 'title': lead.title and lead.title.id or False,
740 'function': lead.function,
741 'street': lead.street,
742 'street2': lead.street2,
745 'country_id': lead.country_id and lead.country_id.id or False,
746 'state_id': lead.state_id and lead.state_id.id or False,
747 'is_company': is_company,
750 partner = partner.create(cr, uid, vals, context=context)
753 def _create_lead_partner(self, cr, uid, lead, context=None):
755 if lead.partner_name and lead.contact_name:
756 partner_id = self._lead_create_contact(cr, uid, lead, lead.partner_name, True, context=context)
757 partner_id = self._lead_create_contact(cr, uid, lead, lead.contact_name, False, partner_id, context=context)
758 elif lead.partner_name and not lead.contact_name:
759 partner_id = self._lead_create_contact(cr, uid, lead, lead.partner_name, True, context=context)
760 elif not lead.partner_name and lead.contact_name:
761 partner_id = self._lead_create_contact(cr, uid, lead, lead.contact_name, False, context=context)
762 elif lead.email_from and self.pool.get('res.partner')._parse_partner_name(lead.email_from, context=context)[0]:
763 contact_name = self.pool.get('res.partner')._parse_partner_name(lead.email_from, context=context)[0]
764 partner_id = self._lead_create_contact(cr, uid, lead, contact_name, False, context=context)
766 raise osv.except_osv(
768 _('No customer name defined. Please fill one of the following fields: Company Name, Contact Name or Email ("Name <email@address>")')
772 def handle_partner_assignation(self, cr, uid, ids, action='create', partner_id=False, context=None):
774 Handle partner assignation during a lead conversion.
775 if action is 'create', create new partner with contact and assign lead to new partner_id.
776 otherwise assign lead to the specified partner_id
778 :param list ids: leads/opportunities ids to process
779 :param string action: what has to be done regarding partners (create it, assign an existing one, or nothing)
780 :param int partner_id: partner to assign if any
781 :return dict: dictionary organized as followed: {lead_id: partner_assigned_id}
783 #TODO this is a duplication of the handle_partner_assignation method of crm_phonecall
785 for lead in self.browse(cr, uid, ids, context=context):
786 # If the action is set to 'create' and no partner_id is set, create a new one
788 partner_ids[lead.id] = lead.partner_id.id
790 if not partner_id and action == 'create':
791 partner_id = self._create_lead_partner(cr, uid, lead, context)
792 self.pool['res.partner'].write(cr, uid, partner_id, {'section_id': lead.section_id and lead.section_id.id or False})
794 lead.write({'partner_id': partner_id}, context=context)
795 partner_ids[lead.id] = partner_id
798 def allocate_salesman(self, cr, uid, ids, user_ids=None, team_id=False, context=None):
800 Assign salesmen and salesteam to a batch of leads. If there are more
801 leads than salesmen, these salesmen will be assigned in round-robin.
802 E.g.: 4 salesmen (S1, S2, S3, S4) for 6 leads (L1, L2, ... L6). They
803 will be assigned as followed: L1 - S1, L2 - S2, L3 - S3, L4 - S4,
806 :param list ids: leads/opportunities ids to process
807 :param list user_ids: salesmen to assign
808 :param int team_id: salesteam to assign
816 value['section_id'] = team_id
818 value['user_id'] = user_ids[index]
819 # Cycle through user_ids
820 index = (index + 1) % len(user_ids)
822 self.write(cr, uid, [lead_id], value, context=context)
825 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):
827 :param string action: ('schedule','Schedule a call'), ('log','Log a call')
829 phonecall = self.pool.get('crm.phonecall')
830 model_data = self.pool.get('ir.model.data')
834 res_id = model_data._get_id(cr, uid, 'crm', 'categ_phone2')
835 categ_id = model_data.browse(cr, uid, res_id, context=context).res_id
838 for lead in self.browse(cr, uid, ids, context=context):
840 section_id = lead.section_id and lead.section_id.id or False
842 user_id = lead.user_id and lead.user_id.id or False
844 'name': call_summary,
845 'opportunity_id': lead.id,
846 'user_id': user_id or False,
847 'categ_id': categ_id or False,
848 'description': desc or '',
849 'date': schedule_time,
850 'section_id': section_id or False,
851 'partner_id': lead.partner_id and lead.partner_id.id or False,
852 'partner_phone': phone or lead.phone or (lead.partner_id and lead.partner_id.phone or False),
853 'partner_mobile': lead.partner_id and lead.partner_id.mobile or False,
854 'priority': lead.priority,
856 new_id = phonecall.create(cr, uid, vals, context=context)
857 phonecall.write(cr, uid, [new_id], {'state': 'open'}, context=context)
859 phonecall.write(cr, uid, [new_id], {'state': 'done'}, context=context)
860 phonecall_dict[lead.id] = new_id
861 self.schedule_phonecall_send_note(cr, uid, [lead.id], new_id, action, context=context)
862 return phonecall_dict
864 def redirect_opportunity_view(self, cr, uid, opportunity_id, context=None):
865 models_data = self.pool.get('ir.model.data')
867 # Get opportunity views
868 dummy, form_view = models_data.get_object_reference(cr, uid, 'crm', 'crm_case_form_view_oppor')
869 dummy, tree_view = models_data.get_object_reference(cr, uid, 'crm', 'crm_case_tree_view_oppor')
871 'name': _('Opportunity'),
873 'view_mode': 'tree, form',
874 'res_model': 'crm.lead',
875 'domain': [('type', '=', 'opportunity')],
876 'res_id': int(opportunity_id),
878 'views': [(form_view or False, 'form'),
879 (tree_view or False, 'tree'),
880 (False, 'calendar'), (False, 'graph')],
881 'type': 'ir.actions.act_window',
884 def redirect_lead_view(self, cr, uid, lead_id, context=None):
885 models_data = self.pool.get('ir.model.data')
888 dummy, form_view = models_data.get_object_reference(cr, uid, 'crm', 'crm_case_form_view_leads')
889 dummy, tree_view = models_data.get_object_reference(cr, uid, 'crm', 'crm_case_tree_view_leads')
893 'view_mode': 'tree, form',
894 'res_model': 'crm.lead',
895 'domain': [('type', '=', 'lead')],
896 'res_id': int(lead_id),
898 'views': [(form_view or False, 'form'),
899 (tree_view or False, 'tree'),
900 (False, 'calendar'), (False, 'graph')],
901 'type': 'ir.actions.act_window',
904 def action_makeMeeting(self, cr, uid, ids, context=None):
906 Open meeting's calendar view to schedule meeting on current opportunity.
907 :return dict: dictionary value for created Meeting view
909 opportunity = self.browse(cr, uid, ids[0], context)
910 res = self.pool.get('ir.actions.act_window').for_xml_id(cr, uid, 'calendar', 'action_calendar_event', context)
912 'default_opportunity_id': opportunity.id,
913 'default_partner_id': opportunity.partner_id and opportunity.partner_id.id or False,
914 'default_partner_ids' : opportunity.partner_id and [opportunity.partner_id.id] or False,
915 'default_user_id': uid,
916 'default_section_id': opportunity.section_id and opportunity.section_id.id or False,
917 'default_email_from': opportunity.email_from,
918 'default_name': opportunity.name,
922 def create(self, cr, uid, vals, context=None):
925 if vals.get('type') and not context.get('default_type'):
926 context['default_type'] = vals.get('type')
927 if vals.get('section_id') and not context.get('default_section_id'):
928 context['default_section_id'] = vals.get('section_id')
930 # context: no_log, because subtype already handle this
931 create_context = dict(context, mail_create_nolog=True)
932 return super(crm_lead, self).create(cr, uid, vals, context=create_context)
934 def write(self, cr, uid, ids, vals, context=None):
935 # stage change: update date_last_stage_update
936 if 'stage_id' in vals:
937 vals['date_last_stage_update'] = fields.datetime.now()
938 # stage change with new stage: update probability
939 if vals.get('stage_id') and not vals.get('probability'):
940 onchange_stage_values = self.onchange_stage_id(cr, uid, ids, vals.get('stage_id'), context=context)['value']
941 vals.update(onchange_stage_values)
942 return super(crm_lead, self).write(cr, uid, ids, vals, context=context)
944 def copy(self, cr, uid, id, default=None, context=None):
949 lead = self.browse(cr, uid, id, context=context)
950 local_context = dict(context)
951 local_context.setdefault('default_type', lead.type)
952 local_context.setdefault('default_section_id', lead.section_id)
953 if lead.type == 'opportunity':
954 default['date_open'] = fields.datetime.now()
956 default['date_open'] = False
957 default['date_closed'] = False
958 default['stage_id'] = self._get_default_stage_id(cr, uid, local_context)
959 return super(crm_lead, self).copy(cr, uid, id, default, context=context)
961 # ----------------------------------------
963 # ----------------------------------------
965 def message_get_reply_to(self, cr, uid, ids, context=None):
966 """ Override to get the reply_to of the parent project. """
967 return [lead.section_id.message_get_reply_to()[0] if lead.section_id else False
968 for lead in self.browse(cr, SUPERUSER_ID, ids, context=context)]
970 def _get_formview_action(self, cr, uid, id, context=None):
971 action = super(crm_lead, self)._get_formview_action(cr, uid, id, context=context)
972 obj = self.browse(cr, uid, id, context=context)
973 if obj.type == 'opportunity':
974 model, view_id = self.pool.get('ir.model.data').get_object_reference(cr, uid, 'crm', 'crm_case_form_view_oppor')
976 'views': [(view_id, 'form')],
980 def message_get_suggested_recipients(self, cr, uid, ids, context=None):
981 recipients = super(crm_lead, self).message_get_suggested_recipients(cr, uid, ids, context=context)
983 for lead in self.browse(cr, uid, ids, context=context):
985 self._message_add_suggested_recipient(cr, uid, recipients, lead, partner=lead.partner_id, reason=_('Customer'))
986 elif lead.email_from:
987 self._message_add_suggested_recipient(cr, uid, recipients, lead, email=lead.email_from, reason=_('Customer Email'))
988 except (osv.except_osv, orm.except_orm): # no read access rights -> just ignore suggested recipients because this imply modifying followers
992 def message_new(self, cr, uid, msg, custom_values=None, context=None):
993 """ Overrides mail_thread message_new that is called by the mailgateway
994 through message_process.
995 This override updates the document according to the email.
997 if custom_values is None:
1000 'name': msg.get('subject') or _("No Subject"),
1001 'email_from': msg.get('from'),
1002 'email_cc': msg.get('cc'),
1003 'partner_id': msg.get('author_id', False),
1006 if msg.get('author_id'):
1007 defaults.update(self.on_change_partner_id(cr, uid, None, msg.get('author_id'), context=context)['value'])
1008 if msg.get('priority') in dict(crm.AVAILABLE_PRIORITIES):
1009 defaults['priority'] = msg.get('priority')
1010 defaults.update(custom_values)
1011 return super(crm_lead, self).message_new(cr, uid, msg, custom_values=defaults, context=context)
1013 def message_update(self, cr, uid, ids, msg, update_vals=None, context=None):
1014 """ Overrides mail_thread message_update that is called by the mailgateway
1015 through message_process.
1016 This method updates the document according to the email.
1018 if isinstance(ids, (str, int, long)):
1020 if update_vals is None: update_vals = {}
1022 if msg.get('priority') in dict(crm.AVAILABLE_PRIORITIES):
1023 update_vals['priority'] = msg.get('priority')
1025 'cost':'planned_cost',
1026 'revenue': 'planned_revenue',
1027 'probability':'probability',
1029 for line in msg.get('body', '').split('\n'):
1031 res = tools.command_re.match(line)
1032 if res and maps.get(res.group(1).lower()):
1033 key = maps.get(res.group(1).lower())
1034 update_vals[key] = res.group(2).lower()
1036 return super(crm_lead, self).message_update(cr, uid, ids, msg, update_vals=update_vals, context=context)
1038 # ----------------------------------------
1039 # OpenChatter methods and notifications
1040 # ----------------------------------------
1042 def schedule_phonecall_send_note(self, cr, uid, ids, phonecall_id, action, context=None):
1043 phonecall = self.pool.get('crm.phonecall').browse(cr, uid, [phonecall_id], context=context)[0]
1045 message = _('Logged a call for %(date)s. %(description)s')
1047 message = _('Scheduled a call for %(date)s. %(description)s')
1048 phonecall_date = datetime.strptime(phonecall.date, tools.DEFAULT_SERVER_DATETIME_FORMAT)
1049 phonecall_usertime = fields.datetime.context_timestamp(cr, uid, phonecall_date, context=context).strftime(tools.DEFAULT_SERVER_DATETIME_FORMAT)
1050 html_time = "<time datetime='%s+00:00'>%s</time>" % (phonecall.date, phonecall_usertime)
1051 message = message % dict(date=html_time, description=phonecall.description)
1052 return self.message_post(cr, uid, ids, body=message, context=context)
1054 def log_meeting(self, cr, uid, ids, meeting_subject, meeting_date, duration, context=None):
1056 duration = _('unknown')
1058 duration = str(duration)
1059 message = _("Meeting scheduled at '%s'<br> Subject: %s <br> Duration: %s hour(s)") % (meeting_date, meeting_subject, duration)
1060 return self.message_post(cr, uid, ids, body=message, context=context)
1062 def onchange_state(self, cr, uid, ids, state_id, context=None):
1064 country_id=self.pool.get('res.country.state').browse(cr, uid, state_id, context).country_id.id
1065 return {'value':{'country_id':country_id}}
1068 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: