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