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