[FIX] crm: fixed on_change_user that was crashing because
[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         """ When changing the user, also set a section_id or restrict section id
361             to the ones user_id is member of. """
362         section_id = False
363         if user_id:
364             section_ids = self.pool.get('crm.case.section').search(cr, uid, ['|', ('user_id', '=', user_id), ('member_ids', '=', user_id)], context=context)
365             if section_ids:
366                 section_id = section_ids[0]
367         return {'value': {'section_id': section_id}}
368
369     def _check(self, cr, uid, ids=False, context=None):
370         """ Override of the base.stage method.
371             Function called by the scheduler to process cases for date actions
372             Only works on not done and cancelled cases
373         """
374         cr.execute('select * from crm_case \
375                 where (date_action_last<%s or date_action_last is null) \
376                 and (date_action_next<=%s or date_action_next is null) \
377                 and state not in (\'cancel\',\'done\')',
378                 (time.strftime("%Y-%m-%d %H:%M:%S"),
379                     time.strftime('%Y-%m-%d %H:%M:%S')))
380
381         ids2 = map(lambda x: x[0], cr.fetchall() or [])
382         cases = self.browse(cr, uid, ids2, context=context)
383         return self._action(cr, uid, cases, False, context=context)
384
385     def stage_find(self, cr, uid, cases, section_id, domain=None, order='sequence', context=None):
386         """ Override of the base.stage method
387             Parameter of the stage search taken from the lead:
388             - type: stage type must be the same or 'both'
389             - section_id: if set, stages must belong to this section or
390               be a default stage; if not set, stages must be default
391               stages
392         """
393         if isinstance(cases, (int, long)):
394             cases = self.browse(cr, uid, cases, context=context)
395         # collect all section_ids
396         section_ids = []
397         types = ['both']
398         if not cases :
399             type = context.get('default_type')
400             types += [type]
401         if section_id:
402             section_ids.append(section_id)
403         for lead in cases:
404             if lead.section_id:
405                 section_ids.append(lead.section_id.id)
406             if lead.type not in types:
407                 types.append(lead.type)
408         # OR all section_ids and OR with case_default
409         search_domain = []
410         if section_ids:
411             search_domain += [('|')] * len(section_ids)
412             for section_id in section_ids:
413                 search_domain.append(('section_ids', '=', section_id))
414         else:
415             search_domain.append(('case_default', '=', True))
416         # AND with cases types
417         search_domain.append(('type', 'in', types))
418         # AND with the domain in parameter
419         search_domain += list(domain)
420         # perform search, return the first found
421         stage_ids = self.pool.get('crm.case.stage').search(cr, uid, search_domain, order=order, context=context)
422         if stage_ids:
423             return stage_ids[0]
424         return False
425
426     def case_cancel(self, cr, uid, ids, context=None):
427         """ Overrides case_cancel from base_stage to set probability """
428         res = super(crm_lead, self).case_cancel(cr, uid, ids, context=context)
429         self.write(cr, uid, ids, {'probability' : 0.0}, context=context)
430         return res
431
432     def case_reset(self, cr, uid, ids, context=None):
433         """ Overrides case_reset from base_stage to set probability """
434         res = super(crm_lead, self).case_reset(cr, uid, ids, context=context)
435         self.write(cr, uid, ids, {'probability': 0.0}, context=context)
436         return res
437
438     def case_mark_lost(self, cr, uid, ids, context=None):
439         """ Mark the case as lost: state=cancel and probability=0 """
440         for lead in self.browse(cr, uid, ids):
441             stage_id = self.stage_find(cr, uid, [lead], lead.section_id.id or False, [('probability', '=', 0.0),('on_change','=',True)], context=context)
442             if stage_id:
443                 self.case_set(cr, uid, [lead.id], values_to_update={'probability': 0.0}, new_stage_id=stage_id, context=context)
444         return True
445
446     def case_mark_won(self, cr, uid, ids, context=None):
447         """ Mark the case as won: state=done and probability=100 """
448         for lead in self.browse(cr, uid, ids):
449             stage_id = self.stage_find(cr, uid, [lead], lead.section_id.id or False, [('probability', '=', 100.0),('on_change','=',True)], context=context)
450             if stage_id:
451                 self.case_set(cr, uid, [lead.id], values_to_update={'probability': 100.0}, new_stage_id=stage_id, context=context)
452         return True
453
454     def set_priority(self, cr, uid, ids, priority):
455         """ Set lead priority
456         """
457         return self.write(cr, uid, ids, {'priority' : priority})
458
459     def set_high_priority(self, cr, uid, ids, context=None):
460         """ Set lead priority to high
461         """
462         return self.set_priority(cr, uid, ids, '1')
463
464     def set_normal_priority(self, cr, uid, ids, context=None):
465         """ Set lead priority to normal
466         """
467         return self.set_priority(cr, uid, ids, '3')
468
469     def _merge_get_result_type(self, cr, uid, opps, context=None):
470         """
471         Define the type of the result of the merge.  If at least one of the
472         element to merge is an opp, the resulting new element will be an opp.
473         Otherwise it will be a lead.
474
475         We'll directly use a list of browse records instead of a list of ids
476         for performances' sake: it will spare a second browse of the
477         leads/opps.
478
479         :param list opps: list of browse records containing the leads/opps to process
480         :return string type: the type of the final element
481         """
482         for opp in opps:
483             if (opp.type == 'opportunity'):
484                 return 'opportunity'
485
486         return 'lead'
487
488     def _merge_data(self, cr, uid, ids, oldest, fields, context=None):
489         """
490         Prepare lead/opp data into a dictionary for merging.  Different types
491         of fields are processed in different ways:
492         - text: all the values are concatenated
493         - m2m and o2m: those fields aren't processed
494         - m2o: the first not null value prevails (the other are dropped)
495         - any other type of field: same as m2o
496
497         :param list ids: list of ids of the leads to process
498         :param list fields: list of leads' fields to process
499         :return dict data: contains the merged values
500         """
501         opportunities = self.browse(cr, uid, ids, context=context)
502
503         def _get_first_not_null(attr):
504             for opp in opportunities:
505                 if hasattr(opp, attr) and bool(getattr(opp, attr)):
506                     return getattr(opp, attr)
507             return False
508
509         def _get_first_not_null_id(attr):
510             res = _get_first_not_null(attr)
511             return res and res.id or False
512
513         def _concat_all(attr):
514             return '\n\n'.join(filter(lambda x: x, [getattr(opp, attr) or '' for opp in opportunities if hasattr(opp, attr)]))
515
516         # Process the fields' values
517         data = {}
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             if field._type in ('many2many', 'one2many'):
524                 continue
525             elif field._type == 'many2one':
526                 data[field_name] = _get_first_not_null_id(field_name)  # !!
527             elif field._type == 'text':
528                 data[field_name] = _concat_all(field_name)  #not lost
529             else:
530                 data[field_name] = _get_first_not_null(field_name)  #not lost
531
532         # Define the resulting type ('lead' or 'opportunity')
533         data['type'] = self._merge_get_result_type(cr, uid, opportunities, context)
534         return data
535
536     def _mail_body(self, cr, uid, lead, fields, title=False, context=None):
537         body = []
538         if title:
539             body.append("%s\n" % (title))
540
541         for field_name in fields:
542             field_info = self._all_columns.get(field_name)
543             if field_info is None:
544                 continue
545             field = field_info.column
546             value = ''
547
548             if field._type == 'selection':
549                 if hasattr(field.selection, '__call__'):
550                     key = field.selection(self, cr, uid, context=context)
551                 else:
552                     key = field.selection
553                 value = dict(key).get(lead[field_name], lead[field_name])
554             elif field._type == 'many2one':
555                 if lead[field_name]:
556                     value = lead[field_name].name_get()[0][1]
557             elif field._type == 'many2many':
558                 if lead[field_name]:
559                     for val in lead[field_name]:
560                         field_value = val.name_get()[0][1]
561                         value += field_value + ","
562             else:
563                 value = lead[field_name]
564
565             body.append("%s: %s" % (field.string, value or ''))
566         return "<br/>".join(body + ['<br/>'])
567
568     def _merge_notify(self, cr, uid, opportunity_id, opportunities, context=None):
569         """
570         Create a message gathering merged leads/opps information.
571         """
572         #TOFIX: mail template should be used instead of fix body, subject text
573         details = []
574         result_type = self._merge_get_result_type(cr, uid, opportunities, context)
575         if result_type == 'lead':
576             merge_message = _('Merged leads')
577         else:
578             merge_message = _('Merged opportunities')
579         subject = [merge_message]
580         for opportunity in opportunities:
581             subject.append(opportunity.name)
582             title = "%s : %s" % (opportunity.type == 'opportunity' and _('Merged opportunity') or _('Merged lead'), opportunity.name)
583             fields = list(CRM_LEAD_FIELDS_TO_MERGE)
584             details.append(self._mail_body(cr, uid, opportunity, fields, title=title, context=context))
585
586         # Chatter message's subject
587         subject = subject[0] + ": " + ", ".join(subject[1:])
588         details = "\n\n".join(details)
589         return self.message_post(cr, uid, [opportunity_id], body=details, subject=subject, context=context)
590
591     def _merge_opportunity_history(self, cr, uid, opportunity_id, opportunities, context=None):
592         message = self.pool.get('mail.message')
593         for opportunity in opportunities:
594             for history in opportunity.message_ids:
595                 message.write(cr, uid, history.id, {
596                         'res_id': opportunity_id,
597                         'subject' : _("From %s : %s") % (opportunity.name, history.subject)
598                 }, context=context)
599
600         return True
601
602     def _merge_opportunity_attachments(self, cr, uid, opportunity_id, opportunities, context=None):
603         attach_obj = self.pool.get('ir.attachment')
604
605         # return attachments of opportunity
606         def _get_attachments(opportunity_id):
607             attachment_ids = attach_obj.search(cr, uid, [('res_model', '=', self._name), ('res_id', '=', opportunity_id)], context=context)
608             return attach_obj.browse(cr, uid, attachment_ids, context=context)
609
610         first_attachments = _get_attachments(opportunity_id)
611         #counter of all attachments to move. Used to make sure the name is different for all attachments
612         count = 1
613         for opportunity in opportunities:
614             attachments = _get_attachments(opportunity.id)
615             for attachment in attachments:
616                 values = {'res_id': opportunity_id,}
617                 for attachment_in_first in first_attachments:
618                     if attachment.name == attachment_in_first.name:
619                         name = "%s (%s)" % (attachment.name, count,),
620                 count+=1
621                 attachment.write(values)
622         return True
623
624     def merge_opportunity(self, cr, uid, ids, context=None):
625         """
626         Different cases of merge:
627         - merge leads together = 1 new lead
628         - merge at least 1 opp with anything else (lead or opp) = 1 new opp
629
630         :param list ids: leads/opportunities ids to merge
631         :return int id: id of the resulting lead/opp
632         """
633         if context is None:
634             context = {}
635
636         if len(ids) <= 1:
637             raise osv.except_osv(_('Warning!'), _('Please select more than one element (lead or opportunity) from the list view.'))
638
639         opportunities = self.browse(cr, uid, ids, context=context)
640         sequenced_opps = []
641         for opportunity in opportunities:
642             sequence = -1
643             if opportunity.stage_id and opportunity.stage_id.state != 'cancel':
644                 sequence = opportunity.stage_id.sequence
645             sequenced_opps.append(((int(sequence != -1 and opportunity.type == 'opportunity'), sequence, -opportunity.id), opportunity))
646
647         sequenced_opps.sort(reverse=True)
648         opportunities = map(itemgetter(1), sequenced_opps)
649         ids = [opportunity.id for opportunity in opportunities]
650         highest = opportunities[0]
651         opportunities_rest = opportunities[1:]
652
653         tail_opportunities = opportunities_rest
654
655         fields = list(CRM_LEAD_FIELDS_TO_MERGE)
656         merged_data = self._merge_data(cr, uid, ids, highest, fields, context=context)
657
658         # Merge messages and attachements into the first opportunity
659         self._merge_opportunity_history(cr, uid, highest.id, tail_opportunities, context=context)
660         self._merge_opportunity_attachments(cr, uid, highest.id, tail_opportunities, context=context)
661
662         # Merge notifications about loss of information
663         opportunities = [highest]
664         opportunities.extend(opportunities_rest)
665         self._merge_notify(cr, uid, highest, opportunities, context=context)
666         # Check if the stage is in the stages of the sales team. If not, assign the stage with the lowest sequence
667         if merged_data.get('section_id'):
668             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)
669             if merged_data.get('stage_id') not in section_stage_ids:
670                 merged_data['stage_id'] = section_stage_ids and section_stage_ids[0] or False
671         # Write merged data into first opportunity
672         self.write(cr, uid, [highest.id], merged_data, context=context)
673         # Delete tail opportunities
674         self.unlink(cr, uid, [x.id for x in tail_opportunities], context=context)
675
676         return highest.id
677
678     def _convert_opportunity_data(self, cr, uid, lead, customer, section_id=False, context=None):
679         crm_stage = self.pool.get('crm.case.stage')
680         contact_id = False
681         if customer:
682             contact_id = self.pool.get('res.partner').address_get(cr, uid, [customer.id])['default']
683         if not section_id:
684             section_id = lead.section_id and lead.section_id.id or False
685         val = {
686             'planned_revenue': lead.planned_revenue,
687             'probability': lead.probability,
688             'name': lead.name,
689             'partner_id': customer and customer.id or False,
690             'user_id': (lead.user_id and lead.user_id.id),
691             'type': 'opportunity',
692             'date_action': fields.datetime.now(),
693             'date_open': fields.datetime.now(),
694             'email_from': customer and customer.email or lead.email_from,
695             'phone': customer and customer.phone or lead.phone,
696         }
697         if not lead.stage_id or lead.stage_id.type=='lead':
698             val['stage_id'] = self.stage_find(cr, uid, [lead], section_id, [('state', '=', 'draft'),('type', 'in', ('opportunity','both'))], context=context)
699         return val
700
701     def convert_opportunity(self, cr, uid, ids, partner_id, user_ids=False, section_id=False, context=None):
702         customer = False
703         if partner_id:
704             partner = self.pool.get('res.partner')
705             customer = partner.browse(cr, uid, partner_id, context=context)
706         for lead in self.browse(cr, uid, ids, context=context):
707             if lead.state in ('done', 'cancel'):
708                 continue
709             vals = self._convert_opportunity_data(cr, uid, lead, customer, section_id, context=context)
710             self.write(cr, uid, [lead.id], vals, context=context)
711         self.message_post(cr, uid, ids, body=_("Lead <b>converted into an Opportunity</b>"), subtype="crm.mt_lead_convert_to_opportunity", context=context)
712
713         if user_ids or section_id:
714             self.allocate_salesman(cr, uid, ids, user_ids, section_id, context=context)
715
716         return True
717
718     def _lead_create_contact(self, cr, uid, lead, name, is_company, parent_id=False, context=None):
719         partner = self.pool.get('res.partner')
720         vals = {'name': name,
721             'user_id': lead.user_id.id,
722             'comment': lead.description,
723             'section_id': lead.section_id.id or False,
724             'parent_id': parent_id,
725             'phone': lead.phone,
726             'mobile': lead.mobile,
727             'email': tools.email_split(lead.email_from) and tools.email_split(lead.email_from)[0] or False,
728             'fax': lead.fax,
729             'title': lead.title and lead.title.id or False,
730             'function': lead.function,
731             'street': lead.street,
732             'street2': lead.street2,
733             'zip': lead.zip,
734             'city': lead.city,
735             'country_id': lead.country_id and lead.country_id.id or False,
736             'state_id': lead.state_id and lead.state_id.id or False,
737             'is_company': is_company,
738             'type': 'contact'
739         }
740         partner = partner.create(cr, uid, vals, context=context)
741         return partner
742
743     def _create_lead_partner(self, cr, uid, lead, context=None):
744         partner_id = False
745         if lead.partner_name and lead.contact_name:
746             partner_id = self._lead_create_contact(cr, uid, lead, lead.partner_name, True, context=context)
747             partner_id = self._lead_create_contact(cr, uid, lead, lead.contact_name, False, partner_id, context=context)
748         elif lead.partner_name and not lead.contact_name:
749             partner_id = self._lead_create_contact(cr, uid, lead, lead.partner_name, True, context=context)
750         elif not lead.partner_name and lead.contact_name:
751             partner_id = self._lead_create_contact(cr, uid, lead, lead.contact_name, False, context=context)
752         elif lead.email_from and self.pool.get('res.partner')._parse_partner_name(lead.email_from, context=context)[0]:
753             contact_name = self.pool.get('res.partner')._parse_partner_name(lead.email_from, context=context)[0]
754             partner_id = self._lead_create_contact(cr, uid, lead, contact_name, False, context=context)
755         else:
756             raise osv.except_osv(
757                 _('Warning!'),
758                 _('No customer name defined. Please fill one of the following fields: Company Name, Contact Name or Email ("Name <email@address>")')
759             )
760         return partner_id
761
762     def _lead_set_partner(self, cr, uid, lead, partner_id, context=None):
763         """
764         Assign a partner to a lead.
765
766         :param object lead: browse record of the lead to process
767         :param int partner_id: identifier of the partner to assign
768         :return bool: True if the partner has properly been assigned
769         """
770         res = False
771         res_partner = self.pool.get('res.partner')
772         if partner_id:
773             res_partner.write(cr, uid, partner_id, {'section_id': lead.section_id and lead.section_id.id or False})
774             contact_id = res_partner.address_get(cr, uid, [partner_id])['default']
775             res = lead.write({'partner_id': partner_id}, context=context)
776             message = _("<b>Partner</b> set to <em>%s</em>." % (lead.partner_id.name))
777             self.message_post(cr, uid, [lead.id], body=message, context=context)
778         return res
779
780     def handle_partner_assignation(self, cr, uid, ids, action='create', partner_id=False, context=None):
781         """
782         Handle partner assignation during a lead conversion.
783         if action is 'create', create new partner with contact and assign lead to new partner_id.
784         otherwise assign lead to the specified partner_id
785
786         :param list ids: leads/opportunities ids to process
787         :param string action: what has to be done regarding partners (create it, assign an existing one, or nothing)
788         :param int partner_id: partner to assign if any
789         :return dict: dictionary organized as followed: {lead_id: partner_assigned_id}
790         """
791         #TODO this is a duplication of the handle_partner_assignation method of crm_phonecall
792         partner_ids = {}
793         # If a partner_id is given, force this partner for all elements
794         force_partner_id = partner_id
795         for lead in self.browse(cr, uid, ids, context=context):
796             # If the action is set to 'create' and no partner_id is set, create a new one
797             if action == 'create':
798                 partner_id = force_partner_id or self._create_lead_partner(cr, uid, lead, context)
799             self._lead_set_partner(cr, uid, lead, partner_id, context=context)
800             partner_ids[lead.id] = partner_id
801         return partner_ids
802
803     def allocate_salesman(self, cr, uid, ids, user_ids=None, team_id=False, context=None):
804         """
805         Assign salesmen and salesteam to a batch of leads.  If there are more
806         leads than salesmen, these salesmen will be assigned in round-robin.
807         E.g.: 4 salesmen (S1, S2, S3, S4) for 6 leads (L1, L2, ... L6).  They
808         will be assigned as followed: L1 - S1, L2 - S2, L3 - S3, L4 - S4,
809         L5 - S1, L6 - S2.
810
811         :param list ids: leads/opportunities ids to process
812         :param list user_ids: salesmen to assign
813         :param int team_id: salesteam to assign
814         :return bool
815         """
816         index = 0
817
818         for lead_id in ids:
819             value = {}
820             if team_id:
821                 value['section_id'] = team_id
822             if user_ids:
823                 value['user_id'] = user_ids[index]
824                 # Cycle through user_ids
825                 index = (index + 1) % len(user_ids)
826             if value:
827                 self.write(cr, uid, [lead_id], value, context=context)
828         return True
829
830     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):
831         """
832         :param string action: ('schedule','Schedule a call'), ('log','Log a call')
833         """
834         phonecall = self.pool.get('crm.phonecall')
835         model_data = self.pool.get('ir.model.data')
836         phonecall_dict = {}
837         if not categ_id:
838             res_id = model_data._get_id(cr, uid, 'crm', 'categ_phone2')
839             if res_id:
840                 categ_id = model_data.browse(cr, uid, res_id, context=context).res_id
841         for lead in self.browse(cr, uid, ids, context=context):
842             if not section_id:
843                 section_id = lead.section_id and lead.section_id.id or False
844             if not user_id:
845                 user_id = lead.user_id and lead.user_id.id or False
846             vals = {
847                 'name': call_summary,
848                 'opportunity_id': lead.id,
849                 'user_id': user_id or False,
850                 'categ_id': categ_id or False,
851                 'description': desc or '',
852                 'date': schedule_time,
853                 'section_id': section_id or False,
854                 'partner_id': lead.partner_id and lead.partner_id.id or False,
855                 'partner_phone': phone or lead.phone or (lead.partner_id and lead.partner_id.phone or False),
856                 'partner_mobile': lead.partner_id and lead.partner_id.mobile or False,
857                 'priority': lead.priority,
858             }
859             new_id = phonecall.create(cr, uid, vals, context=context)
860             phonecall.case_open(cr, uid, [new_id], context=context)
861             if action == 'log':
862                 phonecall.case_close(cr, uid, [new_id], context=context)
863             phonecall_dict[lead.id] = new_id
864             self.schedule_phonecall_send_note(cr, uid, [lead.id], new_id, action, context=context)
865         return phonecall_dict
866
867     def redirect_opportunity_view(self, cr, uid, opportunity_id, context=None):
868         models_data = self.pool.get('ir.model.data')
869
870         # Get opportunity views
871         dummy, form_view = models_data.get_object_reference(cr, uid, 'crm', 'crm_case_form_view_oppor')
872         dummy, tree_view = models_data.get_object_reference(cr, uid, 'crm', 'crm_case_tree_view_oppor')
873         return {
874             'name': _('Opportunity'),
875             'view_type': 'form',
876             'view_mode': 'tree, form',
877             'res_model': 'crm.lead',
878             'domain': [('type', '=', 'opportunity')],
879             'res_id': int(opportunity_id),
880             'view_id': False,
881             'views': [(form_view or False, 'form'),
882                     (tree_view or False, 'tree'),
883                     (False, 'calendar'), (False, 'graph')],
884             'type': 'ir.actions.act_window',
885         }
886
887     def redirect_lead_view(self, cr, uid, lead_id, context=None):
888         models_data = self.pool.get('ir.model.data')
889
890         # Get lead views
891         dummy, form_view = models_data.get_object_reference(cr, uid, 'crm', 'crm_case_form_view_leads')
892         dummy, tree_view = models_data.get_object_reference(cr, uid, 'crm', 'crm_case_tree_view_leads')
893         return {
894             'name': _('Lead'),
895             'view_type': 'form',
896             'view_mode': 'tree, form',
897             'res_model': 'crm.lead',
898             'domain': [('type', '=', 'lead')],
899             'res_id': int(lead_id),
900             'view_id': False,
901             'views': [(form_view or False, 'form'),
902                       (tree_view or False, 'tree'),
903                       (False, 'calendar'), (False, 'graph')],
904             'type': 'ir.actions.act_window',
905         }
906
907     def action_makeMeeting(self, cr, uid, ids, context=None):
908         """
909         Open meeting's calendar view to schedule meeting on current opportunity.
910         :return dict: dictionary value for created Meeting view
911         """
912         opportunity = self.browse(cr, uid, ids[0], context)
913         res = self.pool.get('ir.actions.act_window').for_xml_id(cr, uid, 'base_calendar', 'action_crm_meeting', context)
914         res['context'] = {
915             'default_opportunity_id': opportunity.id,
916             'default_partner_id': opportunity.partner_id and opportunity.partner_id.id or False,
917             'default_partner_ids' : opportunity.partner_id and [opportunity.partner_id.id] or False,
918             'default_user_id': uid,
919             'default_section_id': opportunity.section_id and opportunity.section_id.id or False,
920             'default_email_from': opportunity.email_from,
921             'default_name': opportunity.name,
922         }
923         return res
924
925     def write(self, cr, uid, ids, vals, context=None):
926         if vals.get('stage_id') and not vals.get('probability'):
927             # change probability of lead(s) if required by stage
928             stage = self.pool.get('crm.case.stage').browse(cr, uid, vals['stage_id'], context=context)
929             if stage.on_change:
930                 vals['probability'] = stage.probability
931         return super(crm_lead, self).write(cr, uid, ids, vals, context=context)
932
933     def new_mail_send(self, cr, uid, ids, context=None):
934         '''
935         This function opens a window to compose an email, with the edi sale template message loaded by default
936         '''
937         assert len(ids) == 1, 'This option should only be used for a single id at a time.'
938         ir_model_data = self.pool.get('ir.model.data')
939         try:
940             template_id = ir_model_data.get_object_reference(cr, uid, 'crm', 'email_template_opportunity_mail')[1]
941         except ValueError:
942             template_id = False
943         try:
944             compose_form_id = ir_model_data.get_object_reference(cr, uid, 'mail', 'email_compose_message_wizard_form')[1]
945         except ValueError:
946             compose_form_id = False
947         if context is None:
948             context = {}
949         ctx = context.copy()
950         ctx.update({
951             'default_model': 'crm.lead',
952             'default_res_id': ids[0],
953             'default_use_template': bool(template_id),
954             'default_template_id': template_id,
955             'default_composition_mode': 'comment',
956         })
957         return {
958             'type': 'ir.actions.act_window',
959             'view_type': 'form',
960             'view_mode': 'form',
961             'res_model': 'mail.compose.message',
962             'views': [(compose_form_id, 'form')],
963             'view_id': compose_form_id,
964             'target': 'new',
965             'context': ctx,
966         }
967
968     # ----------------------------------------
969     # Mail Gateway
970     # ----------------------------------------
971
972     def message_get_reply_to(self, cr, uid, ids, context=None):
973         """ Override to get the reply_to of the parent project. """
974         return [lead.section_id.message_get_reply_to()[0] if lead.section_id else False
975                     for lead in self.browse(cr, uid, ids, context=context)]
976
977     def message_get_suggested_recipients(self, cr, uid, ids, context=None):
978         recipients = super(crm_lead, self).message_get_suggested_recipients(cr, uid, ids, context=context)
979         for lead in self.browse(cr, uid, ids, context=context):
980             if lead.partner_id:
981                 self._message_add_suggested_recipient(cr, uid, recipients, lead, partner=lead.partner_id, reason=_('Customer'))
982             elif lead.email_from:
983                 self._message_add_suggested_recipient(cr, uid, recipients, lead, email=lead.email_from, reason=_('Customer Email'))
984         return recipients
985
986     def message_new(self, cr, uid, msg, custom_values=None, context=None):
987         """ Overrides mail_thread message_new that is called by the mailgateway
988             through message_process.
989             This override updates the document according to the email.
990         """
991         if custom_values is None:
992             custom_values = {}
993         desc = html2plaintext(msg.get('body')) if msg.get('body') else ''
994         defaults = {
995             'name':  msg.get('subject') or _("No Subject"),
996             'description': desc,
997             'email_from': msg.get('from'),
998             'email_cc': msg.get('cc'),
999             'partner_id': msg.get('author_id', False),
1000             'user_id': False,
1001         }
1002         if msg.get('author_id'):
1003             defaults.update(self.on_change_partner(cr, uid, None, msg.get('author_id'), context=context)['value'])
1004         if msg.get('priority') in dict(crm.AVAILABLE_PRIORITIES):
1005             defaults['priority'] = msg.get('priority')
1006         defaults.update(custom_values)
1007         return super(crm_lead, self).message_new(cr, uid, msg, custom_values=defaults, context=context)
1008
1009     def message_update(self, cr, uid, ids, msg, update_vals=None, context=None):
1010         """ Overrides mail_thread message_update that is called by the mailgateway
1011             through message_process.
1012             This method updates the document according to the email.
1013         """
1014         if isinstance(ids, (str, int, long)):
1015             ids = [ids]
1016         if update_vals is None: update_vals = {}
1017
1018         if msg.get('priority') in dict(crm.AVAILABLE_PRIORITIES):
1019             update_vals['priority'] = msg.get('priority')
1020         maps = {
1021             'cost':'planned_cost',
1022             'revenue': 'planned_revenue',
1023             'probability':'probability',
1024         }
1025         for line in msg.get('body', '').split('\n'):
1026             line = line.strip()
1027             res = tools.command_re.match(line)
1028             if res and maps.get(res.group(1).lower()):
1029                 key = maps.get(res.group(1).lower())
1030                 update_vals[key] = res.group(2).lower()
1031
1032         return super(crm_lead, self).message_update(cr, uid, ids, msg, update_vals=update_vals, context=context)
1033
1034     # ----------------------------------------
1035     # OpenChatter methods and notifications
1036     # ----------------------------------------
1037
1038     def schedule_phonecall_send_note(self, cr, uid, ids, phonecall_id, action, context=None):
1039         phonecall = self.pool.get('crm.phonecall').browse(cr, uid, [phonecall_id], context=context)[0]
1040         if action == 'log':
1041             prefix = 'Logged'
1042         else:
1043             prefix = 'Scheduled'
1044         suffix = ' %s' % phonecall.description
1045         message = _("%s a call for %s.%s") % (prefix, phonecall.date, suffix)
1046         return self.message_post(cr, uid, ids, body=message, context=context)
1047
1048     def onchange_state(self, cr, uid, ids, state_id, context=None):
1049         if state_id:
1050             country_id=self.pool.get('res.country.state').browse(cr, uid, state_id, context).country_id.id
1051             return {'value':{'country_id':country_id}}
1052         return {}
1053
1054 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: