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 tools
31 from openerp.osv import osv, fields
32 from openerp.osv.expression import get_unaccent_wrapper
33 from openerp.tools.translate import _
35 class format_address(object):
36 def fields_view_get_address(self, cr, uid, arch, context={}):
37 user_obj = self.pool['res.users']
38 fmt = user_obj.browse(cr, SUPERUSER_ID, uid, context).company_id.country_id
39 fmt = fmt and fmt.address_format
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}'/>
46 <field name="zip" placeholder="ZIP"/>
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%%"/>
54 <field name="state_id" class="oe_no_button" placeholder="State" options='{"no_open": true}'/>
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"/>
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)
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 '_')]
80 class res_partner_category(osv.osv):
82 def name_get(self, cr, uid, ids, context=None):
83 """Return the categories' display name, including their direct
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
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)):
97 reads = self.read(cr, uid, ids, ['name', 'parent_id'], context=context)
100 name = record['name']
101 if record['parent_id']:
102 name = record['parent_id'][1] + ' / ' + name
103 res.append((record['id'], name))
106 def name_search(self, cr, uid, name, args=None, operator='ilike', context=None, limit=100):
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)
116 ids = self.search(cr, uid, args, limit=limit, context=context)
117 return self.name_get(cr, uid, ids, context)
120 def _name_get_fnc(self, cr, uid, ids, prop, unknow_none, context=None):
121 res = self.name_get(cr, uid, ids, context=context)
124 _description = 'Partner Tags'
125 _name = 'res.partner.category'
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'),
137 (osv.osv._check_recursion, 'Error ! You can not create recursive categories.', ['parent_id'])
143 _parent_order = 'name'
144 _order = 'parent_left'
146 class res_partner_title(osv.osv):
147 _name = 'res.partner.title'
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)
158 def _lang_get(self, cr, uid, context=None):
159 lang_pool = self.pool['res.lang']
160 ids = lang_pool.search(cr, uid, [], context=context)
161 res = lang_pool.read(cr, uid, ids, ['code', 'name'], context)
162 return [(r['code'], r['name']) for r in res]
164 # fields copy if 'use_parent_address' is checked
165 ADDRESS_FIELDS = ('street', 'street2', 'zip', 'city', 'state_id', 'country_id')
167 class res_partner(osv.osv, format_address):
168 _description = 'Partner'
169 _name = "res.partner"
171 def _address_display(self, cr, uid, ids, name, args, context=None):
173 for partner in self.browse(cr, uid, ids, context=context):
174 res[partner.id] = self._display_address(cr, uid, partner, context=context)
177 def _get_image(self, cr, uid, ids, name, args, context=None):
178 result = dict.fromkeys(ids, False)
179 for obj in self.browse(cr, uid, ids, context=context):
180 result[obj.id] = tools.image_get_resized_images(obj.image)
183 def _get_tz_offset(self, cr, uid, ids, name, args, context=None):
184 result = dict.fromkeys(ids, False)
185 for obj in self.browse(cr, uid, ids, context=context):
186 result[obj.id] = datetime.datetime.now(pytz.timezone(obj.tz or 'GMT')).strftime('%z')
189 def _set_image(self, cr, uid, id, name, value, args, context=None):
190 return self.write(cr, uid, [id], {'image': tools.image_resize_image_big(value)}, context=context)
192 def _has_image(self, cr, uid, ids, name, args, context=None):
194 for obj in self.browse(cr, uid, ids, context=context):
195 result[obj.id] = obj.image != False
198 def _commercial_partner_compute(self, cr, uid, ids, name, args, context=None):
199 """ Returns the partner that is considered the commercial
200 entity of this partner. The commercial entity holds the master data
201 for all commercial fields (see :py:meth:`~_commercial_fields`) """
202 result = dict.fromkeys(ids, False)
203 for partner in self.browse(cr, uid, ids, context=context):
204 current_partner = partner
205 while not current_partner.is_company and current_partner.parent_id:
206 current_partner = current_partner.parent_id
207 result[partner.id] = current_partner.id
210 def _display_name_compute(self, cr, uid, ids, name, args, context=None):
211 context = dict(context or {})
212 context.pop('show_address', None)
213 context.pop('show_address_only', None)
214 context.pop('show_email', None)
215 return dict(self.name_get(cr, uid, ids, context=context))
217 # indirections to avoid passing a copy of the overridable method when declaring the function field
218 _commercial_partner_id = lambda self, *args, **kwargs: self._commercial_partner_compute(*args, **kwargs)
219 _display_name = lambda self, *args, **kwargs: self._display_name_compute(*args, **kwargs)
221 _commercial_partner_store_triggers = {
222 'res.partner': (lambda self,cr,uid,ids,context=None: self.search(cr, uid, [('id','child_of',ids)], context=dict(active_test=False)),
223 ['parent_id', 'is_company'], 10)
225 _display_name_store_triggers = {
226 'res.partner': (lambda self,cr,uid,ids,context=None: self.search(cr, uid, [('id','child_of',ids)], context=dict(active_test=False)),
227 ['parent_id', 'is_company', 'name'], 10)
230 _order = "display_name"
232 'name': fields.char('Name', size=128, required=True, select=True),
233 'display_name': fields.function(_display_name, type='char', string='Name', store=_display_name_store_triggers, select=True),
234 'date': fields.date('Date', select=1),
235 'title': fields.many2one('res.partner.title', 'Title'),
236 'parent_id': fields.many2one('res.partner', 'Related Company', select=True),
237 'child_ids': fields.one2many('res.partner', 'parent_id', 'Contacts', domain=[('active','=',True)]), # force "active_test" domain to bypass _search() override
238 'ref': fields.char('Contact Reference', size=64, select=1),
239 'lang': fields.selection(_lang_get, 'Language',
240 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."),
241 'tz': fields.selection(_tz_get, 'Timezone', size=64,
242 help="The partner's timezone, used to output proper date and time values inside printed reports. "
243 "It is important to set a value for this field. You should use the same timezone "
244 "that is otherwise used to pick and render date and time values: your computer's timezone."),
245 'tz_offset': fields.function(_get_tz_offset, type='char', size=5, string='Timezone offset', invisible=True),
246 'user_id': fields.many2one('res.users', 'Salesperson', help='The internal user that is in charge of communicating with this contact if any.'),
247 '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."),
248 'bank_ids': fields.one2many('res.partner.bank', 'partner_id', 'Banks'),
249 'website': fields.char('Website', size=64, help="Website of Partner or Company"),
250 'comment': fields.text('Notes'),
251 'category_id': fields.many2many('res.partner.category', id1='partner_id', id2='category_id', string='Tags'),
252 'credit_limit': fields.float(string='Credit Limit'),
253 'ean13': fields.char('EAN13', size=13),
254 'active': fields.boolean('Active'),
255 'customer': fields.boolean('Customer', help="Check this box if this contact is a customer."),
256 '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."),
257 'employee': fields.boolean('Employee', help="Check this box if this contact is an Employee."),
258 'function': fields.char('Job Position', size=128),
259 'type': fields.selection([('default', 'Default'), ('invoice', 'Invoice'),
260 ('delivery', 'Shipping'), ('contact', 'Contact'),
261 ('other', 'Other')], 'Address Type',
262 help="Used to select automatically the right address according to the context in sales and purchases documents."),
263 'street': fields.char('Street', size=128),
264 'street2': fields.char('Street2', size=128),
265 'zip': fields.char('Zip', change_default=True, size=24),
266 'city': fields.char('City', size=128),
267 'state_id': fields.many2one("res.country.state", 'State', ondelete='restrict'),
268 'country_id': fields.many2one('res.country', 'Country', ondelete='restrict'),
269 'email': fields.char('Email', size=240),
270 'phone': fields.char('Phone', size=64),
271 'fax': fields.char('Fax', size=64),
272 'mobile': fields.char('Mobile', size=64),
273 'birthdate': fields.char('Birthdate', size=64),
274 'is_company': fields.boolean('Is a Company', help="Check if the contact is a company, otherwise it is a person"),
275 'use_parent_address': fields.boolean('Use Company Address', help="Select this if you want to set company's address information for this contact"),
276 # image: all image fields are base64 encoded and PIL-supported
277 'image': fields.binary("Image",
278 help="This field holds the image used as avatar for this contact, limited to 1024x1024px"),
279 'image_medium': fields.function(_get_image, fnct_inv=_set_image,
280 string="Medium-sized image", type="binary", multi="_get_image",
282 'res.partner': (lambda self, cr, uid, ids, c={}: ids, ['image'], 10),
284 help="Medium-sized image of this contact. It is automatically "\
285 "resized as a 128x128px image, with aspect ratio preserved. "\
286 "Use this field in form views or some kanban views."),
287 'image_small': fields.function(_get_image, fnct_inv=_set_image,
288 string="Small-sized image", type="binary", multi="_get_image",
290 'res.partner': (lambda self, cr, uid, ids, c={}: ids, ['image'], 10),
292 help="Small-sized image of this contact. It is automatically "\
293 "resized as a 64x64px image, with aspect ratio preserved. "\
294 "Use this field anywhere a small image is required."),
295 'has_image': fields.function(_has_image, type="boolean"),
296 'company_id': fields.many2one('res.company', 'Company', select=1),
297 'color': fields.integer('Color Index'),
298 'user_ids': fields.one2many('res.users', 'partner_id', 'Users'),
299 'contact_address': fields.function(_address_display, type='char', string='Complete Address'),
301 # technical field used for managing commercial fields
302 'commercial_partner_id': fields.function(_commercial_partner_id, type='many2one', relation='res.partner', string='Commercial Entity', store=_commercial_partner_store_triggers)
305 def _default_category(self, cr, uid, context=None):
308 if context.get('category_id'):
309 return [context['category_id']]
312 def _get_default_image(self, cr, uid, is_company, context=None, colorize=False):
313 img_path = openerp.modules.get_module_resource('base', 'static/src/img',
314 ('company_image.png' if is_company else 'avatar.png'))
315 with open(img_path, 'rb') as f:
318 # colorize user avatars
320 image = tools.image_colorize(image)
322 return tools.image_resize_image_big(image.encode('base64'))
324 def fields_view_get(self, cr, user, view_id=None, view_type='form', context=None, toolbar=False, submenu=False):
325 if (not view_id) and (view_type=='form') and context and context.get('force_email', False):
326 view_id = self.pool['ir.model.data'].get_object_reference(cr, user, 'base', 'view_partner_simple_form')[1]
327 res = super(res_partner,self).fields_view_get(cr, user, view_id, view_type, context, toolbar=toolbar, submenu=submenu)
328 if view_type == 'form':
329 res['arch'] = self.fields_view_get_address(cr, user, res['arch'], context=context)
334 'lang': lambda self, cr, uid, ctx: ctx.get('lang', 'en_US'),
335 'tz': lambda self, cr, uid, ctx: ctx.get('tz', False),
337 'category_id': _default_category,
338 'company_id': lambda self, cr, uid, ctx: self.pool['res.company']._company_default_get(cr, uid, 'res.partner', context=ctx),
341 'type': 'contact', # type 'default' is wildcard and thus inappropriate
342 'use_parent_address': False,
347 (osv.osv._check_recursion, 'You cannot create recursive Partner hierarchies.', ['parent_id']),
350 def copy(self, cr, uid, id, default=None, context=None):
353 default['user_ids'] = False
354 name = self.read(cr, uid, [id], ['name'], context)[0]['name']
355 default.update({'name': _('%s (copy)') % name})
356 return super(res_partner, self).copy(cr, uid, id, default, context)
358 def onchange_type(self, cr, uid, ids, is_company, context=None):
360 value['title'] = False
362 value['use_parent_address'] = False
363 domain = {'title': [('domain', '=', 'partner')]}
365 domain = {'title': [('domain', '=', 'contact')]}
366 return {'value': value, 'domain': domain}
368 def onchange_address(self, cr, uid, ids, use_parent_address, parent_id, context=None):
369 def value_or_id(val):
370 """ return val or val.id if val is a browse record """
371 return val if isinstance(val, (bool, int, long, float, basestring)) else val.id
375 partner = self.browse(cr, uid, ids[0], context=context)
376 if partner.parent_id and partner.parent_id.id != parent_id:
377 result['warning'] = {'title': _('Warning'),
378 'message': _('Changing the company of a contact should only be done if it '
379 'was never correctly set. If an existing contact starts working for a new '
380 'company then a new contact should be created under that new '
381 'company. You can use the "Discard" button to abandon this change.')}
382 if use_parent_address:
383 parent = self.browse(cr, uid, parent_id, context=context)
384 address_fields = self._address_fields(cr, uid, context=context)
385 result['value'] = dict((key, value_or_id(parent[key])) for key in address_fields)
387 result['value'] = {'use_parent_address': False}
390 def onchange_state(self, cr, uid, ids, state_id, context=None):
392 country_id = self.pool['res.country.state'].browse(cr, uid, state_id, context).country_id.id
393 return {'value':{'country_id':country_id}}
396 def _check_ean_key(self, cr, uid, ids, context=None):
397 for partner_o in self.pool['res.partner'].read(cr, uid, ids, ['ean13',]):
398 thisean=partner_o['ean13']
399 if thisean and thisean!='':
407 sum+=3*int(thisean[i])
408 if math.ceil(sum/10.0)*10-sum!=int(thisean[12]):
412 # _constraints = [(_check_ean_key, 'Error: Invalid ean code', ['ean13'])]
414 def _update_fields_values(self, cr, uid, partner, fields, context=None):
415 """ Returns dict of write() values for synchronizing ``fields`` """
418 column = self._all_columns[field].column
419 if column._type == 'one2many':
420 raise AssertionError('One2Many fields cannot be synchronized as part of `commercial_fields` or `address fields`')
421 if column._type == 'many2one':
422 values[field] = partner[field].id if partner[field] else False
423 elif column._type == 'many2many':
424 values[field] = [(6,0,[r.id for r in partner[field] or []])]
426 values[field] = partner[field]
429 def _address_fields(self, cr, uid, context=None):
430 """ Returns the list of address fields that are synced from the parent
431 when the `use_parent_address` flag is set. """
432 return list(ADDRESS_FIELDS)
434 def update_address(self, cr, uid, ids, vals, context=None):
435 address_fields = self._address_fields(cr, uid, context=context)
436 addr_vals = dict((key, vals[key]) for key in address_fields if key in vals)
438 return super(res_partner, self).write(cr, uid, ids, addr_vals, context)
440 def _commercial_fields(self, cr, uid, context=None):
441 """ Returns the list of fields that are managed by the commercial entity
442 to which a partner belongs. These fields are meant to be hidden on
443 partners that aren't `commercial entities` themselves, and will be
444 delegated to the parent `commercial entity`. The list is meant to be
445 extended by inheriting classes. """
448 def _commercial_sync_from_company(self, cr, uid, partner, context=None):
449 """ Handle sync of commercial fields when a new parent commercial entity is set,
450 as if they were related fields """
451 if partner.commercial_partner_id != partner:
452 commercial_fields = self._commercial_fields(cr, uid, context=context)
453 sync_vals = self._update_fields_values(cr, uid, partner.commercial_partner_id,
454 commercial_fields, context=context)
455 partner.write(sync_vals)
457 def _commercial_sync_to_children(self, cr, uid, partner, context=None):
458 """ Handle sync of commercial fields to descendants """
459 commercial_fields = self._commercial_fields(cr, uid, context=context)
460 sync_vals = self._update_fields_values(cr, uid, partner.commercial_partner_id,
461 commercial_fields, context=context)
462 sync_children = [c for c in partner.child_ids if not c.is_company]
463 for child in sync_children:
464 self._commercial_sync_to_children(cr, uid, child, context=context)
465 return self.write(cr, uid, [c.id for c in sync_children], sync_vals, context=context)
467 def _fields_sync(self, cr, uid, partner, update_values, context=None):
468 """ Sync commercial fields and address fields from company and to children after create/update,
469 just as if those were all modeled as fields.related to the parent """
470 # 1. From UPSTREAM: sync from parent
471 if update_values.get('parent_id') or update_values.get('use_parent_address'):
472 # 1a. Commercial fields: sync if parent changed
473 if update_values.get('parent_id'):
474 self._commercial_sync_from_company(cr, uid, partner, context=context)
475 # 1b. Address fields: sync if parent or use_parent changed *and* both are now set
476 if partner.parent_id and partner.use_parent_address:
477 onchange_vals = self.onchange_address(cr, uid, [partner.id],
478 use_parent_address=partner.use_parent_address,
479 parent_id=partner.parent_id.id,
480 context=context).get('value', {})
481 partner.update_address(onchange_vals)
483 # 2. To DOWNSTREAM: sync children
484 if partner.child_ids:
485 # 2a. Commercial Fields: sync if commercial entity
486 if partner.commercial_partner_id == partner:
487 commercial_fields = self._commercial_fields(cr, uid,
489 if any(field in update_values for field in commercial_fields):
490 self._commercial_sync_to_children(cr, uid, partner,
492 # 2b. Address fields: sync if address changed
493 address_fields = self._address_fields(cr, uid, context=context)
494 if any(field in update_values for field in address_fields):
495 domain_children = [('parent_id', '=', partner.id), ('use_parent_address', '=', True)]
496 update_ids = self.search(cr, uid, domain_children, context=context)
497 self.update_address(cr, uid, update_ids, update_values, context=context)
499 def _handle_first_contact_creation(self, cr, uid, partner, context=None):
500 """ On creation of first contact for a company (or root) that has no address, assume contact address
501 was meant to be company address """
502 parent = partner.parent_id
503 address_fields = self._address_fields(cr, uid, context=context)
504 if parent and (parent.is_company or not parent.parent_id) and len(parent.child_ids) == 1 and \
505 any(partner[f] for f in address_fields) and not any(parent[f] for f in address_fields):
506 addr_vals = self._update_fields_values(cr, uid, partner, address_fields, context=context)
507 parent.update_address(addr_vals)
508 if not parent.is_company:
509 parent.write({'is_company': True})
511 def _clean_website(self, website):
512 (scheme, netloc, path, params, query, fragment) = urlparse.urlparse(website)
515 netloc, path = path, ''
516 website = urlparse.urlunparse(('http', netloc, path, params, query, fragment))
519 def write(self, cr, uid, ids, vals, context=None):
520 if isinstance(ids, (int, long)):
522 #res.partner must only allow to set the company_id of a partner if it
523 #is the same as the company of all users that inherit from this partner
524 #(this is to allow the code from res_users to write to the partner!) or
525 #if setting the company_id to False (this is compatible with any user company)
526 if vals.get('website'):
527 vals['website'] = self._clean_website(vals['website'])
528 if vals.get('company_id'):
529 for partner in self.browse(cr, uid, ids, context=context):
531 user_companies = set([user.company_id.id for user in partner.user_ids])
532 if len(user_companies) > 1 or vals['company_id'] not in user_companies:
533 raise osv.except_osv(_("Warning"),_("You can not change the company as the partner/user has multiple user linked with different companies."))
534 result = super(res_partner,self).write(cr, uid, ids, vals, context=context)
535 for partner in self.browse(cr, uid, ids, context=context):
536 self._fields_sync(cr, uid, partner, vals, context)
539 def create(self, cr, uid, vals, context=None):
540 if vals.get('website'):
541 vals['website'] = self._clean_website(vals['website'])
542 new_id = super(res_partner, self).create(cr, uid, vals, context=context)
543 partner = self.browse(cr, uid, new_id, context=context)
544 self._fields_sync(cr, uid, partner, vals, context)
545 self._handle_first_contact_creation(cr, uid, partner, context)
548 def open_commercial_entity(self, cr, uid, ids, context=None):
549 """ Utility method used to add an "Open Company" button in partner views """
550 partner = self.browse(cr, uid, ids[0], context=context)
551 return {'type': 'ir.actions.act_window',
552 'res_model': 'res.partner',
554 'res_id': partner.commercial_partner_id.id,
556 'flags': {'form': {'action_buttons': True}}}
558 def open_parent(self, cr, uid, ids, context=None):
559 """ Utility method used to add an "Open Parent" button in partner views """
560 partner = self.browse(cr, uid, ids[0], context=context)
561 return {'type': 'ir.actions.act_window',
562 'res_model': 'res.partner',
564 'res_id': partner.parent_id.id,
566 'flags': {'form': {'action_buttons': True}}}
568 def name_get(self, cr, uid, ids, context=None):
571 if isinstance(ids, (int, long)):
574 for record in self.browse(cr, uid, ids, context=context):
576 if record.parent_id and not record.is_company:
577 name = "%s, %s" % (record.parent_id.name, name)
578 if context.get('show_address_only'):
579 name = self._display_address(cr, uid, record, without_company=True, context=context)
580 if context.get('show_address'):
581 name = name + "\n" + self._display_address(cr, uid, record, without_company=True, context=context)
582 name = name.replace('\n\n','\n')
583 name = name.replace('\n\n','\n')
584 if context.get('show_email') and record.email:
585 name = "%s <%s>" % (name, record.email)
586 res.append((record.id, name))
589 def _parse_partner_name(self, text, context=None):
590 """ Supported syntax:
591 - 'Raoul <raoul@grosbedon.fr>': will find name and email address
592 - otherwise: default, everything is set as the name """
593 emails = tools.email_split(text)
596 name = text[:text.index(email)].replace('"', '').replace('<', '').strip()
598 name, email = text, ''
601 def name_create(self, cr, uid, name, context=None):
602 """ Override of orm's name_create method for partners. The purpose is
603 to handle some basic formats to create partners using the
605 If only an email address is received and that the regex cannot find
606 a name, the name will have the email value.
607 If 'force_email' key in context: must find the email address. """
610 name, email = self._parse_partner_name(name, context=context)
611 if context.get('force_email') and not email:
612 raise osv.except_osv(_('Warning'), _("Couldn't create contact without email address!"))
613 if not name and email:
615 rec_id = self.create(cr, uid, {self._rec_name: name or email, 'email': email or False}, context=context)
616 return self.name_get(cr, uid, [rec_id], context)[0]
618 def _search(self, cr, user, args, offset=0, limit=None, order=None, context=None, count=False, access_rights_uid=None):
619 """ Override search() to always show inactive children when searching via ``child_of`` operator. The ORM will
620 always call search() with a simple domain of the form [('parent_id', 'in', [ids])]. """
621 # a special ``domain`` is set on the ``child_ids`` o2m to bypass this logic, as it uses similar domain expressions
622 if len(args) == 1 and len(args[0]) == 3 and args[0][:2] == ('parent_id','in') \
623 and args[0][2] != [False]:
624 context = dict(context or {}, active_test=False)
625 return super(res_partner, self)._search(cr, user, args, offset=offset, limit=limit, order=order, context=context,
626 count=count, access_rights_uid=access_rights_uid)
628 def name_search(self, cr, uid, name, args=None, operator='ilike', context=None, limit=100):
631 if name and operator in ('=', 'ilike', '=ilike', 'like', '=like'):
633 self.check_access_rights(cr, uid, 'read')
634 where_query = self._where_calc(cr, uid, args, context=context)
635 self._apply_ir_rules(cr, uid, where_query, 'read', context=context)
636 from_clause, where_clause, where_clause_params = where_query.get_sql()
637 where_str = where_clause and (" WHERE %s AND " % where_clause) or ' WHERE '
639 # search on the name of the contacts and of its company
641 if operator in ('ilike', 'like'):
642 search_name = '%%%s%%' % name
643 if operator in ('=ilike', '=like'):
644 operator = operator[1:]
646 unaccent = get_unaccent_wrapper(cr)
650 {where} ({email} {operator} {percent}
651 OR {display_name} {operator} {percent})
652 ORDER BY {display_name}
653 """.format(where=where_str, operator=operator,
654 email=unaccent('email'),
655 display_name=unaccent('display_name'),
656 percent=unaccent('%s'))
658 where_clause_params += [search_name, search_name]
661 where_clause_params.append(limit)
662 cr.execute(query, where_clause_params)
663 ids = map(lambda x: x[0], cr.fetchall())
666 return self.name_get(cr, uid, ids, context)
669 return super(res_partner,self).name_search(cr, uid, name, args, operator=operator, context=context, limit=limit)
671 def find_or_create(self, cr, uid, email, context=None):
672 """ Find a partner with the given ``email`` or use :py:method:`~.name_create`
675 :param str email: email-like string, which should contain at least one email,
676 e.g. ``"Raoul Grosbedon <r.g@grosbedon.fr>"``"""
677 assert email, 'an email is required for find_or_create to work'
678 emails = tools.email_split(email)
681 ids = self.search(cr, uid, [('email','ilike',email)], context=context)
683 return self.name_create(cr, uid, email, context=context)[0]
686 def _email_send(self, cr, uid, ids, email_from, subject, body, on_error=None):
687 partners = self.browse(cr, uid, ids)
688 for partner in partners:
690 tools.email_send(email_from, [partner.email], subject, body, on_error)
693 def email_send(self, cr, uid, ids, email_from, subject, body, on_error=''):
695 self.pool['ir.cron'].create(cr, uid, {
696 'name': 'Send Partner Emails',
698 'model': 'res.partner',
699 'function': '_email_send',
700 'args': repr([ids[:16], email_from, subject, body, on_error])
705 def address_get(self, cr, uid, ids, adr_pref=None, context=None):
706 """ Find contacts/addresses of the right type(s) by doing a depth-first-search
707 through descendants within company boundaries (stop at entities flagged ``is_company``)
708 then continuing the search at the ancestors that are within the same company boundaries.
709 Defaults to partners of type ``'default'`` when the exact type is not found, or to the
710 provided partner itself if no type ``'default'`` is found either. """
711 adr_pref = set(adr_pref or [])
712 if 'default' not in adr_pref:
713 adr_pref.add('default')
716 for partner in self.browse(cr, uid, filter(None, ids), context=context):
717 current_partner = partner
718 while current_partner:
719 to_scan = [current_partner]
720 # Scan descendants, DFS
722 record = to_scan.pop(0)
724 if record.type in adr_pref and not result.get(record.type):
725 result[record.type] = record.id
726 if len(result) == len(adr_pref):
728 to_scan = [c for c in record.child_ids
730 if not c.is_company] + to_scan
732 # Continue scanning at ancestor if current_partner is not a commercial entity
733 if current_partner.is_company or not current_partner.parent_id:
735 current_partner = current_partner.parent_id
737 # default to type 'default' or the partner itself
738 default = result.get('default', partner.id)
739 for adr_type in adr_pref:
740 result[adr_type] = result.get(adr_type) or default
743 def view_header_get(self, cr, uid, view_id, view_type, context):
744 res = super(res_partner, self).view_header_get(cr, uid, view_id, view_type, context)
746 if not context.get('category_id', False):
748 return _('Partners: ')+self.pool['res.partner.category'].browse(cr, uid, context['category_id'], context).name
750 def main_partner(self, cr, uid):
751 ''' Return the id of the main partner
753 model_data = self.pool['ir.model.data']
754 return model_data.browse(cr, uid,
755 model_data.search(cr, uid, [('module','=','base'),
756 ('name','=','main_partner')])[0],
759 def _display_address(self, cr, uid, address, without_company=False, context=None):
762 The purpose of this function is to build and return an address formatted accordingly to the
763 standards of the country where it belongs.
765 :param address: browse record of the res.partner to format
766 :returns: the address formatted in a display that fit its country habits (or the default ones
767 if not country is specified)
771 # get the information that will be injected into the display format
772 # get the address format
773 address_format = address.country_id and address.country_id.address_format or \
774 "%(street)s\n%(street2)s\n%(city)s %(state_code)s %(zip)s\n%(country_name)s"
776 'state_code': address.state_id and address.state_id.code or '',
777 'state_name': address.state_id and address.state_id.name or '',
778 'country_code': address.country_id and address.country_id.code or '',
779 'country_name': address.country_id and address.country_id.name or '',
780 'company_name': address.parent_id and address.parent_id.name or '',
782 for field in self._address_fields(cr, uid, context=context):
783 args[field] = getattr(address, field) or ''
785 args['company_name'] = ''
786 elif address.parent_id:
787 address_format = '%(company_name)s\n' + address_format
788 return address_format % args
790 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: