[ADD] crm: mass assign apply deduplication
[odoo/odoo.git] / addons / crm / crm_lead.py
1 # -*- coding: utf-8 -*-
2 ##############################################################################
3 #
4 #    OpenERP, Open Source Management Solution
5 #    Copyright (C) 2004-today OpenERP SA (<http://www.openerp.com>)
6 #
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.
11 #
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.
16 #
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/>.
19 #
20 ##############################################################################
21
22 import crm
23 from datetime import datetime
24 from operator import itemgetter
25
26 import openerp
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 _
33
34 CRM_LEAD_FIELDS_TO_MERGE = ['name',
35     'partner_id',
36     'channel_id',
37     'company_id',
38     'country_id',
39     'section_id',
40     'state_id',
41     'stage_id',
42     'type_id',
43     'user_id',
44     'title',
45     'city',
46     'contact_name',
47     'description',
48     'email',
49     'fax',
50     'mobile',
51     'partner_name',
52     'phone',
53     'probability',
54     'planned_revenue',
55     'street',
56     'street2',
57     'zip',
58     'create_date',
59     'date_action_last',
60     'date_action_next',
61     'email_from',
62     'email_cc',
63     'partner_name']
64
65
66 class crm_lead(format_address, osv.osv):
67     """ CRM Lead Case """
68     _name = "crm.lead"
69     _description = "Lead/Opportunity"
70     _order = "priority,date_action,id desc"
71     _inherit = ['mail.thread', 'ir.needaction_mixin']
72
73     _track = {
74         'stage_id': {
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,
80         },
81     }
82
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)
89
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
93
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)
98
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
102             Sales Team.
103         """
104         if context is None:
105             context = {}
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])
112         return None
113
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.
117         """
118         if context is None:
119             context = {}
120         return context.get('default_type')
121
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
133         search_domain = []
134         section_id = self._resolve_section_id_from_context(cr, uid, context=context)
135         if section_id:
136             search_domain += ['|', ('section_ids', '=', section_id)]
137             search_domain += [('id', 'in', ids)]
138         else:
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)
142         if type:
143             search_domain += ['|', ('type', '=', type), ('type', '=', 'both')]
144         # perform search
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])))
149
150         fold = {}
151         for stage in stage_obj.browse(cr, access_rights_uid, stage_ids, context=context):
152             fold[stage.id] = stage.fold or False
153         return result, fold
154
155     def fields_view_get(self, cr, user, view_id=None, view_type='form', context=None, toolbar=False, submenu=False):
156         res = super(crm_lead, self).fields_view_get(cr, user, view_id, view_type, context, toolbar=toolbar, submenu=submenu)
157         if view_type == 'form':
158             res['arch'] = self.fields_view_get_address(cr, user, res['arch'], context=context)
159         return res
160
161     _group_by_full = {
162         'stage_id': _read_group_stage_ids
163     }
164
165     def _compute_day(self, cr, uid, ids, fields, args, context=None):
166         """
167         :return dict: difference between current date and log date
168         """
169         cal_obj = self.pool.get('resource.calendar')
170         res_obj = self.pool.get('resource.resource')
171
172         res = {}
173         for lead in self.browse(cr, uid, ids, context=context):
174             for field in fields:
175                 res[lead.id] = {}
176                 duration = 0
177                 ans = False
178                 if field == 'day_open':
179                     if lead.date_open:
180                         date_create = datetime.strptime(lead.create_date, "%Y-%m-%d %H:%M:%S")
181                         date_open = datetime.strptime(lead.date_open, "%Y-%m-%d %H:%M:%S")
182                         ans = date_open - date_create
183                         date_until = lead.date_open
184                 elif field == 'day_close':
185                     if lead.date_closed:
186                         date_create = datetime.strptime(lead.create_date, "%Y-%m-%d %H:%M:%S")
187                         date_close = datetime.strptime(lead.date_closed, "%Y-%m-%d %H:%M:%S")
188                         date_until = lead.date_closed
189                         ans = date_close - date_create
190                 if ans:
191                     resource_id = False
192                     if lead.user_id:
193                         resource_ids = res_obj.search(cr, uid, [('user_id','=',lead.user_id.id)])
194                         if len(resource_ids):
195                             resource_id = resource_ids[0]
196
197                     duration = float(ans.days)
198                     if lead.section_id and lead.section_id.resource_calendar_id:
199                         duration =  float(ans.days) * 24
200                         new_dates = cal_obj.interval_get(cr,
201                             uid,
202                             lead.section_id.resource_calendar_id and lead.section_id.resource_calendar_id.id or False,
203                             datetime.strptime(lead.create_date, '%Y-%m-%d %H:%M:%S'),
204                             duration,
205                             resource=resource_id
206                         )
207                         no_days = []
208                         date_until = datetime.strptime(date_until, '%Y-%m-%d %H:%M:%S')
209                         for in_time, out_time in new_dates:
210                             if in_time.date not in no_days:
211                                 no_days.append(in_time.date)
212                             if out_time > date_until:
213                                 break
214                         duration =  len(no_days)
215                 res[lead.id][field] = abs(int(duration))
216         return res
217
218     _columns = {
219         'partner_id': fields.many2one('res.partner', 'Partner', ondelete='set null', track_visibility='onchange',
220             select=True, help="Linked partner (optional). Usually created when converting the lead."),
221
222         'id': fields.integer('ID', readonly=True),
223         'name': fields.char('Subject', size=64, required=True, select=1),
224         'active': fields.boolean('Active', required=False),
225         'date_action_last': fields.datetime('Last Action', readonly=1),
226         'date_action_next': fields.datetime('Next Action', readonly=1),
227         'email_from': fields.char('Email', size=128, help="Email address of the contact", select=1),
228         'section_id': fields.many2one('crm.case.section', 'Sales Team',
229                         select=True, track_visibility='onchange', help='When sending mails, the default email address is taken from the sales team.'),
230         'create_date': fields.datetime('Creation Date', readonly=True),
231         '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"),
232         'description': fields.text('Notes'),
233         'write_date': fields.datetime('Update Date', readonly=True),
234         'categ_ids': fields.many2many('crm.case.categ', 'crm_lead_category_rel', 'lead_id', 'category_id', 'Categories', \
235             domain="['|',('section_id','=',section_id),('section_id','=',False), ('object_id.model', '=', 'crm.lead')]"),
236         'type_id': fields.many2one('crm.case.resource.type', 'Campaign', \
237             domain="['|',('section_id','=',section_id),('section_id','=',False)]", help="From which campaign (seminar, marketing campaign, mass mailing, ...) did this contact come from?"),
238         'channel_id': fields.many2one('crm.case.channel', 'Channel', help="Communication channel (mail, direct, phone, ...)"),
239         'contact_name': fields.char('Contact Name', size=64),
240         '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),
241         'opt_out': fields.boolean('Opt-Out', oldname='optout',
242             help="If opt-out is checked, this contact has refused to receive emails for mass mailing and marketing campaign. "
243                     "Filter 'Available for Mass Mailing' allows users to filter the leads when performing mass mailing."),
244         'type':fields.selection([ ('lead','Lead'), ('opportunity','Opportunity'), ],'Type', help="Type is used to separate Leads and Opportunities"),
245         'priority': fields.selection(crm.AVAILABLE_PRIORITIES, 'Priority', select=True),
246         'date_closed': fields.datetime('Closed', readonly=True),
247         'stage_id': fields.many2one('crm.case.stage', 'Stage', track_visibility='onchange',
248                         domain="['&', ('section_ids', '=', section_id), '|', ('type', '=', type), ('type', '=', 'both')]"),
249         'user_id': fields.many2one('res.users', 'Salesperson', select=True, track_visibility='onchange'),
250         'referred': fields.char('Referred By', size=64),
251         'date_open': fields.datetime('Assigned', readonly=True),
252         'day_open': fields.function(_compute_day, string='Days to Open', \
253                                 multi='day_open', type="float", store=True),
254         'day_close': fields.function(_compute_day, string='Days to Close', \
255                                 multi='day_close', type="float", store=True),
256         'date_last_stage_update': fields.datetime('Last Stage Update', select=True),
257
258         # Messaging and marketing
259         'message_bounce': fields.integer('Bounce'),
260         # Only used for type opportunity
261         'probability': fields.float('Success Rate (%)', group_operator="avg"),
262         'planned_revenue': fields.float('Expected Revenue', track_visibility='always'),
263         'ref': fields.reference('Reference', selection=openerp.addons.base.res.res_request.referencable_models),
264         'ref2': fields.reference('Reference 2', selection=openerp.addons.base.res.res_request.referencable_models),
265         'phone': fields.char("Phone", size=64),
266         'date_deadline': fields.date('Expected Closing', help="Estimate of the date on which the opportunity will be won."),
267         'date_action': fields.date('Next Action Date', select=True),
268         'title_action': fields.char('Next Action', size=64),
269         'color': fields.integer('Color Index'),
270         'partner_address_name': fields.related('partner_id', 'name', type='char', string='Partner Contact Name', readonly=True),
271         'partner_address_email': fields.related('partner_id', 'email', type='char', string='Partner Contact Email', readonly=True),
272         'company_currency': fields.related('company_id', 'currency_id', type='many2one', string='Currency', readonly=True, relation="res.currency"),
273         'user_email': fields.related('user_id', 'email', type='char', string='User Email', readonly=True),
274         'user_login': fields.related('user_id', 'login', type='char', string='User Login', readonly=True),
275
276         # Fields for address, due to separation from crm and res.partner
277         'street': fields.char('Street', size=128),
278         'street2': fields.char('Street2', size=128),
279         'zip': fields.char('Zip', change_default=True, size=24),
280         'city': fields.char('City', size=128),
281         'state_id': fields.many2one("res.country.state", 'State'),
282         'country_id': fields.many2one('res.country', 'Country'),
283         'phone': fields.char('Phone', size=64),
284         'fax': fields.char('Fax', size=64),
285         'mobile': fields.char('Mobile', size=64),
286         'function': fields.char('Function', size=128),
287         'title': fields.many2one('res.partner.title', 'Title'),
288         'company_id': fields.many2one('res.company', 'Company', select=1),
289         'payment_mode': fields.many2one('crm.payment.mode', 'Payment Mode', \
290                             domain="[('section_id','=',section_id)]"),
291         'planned_cost': fields.float('Planned Costs'),
292     }
293
294     _defaults = {
295         'active': 1,
296         'type': 'lead',
297         'user_id': lambda s, cr, uid, c: uid,
298         'stage_id': lambda s, cr, uid, c: s._get_default_stage_id(cr, uid, c),
299         'section_id': lambda s, cr, uid, c: s._get_default_section_id(cr, uid, c),
300         'company_id': lambda s, cr, uid, c: s.pool.get('res.company')._company_default_get(cr, uid, 'crm.lead', context=c),
301         'priority': lambda *a: crm.AVAILABLE_PRIORITIES[2][0],
302         'color': 0,
303         'date_last_stage_update': fields.datetime.now,
304     }
305
306     _sql_constraints = [
307         ('check_probability', 'check(probability >= 0 and probability <= 100)', 'The probability of closing the deal should be between 0% and 100%!')
308     ]
309
310     def onchange_stage_id(self, cr, uid, ids, stage_id, context=None):
311         if not stage_id:
312             return {'value': {}}
313         stage = self.pool.get('crm.case.stage').browse(cr, uid, stage_id, context=context)
314         if not stage.on_change:
315             return {'value': {}}
316         return {'value': {'probability': stage.probability}}
317
318     def on_change_partner_id(self, cr, uid, ids, partner_id, context=None):
319         values = {}
320         if partner_id:
321             partner = self.pool.get('res.partner').browse(cr, uid, partner_id, context=context)
322             values = {
323                 'partner_name': partner.name,
324                 'street': partner.street,
325                 'street2': partner.street2,
326                 'city': partner.city,
327                 'state_id': partner.state_id and partner.state_id.id or False,
328                 'country_id': partner.country_id and partner.country_id.id or False,
329                 'email_from': partner.email,
330                 'phone': partner.phone,
331                 'mobile': partner.mobile,
332                 'fax': partner.fax,
333             }
334         return {'value': values}
335
336     def on_change_user(self, cr, uid, ids, user_id, context=None):
337         """ When changing the user, also set a section_id or restrict section id
338             to the ones user_id is member of. """
339         section_id = self._get_default_section_id(cr, uid, context=context) or False
340         if user_id and not section_id:
341             section_ids = self.pool.get('crm.case.section').search(cr, uid, ['|', ('user_id', '=', user_id), ('member_ids', '=', user_id)], context=context)
342             if section_ids:
343                 section_id = section_ids[0]
344         return {'value': {'section_id': section_id}}
345
346     def stage_find(self, cr, uid, cases, section_id, domain=None, order='sequence', context=None):
347         """ Override of the base.stage method
348             Parameter of the stage search taken from the lead:
349             - type: stage type must be the same or 'both'
350             - section_id: if set, stages must belong to this section or
351               be a default stage; if not set, stages must be default
352               stages
353         """
354         if isinstance(cases, (int, long)):
355             cases = self.browse(cr, uid, cases, context=context)
356         if context is None:
357             context = {}
358         # check whether we should try to add a condition on type
359         avoid_add_type_term = any([term for term in domain if len(term) == 3 if term[0] == 'type'])
360         # collect all section_ids
361         section_ids = set()
362         types = ['both']
363         if not cases and context.get('default_type'):
364             ctx_type = context.get('default_type')
365             types += [ctx_type]
366         if section_id:
367             section_ids.add(section_id)
368         for lead in cases:
369             if lead.section_id:
370                 section_ids.add(lead.section_id.id)
371             if lead.type not in types:
372                 types.append(lead.type)
373         # OR all section_ids and OR with case_default
374         search_domain = []
375         if section_ids:
376             search_domain += [('|')] * len(section_ids)
377             for section_id in section_ids:
378                 search_domain.append(('section_ids', '=', section_id))
379         search_domain.append(('case_default', '=', True))
380         # AND with cases types
381         if not avoid_add_type_term:
382             search_domain.append(('type', 'in', types))
383         # AND with the domain in parameter
384         search_domain += list(domain)
385         # perform search, return the first found
386         stage_ids = self.pool.get('crm.case.stage').search(cr, uid, search_domain, order=order, limit=1, context=context)
387         if stage_ids:
388             return stage_ids[0]
389         return False
390
391     def case_mark_lost(self, cr, uid, ids, context=None):
392         """ Mark the case as lost: state=cancel and probability=0
393             :deprecated: this method will be removed in OpenERP v8.
394         """
395         stages_leads = {}
396         for lead in self.browse(cr, uid, ids, context=context):
397             stage_id = self.stage_find(cr, uid, [lead], lead.section_id.id or False, [('probability', '=', 0.0), ('fold', '=', True), ('sequence', '>', 1)], context=context)
398             if stage_id:
399                 if stages_leads.get(stage_id):
400                     stages_leads[stage_id].append(lead.id)
401                 else:
402                     stages_leads[stage_id] = [lead.id]
403             else:
404                 raise osv.except_osv(_('Warning!'),
405                     _('To relieve your sales pipe and group all Lost opportunities, configure one of your sales stage as follow:\n'
406                         'probability = 0 %, select "Change Probability Automatically".\n'
407                         'Create a specific stage or edit an existing one by editing columns of your opportunity pipe.'))
408         for stage_id, lead_ids in stages_leads.items():
409             self.write(cr, uid, lead_ids, {'stage_id': stage_id}, context=context)
410         return True
411
412     def case_mark_won(self, cr, uid, ids, context=None):
413         """ Mark the case as won: state=done and probability=100
414             :deprecated: this method will be removed in OpenERP v8.
415         """
416         stages_leads = {}
417         for lead in self.browse(cr, uid, ids, context=context):
418             stage_id = self.stage_find(cr, uid, [lead], lead.section_id.id or False, [('probability', '=', 100.0), ('fold', '=', True)], context=context)
419             if stage_id:
420                 if stages_leads.get(stage_id):
421                     stages_leads[stage_id].append(lead.id)
422                 else:
423                     stages_leads[stage_id] = [lead.id]
424             else:
425                 raise osv.except_osv(_('Warning!'),
426                     _('To relieve your sales pipe and group all Won opportunities, configure one of your sales stage as follow:\n'
427                         'probability = 100 % and select "Change Probability Automatically".\n'
428                         'Create a specific stage or edit an existing one by editing columns of your opportunity pipe.'))
429         for stage_id, lead_ids in stages_leads.items():
430             self.write(cr, uid, lead_ids, {'stage_id': stage_id}, context=context)
431         return True
432
433     def case_escalate(self, cr, uid, ids, context=None):
434         """ Escalates case to parent level """
435         for case in self.browse(cr, uid, ids, context=context):
436             data = {'active': True}
437             if case.section_id.parent_id:
438                 data['section_id'] = case.section_id.parent_id.id
439                 if case.section_id.parent_id.change_responsible:
440                     if case.section_id.parent_id.user_id:
441                         data['user_id'] = case.section_id.parent_id.user_id.id
442             else:
443                 raise osv.except_osv(_('Error!'), _("You are already at the top level of your sales-team category.\nTherefore you cannot escalate furthermore."))
444             self.write(cr, uid, [case.id], data, context=context)
445         return True
446
447     def set_priority(self, cr, uid, ids, priority, context=None):
448         """ Set lead priority
449         """
450         return self.write(cr, uid, ids, {'priority': priority}, context=context)
451
452     def set_high_priority(self, cr, uid, ids, context=None):
453         """ Set lead priority to high
454         """
455         return self.set_priority(cr, uid, ids, '1', context=context)
456
457     def set_normal_priority(self, cr, uid, ids, context=None):
458         """ Set lead priority to normal
459         """
460         return self.set_priority(cr, uid, ids, '3', context=context)
461
462     def _merge_get_result_type(self, cr, uid, opps, context=None):
463         """
464         Define the type of the result of the merge.  If at least one of the
465         element to merge is an opp, the resulting new element will be an opp.
466         Otherwise it will be a lead.
467
468         We'll directly use a list of browse records instead of a list of ids
469         for performances' sake: it will spare a second browse of the
470         leads/opps.
471
472         :param list opps: list of browse records containing the leads/opps to process
473         :return string type: the type of the final element
474         """
475         for opp in opps:
476             if (opp.type == 'opportunity'):
477                 return 'opportunity'
478
479         return 'lead'
480
481     def _merge_data(self, cr, uid, ids, oldest, fields, context=None):
482         """
483         Prepare lead/opp data into a dictionary for merging.  Different types
484         of fields are processed in different ways:
485         - text: all the values are concatenated
486         - m2m and o2m: those fields aren't processed
487         - m2o: the first not null value prevails (the other are dropped)
488         - any other type of field: same as m2o
489
490         :param list ids: list of ids of the leads to process
491         :param list fields: list of leads' fields to process
492         :return dict data: contains the merged values
493         """
494         opportunities = self.browse(cr, uid, ids, context=context)
495
496         def _get_first_not_null(attr):
497             for opp in opportunities:
498                 if hasattr(opp, attr) and bool(getattr(opp, attr)):
499                     return getattr(opp, attr)
500             return False
501
502         def _get_first_not_null_id(attr):
503             res = _get_first_not_null(attr)
504             return res and res.id or False
505
506         def _concat_all(attr):
507             return '\n\n'.join(filter(lambda x: x, [getattr(opp, attr) or '' for opp in opportunities if hasattr(opp, attr)]))
508
509         # Process the fields' values
510         data = {}
511         for field_name in fields:
512             field_info = self._all_columns.get(field_name)
513             if field_info is None:
514                 continue
515             field = field_info.column
516             if field._type in ('many2many', 'one2many'):
517                 continue
518             elif field._type == 'many2one':
519                 data[field_name] = _get_first_not_null_id(field_name)  # !!
520             elif field._type == 'text':
521                 data[field_name] = _concat_all(field_name)  #not lost
522             else:
523                 data[field_name] = _get_first_not_null(field_name)  #not lost
524
525         # Define the resulting type ('lead' or 'opportunity')
526         data['type'] = self._merge_get_result_type(cr, uid, opportunities, context)
527         return data
528
529     def _mail_body(self, cr, uid, lead, fields, title=False, context=None):
530         body = []
531         if title:
532             body.append("%s\n" % (title))
533
534         for field_name in fields:
535             field_info = self._all_columns.get(field_name)
536             if field_info is None:
537                 continue
538             field = field_info.column
539             value = ''
540
541             if field._type == 'selection':
542                 if hasattr(field.selection, '__call__'):
543                     key = field.selection(self, cr, uid, context=context)
544                 else:
545                     key = field.selection
546                 value = dict(key).get(lead[field_name], lead[field_name])
547             elif field._type == 'many2one':
548                 if lead[field_name]:
549                     value = lead[field_name].name_get()[0][1]
550             elif field._type == 'many2many':
551                 if lead[field_name]:
552                     for val in lead[field_name]:
553                         field_value = val.name_get()[0][1]
554                         value += field_value + ","
555             else:
556                 value = lead[field_name]
557
558             body.append("%s: %s" % (field.string, value or ''))
559         return "<br/>".join(body + ['<br/>'])
560
561     def _merge_notify(self, cr, uid, opportunity_id, opportunities, context=None):
562         """
563         Create a message gathering merged leads/opps information.
564         """
565         #TOFIX: mail template should be used instead of fix body, subject text
566         details = []
567         result_type = self._merge_get_result_type(cr, uid, opportunities, context)
568         if result_type == 'lead':
569             merge_message = _('Merged leads')
570         else:
571             merge_message = _('Merged opportunities')
572         subject = [merge_message]
573         for opportunity in opportunities:
574             subject.append(opportunity.name)
575             title = "%s : %s" % (opportunity.type == 'opportunity' and _('Merged opportunity') or _('Merged lead'), opportunity.name)
576             fields = list(CRM_LEAD_FIELDS_TO_MERGE)
577             details.append(self._mail_body(cr, uid, opportunity, fields, title=title, context=context))
578
579         # Chatter message's subject
580         subject = subject[0] + ": " + ", ".join(subject[1:])
581         details = "\n\n".join(details)
582         return self.message_post(cr, uid, [opportunity_id], body=details, subject=subject, context=context)
583
584     def _merge_opportunity_history(self, cr, uid, opportunity_id, opportunities, context=None):
585         message = self.pool.get('mail.message')
586         for opportunity in opportunities:
587             for history in opportunity.message_ids:
588                 message.write(cr, uid, history.id, {
589                         'res_id': opportunity_id,
590                         'subject' : _("From %s : %s") % (opportunity.name, history.subject)
591                 }, context=context)
592
593         return True
594
595     def _merge_opportunity_attachments(self, cr, uid, opportunity_id, opportunities, context=None):
596         attach_obj = self.pool.get('ir.attachment')
597
598         # return attachments of opportunity
599         def _get_attachments(opportunity_id):
600             attachment_ids = attach_obj.search(cr, uid, [('res_model', '=', self._name), ('res_id', '=', opportunity_id)], context=context)
601             return attach_obj.browse(cr, uid, attachment_ids, context=context)
602
603         first_attachments = _get_attachments(opportunity_id)
604         #counter of all attachments to move. Used to make sure the name is different for all attachments
605         count = 1
606         for opportunity in opportunities:
607             attachments = _get_attachments(opportunity.id)
608             for attachment in attachments:
609                 values = {'res_id': opportunity_id,}
610                 for attachment_in_first in first_attachments:
611                     if attachment.name == attachment_in_first.name:
612                         name = "%s (%s)" % (attachment.name, count,),
613                 count+=1
614                 attachment.write(values)
615         return True
616
617     def merge_opportunity(self, cr, uid, ids, user_id=False, section_id=False, context=None):
618         """
619         Different cases of merge:
620         - merge leads together = 1 new lead
621         - merge at least 1 opp with anything else (lead or opp) = 1 new opp
622
623         :param list ids: leads/opportunities ids to merge
624         :return int id: id of the resulting lead/opp
625         """
626         if context is None:
627             context = {}
628
629         if len(ids) <= 1:
630             raise osv.except_osv(_('Warning!'), _('Please select more than one element (lead or opportunity) from the list view.'))
631
632         opportunities = self.browse(cr, uid, ids, context=context)
633         sequenced_opps = []
634         # Sorting the leads/opps according to the confidence level of its stage, which relates to the probability of winning it
635         # The confidence level increases with the stage sequence, except when the stage probability is 0.0 (Lost cases)
636         # An Opportunity always has higher confidence level than a lead, unless its stage probability is 0.0
637         for opportunity in opportunities:
638             sequence = -1
639             if opportunity.stage_id and not opportunity.stage_id.fold:
640                 sequence = opportunity.stage_id.sequence
641             sequenced_opps.append(((int(sequence != -1 and opportunity.type == 'opportunity'), sequence, -opportunity.id), opportunity))
642
643         sequenced_opps.sort(reverse=True)
644         opportunities = map(itemgetter(1), sequenced_opps)
645         ids = [opportunity.id for opportunity in opportunities]
646         highest = opportunities[0]
647         opportunities_rest = opportunities[1:]
648
649         tail_opportunities = opportunities_rest
650
651         fields = list(CRM_LEAD_FIELDS_TO_MERGE)
652         merged_data = self._merge_data(cr, uid, ids, highest, fields, context=context)
653
654         if user_id:
655             merged_data['user_id'] = user_id
656         if section_id:
657             merged_data['section_id'] = section_id
658
659         # Merge messages and attachements into the first opportunity
660         self._merge_opportunity_history(cr, uid, highest.id, tail_opportunities, context=context)
661         self._merge_opportunity_attachments(cr, uid, highest.id, tail_opportunities, context=context)
662
663         # Merge notifications about loss of information
664         opportunities = [highest]
665         opportunities.extend(opportunities_rest)
666         self._merge_notify(cr, uid, highest.id, opportunities, context=context)
667         # Check if the stage is in the stages of the sales team. If not, assign the stage with the lowest sequence
668         if merged_data.get('section_id'):
669             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)
670             if merged_data.get('stage_id') not in section_stage_ids:
671                 merged_data['stage_id'] = section_stage_ids and section_stage_ids[0] or False
672         # Write merged data into first opportunity
673         self.write(cr, uid, [highest.id], merged_data, context=context)
674         # Delete tail opportunities 
675         # 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
676         self.unlink(cr, SUPERUSER_ID, [x.id for x in tail_opportunities], context=context)
677
678         return highest.id
679
680     def _convert_opportunity_data(self, cr, uid, lead, customer, section_id=False, context=None):
681         crm_stage = self.pool.get('crm.case.stage')
682         contact_id = False
683         if customer:
684             contact_id = self.pool.get('res.partner').address_get(cr, uid, [customer.id])['default']
685         if not section_id:
686             section_id = lead.section_id and lead.section_id.id or False
687         val = {
688             'planned_revenue': lead.planned_revenue,
689             'probability': lead.probability,
690             'name': lead.name,
691             'partner_id': customer and customer.id or False,
692             'user_id': (lead.user_id and lead.user_id.id),
693             'type': 'opportunity',
694             'date_action': fields.datetime.now(),
695             'date_open': fields.datetime.now(),
696             'email_from': customer and customer.email or lead.email_from,
697             'phone': customer and customer.phone or lead.phone,
698         }
699         if not lead.stage_id or lead.stage_id.type=='lead':
700             val['stage_id'] = self.stage_find(cr, uid, [lead], section_id, [('type', 'in', ('opportunity', 'both'))], context=context)
701         return val
702
703     def convert_opportunity(self, cr, uid, ids, partner_id, user_ids=False, section_id=False, context=None):
704         customer = False
705         if partner_id:
706             partner = self.pool.get('res.partner')
707             customer = partner.browse(cr, uid, partner_id, context=context)
708         for lead in self.browse(cr, uid, ids, context=context):
709             # TDE: was if lead.state in ('done', 'cancel'):
710             if lead.probability == 100 or (lead.probability == 0 and lead.stage_id.fold):
711                 continue
712             vals = self._convert_opportunity_data(cr, uid, lead, customer, section_id, context=context)
713             self.write(cr, uid, [lead.id], vals, context=context)
714
715         if user_ids or section_id:
716             self.allocate_salesman(cr, uid, ids, user_ids, section_id, context=context)
717
718         return True
719
720     def _lead_create_contact(self, cr, uid, lead, name, is_company, parent_id=False, context=None):
721         partner = self.pool.get('res.partner')
722         vals = {'name': name,
723             'user_id': lead.user_id.id,
724             'comment': lead.description,
725             'section_id': lead.section_id.id or False,
726             'parent_id': parent_id,
727             'phone': lead.phone,
728             'mobile': lead.mobile,
729             'email': tools.email_split(lead.email_from) and tools.email_split(lead.email_from)[0] or False,
730             'fax': lead.fax,
731             'title': lead.title and lead.title.id or False,
732             'function': lead.function,
733             'street': lead.street,
734             'street2': lead.street2,
735             'zip': lead.zip,
736             'city': lead.city,
737             'country_id': lead.country_id and lead.country_id.id or False,
738             'state_id': lead.state_id and lead.state_id.id or False,
739             'is_company': is_company,
740             'type': 'contact'
741         }
742         partner = partner.create(cr, uid, vals, context=context)
743         return partner
744
745     def _create_lead_partner(self, cr, uid, lead, context=None):
746         partner_id = False
747         if lead.partner_name and lead.contact_name:
748             partner_id = self._lead_create_contact(cr, uid, lead, lead.partner_name, True, context=context)
749             partner_id = self._lead_create_contact(cr, uid, lead, lead.contact_name, False, partner_id, context=context)
750         elif lead.partner_name and not lead.contact_name:
751             partner_id = self._lead_create_contact(cr, uid, lead, lead.partner_name, True, context=context)
752         elif not lead.partner_name and lead.contact_name:
753             partner_id = self._lead_create_contact(cr, uid, lead, lead.contact_name, False, context=context)
754         elif lead.email_from and self.pool.get('res.partner')._parse_partner_name(lead.email_from, context=context)[0]:
755             contact_name = self.pool.get('res.partner')._parse_partner_name(lead.email_from, context=context)[0]
756             partner_id = self._lead_create_contact(cr, uid, lead, contact_name, False, context=context)
757         else:
758             raise osv.except_osv(
759                 _('Warning!'),
760                 _('No customer name defined. Please fill one of the following fields: Company Name, Contact Name or Email ("Name <email@address>")')
761             )
762         return partner_id
763
764     def handle_partner_assignation(self, cr, uid, ids, action='create', partner_id=False, context=None):
765         """
766         Handle partner assignation during a lead conversion.
767         if action is 'create', create new partner with contact and assign lead to new partner_id.
768         otherwise assign lead to the specified partner_id
769
770         :param list ids: leads/opportunities ids to process
771         :param string action: what has to be done regarding partners (create it, assign an existing one, or nothing)
772         :param int partner_id: partner to assign if any
773         :return dict: dictionary organized as followed: {lead_id: partner_assigned_id}
774         """
775         #TODO this is a duplication of the handle_partner_assignation method of crm_phonecall
776         partner_ids = {}
777         for lead in self.browse(cr, uid, ids, context=context):
778             # If the action is set to 'create' and no partner_id is set, create a new one
779             if lead.partner_id:
780                 partner_ids[lead.id] = lead.partner_id.id
781                 continue
782             if not partner_id and action == 'create':
783                 partner_id = self._create_lead_partner(cr, uid, lead, context)
784                 self.pool['res.partner'].write(cr, uid, partner_id, {'section_id': lead.section_id and lead.section_id.id or False})
785             if partner_id:
786                 lead.write({'partner_id': partner_id}, context=context)
787             partner_ids[lead.id] = partner_id
788         return partner_ids
789
790     def allocate_salesman(self, cr, uid, ids, user_ids=None, team_id=False, context=None):
791         """
792         Assign salesmen and salesteam to a batch of leads.  If there are more
793         leads than salesmen, these salesmen will be assigned in round-robin.
794         E.g.: 4 salesmen (S1, S2, S3, S4) for 6 leads (L1, L2, ... L6).  They
795         will be assigned as followed: L1 - S1, L2 - S2, L3 - S3, L4 - S4,
796         L5 - S1, L6 - S2.
797
798         :param list ids: leads/opportunities ids to process
799         :param list user_ids: salesmen to assign
800         :param int team_id: salesteam to assign
801         :return bool
802         """
803         index = 0
804
805         for lead_id in ids:
806             value = {}
807             if team_id:
808                 value['section_id'] = team_id
809             if user_ids:
810                 value['user_id'] = user_ids[index]
811                 # Cycle through user_ids
812                 index = (index + 1) % len(user_ids)
813             if value:
814                 self.write(cr, uid, [lead_id], value, context=context)
815         return True
816
817     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):
818         """
819         :param string action: ('schedule','Schedule a call'), ('log','Log a call')
820         """
821         phonecall = self.pool.get('crm.phonecall')
822         model_data = self.pool.get('ir.model.data')
823         phonecall_dict = {}
824         if not categ_id:
825             try:
826                 res_id = model_data._get_id(cr, uid, 'crm', 'categ_phone2')
827                 categ_id = model_data.browse(cr, uid, res_id, context=context).res_id
828             except ValueError:
829                 pass
830         for lead in self.browse(cr, uid, ids, context=context):
831             if not section_id:
832                 section_id = lead.section_id and lead.section_id.id or False
833             if not user_id:
834                 user_id = lead.user_id and lead.user_id.id or False
835             vals = {
836                 'name': call_summary,
837                 'opportunity_id': lead.id,
838                 'user_id': user_id or False,
839                 'categ_id': categ_id or False,
840                 'description': desc or '',
841                 'date': schedule_time,
842                 'section_id': section_id or False,
843                 'partner_id': lead.partner_id and lead.partner_id.id or False,
844                 'partner_phone': phone or lead.phone or (lead.partner_id and lead.partner_id.phone or False),
845                 'partner_mobile': lead.partner_id and lead.partner_id.mobile or False,
846                 'priority': lead.priority,
847             }
848             new_id = phonecall.create(cr, uid, vals, context=context)
849             phonecall.write(cr, uid, [new_id], {'state': 'open'}, context=context)
850             if action == 'log':
851                 phonecall.write(cr, uid, [new_id], {'state': 'done'}, context=context)
852             phonecall_dict[lead.id] = new_id
853             self.schedule_phonecall_send_note(cr, uid, [lead.id], new_id, action, context=context)
854         return phonecall_dict
855
856     def redirect_opportunity_view(self, cr, uid, opportunity_id, context=None):
857         models_data = self.pool.get('ir.model.data')
858
859         # Get opportunity views
860         dummy, form_view = models_data.get_object_reference(cr, uid, 'crm', 'crm_case_form_view_oppor')
861         dummy, tree_view = models_data.get_object_reference(cr, uid, 'crm', 'crm_case_tree_view_oppor')
862         return {
863             'name': _('Opportunity'),
864             'view_type': 'form',
865             'view_mode': 'tree, form',
866             'res_model': 'crm.lead',
867             'domain': [('type', '=', 'opportunity')],
868             'res_id': int(opportunity_id),
869             'view_id': False,
870             'views': [(form_view or False, 'form'),
871                     (tree_view or False, 'tree'),
872                     (False, 'calendar'), (False, 'graph')],
873             'type': 'ir.actions.act_window',
874         }
875
876     def redirect_lead_view(self, cr, uid, lead_id, context=None):
877         models_data = self.pool.get('ir.model.data')
878
879         # Get lead views
880         dummy, form_view = models_data.get_object_reference(cr, uid, 'crm', 'crm_case_form_view_leads')
881         dummy, tree_view = models_data.get_object_reference(cr, uid, 'crm', 'crm_case_tree_view_leads')
882         return {
883             'name': _('Lead'),
884             'view_type': 'form',
885             'view_mode': 'tree, form',
886             'res_model': 'crm.lead',
887             'domain': [('type', '=', 'lead')],
888             'res_id': int(lead_id),
889             'view_id': False,
890             'views': [(form_view or False, 'form'),
891                       (tree_view or False, 'tree'),
892                       (False, 'calendar'), (False, 'graph')],
893             'type': 'ir.actions.act_window',
894         }
895
896     def action_makeMeeting(self, cr, uid, ids, context=None):
897         """
898         Open meeting's calendar view to schedule meeting on current opportunity.
899         :return dict: dictionary value for created Meeting view
900         """
901         opportunity = self.browse(cr, uid, ids[0], context)
902         res = self.pool.get('ir.actions.act_window').for_xml_id(cr, uid, 'calendar', 'action_calendar_event', context)
903         res['context'] = {
904             'default_opportunity_id': opportunity.id,
905             'default_partner_id': opportunity.partner_id and opportunity.partner_id.id or False,
906             'default_partner_ids' : opportunity.partner_id and [opportunity.partner_id.id] or False,
907             'default_user_id': uid,
908             'default_section_id': opportunity.section_id and opportunity.section_id.id or False,
909             'default_email_from': opportunity.email_from,
910             'default_name': opportunity.name,
911         }
912         return res
913
914     def create(self, cr, uid, vals, context=None):
915         if context is None:
916             context = {}
917         if vals.get('type') and not context.get('default_type'):
918             context['default_type'] = vals.get('type')
919         if vals.get('section_id') and not context.get('default_section_id'):
920             context['default_section_id'] = vals.get('section_id')
921
922         # context: no_log, because subtype already handle this
923         create_context = dict(context, mail_create_nolog=True)
924         return super(crm_lead, self).create(cr, uid, vals, context=create_context)
925
926     def write(self, cr, uid, ids, vals, context=None):
927         # stage change: update date_last_stage_update
928         if 'stage_id' in vals:
929             vals['date_last_stage_update'] = fields.datetime.now()
930         # stage change with new stage: update probability
931         if vals.get('stage_id') and not vals.get('probability'):
932             onchange_stage_values = self.onchange_stage_id(cr, uid, ids, vals.get('stage_id'), context=context)['value']
933             vals.update(onchange_stage_values)
934         return super(crm_lead, self).write(cr, uid, ids, vals, context=context)
935
936     def copy(self, cr, uid, id, default=None, context=None):
937         if not default:
938             default = {}
939         if not context:
940             context = {}
941         lead = self.browse(cr, uid, id, context=context)
942         local_context = dict(context)
943         local_context.setdefault('default_type', lead.type)
944         local_context.setdefault('default_section_id', lead.section_id)
945         if lead.type == 'opportunity':
946             default['date_open'] = fields.datetime.now()
947         else:
948             default['date_open'] = False
949         default['date_closed'] = False
950         default['stage_id'] = self._get_default_stage_id(cr, uid, local_context)
951         return super(crm_lead, self).copy(cr, uid, id, default, context=context)
952
953     # ----------------------------------------
954     # Mail Gateway
955     # ----------------------------------------
956
957     def message_get_reply_to(self, cr, uid, ids, context=None):
958         """ Override to get the reply_to of the parent project. """
959         return [lead.section_id.message_get_reply_to()[0] if lead.section_id else False
960                     for lead in self.browse(cr, SUPERUSER_ID, ids, context=context)]
961
962     def _get_formview_action(self, cr, uid, id, context=None):
963         action = super(crm_lead, self)._get_formview_action(cr, uid, id, context=context)
964         obj = self.browse(cr, uid, id, context=context)
965         if obj.type == 'opportunity':
966             model, view_id = self.pool.get('ir.model.data').get_object_reference(cr, uid, 'crm', 'crm_case_form_view_oppor')
967             action.update({
968                 'views': [(view_id, 'form')],
969                 })
970         return action
971
972     def message_get_suggested_recipients(self, cr, uid, ids, context=None):
973         recipients = super(crm_lead, self).message_get_suggested_recipients(cr, uid, ids, context=context)
974         try:
975             for lead in self.browse(cr, uid, ids, context=context):
976                 if lead.partner_id:
977                     self._message_add_suggested_recipient(cr, uid, recipients, lead, partner=lead.partner_id, reason=_('Customer'))
978                 elif lead.email_from:
979                     self._message_add_suggested_recipient(cr, uid, recipients, lead, email=lead.email_from, reason=_('Customer Email'))
980         except (osv.except_osv, orm.except_orm):  # no read access rights -> just ignore suggested recipients because this imply modifying followers
981             pass
982         return recipients
983
984     def message_new(self, cr, uid, msg, custom_values=None, context=None):
985         """ Overrides mail_thread message_new that is called by the mailgateway
986             through message_process.
987             This override updates the document according to the email.
988         """
989         if custom_values is None:
990             custom_values = {}
991         defaults = {
992             'name':  msg.get('subject') or _("No Subject"),
993             'email_from': msg.get('from'),
994             'email_cc': msg.get('cc'),
995             'partner_id': msg.get('author_id', False),
996             'user_id': False,
997         }
998         if msg.get('author_id'):
999             defaults.update(self.on_change_partner_id(cr, uid, None, msg.get('author_id'), context=context)['value'])
1000         if msg.get('priority') in dict(crm.AVAILABLE_PRIORITIES):
1001             defaults['priority'] = msg.get('priority')
1002         defaults.update(custom_values)
1003         return super(crm_lead, self).message_new(cr, uid, msg, custom_values=defaults, context=context)
1004
1005     def message_update(self, cr, uid, ids, msg, update_vals=None, context=None):
1006         """ Overrides mail_thread message_update that is called by the mailgateway
1007             through message_process.
1008             This method updates the document according to the email.
1009         """
1010         if isinstance(ids, (str, int, long)):
1011             ids = [ids]
1012         if update_vals is None: update_vals = {}
1013
1014         if msg.get('priority') in dict(crm.AVAILABLE_PRIORITIES):
1015             update_vals['priority'] = msg.get('priority')
1016         maps = {
1017             'cost':'planned_cost',
1018             'revenue': 'planned_revenue',
1019             'probability':'probability',
1020         }
1021         for line in msg.get('body', '').split('\n'):
1022             line = line.strip()
1023             res = tools.command_re.match(line)
1024             if res and maps.get(res.group(1).lower()):
1025                 key = maps.get(res.group(1).lower())
1026                 update_vals[key] = res.group(2).lower()
1027
1028         return super(crm_lead, self).message_update(cr, uid, ids, msg, update_vals=update_vals, context=context)
1029
1030     # ----------------------------------------
1031     # OpenChatter methods and notifications
1032     # ----------------------------------------
1033
1034     def schedule_phonecall_send_note(self, cr, uid, ids, phonecall_id, action, context=None):
1035         phonecall = self.pool.get('crm.phonecall').browse(cr, uid, [phonecall_id], context=context)[0]
1036         if action == 'log':
1037             message = _('Logged a call for %(date)s. %(description)s')
1038         else:
1039             message = _('Scheduled a call for %(date)s. %(description)s')
1040         phonecall_date = datetime.strptime(phonecall.date, tools.DEFAULT_SERVER_DATETIME_FORMAT)
1041         phonecall_usertime = fields.datetime.context_timestamp(cr, uid, phonecall_date, context=context).strftime(tools.DEFAULT_SERVER_DATETIME_FORMAT)
1042         html_time = "<time datetime='%s+00:00'>%s</time>" % (phonecall.date, phonecall_usertime)
1043         message = message % dict(date=html_time, description=phonecall.description)
1044         return self.message_post(cr, uid, ids, body=message, context=context)
1045
1046     def log_meeting(self, cr, uid, ids, meeting_subject, meeting_date, duration, context=None):
1047         if not duration:
1048             duration = _('unknown')
1049         else:
1050             duration = str(duration)
1051         message = _("Meeting scheduled at '%s'<br> Subject: %s <br> Duration: %s hour(s)") % (meeting_date, meeting_subject, duration)
1052         return self.message_post(cr, uid, ids, body=message, context=context)
1053
1054     def onchange_state(self, cr, uid, ids, state_id, context=None):
1055         if state_id:
1056             country_id=self.pool.get('res.country.state').browse(cr, uid, state_id, context).country_id.id
1057             return {'value':{'country_id':country_id}}
1058         return {}
1059
1060 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: