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