addons/crm/crm_lead.py

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