openerp/addons/base/res/res_partner.py

   1 # -*- coding: utf-8 -*-
   2 ##############################################################################
   3 #
   4 #    OpenERP, Open Source Management Solution
   5 #    Copyright (C) 2004-2009 Tiny SPRL (<http://tiny.be>).
   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 datetime
  23 from lxml import etree
  24 import math
  25 import pytz
  26 import re
  27
  28 import openerp
  29 from openerp import SUPERUSER_ID
  30 from openerp import tools
  31 from openerp.osv import osv, fields
  32 from openerp.tools.translate import _
  33 from openerp.tools.yaml_import import is_comment
  34
  35 class format_address(object):
  36     def fields_view_get_address(self, cr, uid, arch, context={}):
  37         user_obj = self.pool['res.users']
  38         fmt = user_obj.browse(cr, SUPERUSER_ID, uid, context).company_id.country_id
  39         fmt = fmt and fmt.address_format
  40         layouts = {
  41             '%(city)s %(state_code)s\n%(zip)s': """
  42                 <div class="address_format">
  43                     <field name="city" placeholder="City" style="width: 50%%"/>
  44                     <field name="state_id" class="oe_no_button" placeholder="State" style="width: 47%%" options='{"no_open": true}'/>
  45                     <br/>
  46                     <field name="zip" placeholder="ZIP"/>
  47                 </div>
  48             """,
  49             '%(zip)s %(city)s': """
  50                 <div class="address_format">
  51                     <field name="zip" placeholder="ZIP" style="width: 40%%"/>
  52                     <field name="city" placeholder="City" style="width: 57%%"/>
  53                     <br/>
  54                     <field name="state_id" class="oe_no_button" placeholder="State" options='{"no_open": true}'/>
  55                 </div>
  56             """,
  57             '%(city)s\n%(state_name)s\n%(zip)s': """
  58                 <div class="address_format">
  59                     <field name="city" placeholder="City"/>
  60                     <field name="state_id" class="oe_no_button" placeholder="State" options='{"no_open": true}'/>
  61                     <field name="zip" placeholder="ZIP"/>
  62                 </div>
  63             """
  64         }
  65         for k,v in layouts.items():
  66             if fmt and (k in fmt):
  67                 doc = etree.fromstring(arch)
  68                 for node in doc.xpath("//div[@class='address_format']"):
  69                     tree = etree.fromstring(v)
  70                     node.getparent().replace(node, tree)
  71                 arch = etree.tostring(doc)
  72                 break
  73         return arch
  74
  75
  76 def _tz_get(self,cr,uid, context=None):
  77     # put POSIX 'Etc/*' entries at the end to avoid confusing users - see bug 1086728
  78     return [(tz,tz) for tz in sorted(pytz.all_timezones, key=lambda tz: tz if not tz.startswith('Etc/') else '_')]
  79
  80 class res_partner_category(osv.osv):
  81
  82     def name_get(self, cr, uid, ids, context=None):
  83         """Return the categories' display name, including their direct
  84            parent by default.
  85
  86         :param dict context: the ``partner_category_display`` key can be
  87                              used to select the short version of the
  88                              category name (without the direct parent),
  89                              when set to ``'short'``. The default is
  90                              the long version."""
  91         if context is None:
  92             context = {}
  93         if context.get('partner_category_display') == 'short':
  94             return super(res_partner_category, self).name_get(cr, uid, ids, context=context)
  95         if isinstance(ids, (int, long)):
  96             ids = [ids]
  97         reads = self.read(cr, uid, ids, ['name', 'parent_id'], context=context)
  98         res = []
  99         for record in reads:
 100             name = record['name']
 101             if record['parent_id']:
 102                 name = record['parent_id'][1] + ' / ' + name
 103             res.append((record['id'], name))
 104         return res
 105
 106     def name_search(self, cr, uid, name, args=None, operator='ilike', context=None, limit=100):
 107         if not args:
 108             args = []
 109         if not context:
 110             context = {}
 111         if name:
 112             # Be sure name_search is symetric to name_get
 113             name = name.split(' / ')[-1]
 114             ids = self.search(cr, uid, [('name', operator, name)] + args, limit=limit, context=context)
 115         else:
 116             ids = self.search(cr, uid, args, limit=limit, context=context)
 117         return self.name_get(cr, uid, ids, context)
 118
 119
 120     def _name_get_fnc(self, cr, uid, ids, prop, unknow_none, context=None):
 121         res = self.name_get(cr, uid, ids, context=context)
 122         return dict(res)
 123
 124     _description = 'Partner Tags'
 125     _name = 'res.partner.category'
 126     _columns = {
 127         'name': fields.char('Category Name', required=True, size=64, translate=True),
 128         'parent_id': fields.many2one('res.partner.category', 'Parent Category', select=True, ondelete='cascade'),
 129         'complete_name': fields.function(_name_get_fnc, type="char", string='Full Name'),
 130         'child_ids': fields.one2many('res.partner.category', 'parent_id', 'Child Categories'),
 131         'active': fields.boolean('Active', help="The active field allows you to hide the category without removing it."),
 132         'parent_left': fields.integer('Left parent', select=True),
 133         'parent_right': fields.integer('Right parent', select=True),
 134         'partner_ids': fields.many2many('res.partner', id1='category_id', id2='partner_id', string='Partners'),
 135     }
 136     _constraints = [
 137         (osv.osv._check_recursion, 'Error ! You can not create recursive categories.', ['parent_id'])
 138     ]
 139     _defaults = {
 140         'active': 1,
 141     }
 142     _parent_store = True
 143     _parent_order = 'name'
 144     _order = 'parent_left'
 145
 146 class res_partner_title(osv.osv):
 147     _name = 'res.partner.title'
 148     _order = 'name'
 149     _columns = {
 150         'name': fields.char('Title', required=True, size=46, translate=True),
 151         'shortcut': fields.char('Abbreviation', size=16, translate=True),
 152         'domain': fields.selection([('partner', 'Partner'), ('contact', 'Contact')], 'Domain', required=True, size=24)
 153     }
 154     _defaults = {
 155         'domain': 'contact',
 156     }
 157
 158 def _lang_get(self, cr, uid, context=None):
 159     lang_pool = self.pool['res.lang']
 160     ids = lang_pool.search(cr, uid, [], context=context)
 161     res = lang_pool.read(cr, uid, ids, ['code', 'name'], context)
 162     return [(r['code'], r['name']) for r in res]
 163
 164 # fields copy if 'use_parent_address' is checked
 165 ADDRESS_FIELDS = ('street', 'street2', 'zip', 'city', 'state_id', 'country_id')
 166
 167 class res_partner(osv.osv, format_address):
 168     _description = 'Partner'
 169     _name = "res.partner"
 170
 171     def _address_display(self, cr, uid, ids, name, args, context=None):
 172         res = {}
 173         for partner in self.browse(cr, uid, ids, context=context):
 174             res[partner.id] = self._display_address(cr, uid, partner, context=context)
 175         return res
 176
 177     def _get_image(self, cr, uid, ids, name, args, context=None):
 178         result = dict.fromkeys(ids, False)
 179         for obj in self.browse(cr, uid, ids, context=context):
 180             result[obj.id] = tools.image_get_resized_images(obj.image)
 181         return result
 182
 183     def _get_tz_offset(self, cr, uid, ids, name, args, context=None):
 184         result = dict.fromkeys(ids, False)
 185         for obj in self.browse(cr, uid, ids, context=context):
 186             result[obj.id] = datetime.datetime.now(pytz.timezone(obj.tz or 'GMT')).strftime('%z')
 187         return result
 188
 189     def _set_image(self, cr, uid, id, name, value, args, context=None):
 190         return self.write(cr, uid, [id], {'image': tools.image_resize_image_big(value)}, context=context)
 191
 192     def _has_image(self, cr, uid, ids, name, args, context=None):
 193         result = {}
 194         for obj in self.browse(cr, uid, ids, context=context):
 195             result[obj.id] = obj.image != False
 196         return result
 197
 198     def _commercial_partner_compute(self, cr, uid, ids, name, args, context=None):
 199         """ Returns the partner that is considered the commercial
 200         entity of this partner. The commercial entity holds the master data
 201         for all commercial fields (see :py:meth:`~_commercial_fields`) """
 202         result = dict.fromkeys(ids, False)
 203         for partner in self.browse(cr, uid, ids, context=context):
 204             current_partner = partner
 205             while not current_partner.is_company and current_partner.parent_id:
 206                 current_partner = current_partner.parent_id
 207             result[partner.id] = current_partner.id
 208         return result
 209
 210     def _display_name_compute(self, cr, uid, ids, name, args, context=None):
 211         context = dict(context or {})
 212         context.pop('show_address', None)
 213         return dict(self.name_get(cr, uid, ids, context=context))
 214
 215     # indirections to avoid passing a copy of the overridable method when declaring the function field
 216     _commercial_partner_id = lambda self, *args, **kwargs: self._commercial_partner_compute(*args, **kwargs)
 217     _display_name = lambda self, *args, **kwargs: self._display_name_compute(*args, **kwargs)
 218
 219     _commercial_partner_store_triggers = {
 220         'res.partner': (lambda self,cr,uid,ids,context=None: self.search(cr, uid, [('id','child_of',ids)]),
 221                         ['parent_id', 'is_company'], 10)
 222     }
 223     _display_name_store_triggers = {
 224         'res.partner': (lambda self,cr,uid,ids,context=None: self.search(cr, uid, [('id','child_of',ids)]),
 225                         ['parent_id', 'is_company', 'name'], 10)
 226     }
 227
 228     _order = "display_name"
 229     _columns = {
 230         'name': fields.char('Name', size=128, required=True, select=True),
 231         'display_name': fields.function(_display_name, type='char', string='Name', store=_display_name_store_triggers),
 232         'date': fields.date('Date', select=1),
 233         'title': fields.many2one('res.partner.title', 'Title'),
 234         'parent_id': fields.many2one('res.partner', 'Related Company'),
 235         'child_ids': fields.one2many('res.partner', 'parent_id', 'Contacts', domain=[('active','=',True)]), # force "active_test" domain to bypass _search() override
 236         'ref': fields.char('Reference', size=64, select=1),
 237         'lang': fields.selection(_lang_get, 'Language',
 238             help="If the selected language is loaded in the system, all documents related to this contact will be printed in this language. If not, it will be English."),
 239         'tz': fields.selection(_tz_get,  'Timezone', size=64,
 240             help="The partner's timezone, used to output proper date and time values inside printed reports. "
 241                  "It is important to set a value for this field. You should use the same timezone "
 242                  "that is otherwise used to pick and render date and time values: your computer's timezone."),
 243         'tz_offset': fields.function(_get_tz_offset, type='char', size=5, string='Timezone offset', invisible=True),
 244         'user_id': fields.many2one('res.users', 'Salesperson', help='The internal user that is in charge of communicating with this contact if any.'),
 245         'vat': fields.char('TIN', size=32, help="Tax Identification Number. Check the box if this contact is subjected to taxes. Used by the some of the legal statements."),
 246         'bank_ids': fields.one2many('res.partner.bank', 'partner_id', 'Banks'),
 247         'website': fields.char('Website', size=64, help="Website of Partner or Company"),
 248         'comment': fields.text('Notes'),
 249         'category_id': fields.many2many('res.partner.category', id1='partner_id', id2='category_id', string='Tags'),
 250         'credit_limit': fields.float(string='Credit Limit'),
 251         'ean13': fields.char('EAN13', size=13),
 252         'active': fields.boolean('Active'),
 253         'customer': fields.boolean('Customer', help="Check this box if this contact is a customer."),
 254         'supplier': fields.boolean('Supplier', help="Check this box if this contact is a supplier. If it's not checked, purchase people will not see it when encoding a purchase order."),
 255         'employee': fields.boolean('Employee', help="Check this box if this contact is an Employee."),
 256         'function': fields.char('Job Position', size=128),
 257         'type': fields.selection([('default', 'Default'), ('invoice', 'Invoice'),
 258                                    ('delivery', 'Shipping'), ('contact', 'Contact'),
 259                                    ('other', 'Other')], 'Address Type',
 260             help="Used to select automatically the right address according to the context in sales and purchases documents."),
 261         'street': fields.char('Street', size=128),
 262         'street2': fields.char('Street2', size=128),
 263         'zip': fields.char('Zip', change_default=True, size=24),
 264         'city': fields.char('City', size=128),
 265         'state_id': fields.many2one("res.country.state", 'State', ondelete='restrict'),
 266         'country_id': fields.many2one('res.country', 'Country', ondelete='restrict'),
 267         'country': fields.related('country_id', type='many2one', relation='res.country', string='Country',
 268                                   deprecated="This field will be removed as of OpenERP 7.1, use country_id instead"),
 269         'email': fields.char('Email', size=240),
 270         'phone': fields.char('Phone', size=64),
 271         'fax': fields.char('Fax', size=64),
 272         'mobile': fields.char('Mobile', size=64),
 273         'birthdate': fields.char('Birthdate', size=64),
 274         'is_company': fields.boolean('Is a Company', help="Check if the contact is a company, otherwise it is a person"),
 275         'use_parent_address': fields.boolean('Use Company Address', help="Select this if you want to set company's address information  for this contact"),
 276         # image: all image fields are base64 encoded and PIL-supported
 277         'image': fields.binary("Image",
 278             help="This field holds the image used as avatar for this contact, limited to 1024x1024px"),
 279         'image_medium': fields.function(_get_image, fnct_inv=_set_image,
 280             string="Medium-sized image", type="binary", multi="_get_image",
 281             store={
 282                 'res.partner': (lambda self, cr, uid, ids, c={}: ids, ['image'], 10),
 283             },
 284             help="Medium-sized image of this contact. It is automatically "\
 285                  "resized as a 128x128px image, with aspect ratio preserved. "\
 286                  "Use this field in form views or some kanban views."),
 287         'image_small': fields.function(_get_image, fnct_inv=_set_image,
 288             string="Small-sized image", type="binary", multi="_get_image",
 289             store={
 290                 'res.partner': (lambda self, cr, uid, ids, c={}: ids, ['image'], 10),
 291             },
 292             help="Small-sized image of this contact. It is automatically "\
 293                  "resized as a 64x64px image, with aspect ratio preserved. "\
 294                  "Use this field anywhere a small image is required."),
 295         'has_image': fields.function(_has_image, type="boolean"),
 296         'company_id': fields.many2one('res.company', 'Company', select=1),
 297         'color': fields.integer('Color Index'),
 298         'user_ids': fields.one2many('res.users', 'partner_id', 'Users'),
 299         'contact_address': fields.function(_address_display,  type='char', string='Complete Address'),
 300
 301         # technical field used for managing commercial fields
 302         'commercial_partner_id': fields.function(_commercial_partner_id, type='many2one', relation='res.partner', string='Commercial Entity', store=_commercial_partner_store_triggers)
 303     }
 304
 305     def _default_category(self, cr, uid, context=None):
 306         if context is None:
 307             context = {}
 308         if context.get('category_id'):
 309             return [context['category_id']]
 310         return False
 311
 312     def _get_default_image(self, cr, uid, is_company, context=None, colorize=False):
 313         img_path = openerp.modules.get_module_resource('base', 'static/src/img',
 314                                                        ('company_image.png' if is_company else 'avatar.png'))
 315         with open(img_path, 'rb') as f:
 316             image = f.read()
 317
 318         # colorize user avatars
 319         if not is_company:
 320             image = tools.image_colorize(image)
 321
 322         return tools.image_resize_image_big(image.encode('base64'))
 323
 324     def fields_view_get(self, cr, user, view_id=None, view_type='form', context=None, toolbar=False, submenu=False):
 325         if (not view_id) and (view_type=='form') and context and context.get('force_email', False):
 326             view_id = self.pool['ir.model.data'].get_object_reference(cr, user, 'base', 'view_partner_simple_form')[1]
 327         res = super(res_partner,self).fields_view_get(cr, user, view_id, view_type, context, toolbar=toolbar, submenu=submenu)
 328         if view_type == 'form':
 329             res['arch'] = self.fields_view_get_address(cr, user, res['arch'], context=context)
 330         return res
 331
 332     _defaults = {
 333         'active': True,
 334         'lang': lambda self, cr, uid, ctx: ctx.get('lang', 'en_US'),
 335         'tz': lambda self, cr, uid, ctx: ctx.get('tz', False),
 336         'customer': True,
 337         'category_id': _default_category,
 338         'company_id': lambda self, cr, uid, ctx: self.pool['res.company']._company_default_get(cr, uid, 'res.partner', context=ctx),
 339         'color': 0,
 340         'is_company': False,
 341         'type': 'contact', # type 'default' is wildcard and thus inappropriate
 342         'use_parent_address': False,
 343         'image': False,
 344     }
 345
 346     _constraints = [
 347         (osv.osv._check_recursion, 'You cannot create recursive Partner hierarchies.', ['parent_id']),
 348     ]
 349
 350     def copy(self, cr, uid, id, default=None, context=None):
 351         if default is None:
 352             default = {}
 353         name = self.read(cr, uid, [id], ['name'], context)[0]['name']
 354         default.update({'name': _('%s (copy)') % name})
 355         return super(res_partner, self).copy(cr, uid, id, default, context)
 356
 357     def onchange_type(self, cr, uid, ids, is_company, context=None):
 358         value = {}
 359         value['title'] = False
 360         if is_company:
 361             value['use_parent_address'] = False
 362             domain = {'title': [('domain', '=', 'partner')]}
 363         else:
 364             domain = {'title': [('domain', '=', 'contact')]}
 365         return {'value': value, 'domain': domain}
 366
 367     def onchange_use_address(self, cr, uid, ids, use_parent_address, parent_id, context=None):
 368         def value_or_id(val):
 369             """ return val or val.id if val is a browse record """
 370             return val if isinstance(val, (bool, int, long, float, basestring)) else val.id
 371         result = {}
 372         address_fields = self._address_fields(cr, uid, context=context)
 373         if parent_id and use_parent_address:
 374             parent = self.browse(cr, uid, parent_id, context=context)
 375             result['value'] = dict((key, value_or_id(parent[key])) for key in address_fields)
 376         else:
 377             result['value'] = dict((key,"") for key in address_fields)
 378         return result
 379
 380     def onchange_address(self, cr, uid, ids, use_parent_address, parent_id, context=None):
 381         def value_or_id(val):
 382             """ return val or val.id if val is a browse record """
 383             return val if isinstance(val, (bool, int, long, float, basestring)) else val.id
 384         result = {}
 385         if parent_id:
 386             if ids:
 387                 partner = self.browse(cr, uid, ids[0], context=context)
 388                 if partner.parent_id and partner.parent_id.id != parent_id:
 389                     result['warning'] = {'title': _('Warning'),
 390                                          'message': _('Changing the company of a contact should only be done if it '
 391                                                       'was never correctly set. If an existing contact starts working for a new '
 392                                                       'company then a new contact should be created under that new '
 393                                                       'company. You can use the "Discard" button to abandon this change.')}
 394             parent = self.browse(cr, uid, parent_id, context=context)
 395             address_fields = self._address_fields(cr, uid, context=context)
 396             if use_parent_address:
 397                 result['value'] = dict((key, value_or_id(parent[key])) for key in address_fields)
 398         return result
 399
 400     def onchange_state(self, cr, uid, ids, state_id, context=None):
 401         if state_id:
 402             country_id = self.pool['res.country.state'].browse(cr, uid, state_id, context).country_id.id
 403             return {'value':{'country_id':country_id}}
 404         return {}
 405
 406     def _check_ean_key(self, cr, uid, ids, context=None):
 407         for partner_o in self.pool['res.partner'].read(cr, uid, ids, ['ean13',]):
 408             thisean=partner_o['ean13']
 409             if thisean and thisean!='':
 410                 if len(thisean)!=13:
 411                     return False
 412                 sum=0
 413                 for i in range(12):
 414                     if not (i % 2):
 415                         sum+=int(thisean[i])
 416                     else:
 417                         sum+=3*int(thisean[i])
 418                 if math.ceil(sum/10.0)*10-sum!=int(thisean[12]):
 419                     return False
 420         return True
 421
 422 #   _constraints = [(_check_ean_key, 'Error: Invalid ean code', ['ean13'])]
 423
 424     def _update_fields_values(self, cr, uid, partner, fields, context=None):
 425         """ Returns dict of write() values for synchronizing ``fields`` """
 426         values = {}
 427         for field in fields:
 428             column = self._all_columns[field].column
 429             if column._type == 'one2many':
 430                 raise AssertionError('One2Many fields cannot be synchronized as part of `commercial_fields` or `address fields`')
 431             if column._type == 'many2one':
 432                 values[field] = partner[field].id if partner[field] else False
 433             elif column._type == 'many2many':
 434                 values[field] = [(6,0,[r.id for r in partner[field] or []])]
 435             else:
 436                 values[field] = partner[field]
 437         return values
 438
 439     def _address_fields(self, cr, uid, context=None):
 440         """ Returns the list of address fields that are synced from the parent
 441         when the `use_parent_address` flag is set. """
 442         return list(ADDRESS_FIELDS)
 443
 444     def update_address(self, cr, uid, ids, vals, context=None):
 445         address_fields = self._address_fields(cr, uid, context=context)
 446         addr_vals = dict((key, vals[key]) for key in address_fields if key in vals)
 447         if addr_vals:
 448             return super(res_partner, self).write(cr, uid, ids, addr_vals, context)
 449
 450     def _commercial_fields(self, cr, uid, context=None):
 451         """ Returns the list of fields that are managed by the commercial entity
 452         to which a partner belongs. These fields are meant to be hidden on
 453         partners that aren't `commercial entities` themselves, and will be
 454         delegated to the parent `commercial entity`. The list is meant to be
 455         extended by inheriting classes. """
 456         return ['vat']
 457
 458     def _commercial_sync_from_company(self, cr, uid, partner, context=None):
 459         """ Handle sync of commercial fields when a new parent commercial entity is set,
 460         as if they were related fields """
 461         if partner.commercial_partner_id != partner:
 462             commercial_fields = self._commercial_fields(cr, uid, context=context)
 463             sync_vals = self._update_fields_values(cr, uid, partner.commercial_partner_id,
 464                                                         commercial_fields, context=context)
 465             partner.write(sync_vals)
 466
 467     def _commercial_sync_to_children(self, cr, uid, partner, context=None):
 468         """ Handle sync of commercial fields to descendants """
 469         commercial_fields = self._commercial_fields(cr, uid, context=context)
 470         sync_vals = self._update_fields_values(cr, uid, partner.commercial_partner_id,
 471                                                    commercial_fields, context=context)
 472         sync_children = [c for c in partner.child_ids if not c.is_company]
 473         for child in sync_children:
 474             self._commercial_sync_to_children(cr, uid, child, context=context)
 475         return self.write(cr, uid, [c.id for c in sync_children], sync_vals, context=context)
 476
 477     def _fields_sync(self, cr, uid, partner, update_values, context=None):
 478         """ Sync commercial fields and address fields from company and to children after create/update,
 479         just as if those were all modeled as fields.related to the parent """
 480         # 1. From UPSTREAM: sync from parent
 481         if update_values.get('parent_id') or update_values.get('use_parent_address'):
 482             # 1a. Commercial fields: sync if parent changed
 483             if update_values.get('parent_id'):
 484                 self._commercial_sync_from_company(cr, uid, partner, context=context)
 485             # 1b. Address fields: sync if parent or use_parent changed *and* both are now set
 486             if partner.parent_id and partner.use_parent_address:
 487                 onchange_vals = self.onchange_address(cr, uid, [partner.id],
 488                                                       use_parent_address=partner.use_parent_address,
 489                                                       parent_id=partner.parent_id.id,
 490                                                       context=context).get('value', {})
 491                 partner.update_address(onchange_vals)
 492
 493         # 2. To DOWNSTREAM: sync children
 494         if partner.child_ids:
 495             # 2a. Commercial Fields: sync if commercial entity
 496             if partner.commercial_partner_id == partner:
 497                 self._commercial_sync_to_children(cr, uid, partner, context=context)
 498             # 2b. Address fields: sync if address changed
 499             address_fields = self._address_fields(cr, uid, context=context)
 500             if any(field in update_values for field in address_fields):
 501                 domain_children = [('parent_id', '=', partner.id), ('use_parent_address', '=', True)]
 502                 update_ids = self.search(cr, uid, domain_children, context=context)
 503                 self.update_address(cr, uid, update_ids, update_values, context=context)
 504
 505     def _handle_first_contact_creation(self, cr, uid, partner, context=None):
 506         """ On creation of first contact for a company (or root) that has no address, assume contact address
 507         was meant to be company address """
 508         parent = partner.parent_id
 509         address_fields = self._address_fields(cr, uid, context=context)
 510         if parent and (parent.is_company or not parent.parent_id) and len(parent.child_ids) == 1 and \
 511             any(partner[f] for f in address_fields) and not any(parent[f] for f in address_fields):
 512             addr_vals = self._update_fields_values(cr, uid, partner, address_fields, context=context)
 513             parent.update_address(addr_vals)
 514             if not parent.is_company:
 515                 parent.write({'is_company': True})
 516
 517     def write(self, cr, uid, ids, vals, context=None):
 518         if isinstance(ids, (int, long)):
 519             ids = [ids]
 520         result = super(res_partner,self).write(cr, uid, ids, vals, context=context)
 521         for partner in self.browse(cr, uid, ids, context=context):
 522             self._fields_sync(cr, uid, partner, vals, context)
 523         return result
 524
 525     def create(self, cr, uid, vals, context=None):
 526         new_id = super(res_partner, self).create(cr, uid, vals, context=context)
 527         partner = self.browse(cr, uid, new_id, context=context)
 528         self._fields_sync(cr, uid, partner, vals, context)
 529         self._handle_first_contact_creation(cr, uid, partner, context)
 530         return new_id
 531
 532     def open_commercial_entity(self, cr, uid, ids, context=None):
 533         """ Utility method used to add an "Open Company" button in partner views """
 534         partner = self.browse(cr, uid, ids[0], context=context)
 535         return {'type': 'ir.actions.act_window',
 536                 'res_model': 'res.partner',
 537                 'view_mode': 'form',
 538                 'res_id': partner.commercial_partner_id.id,
 539                 'target': 'new',
 540                 'flags': {'form': {'action_buttons': True}}}
 541
 542     def open_parent(self, cr, uid, ids, context=None):
 543         """ Utility method used to add an "Open Parent" button in partner views """
 544         partner = self.browse(cr, uid, ids[0], context=context)
 545         return {'type': 'ir.actions.act_window',
 546                 'res_model': 'res.partner',
 547                 'view_mode': 'form',
 548                 'res_id': partner.parent_id.id,
 549                 'target': 'new',
 550                 'flags': {'form': {'action_buttons': True}}}
 551
 552     def name_get(self, cr, uid, ids, context=None):
 553         if context is None:
 554             context = {}
 555         if isinstance(ids, (int, long)):
 556             ids = [ids]
 557         res = []
 558         for record in self.browse(cr, uid, ids, context=context):
 559             name = record.name
 560             if record.parent_id and not record.is_company:
 561                 name =  "%s, %s" % (record.parent_id.name, name)
 562             if context.get('show_address'):
 563                 name = name + "\n" + self._display_address(cr, uid, record, without_company=True, context=context)
 564                 name = name.replace('\n\n','\n')
 565                 name = name.replace('\n\n','\n')
 566             if context.get('show_email') and record.email:
 567                 name = "%s <%s>" % (name, record.email)
 568             res.append((record.id, name))
 569         return res
 570
 571     def _parse_partner_name(self, text, context=None):
 572         """ Supported syntax:
 573             - 'Raoul <raoul@grosbedon.fr>': will find name and email address
 574             - otherwise: default, everything is set as the name """
 575         emails = tools.email_split(text)
 576         if emails:
 577             email = emails[0]
 578             name = text[:text.index(email)].replace('"', '').replace('<', '').strip()
 579         else:
 580             name, email = text, ''
 581         return name, email
 582
 583     def name_create(self, cr, uid, name, context=None):
 584         """ Override of orm's name_create method for partners. The purpose is
 585             to handle some basic formats to create partners using the
 586             name_create.
 587             If only an email address is received and that the regex cannot find
 588             a name, the name will have the email value.
 589             If 'force_email' key in context: must find the email address. """
 590         if context is None:
 591             context = {}
 592         name, email = self._parse_partner_name(name, context=context)
 593         if context.get('force_email') and not email:
 594             raise osv.except_osv(_('Warning'), _("Couldn't create contact without email address!"))
 595         if not name and email:
 596             name = email
 597         rec_id = self.create(cr, uid, {self._rec_name: name or email, 'email': email or False}, context=context)
 598         return self.name_get(cr, uid, [rec_id], context)[0]
 599
 600     def _search(self, cr, user, args, offset=0, limit=None, order=None, context=None, count=False, access_rights_uid=None):
 601         """ Override search() to always show inactive children when searching via ``child_of`` operator. The ORM will
 602         always call search() with a simple domain of the form [('parent_id', 'in', [ids])]. """
 603         # a special ``domain`` is set on the ``child_ids`` o2m to bypass this logic, as it uses similar domain expressions
 604         if len(args) == 1 and len(args[0]) == 3 and args[0][:2] == ('parent_id','in'):
 605             context = dict(context or {}, active_test=False)
 606         return super(res_partner, self)._search(cr, user, args, offset=offset, limit=limit, order=order, context=context,
 607                                                 count=count, access_rights_uid=access_rights_uid)
 608
 609     def name_search(self, cr, uid, name, args=None, operator='ilike', context=None, limit=100):
 610         if not args:
 611             args = []
 612         if name and operator in ('=', 'ilike', '=ilike', 'like', '=like'):
 613             # search on the name of the contacts and of its company
 614             search_name = name
 615             if operator in ('ilike', 'like'):
 616                 search_name = '%%%s%%' % name
 617             if operator in ('=ilike', '=like'):
 618                 operator = operator[1:]
 619             query_args = {'name': search_name}
 620             limit_str = ''
 621             if limit:
 622                 limit_str = ' limit %(limit)s'
 623                 query_args['limit'] = limit
 624             cr.execute('''SELECT partner.id FROM res_partner partner
 625                           LEFT JOIN res_partner company ON partner.parent_id = company.id
 626                           WHERE partner.email ''' + operator +''' %(name)s OR
 627                                 partner.display_name ''' + operator + ' %(name)s ' + limit_str, query_args)
 628             ids = map(lambda x: x[0], cr.fetchall())
 629             ids = self.search(cr, uid, [('id', 'in', ids)] + args, limit=limit, context=context)
 630             if ids:
 631                 return self.name_get(cr, uid, ids, context)
 632         return super(res_partner,self).name_search(cr, uid, name, args, operator=operator, context=context, limit=limit)
 633
 634     def find_or_create(self, cr, uid, email, context=None):
 635         """ Find a partner with the given ``email`` or use :py:method:`~.name_create`
 636             to create one
 637
 638             :param str email: email-like string, which should contain at least one email,
 639                 e.g. ``"Raoul Grosbedon <r.g@grosbedon.fr>"``"""
 640         assert email, 'an email is required for find_or_create to work'
 641         emails = tools.email_split(email)
 642         if emails:
 643             email = emails[0]
 644         ids = self.search(cr, uid, [('email','ilike',email)], context=context)
 645         if not ids:
 646             return self.name_create(cr, uid, email, context=context)[0]
 647         return ids[0]
 648
 649     def _email_send(self, cr, uid, ids, email_from, subject, body, on_error=None):
 650         partners = self.browse(cr, uid, ids)
 651         for partner in partners:
 652             if partner.email:
 653                 tools.email_send(email_from, [partner.email], subject, body, on_error)
 654         return True
 655
 656     def email_send(self, cr, uid, ids, email_from, subject, body, on_error=''):
 657         while len(ids):
 658             self.pool['ir.cron'].create(cr, uid, {
 659                 'name': 'Send Partner Emails',
 660                 'user_id': uid,
 661                 'model': 'res.partner',
 662                 'function': '_email_send',
 663                 'args': repr([ids[:16], email_from, subject, body, on_error])
 664             })
 665             ids = ids[16:]
 666         return True
 667
 668     def address_get(self, cr, uid, ids, adr_pref=None, context=None):
 669         """ Find contacts/addresses of the right type(s) by doing a depth-first-search
 670         through descendants within company boundaries (stop at entities flagged ``is_company``)
 671         then continuing the search at the ancestors that are within the same company boundaries.
 672         Defaults to partners of type ``'default'`` when the exact type is not found, or to the
 673         provided partner itself if no type ``'default'`` is found either. """
 674         adr_pref = set(adr_pref or [])
 675         if 'default' not in adr_pref:
 676             adr_pref.add('default')
 677         result = {}
 678         visited = set()
 679         for partner in self.browse(cr, uid, filter(None, ids), context=context):
 680             current_partner = partner
 681             while current_partner:
 682                 to_scan = [current_partner]
 683                 # Scan descendants, DFS
 684                 while to_scan:
 685                     record = to_scan.pop(0)
 686                     visited.add(record)
 687                     if record.type in adr_pref and not result.get(record.type):
 688                         result[record.type] = record.id
 689                     if len(result) == len(adr_pref):
 690                         return result
 691                     to_scan = [c for c in record.child_ids
 692                                  if c not in visited
 693                                  if not c.is_company] + to_scan
 694
 695                 # Continue scanning at ancestor if current_partner is not a commercial entity
 696                 if current_partner.is_company or not current_partner.parent_id:
 697                     break
 698                 current_partner = current_partner.parent_id
 699
 700         # default to type 'default' or the partner itself
 701         default = result.get('default', partner.id)
 702         for adr_type in adr_pref:
 703             result[adr_type] = result.get(adr_type) or default
 704         return result
 705
 706     def view_header_get(self, cr, uid, view_id, view_type, context):
 707         res = super(res_partner, self).view_header_get(cr, uid, view_id, view_type, context)
 708         if res: return res
 709         if not context.get('category_id', False):
 710             return False
 711         return _('Partners: ')+self.pool['res.partner.category'].browse(cr, uid, context['category_id'], context).name
 712
 713     def main_partner(self, cr, uid):
 714         ''' Return the id of the main partner
 715         '''
 716         model_data = self.pool['ir.model.data']
 717         return model_data.browse(cr, uid,
 718                             model_data.search(cr, uid, [('module','=','base'),
 719                                                 ('name','=','main_partner')])[0],
 720                 ).res_id
 721
 722     def _display_address(self, cr, uid, address, without_company=False, context=None):
 723
 724         '''
 725         The purpose of this function is to build and return an address formatted accordingly to the
 726         standards of the country where it belongs.
 727
 728         :param address: browse record of the res.partner to format
 729         :returns: the address formatted in a display that fit its country habits (or the default ones
 730             if not country is specified)
 731         :rtype: string
 732         '''
 733
 734         # get the information that will be injected into the display format
 735         # get the address format
 736         address_format = address.country_id and address.country_id.address_format or \
 737               "%(street)s\n%(street2)s\n%(city)s %(state_code)s %(zip)s\n%(country_name)s"
 738         args = {
 739             'state_code': address.state_id and address.state_id.code or '',
 740             'state_name': address.state_id and address.state_id.name or '',
 741             'country_code': address.country_id and address.country_id.code or '',
 742             'country_name': address.country_id and address.country_id.name or '',
 743             'company_name': address.parent_id and address.parent_id.name or '',
 744         }
 745         for field in self._address_fields(cr, uid, context=context):
 746             args[field] = getattr(address, field) or ''
 747         if without_company:
 748             args['company_name'] = ''
 749         elif address.parent_id:
 750             address_format = '%(company_name)s\n' + address_format
 751         return address_format % args
 752
 753 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: