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