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