1 # -*- coding: utf-8 -*-
2 ##############################################################################
4 # OpenERP, Open Source Management Solution
5 # Copyright (C) 2004-2009 Tiny SPRL (<http://tiny.be>).
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.
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.
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/>.
20 ##############################################################################
23 from lxml import etree
29 from openerp import SUPERUSER_ID
30 from openerp import pooler, tools
31 from openerp.osv import osv, fields
32 from openerp.osv.expression import get_unaccent_wrapper
33 from openerp.tools.translate import _
34 from openerp.tools.yaml_import import is_comment
36 class format_address(object):
37 def fields_view_get_address(self, cr, uid, arch, context={}):
38 user_obj = self.pool.get('res.users')
39 fmt = user_obj.browse(cr, SUPERUSER_ID, uid, context).company_id.country_id
40 fmt = fmt and fmt.address_format
42 '%(city)s %(state_code)s\n%(zip)s': """
43 <div class="address_format">
44 <field name="city" placeholder="City" style="width: 50%%"/>
45 <field name="state_id" class="oe_no_button" placeholder="State" style="width: 47%%" options='{"no_open": true}'/>
47 <field name="zip" placeholder="ZIP"/>
50 '%(zip)s %(city)s': """
51 <div class="address_format">
52 <field name="zip" placeholder="ZIP" style="width: 40%%"/>
53 <field name="city" placeholder="City" style="width: 57%%"/>
55 <field name="state_id" class="oe_no_button" placeholder="State" options='{"no_open": true}'/>
58 '%(city)s\n%(state_name)s\n%(zip)s': """
59 <div class="address_format">
60 <field name="city" placeholder="City"/>
61 <field name="state_id" class="oe_no_button" placeholder="State" options='{"no_open": true}'/>
62 <field name="zip" placeholder="ZIP"/>
66 for k,v in layouts.items():
67 if fmt and (k in fmt):
68 doc = etree.fromstring(arch)
69 for node in doc.xpath("//div[@class='address_format']"):
70 tree = etree.fromstring(v)
71 node.getparent().replace(node, tree)
72 arch = etree.tostring(doc)
77 def _tz_get(self,cr,uid, context=None):
78 # put POSIX 'Etc/*' entries at the end to avoid confusing users - see bug 1086728
79 return [(tz,tz) for tz in sorted(pytz.all_timezones, key=lambda tz: tz if not tz.startswith('Etc/') else '_')]
81 class res_partner_category(osv.osv):
83 def name_get(self, cr, uid, ids, context=None):
84 """Return the categories' display name, including their direct
87 :param dict context: the ``partner_category_display`` key can be
88 used to select the short version of the
89 category name (without the direct parent),
90 when set to ``'short'``. The default is
94 if context.get('partner_category_display') == 'short':
95 return super(res_partner_category, self).name_get(cr, uid, ids, context=context)
96 if isinstance(ids, (int, long)):
98 reads = self.read(cr, uid, ids, ['name', 'parent_id'], context=context)
101 name = record['name']
102 if record['parent_id']:
103 name = record['parent_id'][1] + ' / ' + name
104 res.append((record['id'], name))
107 def name_search(self, cr, uid, name, args=None, operator='ilike', context=None, limit=100):
113 # Be sure name_search is symetric to name_get
114 name = name.split(' / ')[-1]
115 ids = self.search(cr, uid, [('name', operator, name)] + args, limit=limit, context=context)
117 ids = self.search(cr, uid, args, limit=limit, context=context)
118 return self.name_get(cr, uid, ids, context)
121 def _name_get_fnc(self, cr, uid, ids, prop, unknow_none, context=None):
122 res = self.name_get(cr, uid, ids, context=context)
125 _description = 'Partner Categories'
126 _name = 'res.partner.category'
128 'name': fields.char('Category Name', required=True, size=64, translate=True),
129 'parent_id': fields.many2one('res.partner.category', 'Parent Category', select=True, ondelete='cascade'),
130 'complete_name': fields.function(_name_get_fnc, type="char", string='Full Name'),
131 'child_ids': fields.one2many('res.partner.category', 'parent_id', 'Child Categories'),
132 'active': fields.boolean('Active', help="The active field allows you to hide the category without removing it."),
133 'parent_left': fields.integer('Left parent', select=True),
134 'parent_right': fields.integer('Right parent', select=True),
135 'partner_ids': fields.many2many('res.partner', id1='category_id', id2='partner_id', string='Partners'),
138 (osv.osv._check_recursion, 'Error ! You can not create recursive categories.', ['parent_id'])
144 _parent_order = 'name'
145 _order = 'parent_left'
147 class res_partner_title(osv.osv):
148 _name = 'res.partner.title'
151 'name': fields.char('Title', required=True, size=46, translate=True),
152 'shortcut': fields.char('Abbreviation', size=16, translate=True),
153 'domain': fields.selection([('partner', 'Partner'), ('contact', 'Contact')], 'Domain', required=True, size=24)
159 def _lang_get(self, cr, uid, context=None):
160 lang_pool = self.pool.get('res.lang')
161 ids = lang_pool.search(cr, uid, [], context=context)
162 res = lang_pool.read(cr, uid, ids, ['code', 'name'], context)
163 return [(r['code'], r['name']) for r in res]
165 # fields copy if 'use_parent_address' is checked
166 ADDRESS_FIELDS = ('street', 'street2', 'zip', 'city', 'state_id', 'country_id')
167 POSTAL_ADDRESS_FIELDS = ADDRESS_FIELDS # deprecated, to remove after 7.0
169 class res_partner(osv.osv, format_address):
170 _description = 'Partner'
171 _name = "res.partner"
173 def _address_display(self, cr, uid, ids, name, args, context=None):
175 for partner in self.browse(cr, uid, ids, context=context):
176 res[partner.id] = self._display_address(cr, uid, partner, context=context)
179 def _get_image(self, cr, uid, ids, name, args, context=None):
180 result = dict.fromkeys(ids, False)
181 for obj in self.browse(cr, uid, ids, context=context):
182 result[obj.id] = tools.image_get_resized_images(obj.image)
185 def _get_tz_offset(self, cr, uid, ids, name, args, context=None):
186 result = dict.fromkeys(ids, False)
187 for obj in self.browse(cr, uid, ids, context=context):
188 result[obj.id] = datetime.datetime.now(pytz.timezone(obj.tz or 'GMT')).strftime('%z')
191 def _set_image(self, cr, uid, id, name, value, args, context=None):
192 return self.write(cr, uid, [id], {'image': tools.image_resize_image_big(value)}, context=context)
194 def _has_image(self, cr, uid, ids, name, args, context=None):
196 for obj in self.browse(cr, uid, ids, context=context):
197 result[obj.id] = obj.image != False
200 def _commercial_partner_compute(self, cr, uid, ids, name, args, context=None):
201 """ Returns the partner that is considered the commercial
202 entity of this partner. The commercial entity holds the master data
203 for all commercial fields (see :py:meth:`~_commercial_fields`) """
204 result = dict.fromkeys(ids, False)
205 for partner in self.browse(cr, uid, ids, context=context):
206 current_partner = partner
207 while not current_partner.is_company and current_partner.parent_id:
208 current_partner = current_partner.parent_id
209 result[partner.id] = current_partner.id
212 # indirection to avoid passing a copy of the overridable method when declaring the function field
213 _commercial_partner_id = lambda self, *args, **kwargs: self._commercial_partner_compute(*args, **kwargs)
217 'name': fields.char('Name', size=128, required=True, select=True),
218 'date': fields.date('Date', select=1),
219 'title': fields.many2one('res.partner.title', 'Title'),
220 'parent_id': fields.many2one('res.partner', 'Related Company', select=True),
221 'child_ids': fields.one2many('res.partner', 'parent_id', 'Contacts', domain=[('active','=',True)]), # force "active_test" domain to bypass _search() override
222 'ref': fields.char('Reference', size=64, select=1),
223 'lang': fields.selection(_lang_get, 'Language',
224 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."),
225 'tz': fields.selection(_tz_get, 'Timezone', size=64,
226 help="The partner's timezone, used to output proper date and time values inside printed reports. "
227 "It is important to set a value for this field. You should use the same timezone "
228 "that is otherwise used to pick and render date and time values: your computer's timezone."),
229 'tz_offset': fields.function(_get_tz_offset, type='char', size=5, string='Timezone offset', invisible=True),
230 'user_id': fields.many2one('res.users', 'Salesperson', help='The internal user that is in charge of communicating with this contact if any.'),
231 '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."),
232 'bank_ids': fields.one2many('res.partner.bank', 'partner_id', 'Banks'),
233 'website': fields.char('Website', size=64, help="Website of Partner or Company"),
234 'comment': fields.text('Notes'),
235 'category_id': fields.many2many('res.partner.category', id1='partner_id', id2='category_id', string='Tags'),
236 'credit_limit': fields.float(string='Credit Limit'),
237 'ean13': fields.char('EAN13', size=13),
238 'active': fields.boolean('Active'),
239 'customer': fields.boolean('Customer', help="Check this box if this contact is a customer."),
240 '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."),
241 'employee': fields.boolean('Employee', help="Check this box if this contact is an Employee."),
242 'function': fields.char('Job Position', size=128),
243 'type': fields.selection([('default', 'Default'), ('invoice', 'Invoice'),
244 ('delivery', 'Shipping'), ('contact', 'Contact'),
245 ('other', 'Other')], 'Address Type',
246 help="Used to select automatically the right address according to the context in sales and purchases documents."),
247 'street': fields.char('Street', size=128),
248 'street2': fields.char('Street2', size=128),
249 'zip': fields.char('Zip', change_default=True, size=24),
250 'city': fields.char('City', size=128),
251 'state_id': fields.many2one("res.country.state", 'State'),
252 'country_id': fields.many2one('res.country', 'Country'),
253 'country': fields.related('country_id', type='many2one', relation='res.country', string='Country',
254 deprecated="This field will be removed as of OpenERP 7.1, use country_id instead"),
255 'email': fields.char('Email', size=240),
256 'phone': fields.char('Phone', size=64),
257 'fax': fields.char('Fax', size=64),
258 'mobile': fields.char('Mobile', size=64),
259 'birthdate': fields.char('Birthdate', size=64),
260 'is_company': fields.boolean('Is a Company', help="Check if the contact is a company, otherwise it is a person"),
261 'use_parent_address': fields.boolean('Use Company Address', help="Select this if you want to set company's address information for this contact"),
262 # image: all image fields are base64 encoded and PIL-supported
263 'image': fields.binary("Image",
264 help="This field holds the image used as avatar for this contact, limited to 1024x1024px"),
265 'image_medium': fields.function(_get_image, fnct_inv=_set_image,
266 string="Medium-sized image", type="binary", multi="_get_image",
268 'res.partner': (lambda self, cr, uid, ids, c={}: ids, ['image'], 10),
270 help="Medium-sized image of this contact. It is automatically "\
271 "resized as a 128x128px image, with aspect ratio preserved. "\
272 "Use this field in form views or some kanban views."),
273 'image_small': fields.function(_get_image, fnct_inv=_set_image,
274 string="Small-sized image", type="binary", multi="_get_image",
276 'res.partner': (lambda self, cr, uid, ids, c={}: ids, ['image'], 10),
278 help="Small-sized image of this contact. It is automatically "\
279 "resized as a 64x64px image, with aspect ratio preserved. "\
280 "Use this field anywhere a small image is required."),
281 'has_image': fields.function(_has_image, type="boolean"),
282 'company_id': fields.many2one('res.company', 'Company', select=1),
283 'color': fields.integer('Color Index'),
284 'user_ids': fields.one2many('res.users', 'partner_id', 'Users'),
285 'contact_address': fields.function(_address_display, type='char', string='Complete Address'),
287 # technical field used for managing commercial fields
288 'commercial_partner_id': fields.function(_commercial_partner_id, type='many2one', relation='res.partner', string='Commercial Entity')
291 def _default_category(self, cr, uid, context=None):
294 if context.get('category_id'):
295 return [context['category_id']]
298 def _get_default_image(self, cr, uid, is_company, context=None, colorize=False):
299 img_path = openerp.modules.get_module_resource('base', 'static/src/img',
300 ('company_image.png' if is_company else 'avatar.png'))
301 with open(img_path, 'rb') as f:
304 # colorize user avatars
306 image = tools.image_colorize(image)
308 return tools.image_resize_image_big(image.encode('base64'))
310 def fields_view_get(self, cr, user, view_id=None, view_type='form', context=None, toolbar=False, submenu=False):
311 if (not view_id) and (view_type=='form') and context and context.get('force_email', False):
312 view_id = self.pool.get('ir.model.data').get_object_reference(cr, user, 'base', 'view_partner_simple_form')[1]
313 res = super(res_partner,self).fields_view_get(cr, user, view_id, view_type, context, toolbar=toolbar, submenu=submenu)
314 if view_type == 'form':
315 res['arch'] = self.fields_view_get_address(cr, user, res['arch'], context=context)
320 'lang': lambda self, cr, uid, ctx: ctx.get('lang', 'en_US'),
321 'tz': lambda self, cr, uid, ctx: ctx.get('tz', False),
323 'category_id': _default_category,
324 'company_id': lambda self, cr, uid, ctx: self.pool.get('res.company')._company_default_get(cr, uid, 'res.partner', context=ctx),
327 'type': 'contact', # type 'default' is wildcard and thus inappropriate
328 'use_parent_address': False,
333 (osv.osv._check_recursion, 'You cannot create recursive Partner hierarchies.', ['parent_id']),
336 def copy(self, cr, uid, id, default=None, context=None):
339 name = self.read(cr, uid, [id], ['name'], context)[0]['name']
340 default.update({'name': _('%s (copy)') % name})
341 return super(res_partner, self).copy(cr, uid, id, default, context)
343 def onchange_type(self, cr, uid, ids, is_company, context=None):
345 value['title'] = False
347 domain = {'title': [('domain', '=', 'partner')]}
349 domain = {'title': [('domain', '=', 'contact')]}
350 return {'value': value, 'domain': domain}
352 def onchange_address(self, cr, uid, ids, use_parent_address, parent_id, context=None):
353 def value_or_id(val):
354 """ return val or val.id if val is a browse record """
355 return val if isinstance(val, (bool, int, long, float, basestring)) else val.id
359 partner = self.browse(cr, uid, ids[0], context=context)
360 if partner.parent_id and partner.parent_id.id != parent_id:
361 result['warning'] = {'title': _('Warning'),
362 'message': _('Changing the company of a contact should only be done if it '
363 'was never correctly set. If an existing contact starts working for a new '
364 'company then a new contact should be created under that new '
365 'company. You can use the "Discard" button to abandon this change.')}
366 parent = self.browse(cr, uid, parent_id, context=context)
367 address_fields = self._address_fields(cr, uid, context=context)
368 result['value'] = dict((key, value_or_id(parent[key])) for key in address_fields)
370 result['value'] = {'use_parent_address': False}
373 def onchange_state(self, cr, uid, ids, state_id, context=None):
375 country_id = self.pool.get('res.country.state').browse(cr, uid, state_id, context).country_id.id
376 return {'value':{'country_id':country_id}}
379 def _check_ean_key(self, cr, uid, ids, context=None):
380 for partner_o in pooler.get_pool(cr.dbname).get('res.partner').read(cr, uid, ids, ['ean13',]):
381 thisean=partner_o['ean13']
382 if thisean and thisean!='':
390 sum+=3*int(thisean[i])
391 if math.ceil(sum/10.0)*10-sum!=int(thisean[12]):
395 # _constraints = [(_check_ean_key, 'Error: Invalid ean code', ['ean13'])]
397 def _update_fields_values(self, cr, uid, partner, fields, context=None):
398 """ Returns dict of write() values for synchronizing ``fields`` """
401 column = self._all_columns[field].column
402 if column._type == 'one2many':
403 raise AssertionError('One2Many fields cannot be synchronized as part of `commercial_fields` or `address fields`')
404 if column._type == 'many2one':
405 values[field] = partner[field].id if partner[field] else False
406 elif column._type == 'many2many':
407 values[field] = [(6,0,[r.id for r in partner[field] or []])]
409 values[field] = partner[field]
412 def _address_fields(self, cr, uid, context=None):
413 """ Returns the list of address fields that are synced from the parent
414 when the `use_parent_address` flag is set. """
415 return list(ADDRESS_FIELDS)
417 def update_address(self, cr, uid, ids, vals, context=None):
418 address_fields = self._address_fields(cr, uid, context=context)
419 addr_vals = dict((key, vals[key]) for key in address_fields if key in vals)
421 return super(res_partner, self).write(cr, uid, ids, addr_vals, context)
423 def _commercial_fields(self, cr, uid, context=None):
424 """ Returns the list of fields that are managed by the commercial entity
425 to which a partner belongs. These fields are meant to be hidden on
426 partners that aren't `commercial entities` themselves, and will be
427 delegated to the parent `commercial entity`. The list is meant to be
428 extended by inheriting classes. """
431 def _commercial_sync_from_company(self, cr, uid, partner, context=None):
432 """ Handle sync of commercial fields when a new parent commercial entity is set,
433 as if they were related fields """
434 if partner.commercial_partner_id != partner:
435 commercial_fields = self._commercial_fields(cr, uid, context=context)
436 sync_vals = self._update_fields_values(cr, uid, partner.commercial_partner_id,
437 commercial_fields, context=context)
438 partner.write(sync_vals)
440 def _commercial_sync_to_children(self, cr, uid, partner, context=None):
441 """ Handle sync of commercial fields to descendants """
442 commercial_fields = self._commercial_fields(cr, uid, context=context)
443 sync_vals = self._update_fields_values(cr, uid, partner.commercial_partner_id,
444 commercial_fields, context=context)
445 sync_children = [c for c in partner.child_ids if not c.is_company]
446 for child in sync_children:
447 self._commercial_sync_to_children(cr, uid, child, context=context)
448 return self.write(cr, uid, [c.id for c in sync_children], sync_vals, context=context)
450 def _fields_sync(self, cr, uid, partner, update_values, context=None):
451 """ Sync commercial fields and address fields from company and to children after create/update,
452 just as if those were all modeled as fields.related to the parent """
453 # 1. From UPSTREAM: sync from parent
454 if update_values.get('parent_id') or update_values.get('use_parent_address'):
455 # 1a. Commercial fields: sync if parent changed
456 if update_values.get('parent_id'):
457 self._commercial_sync_from_company(cr, uid, partner, context=context)
458 # 1b. Address fields: sync if parent or use_parent changed *and* both are now set
459 if partner.parent_id and partner.use_parent_address:
460 onchange_vals = self.onchange_address(cr, uid, [partner.id],
461 use_parent_address=partner.use_parent_address,
462 parent_id=partner.parent_id.id,
463 context=context).get('value', {})
464 partner.update_address(onchange_vals)
466 # 2. To DOWNSTREAM: sync children
467 if partner.child_ids:
468 # 2a. Commercial Fields: sync if commercial entity
469 if partner.commercial_partner_id == partner:
470 commercial_fields = self._commercial_fields(cr, uid,
472 if any(field in update_values for field in commercial_fields):
473 self._commercial_sync_to_children(cr, uid, partner,
475 # 2b. Address fields: sync if address changed
476 address_fields = self._address_fields(cr, uid, context=context)
477 if any(field in update_values for field in address_fields):
478 domain_children = [('parent_id', '=', partner.id), ('use_parent_address', '=', True)]
479 update_ids = self.search(cr, uid, domain_children, context=context)
480 self.update_address(cr, uid, update_ids, update_values, context=context)
482 def _handle_first_contact_creation(self, cr, uid, partner, context=None):
483 """ On creation of first contact for a company (or root) that has no address, assume contact address
484 was meant to be company address """
485 parent = partner.parent_id
486 address_fields = self._address_fields(cr, uid, context=context)
487 if parent and (parent.is_company or not parent.parent_id) and len(parent.child_ids) == 1 and \
488 any(partner[f] for f in address_fields) and not any(parent[f] for f in address_fields):
489 addr_vals = self._update_fields_values(cr, uid, partner, address_fields, context=context)
490 parent.update_address(addr_vals)
491 if not parent.is_company:
492 parent.write({'is_company': True})
494 def write(self, cr, uid, ids, vals, context=None):
495 if isinstance(ids, (int, long)):
497 #res.partner must only allow to set the company_id of a partner if it
498 #is the same as the company of all users that inherit from this partner
499 #(this is to allow the code from res_users to write to the partner!) or
500 #if setting the company_id to False (this is compatible with any user company)
501 if vals.get('company_id'):
502 for partner in self.browse(cr, uid, ids, context=context):
504 user_companies = set([user.company_id.id for user in partner.user_ids])
505 if len(user_companies) > 1 or vals['company_id'] not in user_companies:
506 raise osv.except_osv(_("Warning"),_("You can not change the company as the partner/user has multiple user linked with different companies."))
507 result = super(res_partner,self).write(cr, uid, ids, vals, context=context)
508 for partner in self.browse(cr, uid, ids, context=context):
509 self._fields_sync(cr, uid, partner, vals, context)
512 def create(self, cr, uid, vals, context=None):
513 new_id = super(res_partner, self).create(cr, uid, vals, context=context)
514 partner = self.browse(cr, uid, new_id, context=context)
515 self._fields_sync(cr, uid, partner, vals, context)
516 self._handle_first_contact_creation(cr, uid, partner, context)
519 def open_commercial_entity(self, cr, uid, ids, context=None):
520 """ Utility method used to add an "Open Company" button in partner views """
521 partner = self.browse(cr, uid, ids[0], context=context)
522 return {'type': 'ir.actions.act_window',
523 'res_model': 'res.partner',
525 'res_id': partner.commercial_partner_id.id,
527 'flags': {'form': {'action_buttons': True}}}
529 def open_parent(self, cr, uid, ids, context=None):
530 """ Utility method used to add an "Open Parent" button in partner views """
531 partner = self.browse(cr, uid, ids[0], context=context)
532 return {'type': 'ir.actions.act_window',
533 'res_model': 'res.partner',
535 'res_id': partner.parent_id.id,
537 'flags': {'form': {'action_buttons': True}}}
539 def name_get(self, cr, uid, ids, context=None):
542 if isinstance(ids, (int, long)):
545 for record in self.browse(cr, uid, ids, context=context):
547 if record.parent_id and not record.is_company:
548 name = "%s, %s" % (record.parent_id.name, name)
549 if context.get('show_address'):
550 name = name + "\n" + self._display_address(cr, uid, record, without_company=True, context=context)
551 name = name.replace('\n\n','\n')
552 name = name.replace('\n\n','\n')
553 if context.get('show_email') and record.email:
554 name = "%s <%s>" % (name, record.email)
555 res.append((record.id, name))
558 def _parse_partner_name(self, text, context=None):
559 """ Supported syntax:
560 - 'Raoul <raoul@grosbedon.fr>': will find name and email address
561 - otherwise: default, everything is set as the name """
562 emails = tools.email_split(text)
565 name = text[:text.index(email)].replace('"', '').replace('<', '').strip()
567 name, email = text, ''
570 def name_create(self, cr, uid, name, context=None):
571 """ Override of orm's name_create method for partners. The purpose is
572 to handle some basic formats to create partners using the
574 If only an email address is received and that the regex cannot find
575 a name, the name will have the email value.
576 If 'force_email' key in context: must find the email address. """
579 name, email = self._parse_partner_name(name, context=context)
580 if context.get('force_email') and not email:
581 raise osv.except_osv(_('Warning'), _("Couldn't create contact without email address!"))
582 if not name and email:
584 rec_id = self.create(cr, uid, {self._rec_name: name or email, 'email': email or False}, context=context)
585 return self.name_get(cr, uid, [rec_id], context)[0]
587 def _search(self, cr, user, args, offset=0, limit=None, order=None, context=None, count=False, access_rights_uid=None):
588 """ Override search() to always show inactive children when searching via ``child_of`` operator. The ORM will
589 always call search() with a simple domain of the form [('parent_id', 'in', [ids])]. """
590 # a special ``domain`` is set on the ``child_ids`` o2m to bypass this logic, as it uses similar domain expressions
591 if len(args) == 1 and len(args[0]) == 3 and args[0][:2] == ('parent_id','in'):
592 context = dict(context or {}, active_test=False)
593 return super(res_partner, self)._search(cr, user, args, offset=offset, limit=limit, order=order, context=context,
594 count=count, access_rights_uid=access_rights_uid)
596 def name_search(self, cr, uid, name, args=None, operator='ilike', context=None, limit=100):
599 if name and operator in ('=', 'ilike', '=ilike', 'like', '=like'):
601 self.check_access_rights(cr, uid, 'read')
602 where_query = self._where_calc(cr, uid, args, context=context)
603 self._apply_ir_rules(cr, uid, where_query, 'read', context=context)
604 from_clause, where_clause, where_clause_params = where_query.get_sql()
605 where_str = where_clause and (" WHERE %s AND " % where_clause) or ' WHERE '
607 # search on the name of the contacts and of its company
609 if operator in ('ilike', 'like'):
610 search_name = '%%%s%%' % name
611 if operator in ('=ilike', '=like'):
612 operator = operator[1:]
614 unaccent = get_unaccent_wrapper(cr)
616 # TODO: simplify this in trunk with `display_name`, once it is stored
617 # Perf note: a CTE expression (WITH ...) seems to have an even higher cost
618 # than this query with duplicated CASE expressions. The bulk of
619 # the cost is the ORDER BY, and it is inevitable if we want
620 # relevant results for the next step, otherwise we'd return
621 # a random selection of `limit` results.
623 display_name = """CASE WHEN company.id IS NULL OR res_partner.is_company
625 ELSE {company_name} || ', ' || {partner_name}
626 END""".format(partner_name=unaccent('res_partner.name'),
627 company_name=unaccent('company.name'))
629 query = """SELECT res_partner.id
631 LEFT JOIN res_partner company
632 ON res_partner.parent_id = company.id
633 {where} ({email} {operator} {percent}
634 OR {display_name} {operator} {percent})
635 ORDER BY {display_name}
636 """.format(where=where_str, operator=operator,
637 email=unaccent('res_partner.email'),
638 percent=unaccent('%s'),
639 display_name=display_name)
641 where_clause_params += [search_name, search_name]
644 where_clause_params.append(limit)
645 cr.execute(query, where_clause_params)
646 ids = map(lambda x: x[0], cr.fetchall())
649 return self.name_get(cr, uid, ids, context)
652 return super(res_partner,self).name_search(cr, uid, name, args, operator=operator, context=context, limit=limit)
654 def find_or_create(self, cr, uid, email, context=None):
655 """ Find a partner with the given ``email`` or use :py:method:`~.name_create`
658 :param str email: email-like string, which should contain at least one email,
659 e.g. ``"Raoul Grosbedon <r.g@grosbedon.fr>"``"""
660 assert email, 'an email is required for find_or_create to work'
661 emails = tools.email_split(email)
664 ids = self.search(cr, uid, [('email','ilike',email)], context=context)
666 return self.name_create(cr, uid, email, context=context)[0]
669 def _email_send(self, cr, uid, ids, email_from, subject, body, on_error=None):
670 partners = self.browse(cr, uid, ids)
671 for partner in partners:
673 tools.email_send(email_from, [partner.email], subject, body, on_error)
676 def email_send(self, cr, uid, ids, email_from, subject, body, on_error=''):
678 self.pool.get('ir.cron').create(cr, uid, {
679 'name': 'Send Partner Emails',
681 'model': 'res.partner',
682 'function': '_email_send',
683 'args': repr([ids[:16], email_from, subject, body, on_error])
688 def address_get(self, cr, uid, ids, adr_pref=None, context=None):
689 """ Find contacts/addresses of the right type(s) by doing a depth-first-search
690 through descendants within company boundaries (stop at entities flagged ``is_company``)
691 then continuing the search at the ancestors that are within the same company boundaries.
692 Defaults to partners of type ``'default'`` when the exact type is not found, or to the
693 provided partner itself if no type ``'default'`` is found either. """
694 adr_pref = set(adr_pref or [])
695 if 'default' not in adr_pref:
696 adr_pref.add('default')
699 for partner in self.browse(cr, uid, filter(None, ids), context=context):
700 current_partner = partner
701 while current_partner:
702 to_scan = [current_partner]
703 # Scan descendants, DFS
705 record = to_scan.pop(0)
707 if record.type in adr_pref and not result.get(record.type):
708 result[record.type] = record.id
709 if len(result) == len(adr_pref):
711 to_scan = [c for c in record.child_ids
713 if not c.is_company] + to_scan
715 # Continue scanning at ancestor if current_partner is not a commercial entity
716 if current_partner.is_company or not current_partner.parent_id:
718 current_partner = current_partner.parent_id
720 # default to type 'default' or the partner itself
721 default = result.get('default', partner.id)
722 for adr_type in adr_pref:
723 result[adr_type] = result.get(adr_type) or default
726 def view_header_get(self, cr, uid, view_id, view_type, context):
727 res = super(res_partner, self).view_header_get(cr, uid, view_id, view_type, context)
729 if not context.get('category_id', False):
731 return _('Partners: ')+self.pool.get('res.partner.category').browse(cr, uid, context['category_id'], context).name
733 def main_partner(self, cr, uid):
734 ''' Return the id of the main partner
736 model_data = self.pool.get('ir.model.data')
737 return model_data.browse(cr, uid,
738 model_data.search(cr, uid, [('module','=','base'),
739 ('name','=','main_partner')])[0],
742 def _display_address(self, cr, uid, address, without_company=False, context=None):
745 The purpose of this function is to build and return an address formatted accordingly to the
746 standards of the country where it belongs.
748 :param address: browse record of the res.partner to format
749 :returns: the address formatted in a display that fit its country habits (or the default ones
750 if not country is specified)
754 # get the information that will be injected into the display format
755 # get the address format
756 address_format = address.country_id and address.country_id.address_format or \
757 "%(street)s\n%(street2)s\n%(city)s %(state_code)s %(zip)s\n%(country_name)s"
759 'state_code': address.state_id and address.state_id.code or '',
760 'state_name': address.state_id and address.state_id.name or '',
761 'country_code': address.country_id and address.country_id.code or '',
762 'country_name': address.country_id and address.country_id.name or '',
763 'company_name': address.parent_id and address.parent_id.name or '',
765 for field in self._address_fields(cr, uid, context=context):
766 args[field] = getattr(address, field) or ''
768 args['company_name'] = ''
769 elif address.parent_id:
770 address_format = '%(company_name)s\n' + address_format
771 return address_format % args
773 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: