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