1 # -*- encoding: utf-8 -*-
2 ##############################################################################
4 # Copyright (c) 2004-2008 TINY SPRL. (http://tiny.be) All Rights Reserved.
8 # WARNING: This program as such is intended to be used by professional
9 # programmers who take the whole responsability of assessing all potential
10 # consequences resulting from its eventual inadequacies and bugs
11 # End users who are looking for a ready-to-use solution with commercial
12 # garantees and support are strongly adviced to contract a Free Software
15 # This program is Free Software; you can redistribute it and/or
16 # modify it under the terms of the GNU General Public License
17 # as published by the Free Software Foundation; either version 2
18 # of the License, or (at your option) any later version.
20 # This program is distributed in the hope that it will be useful,
21 # but WITHOUT ANY WARRANTY; without even the implied warranty of
22 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 # GNU General Public License for more details.
25 # You should have received a copy of the GNU General Public License
26 # along with this program; if not, write to the Free Software
27 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
29 ##############################################################################
33 # - relations (one2many, many2one, many2many)
37 # _classic_read: is a classic sql fields
52 def _symbol_set(symb):
53 if symb == None or symb == False:
55 elif isinstance(symb, unicode):
56 return symb.encode('utf-8')
60 class _column(object):
68 _symbol_f = _symbol_set
69 _symbol_set = (_symbol_c, _symbol_f)
72 def __init__(self, string='unknown', required=False, readonly=False, domain=None, context='', states=None, priority=0, change_default=False, size=None, ondelete="set null", translate=False, select=False, **args):
73 self.states = states or {}
75 self.readonly = readonly
76 self.required = required
78 self.help = args.get('help', '')
79 self.priority = priority
80 self.change_default = change_default
81 self.ondelete = ondelete
82 self.translate = translate
83 self._domain = domain or []
85 self._context = context
92 setattr(self, a, args[a])
94 warnings.warn("The relate attribute doesn't work anymore, use act_window tag instead", DeprecationWarning)
99 def set(self, cr, obj, id, name, value, user=None, context=None):
100 cr.execute('update '+obj._table+' set '+name+'='+self._symbol_set[0]+' where id=%d', (self._symbol_set[1](value), id))
102 def set_memory(self, cr, obj, id, name, value, user=None, context=None):
103 raise Exception(_('Not implemented set_memory method !'))
105 def get_memory(self, cr, obj, ids, name, user=None, context=None, values=None):
106 raise Exception(_('Not implemented get_memory method !'))
108 def get(self, cr, obj, ids, name, user=None, offset=0, context=None, values=None):
109 raise Exception(_('undefined get method !'))
111 def search(self, cr, obj, args, name, value, offset=0, limit=None, uid=None):
112 ids = obj.search(cr, uid, args+self._domain+[(name, 'ilike', value)], offset, limit)
113 res = obj.read(cr, uid, ids, [name])
114 return [x[name] for x in res]
116 def search_memory(self, cr, obj, args, name, value, offset=0, limit=None, uid=None, context=None):
117 raise Exception(_('Not implemented search_memory method !'))
120 # ---------------------------------------------------------
122 # ---------------------------------------------------------
123 class boolean(_column):
126 _symbol_f = lambda x: x and 'True' or 'False'
127 _symbol_set = (_symbol_c, _symbol_f)
130 class integer(_column):
133 _symbol_f = lambda x: int(x or 0)
134 _symbol_set = (_symbol_c, _symbol_f)
137 class reference(_column):
140 def __init__(self, string, selection, size, **args):
141 _column.__init__(self, string=string, size=size, selection=selection, **args)
147 def __init__(self, string, size, **args):
148 _column.__init__(self, string=string, size=size, **args)
149 self._symbol_set = (self._symbol_c, self._symbol_set_char)
151 # takes a string (encoded in utf8) and returns a string (encoded in utf8)
152 def _symbol_set_char(self, symb):
154 # * we need to remove the "symb==False" from the next line BUT
155 # for now too many things rely on this broken behavior
156 # * the symb==None test should be common to all data types
157 if symb == None or symb == False:
160 # we need to convert the string to a unicode object to be able
161 # to evaluate its length (and possibly truncate it) reliably
162 if isinstance(symb, str):
163 u_symb = unicode(symb, 'utf8')
164 elif isinstance(symb, unicode):
167 u_symb = unicode(symb)
168 return u_symb.encode('utf8')[:self.size]
177 class float(_column):
180 _symbol_f = lambda x: __builtin__.float(x or 0.0)
181 _symbol_set = (_symbol_c, _symbol_f)
183 def __init__(self, string='unknown', digits=None, **args):
184 _column.__init__(self, string=string, **args)
192 class datetime(_column):
200 class binary(_column):
203 _symbol_f = lambda symb: symb and psycopg.Binary(symb) or None
204 _symbol_set = (_symbol_c, _symbol_f)
206 _classic_read = False
208 def get_memory(self, cr, obj, ids, name, user=None, context=None, values=None):
221 res.setdefault(i, val)
222 if context.get('get_binary_size', True):
223 res[i] = tools.human_size(val)
229 class selection(_column):
232 def __init__(self, selection, string='unknown', **args):
233 _column.__init__(self, string=string, **args)
234 self.selection = selection
236 # ---------------------------------------------------------
238 # ---------------------------------------------------------
241 # Values: (0, 0, { fields }) create
242 # (1, ID, { fields }) modification
243 # (2, ID) remove (delete)
244 # (3, ID) unlink one (target id or target of relation)
246 # (5) unlink all (only valid for one2many)
248 #CHECKME: dans la pratique c'est quoi la syntaxe utilisee pour le 5? (5) ou (5, 0)?
249 class one2one(_column):
250 _classic_read = False
251 _classic_write = True
254 def __init__(self, obj, string='unknown', **args):
255 warnings.warn("The one2one field doesn't work anymore", DeprecationWarning)
256 _column.__init__(self, string=string, **args)
259 def set(self, cr, obj_src, id, field, act, user=None, context=None):
262 obj = obj_src.pool.get(self._obj)
263 self._table = obj_src.pool.get(self._obj)._table
265 id_new = obj.create(cr, user, act[1])
266 cr.execute('update '+obj_src._table+' set '+field+'=%d where id=%d', (id_new, id))
268 cr.execute('select '+field+' from '+obj_src._table+' where id=%d', (act[0],))
269 id = cr.fetchone()[0]
270 obj.write(cr, user, [id], act[1], context=context)
272 def search(self, cr, obj, args, name, value, offset=0, limit=None, uid=None):
273 return obj.pool.get(self._obj).search(cr, uid, args+self._domain+[('name', 'like', value)], offset, limit)
276 class many2one(_column):
277 _classic_read = False
278 _classic_write = True
281 def __init__(self, obj, string='unknown', **args):
282 _column.__init__(self, string=string, **args)
286 # TODO: speed improvement
288 # name is the name of the relation field
289 def get_memory(self, cr, obj, ids, name, user=None, context=None, values=None):
292 result[id] = obj.datas[id][name]
295 def get(self, cr, obj, ids, name, user=None, context=None, values=None):
302 res[r['id']] = r[name]
304 res.setdefault(id, '')
305 obj = obj.pool.get(self._obj)
306 # build a dictionary of the form {'id_of_distant_resource': name_of_distant_resource}
307 from orm import except_orm
309 names = dict(obj.name_get(cr, user, filter(None, res.values()), context))
313 iids = filter(None, res.values())
314 cr.execute('select id,'+obj._rec_name+' from '+obj._table+' where id in ('+','.join(map(str, iids))+')')
315 for res22 in cr.fetchall():
316 names[res22[0]] = res22[1]
319 if res[r] and res[r] in names:
320 res[r] = (res[r], names[res[r]])
325 def set(self, cr, obj_src, id, field, values, user=None, context=None):
328 obj = obj_src.pool.get(self._obj)
329 self._table = obj_src.pool.get(self._obj)._table
330 if type(values)==type([]):
333 id_new = obj.create(cr, act[2])
334 cr.execute('update '+obj_src._table+' set '+field+'=%d where id=%d', (id_new, id))
336 obj.write(cr, [act[1]], act[2], context=context)
338 cr.execute('delete from '+self._table+' where id=%d', (act[1],))
339 elif act[0] == 3 or act[0] == 5:
340 cr.execute('update '+obj_src._table+' set '+field+'=null where id=%d', (id,))
342 cr.execute('update '+obj_src._table+' set '+field+'=%d where id=%d', (act[1], id))
345 cr.execute('update '+obj_src._table+' set '+field+'=%d where id=%d', (values, id))
347 cr.execute('update '+obj_src._table+' set '+field+'=null where id=%d', (id,))
349 def search(self, cr, obj, args, name, value, offset=0, limit=None, uid=None):
350 return obj.pool.get(self._obj).search(cr, uid, args+self._domain+[('name', 'like', value)], offset, limit)
353 class one2many(_column):
354 _classic_read = False
355 _classic_write = False
358 def __init__(self, obj, fields_id, string='unknown', limit=None, **args):
359 _column.__init__(self, string=string, **args)
361 self._fields_id = fields_id
363 #one2many can't be used as condition for defaults
364 assert(self.change_default != True)
366 def get_memory(self, cr, obj, ids, name, user=None, offset=0, context=None, values=None):
374 ids2 = obj.pool.get(self._obj).search(cr, user, [(self._fields_id, 'in', ids)], limit=self._limit)
375 for r in obj.pool.get(self._obj).read(cr, user, ids2, [self._fields_id], context=context, load='_classic_write'):
376 if r[self._fields_id] in res:
377 res[r[self._fields_id]].append(r['id'])
380 def set_memory(self, cr, obj, id, field, values, user=None, context=None):
385 obj = obj.pool.get(self._obj)
388 act[2][self._fields_id] = id
389 obj.create(cr, user, act[2], context=context)
391 obj.write(cr, user, [act[1]], act[2], context=context)
393 obj.unlink(cr, user, [act[1]], context=context)
395 obj.datas[act[1]][self._fields_id] = False
397 obj.datas[act[1]] = id
399 for o in obj.datas.values():
400 if o[self._fields_id] == id:
401 o[self._fields_id] = False
403 for id2 in (act[2] or []):
404 obj.datas[id2][self._fields_id] = id
406 def search_memory(self, cr, obj, args, name, value, offset=0, limit=None, uid=None, operator='like', context=None):
407 raise _('Not Implemented')
409 def get(self, cr, obj, ids, name, user=None, offset=0, context=None, values=None):
417 ids2 = obj.pool.get(self._obj).search(cr, user, [(self._fields_id, 'in', ids)], limit=self._limit)
418 for r in obj.pool.get(self._obj)._read_flat(cr, user, ids2, [self._fields_id], context=context, load='_classic_write'):
419 res[r[self._fields_id]].append(r['id'])
422 def set(self, cr, obj, id, field, values, user=None, context=None):
427 _table = obj.pool.get(self._obj)._table
428 obj = obj.pool.get(self._obj)
431 act[2][self._fields_id] = id
432 obj.create(cr, user, act[2], context=context)
434 obj.write(cr, user, [act[1]], act[2], context=context)
436 obj.unlink(cr, user, [act[1]], context=context)
438 cr.execute('update '+_table+' set '+self._fields_id+'=null where id=%d', (act[1],))
440 cr.execute('update '+_table+' set '+self._fields_id+'=%d where id=%d', (id, act[1]))
442 cr.execute('update '+_table+' set '+self._fields_id+'=null where '+self._fields_id+'=%d', (id,))
448 cr.execute('update '+_table+' set '+self._fields_id+'=NULL where '+self._fields_id+'=%d and id not in ('+','.join(map(str, ids2))+')', (id,))
450 cr.execute('update '+_table+' set '+self._fields_id+'=%d where id in ('+','.join(map(str, act[2]))+')', (id,))
452 def search(self, cr, obj, args, name, value, offset=0, limit=None, uid=None, operator='like'):
453 return obj.pool.get(self._obj).name_search(cr, uid, value, self._domain, offset, limit)
457 # Values: (0, 0, { fields }) create
458 # (1, ID, { fields }) modification
463 # (6, ?, ids) set a list of links
465 class many2many(_column):
466 _classic_read = False
467 _classic_write = False
470 def __init__(self, obj, rel, id1, id2, string='unknown', limit=None, **args):
471 _column.__init__(self, string=string, **args)
478 def get(self, cr, obj, ids, name, user=None, offset=0, context=None, values=None):
488 ids_s = ','.join(map(str, ids))
489 limit_str = self._limit is not None and ' limit %d' % self._limit or ''
490 obj = obj.pool.get(self._obj)
492 d1, d2 = obj.pool.get('ir.rule').domain_get(cr, user, obj._name)
496 cr.execute('SELECT '+self._rel+'.'+self._id2+','+self._rel+'.'+self._id1+' \
497 FROM '+self._rel+' , '+obj._table+' \
498 WHERE '+self._rel+'.'+self._id1+' in ('+ids_s+') \
499 AND '+self._rel+'.'+self._id2+' = '+obj._table+'.id '+d1
500 +limit_str+' order by '+obj._table+'.'+obj._order+' offset %d',
502 for r in cr.fetchall():
503 res[r[1]].append(r[0])
506 def set(self, cr, obj, id, name, values, user=None, context=None):
511 obj = obj.pool.get(self._obj)
514 idnew = obj.create(cr, user, act[2])
515 cr.execute('insert into '+self._rel+' ('+self._id1+','+self._id2+') values (%d,%d)', (id, idnew))
517 obj.write(cr, user, [act[1]], act[2], context=context)
519 obj.unlink(cr, user, [act[1]], context=context)
521 cr.execute('delete from '+self._rel+' where ' + self._id1 + '=%d and '+ self._id2 + '=%d', (id, act[1]))
523 cr.execute('insert into '+self._rel+' ('+self._id1+','+self._id2+') values (%d,%d)', (id, act[1]))
525 cr.execute('update '+self._rel+' set '+self._id2+'=null where '+self._id2+'=%d', (id,))
528 d1, d2 = obj.pool.get('ir.rule').domain_get(cr, user, obj._name)
531 cr.execute('delete from '+self._rel+' where '+self._id1+'=%d AND '+self._id2+' IN (SELECT '+self._rel+'.'+self._id2+' FROM '+self._rel+', '+obj._table+' WHERE '+self._rel+'.'+self._id1+'=%d AND '+self._rel+'.'+self._id2+' = '+obj._table+'.id '+ d1 +')', [id, id]+d2)
533 for act_nbr in act[2]:
534 cr.execute('insert into '+self._rel+' ('+self._id1+','+self._id2+') values (%d, %d)', (id, act_nbr))
537 # TODO: use a name_search
539 def search(self, cr, obj, args, name, value, offset=0, limit=None, uid=None, operator='like'):
540 return obj.pool.get(self._obj).search(cr, uid, args+self._domain+[('name', operator, value)], offset, limit)
542 def get_memory(self, cr, obj, ids, name, user=None, offset=0, context=None, values=None):
545 result[id] = obj.datas[id].get(name, [])
548 def set_memory(self, cr, obj, id, name, values, user=None, context=None):
552 # TODO: use constants instead of these magic numbers
554 raise _('Not Implemented')
556 raise _('Not Implemented')
558 raise _('Not Implemented')
560 raise _('Not Implemented')
562 raise _('Not Implemented')
564 raise _('Not Implemented')
566 obj.datas[id][name] = act[2]
569 # ---------------------------------------------------------
571 # ---------------------------------------------------------
572 class function(_column):
573 _classic_read = False
574 _classic_write = False
579 # multi: compute several fields in one call
581 def __init__(self, fnct, arg=None, fnct_inv=None, fnct_inv_arg=None, type='float', fnct_search=None, obj=None, method=False, store=False, multi=False, **args):
582 _column.__init__(self, **args)
584 self._method = method
586 self._fnct_inv = fnct_inv
589 if 'relation' in args:
590 self._obj = args['relation']
591 self._fnct_inv_arg = fnct_inv_arg
595 self._fnct_search = fnct_search
598 self._symbol_c = '%f'
599 self._symbol_f = lambda x: __builtin__.float(x or 0.0)
600 self._symbol_set = (self._symbol_c, self._symbol_f)
602 def search(self, cr, uid, obj, name, args):
603 if not self._fnct_search:
604 #CHECKME: should raise an exception
606 return self._fnct_search(obj, cr, uid, obj, name, args)
608 def get(self, cr, obj, ids, name, user=None, context=None, values=None):
615 res = self._fnct(obj, cr, user, ids, name, self._arg, context)
617 res = self._fnct(cr, obj._table, ids, name, self._arg, context)
619 if self._type == 'binary' and context.get('get_binary_size', True):
620 # convert the data returned by the function with the size of that data...
621 res = dict(map(lambda (x, y): (x, tools.human_size(len(y))), res.items()))
624 def set(self, cr, obj, id, name, value, user=None, context=None):
628 self._fnct_inv(obj, cr, user, id, name, value, self._fnct_inv_arg, context)
631 # ---------------------------------------------------------
633 # ---------------------------------------------------------
634 class serialized(_column):
635 def __init__(self, string='unknown', serialize_func=repr, deserialize_func=eval, type='text', **args):
636 self._serialize_func = serialize_func
637 self._deserialize_func = deserialize_func
639 self._symbol_set = (self._symbol_c, self._serialize_func)
640 self._symbol_get = self._deserialize_func
641 super(serialized, self).__init__(string=string, **args)
644 class property(function):
646 def _fnct_write(self, obj, cr, uid, id, prop, id_val, val, context=None):
650 definition_id = self._field_get(cr, uid, obj._name, prop)
652 property = obj.pool.get('ir.property')
653 nid = property.search(cr, uid, [('fields_id', '=', definition_id),
654 ('res_id', '=', obj._name+','+str(id))])
656 cr.execute('DELETE FROM ir_property WHERE id=%d', (nid.pop(),))
658 nid = property.search(cr, uid, [('fields_id', '=', definition_id),
659 ('res_id', '=', False)])
662 default_val = property.browse(cr, uid, nid[0], context).value
664 company_id = obj.pool.get('res.users').company_get(cr, uid, uid)
666 newval = (id_val and obj_dest+','+str(id_val)) or False
667 if (newval != default_val) and newval:
668 propdef = obj.pool.get('ir.model.fields').browse(cr, uid,
669 definition_id, context=context)
670 res = property.create(cr, uid, {
671 'name': propdef.name,
673 'res_id': obj._name+','+str(id),
674 'company_id': company_id,
675 'fields_id': definition_id
679 def _fnct_read(self, obj, cr, uid, ids, prop, val, context=None):
682 property = obj.pool.get('ir.property')
683 definition_id = self._field_get(cr, uid, obj._name, prop)
685 nid = property.search(cr, uid, [('fields_id', '=', definition_id),
686 ('res_id', '=', False)])
689 d = property.browse(cr, uid, nid[0], context).value
690 default_val = (d and int(d.split(',')[1])) or False
692 vids = [obj._name + ',' + str(id) for id in ids]
693 nids = property.search(cr, uid, [('fields_id', '=', definition_id),
694 ('res_id', 'in', vids)])
698 res[id] = default_val
699 for prop in property.browse(cr, uid, nids):
700 res[int(prop.res_id.split(',')[1])] = (prop.value and \
701 int(prop.value.split(',')[1])) or False
703 obj = obj.pool.get(self._obj)
704 names = dict(obj.name_get(cr, uid, filter(None, res.values()), context))
706 if res[r] and res[r] in names:
707 res[r] = (res[r], names[res[r]])
712 def _field_get(self, cr, uid, model_name, prop):
713 if not self.field_id.get(cr.dbname):
714 cr.execute('SELECT id \
715 FROM ir_model_fields \
716 WHERE name=%s AND model=%s', (prop, model_name))
718 self.field_id[cr.dbname] = res and res[0]
719 return self.field_id[cr.dbname]
721 def __init__(self, obj_prop, **args):
723 function.__init__(self, self._fnct_read, False, self._fnct_write,
724 (obj_prop, ), **args)
730 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: