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