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