merge upstream
[odoo/odoo.git] / addons / crm / crm_lead.py
1 # -*- coding: utf-8 -*-
2 ##############################################################################
3 #
4 #    OpenERP, Open Source Management Solution
5 #    Copyright (C) 2004-today OpenERP SA (<http://www.openerp.com>)
6 #
7 #    This program is free software: you can redistribute it and/or modify
8 #    it under the terms of the GNU Affero General Public License as
9 #    published by the Free Software Foundation, either version 3 of the
10 #    License, or (at your option) any later version.
11 #
12 #    This program is distributed in the hope that it will be useful,
13 #    but WITHOUT ANY WARRANTY; without even the implied warranty of
14 #    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15 #    GNU Affero General Public License for more details.
16 #
17 #    You should have received a copy of the GNU Affero General Public License
18 #    along with this program.  If not, see <http://www.gnu.org/licenses/>.
19 #
20 ##############################################################################
21
22 import crm
23 from datetime import datetime
24 from operator import itemgetter
25 from openerp.osv import fields, osv, orm
26 import time
27 from openerp import SUPERUSER_ID
28 from openerp import tools
29 from openerp.tools.translate import _
30 from openerp.tools import html2plaintext
31
32 from openerp.addons.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(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 in ['new', 'draft'],
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', 'draft', 'cancel', 'done'],
85         },
86     }
87
88     def get_empty_list_help(self, cr, uid, help, context=None):
89         if context.get('default_type') == 'lead':
90             context['empty_list_help_model'] = 'crm.case.section'
91             context['empty_list_help_id'] = context.get('default_section_id')
92         context['empty_list_help_document_name'] = _("leads")
93         return super(crm_lead, self).get_empty_list_help(cr, uid, help, context=context)
94
95     def _get_default_section_id(self, cr, uid, context=None):
96         """ Gives default section by checking if present in the context """
97         return self._resolve_section_id_from_context(cr, uid, context=context) or False
98
99     def _get_default_stage_id(self, cr, uid, context=None):
100         """ Gives default stage_id """
101         section_id = self._get_default_section_id(cr, uid, context=context)
102         return self.stage_find(cr, uid, [], section_id, [('state', '=', 'draft')], context=context)
103
104     def _resolve_section_id_from_context(self, cr, uid, context=None):
105         """ Returns ID of section based on the value of 'section_id'
106             context key, or None if it cannot be resolved to a single
107             Sales Team.
108         """
109         if context is None:
110             context = {}
111         if type(context.get('default_section_id')) in (int, long):
112             return context.get('default_section_id')
113         if isinstance(context.get('default_section_id'), basestring):
114             section_ids = self.pool.get('crm.case.section').name_search(cr, uid, name=context['default_section_id'], context=context)
115             if len(section_ids) == 1:
116                 return int(section_ids[0][0])
117         return None
118
119     def _resolve_type_from_context(self, cr, uid, context=None):
120         """ Returns the type (lead or opportunity) from the type context
121             key. Returns None if it cannot be resolved.
122         """
123         if context is None:
124             context = {}
125         return context.get('default_type')
126
127     def _read_group_stage_ids(self, cr, uid, ids, domain, read_group_order=None, access_rights_uid=None, context=None):
128         access_rights_uid = access_rights_uid or uid
129         stage_obj = self.pool.get('crm.case.stage')
130         order = stage_obj._order
131         # lame hack to allow reverting search, should just work in the trivial case
132         if read_group_order == 'stage_id desc':
133             order = "%s desc" % order
134         # retrieve section_id from the context and write the domain
135         # - ('id', 'in', 'ids'): add columns that should be present
136         # - OR ('case_default', '=', True), ('fold', '=', False): add default columns that are not folded
137         # - OR ('section_ids', '=', section_id), ('fold', '=', False) if section_id: add section columns that are not folded
138         search_domain = []
139         section_id = self._resolve_section_id_from_context(cr, uid, context=context)
140         if section_id:
141             search_domain += ['|', ('section_ids', '=', section_id)]
142             search_domain += [('id', 'in', ids)]
143         else:
144             search_domain += ['|', ('id', 'in', ids), ('case_default', '=', True)]
145         # retrieve type from the context (if set: choose 'type' or 'both')
146         type = self._resolve_type_from_context(cr, uid, context=context)
147         if type:
148             search_domain += ['|', ('type', '=', type), ('type', '=', 'both')]
149         # perform search
150         stage_ids = stage_obj._search(cr, uid, search_domain, order=order, access_rights_uid=access_rights_uid, context=context)
151         result = stage_obj.name_get(cr, access_rights_uid, stage_ids, context=context)
152         # restore order of the search
153         result.sort(lambda x,y: cmp(stage_ids.index(x[0]), stage_ids.index(y[0])))
154
155         fold = {}
156         for stage in stage_obj.browse(cr, access_rights_uid, stage_ids, context=context):
157             fold[stage.id] = stage.fold or False
158         return result, fold
159
160     def fields_view_get(self, cr, user, view_id=None, view_type='form', context=None, toolbar=False, submenu=False):
161         res = super(crm_lead,self).fields_view_get(cr, user, view_id, view_type, context, toolbar=toolbar, submenu=submenu)
162         if view_type == 'form':
163             res['arch'] = self.fields_view_get_address(cr, user, res['arch'], context=context)
164         return res
165
166     _group_by_full = {
167         'stage_id': _read_group_stage_ids
168     }
169
170     def _compute_day(self, cr, uid, ids, fields, args, context=None):
171         """
172         :return dict: difference between current date and log date
173         """
174         cal_obj = self.pool.get('resource.calendar')
175         res_obj = self.pool.get('resource.resource')
176
177         res = {}
178         for lead in self.browse(cr, uid, ids, context=context):
179             for field in fields:
180                 res[lead.id] = {}
181                 duration = 0
182                 ans = False
183                 if field == 'day_open':
184                     if lead.date_open:
185                         date_create = datetime.strptime(lead.create_date, "%Y-%m-%d %H:%M:%S")
186                         date_open = datetime.strptime(lead.date_open, "%Y-%m-%d %H:%M:%S")
187                         ans = date_open - date_create
188                         date_until = lead.date_open
189                 elif field == 'day_close':
190                     if lead.date_closed:
191                         date_create = datetime.strptime(lead.create_date, "%Y-%m-%d %H:%M:%S")
192                         date_close = datetime.strptime(lead.date_closed, "%Y-%m-%d %H:%M:%S")
193                         date_until = lead.date_closed
194                         ans = date_close - date_create
195                 if ans:
196                     resource_id = False
197                     if lead.user_id:
198                         resource_ids = res_obj.search(cr, uid, [('user_id','=',lead.user_id.id)])
199                         if len(resource_ids):
200                             resource_id = resource_ids[0]
201
202                     duration = float(ans.days)
203                     if lead.section_id and lead.section_id.resource_calendar_id:
204                         duration =  float(ans.days) * 24
205                         new_dates = cal_obj.interval_get(cr,
206                             uid,
207                             lead.section_id.resource_calendar_id and lead.section_id.resource_calendar_id.id or False,
208                             datetime.strptime(lead.create_date, '%Y-%m-%d %H:%M:%S'),
209                             duration,
210                             resource=resource_id
211                         )
212                         no_days = []
213                         date_until = datetime.strptime(date_until, '%Y-%m-%d %H:%M:%S')
214                         for in_time, out_time in new_dates:
215                             if in_time.date not in no_days:
216                                 no_days.append(in_time.date)
217                             if out_time > date_until:
218                                 break
219                         duration =  len(no_days)
220                 res[lead.id][field] = abs(int(duration))
221         return res
222
223     def _history_search(self, cr, uid, obj, name, args, context=None):
224         res = []
225         msg_obj = self.pool.get('mail.message')
226         message_ids = msg_obj.search(cr, uid, [('email_from','!=',False), ('subject', args[0][1], args[0][2])], context=context)
227         lead_ids = self.search(cr, uid, [('message_ids', 'in', message_ids)], context=context)
228
229         if lead_ids:
230             return [('id', 'in', lead_ids)]
231         else:
232             return [('id', '=', '0')]
233
234     _columns = {
235         'partner_id': fields.many2one('res.partner', 'Partner', ondelete='set null', track_visibility='onchange',
236             select=True, help="Linked partner (optional). Usually created when converting the lead."),
237
238         'id': fields.integer('ID', readonly=True),
239         'name': fields.char('Subject', size=64, required=True, select=1),
240         'active': fields.boolean('Active', required=False),
241         'date_action_last': fields.datetime('Last Action', readonly=1),
242         'date_action_next': fields.datetime('Next Action', readonly=1),
243         'email_from': fields.char('Email', size=128, help="Email address of the contact", select=1),
244         'section_id': fields.many2one('crm.case.section', 'Sales Team',
245                         select=True, track_visibility='onchange', help='When sending mails, the default email address is taken from the sales team.'),
246         'create_date': fields.datetime('Creation Date' , readonly=True),
247         '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"),
248         'description': fields.text('Notes'),
249         'write_date': fields.datetime('Update Date' , readonly=True),
250         'categ_ids': fields.many2many('crm.case.categ', 'crm_lead_category_rel', 'lead_id', 'category_id', 'Categories', \
251             domain="['|',('section_id','=',section_id),('section_id','=',False), ('object_id.model', '=', 'crm.lead')]"),
252         'type_id': fields.many2one('crm.case.resource.type', 'Campaign', \
253             domain="['|',('section_id','=',section_id),('section_id','=',False)]", help="From which campaign (seminar, marketing campaign, mass mailing, ...) did this contact come from?"),
254         'channel_id': fields.many2one('crm.case.channel', 'Channel', help="Communication channel (mail, direct, phone, ...)"),
255         'contact_name': fields.char('Contact Name', size=64),
256         '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),
257         'opt_out': fields.boolean('Opt-Out', oldname='optout',
258             help="If opt-out is checked, this contact has refused to receive emails for mass mailing and marketing campaign. "
259                     "Filter 'Available for Mass Mailing' allows users to filter the leads when performing mass mailing."),
260         'type':fields.selection([ ('lead','Lead'), ('opportunity','Opportunity'), ],'Type', help="Type is used to separate Leads and Opportunities"),
261         'priority': fields.selection(crm.AVAILABLE_PRIORITIES, 'Priority', select=True),
262         'date_closed': fields.datetime('Closed', readonly=True),
263         'stage_id': fields.many2one('crm.case.stage', 'Stage', track_visibility='onchange',
264                         domain="['&', ('section_ids', '=', section_id), '|', ('type', '=', type), ('type', '=', 'both')]"),
265         'user_id': fields.many2one('res.users', 'Salesperson', select=True, track_visibility='onchange'),
266         'referred': fields.char('Referred By', size=64),
267         'date_open': fields.datetime('Opened', readonly=True),
268         'day_open': fields.function(_compute_day, string='Days to Open', \
269                                 multi='day_open', type="float", store=True),
270         'day_close': fields.function(_compute_day, string='Days to Close', \
271                                 multi='day_close', type="float", store=True),
272         'state': fields.related('stage_id', 'state', type="selection", store=True,
273                 selection=crm.AVAILABLE_STATES, string="Status", readonly=True,
274                 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\'.'),
275
276         # Only used for type opportunity
277         'probability': fields.float('Success Rate (%)',group_operator="avg"),
278         'planned_revenue': fields.float('Expected Revenue', track_visibility='always'),
279         'ref': fields.reference('Reference', selection=crm._links_get, size=128),
280         'ref2': fields.reference('Reference 2', selection=crm._links_get, size=128),
281         'phone': fields.char("Phone", size=64),
282         'date_deadline': fields.date('Expected Closing', help="Estimate of the date on which the opportunity will be won."),
283         'date_action': fields.date('Next Action Date', select=True),
284         'title_action': fields.char('Next Action', size=64),
285         'color': fields.integer('Color Index'),
286         'partner_address_name': fields.related('partner_id', 'name', type='char', string='Partner Contact Name', readonly=True),
287         'partner_address_email': fields.related('partner_id', 'email', type='char', string='Partner Contact Email', readonly=True),
288         'company_currency': fields.related('company_id', 'currency_id', type='many2one', string='Currency', readonly=True, relation="res.currency"),
289         'user_email': fields.related('user_id', 'email', type='char', string='User Email', readonly=True),
290         'user_login': fields.related('user_id', 'login', type='char', string='User Login', readonly=True),
291
292         # Fields for address, due to separation from crm and res.partner
293         'street': fields.char('Street', size=128),
294         'street2': fields.char('Street2', size=128),
295         'zip': fields.char('Zip', change_default=True, size=24),
296         'city': fields.char('City', size=128),
297         'state_id': fields.many2one("res.country.state", 'State'),
298         'country_id': fields.many2one('res.country', 'Country'),
299         'phone': fields.char('Phone', size=64),
300         'fax': fields.char('Fax', size=64),
301         'mobile': fields.char('Mobile', size=64),
302         'function': fields.char('Function', size=128),
303         'title': fields.many2one('res.partner.title', 'Title'),
304         'company_id': fields.many2one('res.company', 'Company', select=1),
305         'payment_mode': fields.many2one('crm.payment.mode', 'Payment Mode', \
306                             domain="[('section_id','=',section_id)]"),
307         'planned_cost': fields.float('Planned Costs'),
308     }
309
310     _defaults = {
311         'active': 1,
312         'type': 'lead',
313         'user_id': lambda s, cr, uid, c: uid,
314         'stage_id': lambda s, cr, uid, c: s._get_default_stage_id(cr, uid, c),
315         'section_id': lambda s, cr, uid, c: s._get_default_section_id(cr, uid, c),
316         'company_id': lambda s, cr, uid, c: s.pool.get('res.company')._company_default_get(cr, uid, 'crm.lead', context=c),
317         'priority': lambda *a: crm.AVAILABLE_PRIORITIES[2][0],
318         'color': 0,
319     }
320
321     _sql_constraints = [
322         ('check_probability', 'check(probability >= 0 and probability <= 100)', 'The probability of closing the deal should be between 0% and 100%!')
323     ]
324
325     def onchange_stage_id(self, cr, uid, ids, stage_id, context=None):
326         if not stage_id:
327             return {'value': {}}
328         stage = self.pool.get('crm.case.stage').browse(cr, uid, stage_id, context)
329         if not stage.on_change:
330             return {'value': {}}
331         return {'value': {'probability': stage.probability}}
332
333     def on_change_partner_id(self, cr, uid, ids, partner_id, context=None):
334         values = {}
335         if partner_id:
336             partner = self.pool.get('res.partner').browse(cr, uid, partner_id, context=context)
337             values = {
338                 'partner_name': partner.name,
339                 'street': partner.street,
340                 'street2': partner.street2,
341                 'city': partner.city,
342                 'state_id': partner.state_id and partner.state_id.id or False,
343                 'country_id': partner.country_id and partner.country_id.id or False,
344                 'email_from': partner.email,
345                 'phone': partner.phone,
346                 'mobile': partner.mobile,
347                 'fax': partner.fax,
348             }
349         return {'value': values}
350
351     def on_change_user(self, cr, uid, ids, user_id, context=None):
352         """ When changing the user, also set a section_id or restrict section id
353             to the ones user_id is member of. """
354         section_id = self._get_default_section_id(cr, uid, context=context) or False
355         if user_id and not section_id:
356             section_ids = self.pool.get('crm.case.section').search(cr, uid, ['|', ('user_id', '=', user_id), ('member_ids', '=', user_id)], context=context)
357             if section_ids:
358                 section_id = section_ids[0]
359         return {'value': {'section_id': section_id}}
360
361     def _check(self, cr, uid, ids=False, context=None):
362         """ Override of the base.stage method.
363             Function called by the scheduler to process cases for date actions
364             Only works on not done and cancelled cases
365         """
366         cr.execute('select * from crm_case \
367                 where (date_action_last<%s or date_action_last is null) \
368                 and (date_action_next<=%s or date_action_next is null) \
369                 and state not in (\'cancel\',\'done\')',
370                 (time.strftime("%Y-%m-%d %H:%M:%S"),
371                     time.strftime('%Y-%m-%d %H:%M:%S')))
372
373         ids2 = map(lambda x: x[0], cr.fetchall() or [])
374         cases = self.browse(cr, uid, ids2, context=context)
375         return self._action(cr, uid, cases, False, context=context)
376
377     def stage_find(self, cr, uid, cases, section_id, domain=None, order='sequence', context=None):
378         """ Override of the base.stage method
379             Parameter of the stage search taken from the lead:
380             - type: stage type must be the same or 'both'
381             - section_id: if set, stages must belong to this section or
382               be a default stage; if not set, stages must be default
383               stages
384         """
385         if isinstance(cases, (int, long)):
386             cases = self.browse(cr, uid, cases, context=context)
387         # collect all section_ids
388         section_ids = []
389         types = ['both']
390         if not cases:
391             type = context.get('default_type')
392             types += [type]
393         if section_id:
394             section_ids.append(section_id)
395         for lead in cases:
396             if lead.section_id:
397                 section_ids.append(lead.section_id.id)
398             if lead.type not in types:
399                 types.append(lead.type)
400         # OR all section_ids and OR with case_default
401         search_domain = []
402         if section_ids:
403             search_domain += [('|')] * len(section_ids)
404             for section_id in section_ids:
405                 search_domain.append(('section_ids', '=', section_id))
406         else:
407             search_domain.append(('case_default', '=', True))
408         # AND with cases types
409         search_domain.append(('type', 'in', types))
410         # AND with the domain in parameter
411         search_domain += list(domain)
412         # perform search, return the first found
413         stage_ids = self.pool.get('crm.case.stage').search(cr, uid, search_domain, order=order, context=context)
414         if stage_ids:
415             return stage_ids[0]
416         return False
417
418     def stage_set(self, cr, uid, ids, stage_id, context=None):
419         """ Set the new stage. Now just writes the stage.
420             TDE TODO: remove me when removing state
421         """
422         return self.write(cr, uid, ids, {'stage_id': stage_id}, context=context)
423
424     def case_mark_lost(self, cr, uid, ids, context=None):
425         """ Mark the case as lost: state=cancel and probability=0 """
426         for lead in self.browse(cr, uid, ids):
427             stage_id = self.stage_find(cr, uid, [lead], lead.section_id.id or False, [('probability', '=', 0.0),('on_change','=',True)], context=context)
428             if stage_id:
429                 self.stage_set(cr, uid, [lead.id], stage_id, context=context)
430         return True
431
432     def case_mark_won(self, cr, uid, ids, context=None):
433         """ Mark the case as won: state=done and probability=100 """
434         for lead in self.browse(cr, uid, ids):
435             stage_id = self.stage_find(cr, uid, [lead], lead.section_id.id or False, [('probability', '=', 100.0),('on_change','=',True)], context=context)
436             if stage_id:
437                 self.stage_set(cr, uid, [lead.id], stage_id, context=context)
438         return True
439
440     def case_escalate(self, cr, uid, ids, context=None):
441         """ Escalates case to parent level """
442         for case in self.browse(cr, uid, ids, context=context):
443             data = {'active': True}
444             if case.section_id.parent_id:
445                 data['section_id'] = case.section_id.parent_id.id
446                 if case.section_id.parent_id.change_responsible:
447                     if case.section_id.parent_id.user_id:
448                         data['user_id'] = case.section_id.parent_id.user_id.id
449             else:
450                 raise osv.except_osv(_('Error!'), _("You are already at the top level of your sales-team category.\nTherefore you cannot escalate furthermore."))
451             self.write(cr, uid, [case.id], data, 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, user_id=False, section_id=False, 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         if user_id:
659             merged_data['user_id'] = user_id
660         if section_id:
661             merged_data['section_id'] = section_id
662
663         # Merge messages and attachements into the first opportunity
664         self._merge_opportunity_history(cr, uid, highest.id, tail_opportunities, context=context)
665         self._merge_opportunity_attachments(cr, uid, highest.id, tail_opportunities, context=context)
666
667         # Merge notifications about loss of information
668         opportunities = [highest]
669         opportunities.extend(opportunities_rest)
670         self._merge_notify(cr, uid, highest, opportunities, context=context)
671         # Check if the stage is in the stages of the sales team. If not, assign the stage with the lowest sequence
672         if merged_data.get('section_id'):
673             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)
674             if merged_data.get('stage_id') not in section_stage_ids:
675                 merged_data['stage_id'] = section_stage_ids and section_stage_ids[0] or False
676         # Write merged data into first opportunity
677         self.write(cr, uid, [highest.id], merged_data, context=context)
678         # Delete tail opportunities 
679         # We use the SUPERUSER to avoid access rights issues because as the user had the rights to see the records it should be safe to do so
680         self.unlink(cr, SUPERUSER_ID, [x.id for x in tail_opportunities], context=context)
681
682         return highest.id
683
684     def _convert_opportunity_data(self, cr, uid, lead, customer, section_id=False, context=None):
685         crm_stage = self.pool.get('crm.case.stage')
686         contact_id = False
687         if customer:
688             contact_id = self.pool.get('res.partner').address_get(cr, uid, [customer.id])['default']
689         if not section_id:
690             section_id = lead.section_id and lead.section_id.id or False
691         val = {
692             'planned_revenue': lead.planned_revenue,
693             'probability': lead.probability,
694             'name': lead.name,
695             'partner_id': customer and customer.id or False,
696             'user_id': (lead.user_id and lead.user_id.id),
697             'type': 'opportunity',
698             'date_action': fields.datetime.now(),
699             'date_open': fields.datetime.now(),
700             'email_from': customer and customer.email or lead.email_from,
701             'phone': customer and customer.phone or lead.phone,
702         }
703         if not lead.stage_id or lead.stage_id.type=='lead':
704             val['stage_id'] = self.stage_find(cr, uid, [lead], section_id, [('state', '=', 'draft'),('type', 'in', ('opportunity','both'))], context=context)
705         return val
706
707     def convert_opportunity(self, cr, uid, ids, partner_id, user_ids=False, section_id=False, context=None):
708         customer = False
709         if partner_id:
710             partner = self.pool.get('res.partner')
711             customer = partner.browse(cr, uid, partner_id, context=context)
712         for lead in self.browse(cr, uid, ids, context=context):
713             if lead.state in ('done', 'cancel'):
714                 continue
715             vals = self._convert_opportunity_data(cr, uid, lead, customer, section_id, context=context)
716             self.write(cr, uid, [lead.id], vals, context=context)
717
718         if user_ids or section_id:
719             self.allocate_salesman(cr, uid, ids, user_ids, section_id, context=context)
720
721         return True
722
723     def _lead_create_contact(self, cr, uid, lead, name, is_company, parent_id=False, context=None):
724         partner = self.pool.get('res.partner')
725         vals = {'name': name,
726             'user_id': lead.user_id.id,
727             'comment': lead.description,
728             'section_id': lead.section_id.id or False,
729             'parent_id': parent_id,
730             'phone': lead.phone,
731             'mobile': lead.mobile,
732             'email': tools.email_split(lead.email_from) and tools.email_split(lead.email_from)[0] or False,
733             'fax': lead.fax,
734             'title': lead.title and lead.title.id or False,
735             'function': lead.function,
736             'street': lead.street,
737             'street2': lead.street2,
738             'zip': lead.zip,
739             'city': lead.city,
740             'country_id': lead.country_id and lead.country_id.id or False,
741             'state_id': lead.state_id and lead.state_id.id or False,
742             'is_company': is_company,
743             'type': 'contact'
744         }
745         partner = partner.create(cr, uid, vals, context=context)
746         return partner
747
748     def _create_lead_partner(self, cr, uid, lead, context=None):
749         partner_id = False
750         if lead.partner_name and lead.contact_name:
751             partner_id = self._lead_create_contact(cr, uid, lead, lead.partner_name, True, context=context)
752             partner_id = self._lead_create_contact(cr, uid, lead, lead.contact_name, False, partner_id, context=context)
753         elif lead.partner_name and not lead.contact_name:
754             partner_id = self._lead_create_contact(cr, uid, lead, lead.partner_name, True, context=context)
755         elif not lead.partner_name and lead.contact_name:
756             partner_id = self._lead_create_contact(cr, uid, lead, lead.contact_name, False, context=context)
757         elif lead.email_from and self.pool.get('res.partner')._parse_partner_name(lead.email_from, context=context)[0]:
758             contact_name = self.pool.get('res.partner')._parse_partner_name(lead.email_from, context=context)[0]
759             partner_id = self._lead_create_contact(cr, uid, lead, contact_name, False, context=context)
760         else:
761             raise osv.except_osv(
762                 _('Warning!'),
763                 _('No customer name defined. Please fill one of the following fields: Company Name, Contact Name or Email ("Name <email@address>")')
764             )
765         return partner_id
766
767     def _lead_set_partner(self, cr, uid, lead, partner_id, context=None):
768         """
769         Assign a partner to a lead.
770
771         :param object lead: browse record of the lead to process
772         :param int partner_id: identifier of the partner to assign
773         :return bool: True if the partner has properly been assigned
774         """
775         res = False
776         res_partner = self.pool.get('res.partner')
777         if partner_id:
778             res_partner.write(cr, uid, partner_id, {'section_id': lead.section_id and lead.section_id.id or False})
779             contact_id = res_partner.address_get(cr, uid, [partner_id])['default']
780             res = lead.write({'partner_id': partner_id}, context=context)
781             message = _("<b>Partner</b> set to <em>%s</em>." % (lead.partner_id.name))
782             self.message_post(cr, uid, [lead.id], body=message, context=context)
783         return res
784
785     def handle_partner_assignation(self, cr, uid, ids, action='create', partner_id=False, context=None):
786         """
787         Handle partner assignation during a lead conversion.
788         if action is 'create', create new partner with contact and assign lead to new partner_id.
789         otherwise assign lead to the specified partner_id
790
791         :param list ids: leads/opportunities ids to process
792         :param string action: what has to be done regarding partners (create it, assign an existing one, or nothing)
793         :param int partner_id: partner to assign if any
794         :return dict: dictionary organized as followed: {lead_id: partner_assigned_id}
795         """
796         #TODO this is a duplication of the handle_partner_assignation method of crm_phonecall
797         partner_ids = {}
798         # If a partner_id is given, force this partner for all elements
799         force_partner_id = partner_id
800         for lead in self.browse(cr, uid, ids, context=context):
801             # If the action is set to 'create' and no partner_id is set, create a new one
802             if action == 'create':
803                 partner_id = force_partner_id or self._create_lead_partner(cr, uid, lead, context)
804             self._lead_set_partner(cr, uid, lead, partner_id, context=context)
805             partner_ids[lead.id] = partner_id
806         return partner_ids
807
808     def allocate_salesman(self, cr, uid, ids, user_ids=None, team_id=False, context=None):
809         """
810         Assign salesmen and salesteam to a batch of leads.  If there are more
811         leads than salesmen, these salesmen will be assigned in round-robin.
812         E.g.: 4 salesmen (S1, S2, S3, S4) for 6 leads (L1, L2, ... L6).  They
813         will be assigned as followed: L1 - S1, L2 - S2, L3 - S3, L4 - S4,
814         L5 - S1, L6 - S2.
815
816         :param list ids: leads/opportunities ids to process
817         :param list user_ids: salesmen to assign
818         :param int team_id: salesteam to assign
819         :return bool
820         """
821         index = 0
822
823         for lead_id in ids:
824             value = {}
825             if team_id:
826                 value['section_id'] = team_id
827             if user_ids:
828                 value['user_id'] = user_ids[index]
829                 # Cycle through user_ids
830                 index = (index + 1) % len(user_ids)
831             if value:
832                 self.write(cr, uid, [lead_id], value, context=context)
833         return True
834
835     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):
836         """
837         :param string action: ('schedule','Schedule a call'), ('log','Log a call')
838         """
839         phonecall = self.pool.get('crm.phonecall')
840         model_data = self.pool.get('ir.model.data')
841         phonecall_dict = {}
842         if not categ_id:
843             res_id = model_data._get_id(cr, uid, 'crm', 'categ_phone2')
844             if res_id:
845                 categ_id = model_data.browse(cr, uid, res_id, context=context).res_id
846         for lead in self.browse(cr, uid, ids, context=context):
847             if not section_id:
848                 section_id = lead.section_id and lead.section_id.id or False
849             if not user_id:
850                 user_id = lead.user_id and lead.user_id.id or False
851             vals = {
852                 'name': call_summary,
853                 'opportunity_id': lead.id,
854                 'user_id': user_id or False,
855                 'categ_id': categ_id or False,
856                 'description': desc or '',
857                 'date': schedule_time,
858                 'section_id': section_id or False,
859                 'partner_id': lead.partner_id and lead.partner_id.id or False,
860                 'partner_phone': phone or lead.phone or (lead.partner_id and lead.partner_id.phone or False),
861                 'partner_mobile': lead.partner_id and lead.partner_id.mobile or False,
862                 'priority': lead.priority,
863             }
864             new_id = phonecall.create(cr, uid, vals, context=context)
865             phonecall.case_open(cr, uid, [new_id], context=context)
866             if action == 'log':
867                 phonecall.case_close(cr, uid, [new_id], context=context)
868             phonecall_dict[lead.id] = new_id
869             self.schedule_phonecall_send_note(cr, uid, [lead.id], new_id, action, context=context)
870         return phonecall_dict
871
872     def redirect_opportunity_view(self, cr, uid, opportunity_id, context=None):
873         models_data = self.pool.get('ir.model.data')
874
875         # Get opportunity views
876         dummy, form_view = models_data.get_object_reference(cr, uid, 'crm', 'crm_case_form_view_oppor')
877         dummy, tree_view = models_data.get_object_reference(cr, uid, 'crm', 'crm_case_tree_view_oppor')
878         return {
879             'name': _('Opportunity'),
880             'view_type': 'form',
881             'view_mode': 'tree, form',
882             'res_model': 'crm.lead',
883             'domain': [('type', '=', 'opportunity')],
884             'res_id': int(opportunity_id),
885             'view_id': False,
886             'views': [(form_view or False, 'form'),
887                     (tree_view or False, 'tree'),
888                     (False, 'calendar'), (False, 'graph')],
889             'type': 'ir.actions.act_window',
890         }
891
892     def redirect_lead_view(self, cr, uid, lead_id, context=None):
893         models_data = self.pool.get('ir.model.data')
894
895         # Get lead views
896         dummy, form_view = models_data.get_object_reference(cr, uid, 'crm', 'crm_case_form_view_leads')
897         dummy, tree_view = models_data.get_object_reference(cr, uid, 'crm', 'crm_case_tree_view_leads')
898         return {
899             'name': _('Lead'),
900             'view_type': 'form',
901             'view_mode': 'tree, form',
902             'res_model': 'crm.lead',
903             'domain': [('type', '=', 'lead')],
904             'res_id': int(lead_id),
905             'view_id': False,
906             'views': [(form_view or False, 'form'),
907                       (tree_view or False, 'tree'),
908                       (False, 'calendar'), (False, 'graph')],
909             'type': 'ir.actions.act_window',
910         }
911
912     def action_makeMeeting(self, cr, uid, ids, context=None):
913         """
914         Open meeting's calendar view to schedule meeting on current opportunity.
915         :return dict: dictionary value for created Meeting view
916         """
917         opportunity = self.browse(cr, uid, ids[0], context)
918         res = self.pool.get('ir.actions.act_window').for_xml_id(cr, uid, 'base_calendar', 'action_crm_meeting', context)
919         res['context'] = {
920             'default_opportunity_id': opportunity.id,
921             'default_partner_id': opportunity.partner_id and opportunity.partner_id.id or False,
922             'default_partner_ids' : opportunity.partner_id and [opportunity.partner_id.id] or False,
923             'default_user_id': uid,
924             'default_section_id': opportunity.section_id and opportunity.section_id.id or False,
925             'default_email_from': opportunity.email_from,
926             'default_name': opportunity.name,
927         }
928         return res
929
930     def create(self, cr, uid, vals, context=None):
931         if context is None:
932             context = {}
933         if vals.get('type') and not context.get('default_type'):
934             context['default_type'] = vals.get('type')
935         if vals.get('section_id') and not context.get('default_section_id'):
936             context['default_section_id'] = vals.get('section_id')
937
938         # context: no_log, because subtype already handle this
939         create_context = dict(context, mail_create_nolog=True)
940         return super(crm_lead, self).create(cr, uid, vals, context=create_context)
941
942     def write(self, cr, uid, ids, vals, context=None):
943         if vals.get('stage_id') and not vals.get('probability'):
944             onchange_stage_values = self.onchange_stage_id(cr, uid, ids, vals.get('stage_id'), context=context)['value']
945             vals.update(onchange_stage_values)
946         return super(crm_lead, self).write(cr, uid, ids, vals, context=context)
947
948     def new_mail_send(self, cr, uid, ids, context=None):
949         '''
950         This function opens a window to compose an email, with the edi sale template message loaded by default
951         '''
952         assert len(ids) == 1, 'This option should only be used for a single id at a time.'
953         ir_model_data = self.pool.get('ir.model.data')
954         try:
955             template_id = ir_model_data.get_object_reference(cr, uid, 'crm', 'email_template_opportunity_mail')[1]
956         except ValueError:
957             template_id = False
958         try:
959             compose_form_id = ir_model_data.get_object_reference(cr, uid, 'mail', 'email_compose_message_wizard_form')[1]
960         except ValueError:
961             compose_form_id = False
962         if context is None:
963             context = {}
964         ctx = context.copy()
965         ctx.update({
966             'default_model': 'crm.lead',
967             'default_res_id': ids[0],
968             'default_use_template': bool(template_id),
969             'default_template_id': template_id,
970             'default_composition_mode': 'comment',
971         })
972         return {
973             'name': _('Compose Email'),
974             'type': 'ir.actions.act_window',
975             'view_type': 'form',
976             'view_mode': 'form',
977             'res_model': 'mail.compose.message',
978             'views': [(compose_form_id, 'form')],
979             'view_id': compose_form_id,
980             'target': 'new',
981             'context': ctx,
982         }
983
984     # ----------------------------------------
985     # Mail Gateway
986     # ----------------------------------------
987
988     def message_get_reply_to(self, cr, uid, ids, context=None):
989         """ Override to get the reply_to of the parent project. """
990         return [lead.section_id.message_get_reply_to()[0] if lead.section_id else False
991                     for lead in self.browse(cr, SUPERUSER_ID, ids, context=context)]
992
993     def _get_formview_action(self, cr, uid, id, context=None):
994         action = super(crm_lead, self)._get_formview_action(cr, uid, id, context=context)
995         obj = self.browse(cr, uid, id, context=context)
996         if obj.type == 'opportunity':
997             model, view_id = self.pool.get('ir.model.data').get_object_reference(cr, uid, 'crm', 'crm_case_form_view_oppor')
998             action.update({
999                 'views': [(view_id, 'form')],
1000                 })
1001         return action
1002
1003     def message_get_suggested_recipients(self, cr, uid, ids, context=None):
1004         recipients = super(crm_lead, self).message_get_suggested_recipients(cr, uid, ids, context=context)
1005         try:
1006             for lead in self.browse(cr, uid, ids, context=context):
1007                 if lead.partner_id:
1008                     self._message_add_suggested_recipient(cr, uid, recipients, lead, partner=lead.partner_id, reason=_('Customer'))
1009                 elif lead.email_from:
1010                     self._message_add_suggested_recipient(cr, uid, recipients, lead, email=lead.email_from, reason=_('Customer Email'))
1011         except (osv.except_osv, orm.except_orm):  # no read access rights -> just ignore suggested recipients because this imply modifying followers
1012             pass
1013         return recipients
1014
1015     def message_new(self, cr, uid, msg, custom_values=None, context=None):
1016         """ Overrides mail_thread message_new that is called by the mailgateway
1017             through message_process.
1018             This override updates the document according to the email.
1019         """
1020         if custom_values is None:
1021             custom_values = {}
1022         desc = html2plaintext(msg.get('body')) if msg.get('body') else ''
1023         defaults = {
1024             'name':  msg.get('subject') or _("No Subject"),
1025             'description': desc,
1026             'email_from': msg.get('from'),
1027             'email_cc': msg.get('cc'),
1028             'partner_id': msg.get('author_id', False),
1029             'user_id': False,
1030         }
1031         if msg.get('author_id'):
1032             defaults.update(self.on_change_partner_id(cr, uid, None, msg.get('author_id'), context=context)['value'])
1033         if msg.get('priority') in dict(crm.AVAILABLE_PRIORITIES):
1034             defaults['priority'] = msg.get('priority')
1035         defaults.update(custom_values)
1036         return super(crm_lead, self).message_new(cr, uid, msg, custom_values=defaults, context=context)
1037
1038     def message_update(self, cr, uid, ids, msg, update_vals=None, context=None):
1039         """ Overrides mail_thread message_update that is called by the mailgateway
1040             through message_process.
1041             This method updates the document according to the email.
1042         """
1043         if isinstance(ids, (str, int, long)):
1044             ids = [ids]
1045         if update_vals is None: update_vals = {}
1046
1047         if msg.get('priority') in dict(crm.AVAILABLE_PRIORITIES):
1048             update_vals['priority'] = msg.get('priority')
1049         maps = {
1050             'cost':'planned_cost',
1051             'revenue': 'planned_revenue',
1052             'probability':'probability',
1053         }
1054         for line in msg.get('body', '').split('\n'):
1055             line = line.strip()
1056             res = tools.command_re.match(line)
1057             if res and maps.get(res.group(1).lower()):
1058                 key = maps.get(res.group(1).lower())
1059                 update_vals[key] = res.group(2).lower()
1060
1061         return super(crm_lead, self).message_update(cr, uid, ids, msg, update_vals=update_vals, context=context)
1062
1063     # ----------------------------------------
1064     # OpenChatter methods and notifications
1065     # ----------------------------------------
1066
1067     def schedule_phonecall_send_note(self, cr, uid, ids, phonecall_id, action, context=None):
1068         phonecall = self.pool.get('crm.phonecall').browse(cr, uid, [phonecall_id], context=context)[0]
1069         if action == 'log':
1070             prefix = 'Logged'
1071         else:
1072             prefix = 'Scheduled'
1073         suffix = ' %s' % phonecall.description
1074         message = _("%s a call for %s.%s") % (prefix, phonecall.date, suffix)
1075         return self.message_post(cr, uid, ids, body=message, context=context)
1076
1077     def log_meeting(self, cr, uid, ids, meeting_subject, meeting_date, duration, context=None):
1078         if not duration:
1079             duration = _('unknown')
1080         else:
1081             duration = str(duration)
1082         message = _("Meeting scheduled at '%s'<br> Subject: %s <br> Duration: %s hour(s)") % (meeting_date, meeting_subject, duration)
1083         return self.message_post(cr, uid, ids, body=message, context=context)
1084
1085     def onchange_state(self, cr, uid, ids, state_id, context=None):
1086         if state_id:
1087             country_id=self.pool.get('res.country.state').browse(cr, uid, state_id, context).country_id.id
1088             return {'value':{'country_id':country_id}}
1089         return {}
1090
1091 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: