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