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