69996663dabab531c3cdc527cf3f24c1e98196ce
[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, orm
27 import time
28 from openerp import SUPERUSER_ID
29 from openerp import tools
30 from openerp.tools.translate import _
31 from openerp.tools import html2plaintext
32
33 from base.res.res_partner import format_address
34
35 CRM_LEAD_FIELDS_TO_MERGE = ['name',
36     'partner_id',
37     'channel_id',
38     'company_id',
39     'country_id',
40     'section_id',
41     'state_id',
42     'stage_id',
43     'type_id',
44     'user_id',
45     'title',
46     'city',
47     'contact_name',
48     'description',
49     'email',
50     'fax',
51     'mobile',
52     'partner_name',
53     'phone',
54     'probability',
55     'planned_revenue',
56     'street',
57     'street2',
58     'zip',
59     'create_date',
60     'date_action_last',
61     'date_action_next',
62     'email_from',
63     'email_cc',
64     'partner_name']
65 CRM_LEAD_PENDING_STATES = (
66     crm.AVAILABLE_STATES[2][0], # Cancelled
67     crm.AVAILABLE_STATES[3][0], # Done
68     crm.AVAILABLE_STATES[4][0], # Pending
69 )
70
71 class crm_lead(base_stage, format_address, osv.osv):
72     """ CRM Lead Case """
73     _name = "crm.lead"
74     _description = "Lead/Opportunity"
75     _order = "priority,date_action,id desc"
76     _inherit = ['mail.thread', 'ir.needaction_mixin']
77
78     _track = {
79         'state': {
80             'crm.mt_lead_create': lambda self, cr, uid, obj, ctx=None: obj['state'] in ['new', 'draft'],
81             'crm.mt_lead_won': lambda self, cr, uid, obj, ctx=None: obj['state'] == 'done',
82             'crm.mt_lead_lost': lambda self, cr, uid, obj, ctx=None: obj['state'] == 'cancel',
83         },
84         'stage_id': {
85             'crm.mt_lead_stage': lambda self, cr, uid, obj, ctx=None: obj['state'] not in ['new', 'draft', 'cancel', 'done'],
86         },
87     }
88
89     def create(self, cr, uid, vals, context=None):
90         if context is None:
91             context = {}
92         if vals.get('type') and not context.get('default_type'):
93             context['default_type'] = vals.get('type')
94         if vals.get('section_id') and not context.get('default_section_id'):
95             context['default_section_id'] = vals.get('section_id')
96
97         # context: no_log, because subtype already handle this
98         create_context = dict(context, mail_create_nolog=True)
99         return super(crm_lead, self).create(cr, uid, vals, context=create_context)
100
101     def _get_default_section_id(self, cr, uid, context=None):
102         """ Gives default section by checking if present in the context """
103         return self._resolve_section_id_from_context(cr, uid, context=context) or False
104
105     def _get_default_stage_id(self, cr, uid, context=None):
106         """ Gives default stage_id """
107         section_id = self._get_default_section_id(cr, uid, context=context)
108         return self.stage_find(cr, uid, [], section_id, [('state', '=', 'draft')], context=context)
109
110     def _resolve_section_id_from_context(self, cr, uid, context=None):
111         """ Returns ID of section based on the value of 'section_id'
112             context key, or None if it cannot be resolved to a single
113             Sales Team.
114         """
115         if context is None:
116             context = {}
117         if type(context.get('default_section_id')) in (int, long):
118             return context.get('default_section_id')
119         if isinstance(context.get('default_section_id'), basestring):
120             section_name = context['default_section_id']
121             section_ids = self.pool.get('crm.case.section').name_search(cr, uid, name=section_name, context=context)
122             if len(section_ids) == 1:
123                 return int(section_ids[0][0])
124         return None
125
126     def _resolve_type_from_context(self, cr, uid, context=None):
127         """ Returns the type (lead or opportunity) from the type context
128             key. Returns None if it cannot be resolved.
129         """
130         if context is None:
131             context = {}
132         return context.get('default_type')
133
134     def _read_group_stage_ids(self, cr, uid, ids, domain, read_group_order=None, access_rights_uid=None, context=None):
135         access_rights_uid = access_rights_uid or uid
136         stage_obj = self.pool.get('crm.case.stage')
137         order = stage_obj._order
138         # lame hack to allow reverting search, should just work in the trivial case
139         if read_group_order == 'stage_id desc':
140             order = "%s desc" % order
141         # retrieve section_id from the context and write the domain
142         # - ('id', 'in', 'ids'): add columns that should be present
143         # - OR ('case_default', '=', True), ('fold', '=', False): add default columns that are not folded
144         # - OR ('section_ids', '=', section_id), ('fold', '=', False) if section_id: add section columns that are not folded
145         search_domain = []
146         section_id = self._resolve_section_id_from_context(cr, uid, context=context)
147         if section_id:
148             search_domain += ['|', ('section_ids', '=', section_id)]
149             search_domain += [('id', 'in', ids)]
150         else:
151             search_domain += ['|', ('id', 'in', ids), ('case_default', '=', True)]
152         # retrieve type from the context (if set: choose 'type' or 'both')
153         type = self._resolve_type_from_context(cr, uid, context=context)
154         if type:
155             search_domain += ['|', ('type', '=', type), ('type', '=', 'both')]
156         # perform search
157         stage_ids = stage_obj._search(cr, uid, search_domain, order=order, access_rights_uid=access_rights_uid, context=context)
158         result = stage_obj.name_get(cr, access_rights_uid, stage_ids, context=context)
159         # restore order of the search
160         result.sort(lambda x,y: cmp(stage_ids.index(x[0]), stage_ids.index(y[0])))
161
162         fold = {}
163         for stage in stage_obj.browse(cr, access_rights_uid, stage_ids, context=context):
164             fold[stage.id] = stage.fold or False
165         return result, fold
166
167     def fields_view_get(self, cr, user, view_id=None, view_type='form', context=None, toolbar=False, submenu=False):
168         res = super(crm_lead,self).fields_view_get(cr, user, view_id, view_type, context, toolbar=toolbar, submenu=submenu)
169         if view_type == 'form':
170             res['arch'] = self.fields_view_get_address(cr, user, res['arch'], context=context)
171         return res
172
173     _group_by_full = {
174         'stage_id': _read_group_stage_ids
175     }
176
177     def _compute_day(self, cr, uid, ids, fields, args, context=None):
178         """
179         :return dict: difference between current date and log date
180         """
181         cal_obj = self.pool.get('resource.calendar')
182         res_obj = self.pool.get('resource.resource')
183
184         res = {}
185         for lead in self.browse(cr, uid, ids, context=context):
186             for field in fields:
187                 res[lead.id] = {}
188                 duration = 0
189                 ans = False
190                 if field == 'day_open':
191                     if lead.date_open:
192                         date_create = datetime.strptime(lead.create_date, "%Y-%m-%d %H:%M:%S")
193                         date_open = datetime.strptime(lead.date_open, "%Y-%m-%d %H:%M:%S")
194                         ans = date_open - date_create
195                         date_until = lead.date_open
196                 elif field == 'day_close':
197                     if lead.date_closed:
198                         date_create = datetime.strptime(lead.create_date, "%Y-%m-%d %H:%M:%S")
199                         date_close = datetime.strptime(lead.date_closed, "%Y-%m-%d %H:%M:%S")
200                         date_until = lead.date_closed
201                         ans = date_close - date_create
202                 if ans:
203                     resource_id = False
204                     if lead.user_id:
205                         resource_ids = res_obj.search(cr, uid, [('user_id','=',lead.user_id.id)])
206                         if len(resource_ids):
207                             resource_id = resource_ids[0]
208
209                     duration = float(ans.days)
210                     if lead.section_id and lead.section_id.resource_calendar_id:
211                         duration =  float(ans.days) * 24
212                         new_dates = cal_obj.interval_get(cr,
213                             uid,
214                             lead.section_id.resource_calendar_id and lead.section_id.resource_calendar_id.id or False,
215                             datetime.strptime(lead.create_date, '%Y-%m-%d %H:%M:%S'),
216                             duration,
217                             resource=resource_id
218                         )
219                         no_days = []
220                         date_until = datetime.strptime(date_until, '%Y-%m-%d %H:%M:%S')
221                         for in_time, out_time in new_dates:
222                             if in_time.date not in no_days:
223                                 no_days.append(in_time.date)
224                             if out_time > date_until:
225                                 break
226                         duration =  len(no_days)
227                 res[lead.id][field] = abs(int(duration))
228         return res
229
230     def _history_search(self, cr, uid, obj, name, args, context=None):
231         res = []
232         msg_obj = self.pool.get('mail.message')
233         message_ids = msg_obj.search(cr, uid, [('email_from','!=',False), ('subject', args[0][1], args[0][2])], context=context)
234         lead_ids = self.search(cr, uid, [('message_ids', 'in', message_ids)], context=context)
235
236         if lead_ids:
237             return [('id', 'in', lead_ids)]
238         else:
239             return [('id', '=', '0')]
240
241     _columns = {
242         'partner_id': fields.many2one('res.partner', 'Partner', ondelete='set null', track_visibility='onchange',
243             select=True, help="Linked partner (optional). Usually created when converting the lead."),
244
245         'id': fields.integer('ID', readonly=True),
246         'name': fields.char('Subject', size=64, required=True, select=1),
247         'active': fields.boolean('Active', required=False),
248         'date_action_last': fields.datetime('Last Action', readonly=1),
249         'date_action_next': fields.datetime('Next Action', readonly=1),
250         'email_from': fields.char('Email', size=128, help="Email address of the contact", select=1),
251         'section_id': fields.many2one('crm.case.section', 'Sales Team',
252                         select=True, track_visibility='onchange', help='When sending mails, the default email address is taken from the sales team.'),
253         'create_date': fields.datetime('Creation Date' , readonly=True),
254         '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"),
255         'description': fields.text('Notes'),
256         'write_date': fields.datetime('Update Date' , readonly=True),
257         'categ_ids': fields.many2many('crm.case.categ', 'crm_lead_category_rel', 'lead_id', 'category_id', 'Categories', \
258             domain="['|',('section_id','=',section_id),('section_id','=',False), ('object_id.model', '=', 'crm.lead')]"),
259         'type_id': fields.many2one('crm.case.resource.type', 'Campaign', \
260             domain="['|',('section_id','=',section_id),('section_id','=',False)]", help="From which campaign (seminar, marketing campaign, mass mailing, ...) did this contact come from?"),
261         'channel_id': fields.many2one('crm.case.channel', 'Channel', help="Communication channel (mail, direct, phone, ...)"),
262         'contact_name': fields.char('Contact Name', size=64),
263         '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),
264         'opt_out': fields.boolean('Opt-Out', oldname='optout',
265             help="If opt-out is checked, this contact has refused to receive emails for mass mailing and marketing campaign. "
266                     "Filter 'Available for Mass Mailing' allows users to filter the leads when performing mass mailing."),
267         'type':fields.selection([ ('lead','Lead'), ('opportunity','Opportunity'), ],'Type', help="Type is used to separate Leads and Opportunities"),
268         'priority': fields.selection(crm.AVAILABLE_PRIORITIES, 'Priority', select=True),
269         'date_closed': fields.datetime('Closed', readonly=True),
270         'stage_id': fields.many2one('crm.case.stage', 'Stage', track_visibility='onchange',
271                         domain="['&', '&', ('fold', '=', False), ('section_ids', '=', section_id), '|', ('type', '=', type), ('type', '=', 'both')]"),
272         'user_id': fields.many2one('res.users', 'Salesperson', select=True, track_visibility='onchange'),
273         'referred': fields.char('Referred By', size=64),
274         'date_open': fields.datetime('Opened', readonly=True),
275         'day_open': fields.function(_compute_day, string='Days to Open', \
276                                 multi='day_open', type="float", store=True),
277         'day_close': fields.function(_compute_day, string='Days to Close', \
278                                 multi='day_close', type="float", store=True),
279         'state': fields.related('stage_id', 'state', type="selection", store=True,
280                 selection=crm.AVAILABLE_STATES, string="Status", readonly=True,
281                 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\'.'),
282
283         # Only used for type opportunity
284         'probability': fields.float('Success Rate (%)',group_operator="avg"),
285         'planned_revenue': fields.float('Expected Revenue', track_visibility='always'),
286         'ref': fields.reference('Reference', selection=crm._links_get, size=128),
287         'ref2': fields.reference('Reference 2', selection=crm._links_get, size=128),
288         'phone': fields.char("Phone", size=64),
289         'date_deadline': fields.date('Expected Closing', help="Estimate of the date on which the opportunity will be won."),
290         'date_action': fields.date('Next Action Date', select=True),
291         'title_action': fields.char('Next Action', size=64),
292         'color': fields.integer('Color Index'),
293         'partner_address_name': fields.related('partner_id', 'name', type='char', string='Partner Contact Name', readonly=True),
294         'partner_address_email': fields.related('partner_id', 'email', type='char', string='Partner Contact Email', readonly=True),
295         'company_currency': fields.related('company_id', 'currency_id', type='many2one', string='Currency', readonly=True, relation="res.currency"),
296         'user_email': fields.related('user_id', 'email', type='char', string='User Email', readonly=True),
297         'user_login': fields.related('user_id', 'login', type='char', string='User Login', readonly=True),
298
299         # Fields for address, due to separation from crm and res.partner
300         'street': fields.char('Street', size=128),
301         'street2': fields.char('Street2', size=128),
302         'zip': fields.char('Zip', change_default=True, size=24),
303         'city': fields.char('City', size=128),
304         'state_id': fields.many2one("res.country.state", 'State'),
305         'country_id': fields.many2one('res.country', 'Country'),
306         'phone': fields.char('Phone', size=64),
307         'fax': fields.char('Fax', size=64),
308         'mobile': fields.char('Mobile', size=64),
309         'function': fields.char('Function', size=128),
310         'title': fields.many2one('res.partner.title', 'Title'),
311         'company_id': fields.many2one('res.company', 'Company', select=1),
312         'payment_mode': fields.many2one('crm.payment.mode', 'Payment Mode', \
313                             domain="[('section_id','=',section_id)]"),
314         'planned_cost': fields.float('Planned Costs'),
315     }
316
317     _defaults = {
318         'active': 1,
319         'type': 'lead',
320         'user_id': lambda s, cr, uid, c: s._get_default_user(cr, uid, c),
321         'email_from': lambda s, cr, uid, c: s._get_default_email(cr, uid, c),
322         'stage_id': lambda s, cr, uid, c: s._get_default_stage_id(cr, uid, c),
323         'section_id': lambda s, cr, uid, c: s._get_default_section_id(cr, uid, c),
324         'company_id': lambda s, cr, uid, c: s.pool.get('res.company')._company_default_get(cr, uid, 'crm.lead', context=c),
325         'priority': lambda *a: crm.AVAILABLE_PRIORITIES[2][0],
326         'color': 0,
327     }
328
329     _sql_constraints = [
330         ('check_probability', 'check(probability >= 0 and probability <= 100)', 'The probability of closing the deal should be between 0% and 100%!')
331     ]
332
333     def onchange_stage_id(self, cr, uid, ids, stage_id, context=None):
334         if not stage_id:
335             return {'value':{}}
336         stage = self.pool.get('crm.case.stage').browse(cr, uid, stage_id, context)
337         if not stage.on_change:
338             return {'value':{}}
339         return {'value':{'probability': stage.probability}}
340
341     def on_change_partner(self, cr, uid, ids, partner_id, context=None):
342         result = {}
343         values = {}
344         if partner_id:
345             partner = self.pool.get('res.partner').browse(cr, uid, partner_id, context=context)
346             values = {
347                 'partner_name' : partner.name,
348                 'street' : partner.street,
349                 'street2' : partner.street2,
350                 'city' : partner.city,
351                 'state_id' : partner.state_id and partner.state_id.id or False,
352                 'country_id' : partner.country_id and partner.country_id.id or False,
353                 'email_from' : partner.email,
354                 'phone' : partner.phone,
355                 'mobile' : partner.mobile,
356                 'fax' : partner.fax,
357             }
358         return {'value' : values}
359
360     def on_change_user(self, cr, uid, ids, user_id, context=None):
361         """ When changing the user, also set a section_id or restrict section id
362             to the ones user_id is member of. """
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                 return {'value': {'section_id': section_ids[0]}}
367         return {'value': {}}
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.id, 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         # 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
675         self.unlink(cr, SUPERUSER_ID, [x.id for x in tail_opportunities], context=context)
676
677         return highest.id
678
679     def _convert_opportunity_data(self, cr, uid, lead, customer, section_id=False, context=None):
680         crm_stage = self.pool.get('crm.case.stage')
681         contact_id = False
682         if customer:
683             contact_id = self.pool.get('res.partner').address_get(cr, uid, [customer.id])['default']
684         if not section_id:
685             section_id = lead.section_id and lead.section_id.id or False
686         val = {
687             'planned_revenue': lead.planned_revenue,
688             'probability': lead.probability,
689             'name': lead.name,
690             'partner_id': customer and customer.id or False,
691             'user_id': (lead.user_id and lead.user_id.id),
692             'type': 'opportunity',
693             'date_action': fields.datetime.now(),
694             'date_open': fields.datetime.now(),
695             'email_from': customer and customer.email or lead.email_from,
696             'phone': customer and customer.phone or lead.phone,
697         }
698         if not lead.stage_id or lead.stage_id.type=='lead':
699             val['stage_id'] = self.stage_find(cr, uid, [lead], section_id, [('state', '=', 'draft'),('type', 'in', ('opportunity','both'))], context=context)
700         return val
701
702     def convert_opportunity(self, cr, uid, ids, partner_id, user_ids=False, section_id=False, context=None):
703         customer = False
704         if partner_id:
705             partner = self.pool.get('res.partner')
706             customer = partner.browse(cr, uid, partner_id, context=context)
707         for lead in self.browse(cr, uid, ids, context=context):
708             if lead.state in ('done', 'cancel'):
709                 continue
710             vals = self._convert_opportunity_data(cr, uid, lead, customer, section_id, context=context)
711             self.write(cr, uid, [lead.id], vals, context=context)
712         self.message_post(cr, uid, ids, body=_("Lead <b>converted into an Opportunity</b>"), subtype="crm.mt_lead_convert_to_opportunity", context=context)
713
714         if user_ids or section_id:
715             self.allocate_salesman(cr, uid, ids, user_ids, section_id, context=context)
716
717         return True
718
719     def _lead_create_contact(self, cr, uid, lead, name, is_company, parent_id=False, context=None):
720         partner = self.pool.get('res.partner')
721         vals = {'name': name,
722             'user_id': lead.user_id.id,
723             'comment': lead.description,
724             'section_id': lead.section_id.id or False,
725             'parent_id': parent_id,
726             'phone': lead.phone,
727             'mobile': lead.mobile,
728             'email': tools.email_split(lead.email_from) and tools.email_split(lead.email_from)[0] or False,
729             'fax': lead.fax,
730             'title': lead.title and lead.title.id or False,
731             'function': lead.function,
732             'street': lead.street,
733             'street2': lead.street2,
734             'zip': lead.zip,
735             'city': lead.city,
736             'country_id': lead.country_id and lead.country_id.id or False,
737             'state_id': lead.state_id and lead.state_id.id or False,
738             'is_company': is_company,
739             'type': 'contact'
740         }
741         partner = partner.create(cr, uid, vals, context=context)
742         return partner
743
744     def _create_lead_partner(self, cr, uid, lead, context=None):
745         partner_id = False
746         if lead.partner_name and lead.contact_name:
747             partner_id = self._lead_create_contact(cr, uid, lead, lead.partner_name, True, context=context)
748             partner_id = self._lead_create_contact(cr, uid, lead, lead.contact_name, False, partner_id, context=context)
749         elif lead.partner_name and not lead.contact_name:
750             partner_id = self._lead_create_contact(cr, uid, lead, lead.partner_name, True, context=context)
751         elif not lead.partner_name and lead.contact_name:
752             partner_id = self._lead_create_contact(cr, uid, lead, lead.contact_name, False, context=context)
753         elif lead.email_from and self.pool.get('res.partner')._parse_partner_name(lead.email_from, context=context)[0]:
754             contact_name = self.pool.get('res.partner')._parse_partner_name(lead.email_from, context=context)[0]
755             partner_id = self._lead_create_contact(cr, uid, lead, contact_name, False, context=context)
756         else:
757             raise osv.except_osv(
758                 _('Warning!'),
759                 _('No customer name defined. Please fill one of the following fields: Company Name, Contact Name or Email ("Name <email@address>")')
760             )
761         return partner_id
762
763     def _lead_set_partner(self, cr, uid, lead, partner_id, context=None):
764         """
765         Assign a partner to a lead.
766
767         :param object lead: browse record of the lead to process
768         :param int partner_id: identifier of the partner to assign
769         :return bool: True if the partner has properly been assigned
770         """
771         res = False
772         res_partner = self.pool.get('res.partner')
773         if partner_id:
774             res_partner.write(cr, uid, partner_id, {'section_id': lead.section_id and lead.section_id.id or False})
775             contact_id = res_partner.address_get(cr, uid, [partner_id])['default']
776             res = lead.write({'partner_id': partner_id}, context=context)
777             message = _("<b>Partner</b> set to <em>%s</em>." % (lead.partner_id.name))
778             self.message_post(cr, uid, [lead.id], body=message, context=context)
779         return res
780
781     def handle_partner_assignation(self, cr, uid, ids, action='create', partner_id=False, context=None):
782         """
783         Handle partner assignation during a lead conversion.
784         if action is 'create', create new partner with contact and assign lead to new partner_id.
785         otherwise assign lead to the specified partner_id
786
787         :param list ids: leads/opportunities ids to process
788         :param string action: what has to be done regarding partners (create it, assign an existing one, or nothing)
789         :param int partner_id: partner to assign if any
790         :return dict: dictionary organized as followed: {lead_id: partner_assigned_id}
791         """
792         #TODO this is a duplication of the handle_partner_assignation method of crm_phonecall
793         partner_ids = {}
794         # If a partner_id is given, force this partner for all elements
795         force_partner_id = partner_id
796         for lead in self.browse(cr, uid, ids, context=context):
797             # If the action is set to 'create' and no partner_id is set, create a new one
798             if action == 'create':
799                 partner_id = force_partner_id or self._create_lead_partner(cr, uid, lead, context)
800             self._lead_set_partner(cr, uid, lead, partner_id, context=context)
801             partner_ids[lead.id] = partner_id
802         return partner_ids
803
804     def allocate_salesman(self, cr, uid, ids, user_ids=None, team_id=False, context=None):
805         """
806         Assign salesmen and salesteam to a batch of leads.  If there are more
807         leads than salesmen, these salesmen will be assigned in round-robin.
808         E.g.: 4 salesmen (S1, S2, S3, S4) for 6 leads (L1, L2, ... L6).  They
809         will be assigned as followed: L1 - S1, L2 - S2, L3 - S3, L4 - S4,
810         L5 - S1, L6 - S2.
811
812         :param list ids: leads/opportunities ids to process
813         :param list user_ids: salesmen to assign
814         :param int team_id: salesteam to assign
815         :return bool
816         """
817         index = 0
818
819         for lead_id in ids:
820             value = {}
821             if team_id:
822                 value['section_id'] = team_id
823             if user_ids:
824                 value['user_id'] = user_ids[index]
825                 # Cycle through user_ids
826                 index = (index + 1) % len(user_ids)
827             if value:
828                 self.write(cr, uid, [lead_id], value, context=context)
829         return True
830
831     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):
832         """
833         :param string action: ('schedule','Schedule a call'), ('log','Log a call')
834         """
835         phonecall = self.pool.get('crm.phonecall')
836         model_data = self.pool.get('ir.model.data')
837         phonecall_dict = {}
838         if not categ_id:
839             res_id = model_data._get_id(cr, uid, 'crm', 'categ_phone2')
840             if res_id:
841                 categ_id = model_data.browse(cr, uid, res_id, context=context).res_id
842         for lead in self.browse(cr, uid, ids, context=context):
843             if not section_id:
844                 section_id = lead.section_id and lead.section_id.id or False
845             if not user_id:
846                 user_id = lead.user_id and lead.user_id.id or False
847             vals = {
848                 'name': call_summary,
849                 'opportunity_id': lead.id,
850                 'user_id': user_id or False,
851                 'categ_id': categ_id or False,
852                 'description': desc or '',
853                 'date': schedule_time,
854                 'section_id': section_id or False,
855                 'partner_id': lead.partner_id and lead.partner_id.id or False,
856                 'partner_phone': phone or lead.phone or (lead.partner_id and lead.partner_id.phone or False),
857                 'partner_mobile': lead.partner_id and lead.partner_id.mobile or False,
858                 'priority': lead.priority,
859             }
860             new_id = phonecall.create(cr, uid, vals, context=context)
861             phonecall.case_open(cr, uid, [new_id], context=context)
862             if action == 'log':
863                 phonecall.case_close(cr, uid, [new_id], context=context)
864             phonecall_dict[lead.id] = new_id
865             self.schedule_phonecall_send_note(cr, uid, [lead.id], new_id, action, context=context)
866         return phonecall_dict
867
868     def redirect_opportunity_view(self, cr, uid, opportunity_id, context=None):
869         models_data = self.pool.get('ir.model.data')
870
871         # Get opportunity views
872         dummy, form_view = models_data.get_object_reference(cr, uid, 'crm', 'crm_case_form_view_oppor')
873         dummy, tree_view = models_data.get_object_reference(cr, uid, 'crm', 'crm_case_tree_view_oppor')
874         return {
875             'name': _('Opportunity'),
876             'view_type': 'form',
877             'view_mode': 'tree, form',
878             'res_model': 'crm.lead',
879             'domain': [('type', '=', 'opportunity')],
880             'res_id': int(opportunity_id),
881             'view_id': False,
882             'views': [(form_view or False, 'form'),
883                     (tree_view or False, 'tree'),
884                     (False, 'calendar'), (False, 'graph')],
885             'type': 'ir.actions.act_window',
886         }
887
888     def redirect_lead_view(self, cr, uid, lead_id, context=None):
889         models_data = self.pool.get('ir.model.data')
890
891         # Get lead views
892         dummy, form_view = models_data.get_object_reference(cr, uid, 'crm', 'crm_case_form_view_leads')
893         dummy, tree_view = models_data.get_object_reference(cr, uid, 'crm', 'crm_case_tree_view_leads')
894         return {
895             'name': _('Lead'),
896             'view_type': 'form',
897             'view_mode': 'tree, form',
898             'res_model': 'crm.lead',
899             'domain': [('type', '=', 'lead')],
900             'res_id': int(lead_id),
901             'view_id': False,
902             'views': [(form_view or False, 'form'),
903                       (tree_view or False, 'tree'),
904                       (False, 'calendar'), (False, 'graph')],
905             'type': 'ir.actions.act_window',
906         }
907
908     def action_makeMeeting(self, cr, uid, ids, context=None):
909         """
910         Open meeting's calendar view to schedule meeting on current opportunity.
911         :return dict: dictionary value for created Meeting view
912         """
913         opportunity = self.browse(cr, uid, ids[0], context)
914         res = self.pool.get('ir.actions.act_window').for_xml_id(cr, uid, 'base_calendar', 'action_crm_meeting', context)
915         res['context'] = {
916             'default_opportunity_id': opportunity.id,
917             'default_partner_id': opportunity.partner_id and opportunity.partner_id.id or False,
918             'default_partner_ids' : opportunity.partner_id and [opportunity.partner_id.id] or False,
919             'default_user_id': uid,
920             'default_section_id': opportunity.section_id and opportunity.section_id.id or False,
921             'default_email_from': opportunity.email_from,
922             'default_name': opportunity.name,
923         }
924         return res
925
926     def write(self, cr, uid, ids, vals, context=None):
927         if vals.get('stage_id') and not vals.get('probability'):
928             # change probability of lead(s) if required by stage
929             stage = self.pool.get('crm.case.stage').browse(cr, uid, vals['stage_id'], context=context)
930             if stage.on_change:
931                 vals['probability'] = stage.probability
932         return super(crm_lead, self).write(cr, uid, ids, vals, context=context)
933
934     def new_mail_send(self, cr, uid, ids, context=None):
935         '''
936         This function opens a window to compose an email, with the edi sale template message loaded by default
937         '''
938         assert len(ids) == 1, 'This option should only be used for a single id at a time.'
939         ir_model_data = self.pool.get('ir.model.data')
940         try:
941             template_id = ir_model_data.get_object_reference(cr, uid, 'crm', 'email_template_opportunity_mail')[1]
942         except ValueError:
943             template_id = False
944         try:
945             compose_form_id = ir_model_data.get_object_reference(cr, uid, 'mail', 'email_compose_message_wizard_form')[1]
946         except ValueError:
947             compose_form_id = False
948         if context is None:
949             context = {}
950         ctx = context.copy()
951         ctx.update({
952             'default_model': 'crm.lead',
953             'default_res_id': ids[0],
954             'default_use_template': bool(template_id),
955             'default_template_id': template_id,
956             'default_composition_mode': 'comment',
957         })
958         return {
959             'type': 'ir.actions.act_window',
960             'view_type': 'form',
961             'view_mode': 'form',
962             'res_model': 'mail.compose.message',
963             'views': [(compose_form_id, 'form')],
964             'view_id': compose_form_id,
965             'target': 'new',
966             'context': ctx,
967         }
968
969     # ----------------------------------------
970     # Mail Gateway
971     # ----------------------------------------
972
973     def message_get_reply_to(self, cr, uid, ids, context=None):
974         """ Override to get the reply_to of the parent project. """
975         return [lead.section_id.message_get_reply_to()[0] if lead.section_id else False
976                     for lead in self.browse(cr, SUPERUSER_ID, ids, context=context)]
977
978     def message_get_suggested_recipients(self, cr, uid, ids, context=None):
979         recipients = super(crm_lead, self).message_get_suggested_recipients(cr, uid, ids, context=context)
980         try:
981             for lead in self.browse(cr, uid, ids, context=context):
982                 if lead.partner_id:
983                     self._message_add_suggested_recipient(cr, uid, recipients, lead, partner=lead.partner_id, reason=_('Customer'))
984                 elif lead.email_from:
985                     self._message_add_suggested_recipient(cr, uid, recipients, lead, email=lead.email_from, reason=_('Customer Email'))
986         except (osv.except_osv, orm.except_orm):  # no read access rights -> just ignore suggested recipients because this imply modifying followers
987             pass
988         return recipients
989
990     def message_new(self, cr, uid, msg, custom_values=None, context=None):
991         """ Overrides mail_thread message_new that is called by the mailgateway
992             through message_process.
993             This override updates the document according to the email.
994         """
995         if custom_values is None:
996             custom_values = {}
997         desc = html2plaintext(msg.get('body')) if msg.get('body') else ''
998         defaults = {
999             'name':  msg.get('subject') or _("No Subject"),
1000             'description': desc,
1001             'email_from': msg.get('from'),
1002             'email_cc': msg.get('cc'),
1003             'partner_id': msg.get('author_id', False),
1004             'user_id': False,
1005         }
1006         if msg.get('author_id'):
1007             defaults.update(self.on_change_partner(cr, uid, None, msg.get('author_id'), context=context)['value'])
1008         if msg.get('priority') in dict(crm.AVAILABLE_PRIORITIES):
1009             defaults['priority'] = msg.get('priority')
1010         defaults.update(custom_values)
1011         return super(crm_lead, self).message_new(cr, uid, msg, custom_values=defaults, context=context)
1012
1013     def message_update(self, cr, uid, ids, msg, update_vals=None, context=None):
1014         """ Overrides mail_thread message_update that is called by the mailgateway
1015             through message_process.
1016             This method updates the document according to the email.
1017         """
1018         if isinstance(ids, (str, int, long)):
1019             ids = [ids]
1020         if update_vals is None: update_vals = {}
1021
1022         if msg.get('priority') in dict(crm.AVAILABLE_PRIORITIES):
1023             update_vals['priority'] = msg.get('priority')
1024         maps = {
1025             'cost':'planned_cost',
1026             'revenue': 'planned_revenue',
1027             'probability':'probability',
1028         }
1029         for line in msg.get('body', '').split('\n'):
1030             line = line.strip()
1031             res = tools.command_re.match(line)
1032             if res and maps.get(res.group(1).lower()):
1033                 key = maps.get(res.group(1).lower())
1034                 update_vals[key] = res.group(2).lower()
1035
1036         return super(crm_lead, self).message_update(cr, uid, ids, msg, update_vals=update_vals, context=context)
1037
1038     # ----------------------------------------
1039     # OpenChatter methods and notifications
1040     # ----------------------------------------
1041
1042     def schedule_phonecall_send_note(self, cr, uid, ids, phonecall_id, action, context=None):
1043         phonecall = self.pool.get('crm.phonecall').browse(cr, uid, [phonecall_id], context=context)[0]
1044         if action == 'log':
1045             prefix = 'Logged'
1046         else:
1047             prefix = 'Scheduled'
1048         suffix = ' %s' % phonecall.description
1049         message = _("%s a call for %s.%s") % (prefix, phonecall.date, suffix)
1050         return self.message_post(cr, uid, ids, body=message, context=context)
1051
1052     def log_meeting(self, cr, uid, ids, meeting_subject, meeting_date, duration, context=None):
1053         if not duration:
1054             duration = _('unknown')
1055         else:
1056             duration = str(duration)
1057         message = _("Meeting scheduled at '%s'<br> Subject: %s <br> Duration: %s hour(s)") % (meeting_date, meeting_subject, duration)
1058         return self.message_post(cr, uid, ids, body=message, context=context)
1059
1060     def onchange_state(self, cr, uid, ids, state_id, context=None):
1061         if state_id:
1062             country_id=self.pool.get('res.country.state').browse(cr, uid, state_id, context).country_id.id
1063             return {'value':{'country_id':country_id}}
1064         return {}
1065
1066 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: