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
26 from openerp import SUPERUSER_ID
27 from openerp import tools
28 from openerp.addons.base.res.res_partner import format_address
29 from openerp.osv import fields, osv, orm
30 from openerp.tools import html2plaintext
31 from openerp.tools.translate import _
33 CRM_LEAD_FIELDS_TO_MERGE = ['name',
65 class crm_lead(format_address, osv.osv):
68 _description = "Lead/Opportunity"
69 _order = "priority,date_action,id desc"
70 _inherit = ['mail.thread', 'ir.needaction_mixin']
74 'crm.mt_lead_create': lambda self, cr, uid, obj, ctx=None: obj.probability == 0 and obj.stage_id and obj.stage_id.sequence == 1,
75 'crm.mt_lead_stage': lambda self, cr, uid, obj, ctx=None: (obj.stage_id and obj.stage_id.sequence != 1) and obj.probability < 100,
76 'crm.mt_lead_won': lambda self, cr, uid, obj, ctx=None: obj.probability == 100 and obj.stage_id and obj.stage_id.on_change,
77 'crm.mt_lead_lost': lambda self, cr, uid, obj, ctx=None: obj.probability == 0 and obj.stage_id and obj.stage_id.sequence != 1,
81 def get_empty_list_help(self, cr, uid, help, context=None):
82 if context.get('default_type') == 'lead':
83 context['empty_list_help_model'] = 'crm.case.section'
84 context['empty_list_help_id'] = context.get('default_section_id')
85 context['empty_list_help_document_name'] = _("leads")
86 return super(crm_lead, self).get_empty_list_help(cr, uid, help, context=context)
88 def _get_default_section_id(self, cr, uid, context=None):
89 """ Gives default section by checking if present in the context """
90 return self._resolve_section_id_from_context(cr, uid, context=context) or False
92 def _get_default_stage_id(self, cr, uid, context=None):
93 """ Gives default stage_id """
94 section_id = self._get_default_section_id(cr, uid, context=context)
95 return self.stage_find(cr, uid, [], section_id, [('sequence', '=', '1')], context=context)
97 def _resolve_section_id_from_context(self, cr, uid, context=None):
98 """ Returns ID of section based on the value of 'section_id'
99 context key, or None if it cannot be resolved to a single
104 if type(context.get('default_section_id')) in (int, long):
105 return context.get('default_section_id')
106 if isinstance(context.get('default_section_id'), basestring):
107 section_ids = self.pool.get('crm.case.section').name_search(cr, uid, name=context['default_section_id'], context=context)
108 if len(section_ids) == 1:
109 return int(section_ids[0][0])
112 def _resolve_type_from_context(self, cr, uid, context=None):
113 """ Returns the type (lead or opportunity) from the type context
114 key. Returns None if it cannot be resolved.
118 return context.get('default_type')
120 def _read_group_stage_ids(self, cr, uid, ids, domain, read_group_order=None, access_rights_uid=None, context=None):
121 access_rights_uid = access_rights_uid or uid
122 stage_obj = self.pool.get('crm.case.stage')
123 order = stage_obj._order
124 # lame hack to allow reverting search, should just work in the trivial case
125 if read_group_order == 'stage_id desc':
126 order = "%s desc" % order
127 # retrieve section_id from the context and write the domain
128 # - ('id', 'in', 'ids'): add columns that should be present
129 # - OR ('case_default', '=', True), ('fold', '=', False): add default columns that are not folded
130 # - OR ('section_ids', '=', section_id), ('fold', '=', False) if section_id: add section columns that are not folded
132 section_id = self._resolve_section_id_from_context(cr, uid, context=context)
134 search_domain += ['|', ('section_ids', '=', section_id)]
135 search_domain += [('id', 'in', ids)]
137 search_domain += ['|', ('id', 'in', ids), ('case_default', '=', True)]
138 # retrieve type from the context (if set: choose 'type' or 'both')
139 type = self._resolve_type_from_context(cr, uid, context=context)
141 search_domain += ['|', ('type', '=', type), ('type', '=', 'both')]
143 stage_ids = stage_obj._search(cr, uid, search_domain, order=order, access_rights_uid=access_rights_uid, context=context)
144 result = stage_obj.name_get(cr, access_rights_uid, stage_ids, context=context)
145 # restore order of the search
146 result.sort(lambda x, y: cmp(stage_ids.index(x[0]), stage_ids.index(y[0])))
149 for stage in stage_obj.browse(cr, access_rights_uid, stage_ids, context=context):
150 fold[stage.id] = stage.fold or False
153 def fields_view_get(self, cr, user, view_id=None, view_type='form', context=None, toolbar=False, submenu=False):
154 res = super(crm_lead, self).fields_view_get(cr, user, view_id, view_type, context, toolbar=toolbar, submenu=submenu)
155 if view_type == 'form':
156 res['arch'] = self.fields_view_get_address(cr, user, res['arch'], context=context)
160 'stage_id': _read_group_stage_ids
163 def _compute_day(self, cr, uid, ids, fields, args, context=None):
165 :return dict: difference between current date and log date
167 cal_obj = self.pool.get('resource.calendar')
168 res_obj = self.pool.get('resource.resource')
171 for lead in self.browse(cr, uid, ids, context=context):
176 if field == 'day_open':
178 date_create = datetime.strptime(lead.create_date, "%Y-%m-%d %H:%M:%S")
179 date_open = datetime.strptime(lead.date_open, "%Y-%m-%d %H:%M:%S")
180 ans = date_open - date_create
181 date_until = lead.date_open
182 elif field == 'day_close':
184 date_create = datetime.strptime(lead.create_date, "%Y-%m-%d %H:%M:%S")
185 date_close = datetime.strptime(lead.date_closed, "%Y-%m-%d %H:%M:%S")
186 date_until = lead.date_closed
187 ans = date_close - date_create
191 resource_ids = res_obj.search(cr, uid, [('user_id','=',lead.user_id.id)])
192 if len(resource_ids):
193 resource_id = resource_ids[0]
195 duration = float(ans.days)
196 if lead.section_id and lead.section_id.resource_calendar_id:
197 duration = float(ans.days) * 24
198 new_dates = cal_obj.interval_get(cr,
200 lead.section_id.resource_calendar_id and lead.section_id.resource_calendar_id.id or False,
201 datetime.strptime(lead.create_date, '%Y-%m-%d %H:%M:%S'),
206 date_until = datetime.strptime(date_until, '%Y-%m-%d %H:%M:%S')
207 for in_time, out_time in new_dates:
208 if in_time.date not in no_days:
209 no_days.append(in_time.date)
210 if out_time > date_until:
212 duration = len(no_days)
213 res[lead.id][field] = abs(int(duration))
217 'partner_id': fields.many2one('res.partner', 'Partner', ondelete='set null', track_visibility='onchange',
218 select=True, help="Linked partner (optional). Usually created when converting the lead."),
220 'id': fields.integer('ID', readonly=True),
221 'name': fields.char('Subject', size=64, required=True, select=1),
222 'active': fields.boolean('Active', required=False),
223 'date_action_last': fields.datetime('Last Action', readonly=1),
224 'date_action_next': fields.datetime('Next Action', readonly=1),
225 'email_from': fields.char('Email', size=128, help="Email address of the contact", select=1),
226 'section_id': fields.many2one('crm.case.section', 'Sales Team',
227 select=True, track_visibility='onchange', help='When sending mails, the default email address is taken from the sales team.'),
228 'create_date': fields.datetime('Creation Date', readonly=True),
229 '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"),
230 'description': fields.text('Notes'),
231 'write_date': fields.datetime('Update Date', readonly=True),
232 'categ_ids': fields.many2many('crm.case.categ', 'crm_lead_category_rel', 'lead_id', 'category_id', 'Categories', \
233 domain="['|',('section_id','=',section_id),('section_id','=',False), ('object_id.model', '=', 'crm.lead')]"),
234 'type_id': fields.many2one('crm.case.resource.type', 'Campaign', \
235 domain="['|',('section_id','=',section_id),('section_id','=',False)]", help="From which campaign (seminar, marketing campaign, mass mailing, ...) did this contact come from?"),
236 'channel_id': fields.many2one('crm.case.channel', 'Channel', help="Communication channel (mail, direct, phone, ...)"),
237 'contact_name': fields.char('Contact Name', size=64),
238 '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),
239 'opt_out': fields.boolean('Opt-Out', oldname='optout',
240 help="If opt-out is checked, this contact has refused to receive emails for mass mailing and marketing campaign. "
241 "Filter 'Available for Mass Mailing' allows users to filter the leads when performing mass mailing."),
242 'type':fields.selection([ ('lead','Lead'), ('opportunity','Opportunity'), ],'Type', help="Type is used to separate Leads and Opportunities"),
243 'priority': fields.selection(crm.AVAILABLE_PRIORITIES, 'Priority', select=True),
244 'date_closed': fields.datetime('Closed', readonly=True),
245 'stage_id': fields.many2one('crm.case.stage', 'Stage', track_visibility='onchange',
246 domain="['&', ('section_ids', '=', section_id), '|', ('type', '=', type), ('type', '=', 'both')]"),
247 'user_id': fields.many2one('res.users', 'Salesperson', select=True, track_visibility='onchange'),
248 'referred': fields.char('Referred By', size=64),
249 'date_open': fields.datetime('Assigned', readonly=True),
250 'day_open': fields.function(_compute_day, string='Days to Open', \
251 multi='day_open', type="float", store=True),
252 'day_close': fields.function(_compute_day, string='Days to Close', \
253 multi='day_close', type="float", store=True),
254 'date_last_stage_update': fields.datetime('Last Stage Update', select=True),
256 # Only used for type opportunity
257 'probability': fields.float('Success Rate (%)', group_operator="avg"),
258 'planned_revenue': fields.float('Expected Revenue', track_visibility='always'),
259 'ref': fields.reference('Reference', selection=crm._links_get, size=128),
260 'ref2': fields.reference('Reference 2', selection=crm._links_get, size=128),
261 'phone': fields.char("Phone", size=64),
262 'date_deadline': fields.date('Expected Closing', help="Estimate of the date on which the opportunity will be won."),
263 'date_action': fields.date('Next Action Date', select=True),
264 'title_action': fields.char('Next Action', size=64),
265 'color': fields.integer('Color Index'),
266 'partner_address_name': fields.related('partner_id', 'name', type='char', string='Partner Contact Name', readonly=True),
267 'partner_address_email': fields.related('partner_id', 'email', type='char', string='Partner Contact Email', readonly=True),
268 'company_currency': fields.related('company_id', 'currency_id', type='many2one', string='Currency', readonly=True, relation="res.currency"),
269 'user_email': fields.related('user_id', 'email', type='char', string='User Email', readonly=True),
270 'user_login': fields.related('user_id', 'login', type='char', string='User Login', readonly=True),
272 # Fields for address, due to separation from crm and res.partner
273 'street': fields.char('Street', size=128),
274 'street2': fields.char('Street2', size=128),
275 'zip': fields.char('Zip', change_default=True, size=24),
276 'city': fields.char('City', size=128),
277 'state_id': fields.many2one("res.country.state", 'State'),
278 'country_id': fields.many2one('res.country', 'Country'),
279 'phone': fields.char('Phone', size=64),
280 'fax': fields.char('Fax', size=64),
281 'mobile': fields.char('Mobile', size=64),
282 'function': fields.char('Function', size=128),
283 'title': fields.many2one('res.partner.title', 'Title'),
284 'company_id': fields.many2one('res.company', 'Company', select=1),
285 'payment_mode': fields.many2one('crm.payment.mode', 'Payment Mode', \
286 domain="[('section_id','=',section_id)]"),
287 'planned_cost': fields.float('Planned Costs'),
293 'user_id': lambda s, cr, uid, c: uid,
294 'stage_id': lambda s, cr, uid, c: s._get_default_stage_id(cr, uid, c),
295 'section_id': lambda s, cr, uid, c: s._get_default_section_id(cr, uid, c),
296 'company_id': lambda s, cr, uid, c: s.pool.get('res.company')._company_default_get(cr, uid, 'crm.lead', context=c),
297 'priority': lambda *a: crm.AVAILABLE_PRIORITIES[2][0],
299 'date_last_stage_update': fields.datetime.now(),
303 ('check_probability', 'check(probability >= 0 and probability <= 100)', 'The probability of closing the deal should be between 0% and 100%!')
306 def onchange_stage_id(self, cr, uid, ids, stage_id, context=None):
309 stage = self.pool.get('crm.case.stage').browse(cr, uid, stage_id, context=context)
310 if not stage.on_change:
312 return {'value': {'probability': stage.probability}}
314 def on_change_partner_id(self, cr, uid, ids, partner_id, context=None):
317 partner = self.pool.get('res.partner').browse(cr, uid, partner_id, context=context)
319 'partner_name': partner.name,
320 'street': partner.street,
321 'street2': partner.street2,
322 'city': partner.city,
323 'state_id': partner.state_id and partner.state_id.id or False,
324 'country_id': partner.country_id and partner.country_id.id or False,
325 'email_from': partner.email,
326 'phone': partner.phone,
327 'mobile': partner.mobile,
330 return {'value': values}
332 def on_change_user(self, cr, uid, ids, user_id, context=None):
333 """ When changing the user, also set a section_id or restrict section id
334 to the ones user_id is member of. """
335 section_id = self._get_default_section_id(cr, uid, context=context) or False
336 if user_id and not section_id:
337 section_ids = self.pool.get('crm.case.section').search(cr, uid, ['|', ('user_id', '=', user_id), ('member_ids', '=', user_id)], context=context)
339 section_id = section_ids[0]
340 return {'value': {'section_id': section_id}}
342 # TDE NOTE: replaced byu base action rule fully working ?
343 # def _check(self, cr, uid, ids=False, context=None):
344 # """ Override of the base.stage method.
345 # Function called by the scheduler to process cases for date actions
346 # Only works on not done and cancelled cases
348 # cr.execute('select * from crm_case \
349 # where (date_action_last<%s or date_action_last is null) \
350 # and (date_action_next<=%s or date_action_next is null) \
351 # and state not in (\'cancel\',\'done\')',
352 # (time.strftime("%Y-%m-%d %H:%M:%S"),
353 # time.strftime('%Y-%m-%d %H:%M:%S')))
355 # ids2 = map(lambda x: x[0], cr.fetchall() or [])
356 # cases = self.browse(cr, uid, ids2, context=context)
357 # return self._action(cr, uid, cases, False, context=context)
359 def stage_find(self, cr, uid, cases, section_id, domain=None, order='sequence', context=None):
360 """ Override of the base.stage method
361 Parameter of the stage search taken from the lead:
362 - type: stage type must be the same or 'both'
363 - section_id: if set, stages must belong to this section or
364 be a default stage; if not set, stages must be default
367 if isinstance(cases, (int, long)):
368 cases = self.browse(cr, uid, cases, context=context)
369 # collect all section_ids
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 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, 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 for lead in self.browse(cr, uid, ids):
402 stage_id = self.stage_find(cr, uid, [lead], lead.section_id.id or False, [('probability', '=', 0.0), ('on_change', '=', True), ('sequence', '>', 1)], context=context)
404 return self.write(cr, uid, [lead.id], {'stage_id': stage_id}, context=context)
406 raise osv.except_osv(_('Warning!'),
407 _('To relieve your sales pipe and group all Lost opportunities, configure one of your sales stage as follow:\n'
408 'probability = 0 %, select "Change Probability Automatically".\n'
409 'Create a specific stage or edit an existing one by editing columns of your opportunity pipe.'))
411 def case_mark_won(self, cr, uid, ids, context=None):
412 """ Mark the case as won: state=done and probability=100 """
413 for lead in self.browse(cr, uid, ids):
414 stage_id = self.stage_find(cr, uid, [lead], lead.section_id.id or False, [('probability', '=', 100.0), ('on_change', '=', True), ('sequence', '>', 1)], context=context)
416 return self.write(cr, uid, [lead.id], {'stage_id': stage_id}, context=context)
418 raise osv.except_osv(_('Warning!'),
419 _('To relieve your sales pipe and group all Won opportunities, configure one of your sales stage as follow:\n'
420 'probability = 100 % and select "Change Probability Automatically".\n'
421 'Create a specific stage or edit an existing one by editing columns of your opportunity pipe.'))
423 def case_escalate(self, cr, uid, ids, context=None):
424 """ Escalates case to parent level """
425 for case in self.browse(cr, uid, ids, context=context):
426 data = {'active': True}
427 if case.section_id.parent_id:
428 data['section_id'] = case.section_id.parent_id.id
429 if case.section_id.parent_id.change_responsible:
430 if case.section_id.parent_id.user_id:
431 data['user_id'] = case.section_id.parent_id.user_id.id
433 raise osv.except_osv(_('Error!'), _("You are already at the top level of your sales-team category.\nTherefore you cannot escalate furthermore."))
434 self.write(cr, uid, [case.id], data, context=context)
437 def set_priority(self, cr, uid, ids, priority, context=None):
438 """ Set lead priority
440 return self.write(cr, uid, ids, {'priority': priority}, context=context)
442 def set_high_priority(self, cr, uid, ids, context=None):
443 """ Set lead priority to high
445 return self.set_priority(cr, uid, ids, '1', context=context)
447 def set_normal_priority(self, cr, uid, ids, context=None):
448 """ Set lead priority to normal
450 return self.set_priority(cr, uid, ids, '3', context=context)
452 def _merge_get_result_type(self, cr, uid, opps, context=None):
454 Define the type of the result of the merge. If at least one of the
455 element to merge is an opp, the resulting new element will be an opp.
456 Otherwise it will be a lead.
458 We'll directly use a list of browse records instead of a list of ids
459 for performances' sake: it will spare a second browse of the
462 :param list opps: list of browse records containing the leads/opps to process
463 :return string type: the type of the final element
466 if (opp.type == 'opportunity'):
471 def _merge_data(self, cr, uid, ids, oldest, fields, context=None):
473 Prepare lead/opp data into a dictionary for merging. Different types
474 of fields are processed in different ways:
475 - text: all the values are concatenated
476 - m2m and o2m: those fields aren't processed
477 - m2o: the first not null value prevails (the other are dropped)
478 - any other type of field: same as m2o
480 :param list ids: list of ids of the leads to process
481 :param list fields: list of leads' fields to process
482 :return dict data: contains the merged values
484 opportunities = self.browse(cr, uid, ids, context=context)
486 def _get_first_not_null(attr):
487 for opp in opportunities:
488 if hasattr(opp, attr) and bool(getattr(opp, attr)):
489 return getattr(opp, attr)
492 def _get_first_not_null_id(attr):
493 res = _get_first_not_null(attr)
494 return res and res.id or False
496 def _concat_all(attr):
497 return '\n\n'.join(filter(lambda x: x, [getattr(opp, attr) or '' for opp in opportunities if hasattr(opp, attr)]))
499 # Process the fields' values
501 for field_name in fields:
502 field_info = self._all_columns.get(field_name)
503 if field_info is None:
505 field = field_info.column
506 if field._type in ('many2many', 'one2many'):
508 elif field._type == 'many2one':
509 data[field_name] = _get_first_not_null_id(field_name) # !!
510 elif field._type == 'text':
511 data[field_name] = _concat_all(field_name) #not lost
513 data[field_name] = _get_first_not_null(field_name) #not lost
515 # Define the resulting type ('lead' or 'opportunity')
516 data['type'] = self._merge_get_result_type(cr, uid, opportunities, context)
519 def _mail_body(self, cr, uid, lead, fields, title=False, context=None):
522 body.append("%s\n" % (title))
524 for field_name in fields:
525 field_info = self._all_columns.get(field_name)
526 if field_info is None:
528 field = field_info.column
531 if field._type == 'selection':
532 if hasattr(field.selection, '__call__'):
533 key = field.selection(self, cr, uid, context=context)
535 key = field.selection
536 value = dict(key).get(lead[field_name], lead[field_name])
537 elif field._type == 'many2one':
539 value = lead[field_name].name_get()[0][1]
540 elif field._type == 'many2many':
542 for val in lead[field_name]:
543 field_value = val.name_get()[0][1]
544 value += field_value + ","
546 value = lead[field_name]
548 body.append("%s: %s" % (field.string, value or ''))
549 return "<br/>".join(body + ['<br/>'])
551 def _merge_notify(self, cr, uid, opportunity_id, opportunities, context=None):
553 Create a message gathering merged leads/opps information.
555 #TOFIX: mail template should be used instead of fix body, subject text
557 result_type = self._merge_get_result_type(cr, uid, opportunities, context)
558 if result_type == 'lead':
559 merge_message = _('Merged leads')
561 merge_message = _('Merged opportunities')
562 subject = [merge_message]
563 for opportunity in opportunities:
564 subject.append(opportunity.name)
565 title = "%s : %s" % (opportunity.type == 'opportunity' and _('Merged opportunity') or _('Merged lead'), opportunity.name)
566 fields = list(CRM_LEAD_FIELDS_TO_MERGE)
567 details.append(self._mail_body(cr, uid, opportunity, fields, title=title, context=context))
569 # Chatter message's subject
570 subject = subject[0] + ": " + ", ".join(subject[1:])
571 details = "\n\n".join(details)
572 return self.message_post(cr, uid, [opportunity_id], body=details, subject=subject, context=context)
574 def _merge_opportunity_history(self, cr, uid, opportunity_id, opportunities, context=None):
575 message = self.pool.get('mail.message')
576 for opportunity in opportunities:
577 for history in opportunity.message_ids:
578 message.write(cr, uid, history.id, {
579 'res_id': opportunity_id,
580 'subject' : _("From %s : %s") % (opportunity.name, history.subject)
585 def _merge_opportunity_attachments(self, cr, uid, opportunity_id, opportunities, context=None):
586 attach_obj = self.pool.get('ir.attachment')
588 # return attachments of opportunity
589 def _get_attachments(opportunity_id):
590 attachment_ids = attach_obj.search(cr, uid, [('res_model', '=', self._name), ('res_id', '=', opportunity_id)], context=context)
591 return attach_obj.browse(cr, uid, attachment_ids, context=context)
593 first_attachments = _get_attachments(opportunity_id)
594 #counter of all attachments to move. Used to make sure the name is different for all attachments
596 for opportunity in opportunities:
597 attachments = _get_attachments(opportunity.id)
598 for attachment in attachments:
599 values = {'res_id': opportunity_id,}
600 for attachment_in_first in first_attachments:
601 if attachment.name == attachment_in_first.name:
602 name = "%s (%s)" % (attachment.name, count,),
604 attachment.write(values)
607 def merge_opportunity(self, cr, uid, ids, user_id=False, section_id=False, context=None):
609 Different cases of merge:
610 - merge leads together = 1 new lead
611 - merge at least 1 opp with anything else (lead or opp) = 1 new opp
613 :param list ids: leads/opportunities ids to merge
614 :return int id: id of the resulting lead/opp
620 raise osv.except_osv(_('Warning!'), _('Please select more than one element (lead or opportunity) from the list view.'))
622 opportunities = self.browse(cr, uid, ids, context=context)
624 for opportunity in opportunities:
626 # TDE: was "if opportunity.stage_id and opportunity.stage_id.state != 'cancel':"
627 if opportunity.probability == 0 and opportunity.stage_id and opportunity.stage_id.sequence != 1 and opportunity.stage_id.fold:
628 sequence = opportunity.stage_id.sequence
629 sequenced_opps.append(((int(sequence != -1 and opportunity.type == 'opportunity'), sequence, -opportunity.id), opportunity))
631 sequenced_opps.sort(reverse=True)
632 opportunities = map(itemgetter(1), sequenced_opps)
633 ids = [opportunity.id for opportunity in opportunities]
634 highest = opportunities[0]
635 opportunities_rest = opportunities[1:]
637 tail_opportunities = opportunities_rest
639 fields = list(CRM_LEAD_FIELDS_TO_MERGE)
640 merged_data = self._merge_data(cr, uid, ids, highest, fields, context=context)
643 merged_data['user_id'] = user_id
645 merged_data['section_id'] = section_id
647 # Merge messages and attachements into the first opportunity
648 self._merge_opportunity_history(cr, uid, highest.id, tail_opportunities, context=context)
649 self._merge_opportunity_attachments(cr, uid, highest.id, tail_opportunities, context=context)
651 # Merge notifications about loss of information
652 opportunities = [highest]
653 opportunities.extend(opportunities_rest)
654 self._merge_notify(cr, uid, highest, opportunities, context=context)
655 # Check if the stage is in the stages of the sales team. If not, assign the stage with the lowest sequence
656 if merged_data.get('section_id'):
657 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)
658 if merged_data.get('stage_id') not in section_stage_ids:
659 merged_data['stage_id'] = section_stage_ids and section_stage_ids[0] or False
660 # Write merged data into first opportunity
661 self.write(cr, uid, [highest.id], merged_data, context=context)
662 # Delete tail opportunities
663 # 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
664 self.unlink(cr, SUPERUSER_ID, [x.id for x in tail_opportunities], context=context)
668 def _convert_opportunity_data(self, cr, uid, lead, customer, section_id=False, context=None):
669 crm_stage = self.pool.get('crm.case.stage')
672 contact_id = self.pool.get('res.partner').address_get(cr, uid, [customer.id])['default']
674 section_id = lead.section_id and lead.section_id.id or False
676 'planned_revenue': lead.planned_revenue,
677 'probability': lead.probability,
679 'partner_id': customer and customer.id or False,
680 'user_id': (lead.user_id and lead.user_id.id),
681 'type': 'opportunity',
682 'date_action': fields.datetime.now(),
683 'date_open': fields.datetime.now(),
684 'email_from': customer and customer.email or lead.email_from,
685 'phone': customer and customer.phone or lead.phone,
687 if not lead.stage_id or lead.stage_id.type=='lead':
688 val['stage_id'] = self.stage_find(cr, uid, [lead], section_id, [('sequence', '=', '1'), ('type', 'in', ('opportunity','both'))], context=context)
691 def convert_opportunity(self, cr, uid, ids, partner_id, user_ids=False, section_id=False, context=None):
694 partner = self.pool.get('res.partner')
695 customer = partner.browse(cr, uid, partner_id, context=context)
696 for lead in self.browse(cr, uid, ids, context=context):
697 # TDE: was if lead.state in ('done', 'cancel'):
698 if (lead.probability == '100') or (lead.probability == '0' and lead.stage_id.sequence != '1'):
700 vals = self._convert_opportunity_data(cr, uid, lead, customer, section_id, context=context)
701 self.write(cr, uid, [lead.id], vals, context=context)
703 if user_ids or section_id:
704 self.allocate_salesman(cr, uid, ids, user_ids, section_id, context=context)
708 def _lead_create_contact(self, cr, uid, lead, name, is_company, parent_id=False, context=None):
709 partner = self.pool.get('res.partner')
710 vals = {'name': name,
711 'user_id': lead.user_id.id,
712 'comment': lead.description,
713 'section_id': lead.section_id.id or False,
714 'parent_id': parent_id,
716 'mobile': lead.mobile,
717 'email': tools.email_split(lead.email_from) and tools.email_split(lead.email_from)[0] or False,
719 'title': lead.title and lead.title.id or False,
720 'function': lead.function,
721 'street': lead.street,
722 'street2': lead.street2,
725 'country_id': lead.country_id and lead.country_id.id or False,
726 'state_id': lead.state_id and lead.state_id.id or False,
727 'is_company': is_company,
730 partner = partner.create(cr, uid, vals, context=context)
733 def _create_lead_partner(self, cr, uid, lead, context=None):
735 if lead.partner_name and lead.contact_name:
736 partner_id = self._lead_create_contact(cr, uid, lead, lead.partner_name, True, context=context)
737 partner_id = self._lead_create_contact(cr, uid, lead, lead.contact_name, False, partner_id, context=context)
738 elif lead.partner_name and not lead.contact_name:
739 partner_id = self._lead_create_contact(cr, uid, lead, lead.partner_name, True, context=context)
740 elif not lead.partner_name and lead.contact_name:
741 partner_id = self._lead_create_contact(cr, uid, lead, lead.contact_name, False, context=context)
742 elif lead.email_from and self.pool.get('res.partner')._parse_partner_name(lead.email_from, context=context)[0]:
743 contact_name = self.pool.get('res.partner')._parse_partner_name(lead.email_from, context=context)[0]
744 partner_id = self._lead_create_contact(cr, uid, lead, contact_name, False, context=context)
746 raise osv.except_osv(
748 _('No customer name defined. Please fill one of the following fields: Company Name, Contact Name or Email ("Name <email@address>")')
752 def _lead_set_partner(self, cr, uid, lead, partner_id, context=None):
754 Assign a partner to a lead.
756 :param object lead: browse record of the lead to process
757 :param int partner_id: identifier of the partner to assign
758 :return bool: True if the partner has properly been assigned
761 res_partner = self.pool.get('res.partner')
763 res_partner.write(cr, uid, partner_id, {'section_id': lead.section_id and lead.section_id.id or False})
764 contact_id = res_partner.address_get(cr, uid, [partner_id])['default']
765 res = lead.write({'partner_id': partner_id}, context=context)
766 message = _("<b>Partner</b> set to <em>%s</em>." % (lead.partner_id.name))
767 self.message_post(cr, uid, [lead.id], body=message, context=context)
770 def handle_partner_assignation(self, cr, uid, ids, action='create', partner_id=False, context=None):
772 Handle partner assignation during a lead conversion.
773 if action is 'create', create new partner with contact and assign lead to new partner_id.
774 otherwise assign lead to the specified partner_id
776 :param list ids: leads/opportunities ids to process
777 :param string action: what has to be done regarding partners (create it, assign an existing one, or nothing)
778 :param int partner_id: partner to assign if any
779 :return dict: dictionary organized as followed: {lead_id: partner_assigned_id}
781 #TODO this is a duplication of the handle_partner_assignation method of crm_phonecall
783 # If a partner_id is given, force this partner for all elements
784 force_partner_id = partner_id
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
787 if action == 'create':
788 partner_id = force_partner_id or self._create_lead_partner(cr, uid, lead, context)
789 self._lead_set_partner(cr, uid, lead, partner_id, context=context)
790 partner_ids[lead.id] = partner_id
793 def allocate_salesman(self, cr, uid, ids, user_ids=None, team_id=False, context=None):
795 Assign salesmen and salesteam to a batch of leads. If there are more
796 leads than salesmen, these salesmen will be assigned in round-robin.
797 E.g.: 4 salesmen (S1, S2, S3, S4) for 6 leads (L1, L2, ... L6). They
798 will be assigned as followed: L1 - S1, L2 - S2, L3 - S3, L4 - S4,
801 :param list ids: leads/opportunities ids to process
802 :param list user_ids: salesmen to assign
803 :param int team_id: salesteam to assign
811 value['section_id'] = team_id
813 value['user_id'] = user_ids[index]
814 # Cycle through user_ids
815 index = (index + 1) % len(user_ids)
817 self.write(cr, uid, [lead_id], value, context=context)
820 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):
822 :param string action: ('schedule','Schedule a call'), ('log','Log a call')
824 phonecall = self.pool.get('crm.phonecall')
825 model_data = self.pool.get('ir.model.data')
828 res_id = model_data._get_id(cr, uid, 'crm', 'categ_phone2')
830 categ_id = model_data.browse(cr, uid, res_id, context=context).res_id
831 for lead in self.browse(cr, uid, ids, context=context):
833 section_id = lead.section_id and lead.section_id.id or False
835 user_id = lead.user_id and lead.user_id.id or False
837 'name': call_summary,
838 'opportunity_id': lead.id,
839 'user_id': user_id or False,
840 'categ_id': categ_id or False,
841 'description': desc or '',
842 'date': schedule_time,
843 'section_id': section_id or False,
844 'partner_id': lead.partner_id and lead.partner_id.id or False,
845 'partner_phone': phone or lead.phone or (lead.partner_id and lead.partner_id.phone or False),
846 'partner_mobile': lead.partner_id and lead.partner_id.mobile or False,
847 'priority': lead.priority,
849 new_id = phonecall.create(cr, uid, vals, context=context)
850 phonecall.case_open(cr, uid, [new_id], context=context)
852 phonecall.case_close(cr, uid, [new_id], context=context)
853 phonecall_dict[lead.id] = new_id
854 self.schedule_phonecall_send_note(cr, uid, [lead.id], new_id, action, context=context)
855 return phonecall_dict
857 def redirect_opportunity_view(self, cr, uid, opportunity_id, context=None):
858 models_data = self.pool.get('ir.model.data')
860 # Get opportunity views
861 dummy, form_view = models_data.get_object_reference(cr, uid, 'crm', 'crm_case_form_view_oppor')
862 dummy, tree_view = models_data.get_object_reference(cr, uid, 'crm', 'crm_case_tree_view_oppor')
864 'name': _('Opportunity'),
866 'view_mode': 'tree, form',
867 'res_model': 'crm.lead',
868 'domain': [('type', '=', 'opportunity')],
869 'res_id': int(opportunity_id),
871 'views': [(form_view or False, 'form'),
872 (tree_view or False, 'tree'),
873 (False, 'calendar'), (False, 'graph')],
874 'type': 'ir.actions.act_window',
877 def redirect_lead_view(self, cr, uid, lead_id, context=None):
878 models_data = self.pool.get('ir.model.data')
881 dummy, form_view = models_data.get_object_reference(cr, uid, 'crm', 'crm_case_form_view_leads')
882 dummy, tree_view = models_data.get_object_reference(cr, uid, 'crm', 'crm_case_tree_view_leads')
886 'view_mode': 'tree, form',
887 'res_model': 'crm.lead',
888 'domain': [('type', '=', 'lead')],
889 'res_id': int(lead_id),
891 'views': [(form_view or False, 'form'),
892 (tree_view or False, 'tree'),
893 (False, 'calendar'), (False, 'graph')],
894 'type': 'ir.actions.act_window',
897 def action_makeMeeting(self, cr, uid, ids, context=None):
899 Open meeting's calendar view to schedule meeting on current opportunity.
900 :return dict: dictionary value for created Meeting view
902 opportunity = self.browse(cr, uid, ids[0], context)
903 res = self.pool.get('ir.actions.act_window').for_xml_id(cr, uid, 'base_calendar', 'action_crm_meeting', context)
905 'default_opportunity_id': opportunity.id,
906 'default_partner_id': opportunity.partner_id and opportunity.partner_id.id or False,
907 'default_partner_ids' : opportunity.partner_id and [opportunity.partner_id.id] or False,
908 'default_user_id': uid,
909 'default_section_id': opportunity.section_id and opportunity.section_id.id or False,
910 'default_email_from': opportunity.email_from,
911 'default_name': opportunity.name,
915 def create(self, cr, uid, vals, context=None):
918 if vals.get('type') and not context.get('default_type'):
919 context['default_type'] = vals.get('type')
920 if vals.get('section_id') and not context.get('default_section_id'):
921 context['default_section_id'] = vals.get('section_id')
923 # context: no_log, because subtype already handle this
924 create_context = dict(context, mail_create_nolog=True)
925 return super(crm_lead, self).create(cr, uid, vals, context=create_context)
927 def write(self, cr, uid, ids, vals, context=None):
928 # stage change: update date_last_stage_update
929 if 'stage_id' in vals:
930 vals['date_last_stage_update'] = fields.datetime.now()
931 # stage change with new stage: update probability
932 if vals.get('stage_id') and not vals.get('probability'):
933 onchange_stage_values = self.onchange_stage_id(cr, uid, ids, vals.get('stage_id'), context=context)['value']
934 vals.update(onchange_stage_values)
935 return super(crm_lead, self).write(cr, uid, ids, vals, context=context)
937 # ----------------------------------------
939 # ----------------------------------------
941 def message_get_reply_to(self, cr, uid, ids, context=None):
942 """ Override to get the reply_to of the parent project. """
943 return [lead.section_id.message_get_reply_to()[0] if lead.section_id else False
944 for lead in self.browse(cr, SUPERUSER_ID, ids, context=context)]
946 def _get_formview_action(self, cr, uid, id, context=None):
947 action = super(crm_lead, self)._get_formview_action(cr, uid, id, context=context)
948 obj = self.browse(cr, uid, id, context=context)
949 if obj.type == 'opportunity':
950 model, view_id = self.pool.get('ir.model.data').get_object_reference(cr, uid, 'crm', 'crm_case_form_view_oppor')
952 'views': [(view_id, 'form')],
956 def message_get_suggested_recipients(self, cr, uid, ids, context=None):
957 recipients = super(crm_lead, self).message_get_suggested_recipients(cr, uid, ids, context=context)
959 for lead in self.browse(cr, uid, ids, context=context):
961 self._message_add_suggested_recipient(cr, uid, recipients, lead, partner=lead.partner_id, reason=_('Customer'))
962 elif lead.email_from:
963 self._message_add_suggested_recipient(cr, uid, recipients, lead, email=lead.email_from, reason=_('Customer Email'))
964 except (osv.except_osv, orm.except_orm): # no read access rights -> just ignore suggested recipients because this imply modifying followers
968 def message_new(self, cr, uid, msg, custom_values=None, context=None):
969 """ Overrides mail_thread message_new that is called by the mailgateway
970 through message_process.
971 This override updates the document according to the email.
973 if custom_values is None:
975 desc = html2plaintext(msg.get('body')) if msg.get('body') else ''
977 'name': msg.get('subject') or _("No Subject"),
979 'email_from': msg.get('from'),
980 'email_cc': msg.get('cc'),
981 'partner_id': msg.get('author_id', False),
984 if msg.get('author_id'):
985 defaults.update(self.on_change_partner_id(cr, uid, None, msg.get('author_id'), context=context)['value'])
986 if msg.get('priority') in dict(crm.AVAILABLE_PRIORITIES):
987 defaults['priority'] = msg.get('priority')
988 defaults.update(custom_values)
989 return super(crm_lead, self).message_new(cr, uid, msg, custom_values=defaults, context=context)
991 def message_update(self, cr, uid, ids, msg, update_vals=None, context=None):
992 """ Overrides mail_thread message_update that is called by the mailgateway
993 through message_process.
994 This method updates the document according to the email.
996 if isinstance(ids, (str, int, long)):
998 if update_vals is None: update_vals = {}
1000 if msg.get('priority') in dict(crm.AVAILABLE_PRIORITIES):
1001 update_vals['priority'] = msg.get('priority')
1003 'cost':'planned_cost',
1004 'revenue': 'planned_revenue',
1005 'probability':'probability',
1007 for line in msg.get('body', '').split('\n'):
1009 res = tools.command_re.match(line)
1010 if res and maps.get(res.group(1).lower()):
1011 key = maps.get(res.group(1).lower())
1012 update_vals[key] = res.group(2).lower()
1014 return super(crm_lead, self).message_update(cr, uid, ids, msg, update_vals=update_vals, context=context)
1016 # ----------------------------------------
1017 # OpenChatter methods and notifications
1018 # ----------------------------------------
1020 def schedule_phonecall_send_note(self, cr, uid, ids, phonecall_id, action, context=None):
1021 phonecall = self.pool.get('crm.phonecall').browse(cr, uid, [phonecall_id], context=context)[0]
1025 prefix = 'Scheduled'
1026 suffix = ' %s' % phonecall.description
1027 message = _("%s a call for %s.%s") % (prefix, phonecall.date, suffix)
1028 return self.message_post(cr, uid, ids, body=message, context=context)
1030 def log_meeting(self, cr, uid, ids, meeting_subject, meeting_date, duration, context=None):
1032 duration = _('unknown')
1034 duration = str(duration)
1035 message = _("Meeting scheduled at '%s'<br> Subject: %s <br> Duration: %s hour(s)") % (meeting_date, meeting_subject, duration)
1036 return self.message_post(cr, uid, ids, body=message, context=context)
1038 def onchange_state(self, cr, uid, ids, state_id, context=None):
1040 country_id=self.pool.get('res.country.state').browse(cr, uid, state_id, context).country_id.id
1041 return {'value':{'country_id':country_id}}
1044 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: