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