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