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