1 # -*- encoding: utf-8 -*-
2 ##############################################################################
4 # OpenERP, Open Source Management Solution
5 # Copyright (C) 2004-2009 Tiny SPRL (<http://tiny.be>). All Rights Reserved
8 # This program is free software: you can redistribute it and/or modify
9 # it under the terms of the GNU General Public License as published by
10 # the Free Software Foundation, either version 3 of the License, or
11 # (at your option) any later version.
13 # This program is distributed in the hope that it will be useful,
14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 # GNU General Public License for more details.
18 # You should have received a copy of the GNU General Public License
19 # along with this program. If not, see <http://www.gnu.org/licenses/>.
21 ##############################################################################
25 # - relations (one2many, many2one, many2many)
29 # _classic_read: is a classic sql fields
39 from psycopg2 import Binary
45 def _symbol_set(symb):
46 if symb == None or symb == False:
48 elif isinstance(symb, unicode):
49 return symb.encode('utf-8')
53 class _column(object):
61 _symbol_f = _symbol_set
62 _symbol_set = (_symbol_c, _symbol_f)
65 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):
66 self.states = states or {}
68 self.readonly = readonly
69 self.required = required
71 self.help = args.get('help', '')
72 self.priority = priority
73 self.change_default = change_default
74 self.ondelete = ondelete
75 self.translate = translate
76 self._domain = domain or []
77 self._context = context
84 setattr(self, a, args[a])
89 def set(self, cr, obj, id, name, value, user=None, context=None):
90 cr.execute('update '+obj._table+' set '+name+'='+self._symbol_set[0]+' where id=%s', (self._symbol_set[1](value), id))
92 def set_memory(self, cr, obj, id, name, value, user=None, context=None):
93 raise Exception(_('Not implemented set_memory method !'))
95 def get_memory(self, cr, obj, ids, name, user=None, context=None, values=None):
96 raise Exception(_('Not implemented get_memory method !'))
98 def get(self, cr, obj, ids, name, user=None, offset=0, context=None, values=None):
99 raise Exception(_('undefined get method !'))
101 def search(self, cr, obj, args, name, value, offset=0, limit=None, uid=None):
102 ids = obj.search(cr, uid, args+self._domain+[(name, 'ilike', value)], offset, limit)
103 res = obj.read(cr, uid, ids, [name])
104 return [x[name] for x in res]
106 def search_memory(self, cr, obj, args, name, value, offset=0, limit=None, uid=None, context=None):
107 raise Exception(_('Not implemented search_memory method !'))
110 # ---------------------------------------------------------
112 # ---------------------------------------------------------
113 class boolean(_column):
116 _symbol_f = lambda x: x and 'True' or 'False'
117 _symbol_set = (_symbol_c, _symbol_f)
120 class integer_big(_column):
121 _type = 'integer_big'
123 _symbol_f = lambda x: int(x or 0)
124 _symbol_set = (_symbol_c, _symbol_f)
126 class integer(_column):
129 _symbol_f = lambda x: int(x or 0)
130 _symbol_set = (_symbol_c, _symbol_f)
133 class reference(_column):
136 def __init__(self, string, selection, size, **args):
137 _column.__init__(self, string=string, size=size, selection=selection, **args)
143 def __init__(self, string, size, **args):
144 _column.__init__(self, string=string, size=size, **args)
145 self._symbol_set = (self._symbol_c, self._symbol_set_char)
147 # takes a string (encoded in utf8) and returns a string (encoded in utf8)
148 def _symbol_set_char(self, symb):
150 # * we need to remove the "symb==False" from the next line BUT
151 # for now too many things rely on this broken behavior
152 # * the symb==None test should be common to all data types
153 if symb == None or symb == False:
156 # we need to convert the string to a unicode object to be able
157 # to evaluate its length (and possibly truncate it) reliably
158 u_symb = tools.ustr(symb)
160 return u_symb[:self.size].encode('utf8')
168 class float(_column):
171 _symbol_f = lambda x: __builtin__.float(x or 0.0)
172 _symbol_set = (_symbol_c, _symbol_f)
174 def __init__(self, string='unknown', digits=None, **args):
175 _column.__init__(self, string=string, **args)
183 class datetime(_column):
191 class binary(_column):
194 _symbol_f = lambda symb: symb and Binary(symb) or None
195 _symbol_set = (_symbol_c, _symbol_f)
196 _symbol_get = lambda self, x: x and str(x)
198 _classic_read = False
200 def __init__(self, string='unknown', filters=None, **args):
201 _column.__init__(self, string=string, **args)
202 self.filters = filters
204 def get_memory(self, cr, obj, ids, name, user=None, context=None, values=None):
216 if context.get('bin_size', False) and val:
217 res[i] = tools.human_size(long(val))
225 class selection(_column):
228 def __init__(self, selection, string='unknown', **args):
229 _column.__init__(self, string=string, **args)
230 self.selection = selection
232 # ---------------------------------------------------------
234 # ---------------------------------------------------------
237 # Values: (0, 0, { fields }) create
238 # (1, ID, { fields }) modification
239 # (2, ID) remove (delete)
240 # (3, ID) unlink one (target id or target of relation)
242 # (5) unlink all (only valid for one2many)
244 #CHECKME: dans la pratique c'est quoi la syntaxe utilisee pour le 5? (5) ou (5, 0)?
245 class one2one(_column):
246 _classic_read = False
247 _classic_write = True
250 def __init__(self, obj, string='unknown', **args):
251 warnings.warn("The one2one field doesn't work anymore", DeprecationWarning)
252 _column.__init__(self, string=string, **args)
255 def set(self, cr, obj_src, id, field, act, user=None, context=None):
258 obj = obj_src.pool.get(self._obj)
259 self._table = obj_src.pool.get(self._obj)._table
261 id_new = obj.create(cr, user, act[1])
262 cr.execute('update '+obj_src._table+' set '+field+'=%s where id=%s', (id_new, id))
264 cr.execute('select '+field+' from '+obj_src._table+' where id=%s', (act[0],))
265 id = cr.fetchone()[0]
266 obj.write(cr, user, [id], act[1], context=context)
268 def search(self, cr, obj, args, name, value, offset=0, limit=None, uid=None):
269 return obj.pool.get(self._obj).search(cr, uid, args+self._domain+[('name', 'like', value)], offset, limit)
272 class many2one(_column):
273 _classic_read = False
274 _classic_write = True
277 _symbol_f = lambda x: x or None
278 _symbol_set = (_symbol_c, _symbol_f)
280 def __init__(self, obj, string='unknown', **args):
281 _column.__init__(self, string=string, **args)
284 def set_memory(self, cr, obj, id, field, values, user=None, context=None):
285 obj.datas.setdefault(id, {})
286 obj.datas[id][field] = values
288 def get_memory(self, cr, obj, ids, name, user=None, context=None, values=None):
291 result[id] = obj.datas[id][name]
294 def get(self, cr, obj, ids, name, user=None, context=None, values=None):
301 res[r['id']] = r[name]
303 res.setdefault(id, '')
304 obj = obj.pool.get(self._obj)
305 # build a dictionary of the form {'id_of_distant_resource': name_of_distant_resource}
306 from orm import except_orm
308 names = dict(obj.name_get(cr, user, filter(None, res.values()), context))
311 iids = filter(None, res.values())
313 names[iiid] = '// Access Denied //'
316 if res[r] and res[r] in names:
317 res[r] = (res[r], names[res[r]])
322 def set(self, cr, obj_src, id, field, values, user=None, context=None):
325 obj = obj_src.pool.get(self._obj)
326 self._table = obj_src.pool.get(self._obj)._table
327 if type(values) == type([]):
330 id_new = obj.create(cr, act[2])
331 cr.execute('update '+obj_src._table+' set '+field+'=%s where id=%s', (id_new, id))
333 obj.write(cr, [act[1]], act[2], context=context)
335 cr.execute('delete from '+self._table+' where id=%s', (act[1],))
336 elif act[0] == 3 or act[0] == 5:
337 cr.execute('update '+obj_src._table+' set '+field+'=null where id=%s', (id,))
339 cr.execute('update '+obj_src._table+' set '+field+'=%s where id=%s', (act[1], id))
342 cr.execute('update '+obj_src._table+' set '+field+'=%s where id=%s', (values, id))
344 cr.execute('update '+obj_src._table+' set '+field+'=null where id=%s', (id,))
346 def search(self, cr, obj, args, name, value, offset=0, limit=None, uid=None):
347 return obj.pool.get(self._obj).search(cr, uid, args+self._domain+[('name', 'like', value)], offset, limit)
350 class one2many(_column):
351 _classic_read = False
352 _classic_write = False
355 def __init__(self, obj, fields_id, string='unknown', limit=None, **args):
356 _column.__init__(self, string=string, **args)
358 self._fields_id = fields_id
360 #one2many can't be used as condition for defaults
361 assert(self.change_default != True)
363 def get_memory(self, cr, obj, ids, name, user=None, offset=0, context=None, values=None):
371 ids2 = obj.pool.get(self._obj).search(cr, user, [(self._fields_id, 'in', ids)], limit=self._limit)
372 for r in obj.pool.get(self._obj).read(cr, user, ids2, [self._fields_id], context=context, load='_classic_write'):
373 if r[self._fields_id] in res:
374 res[r[self._fields_id]].append(r['id'])
377 def set_memory(self, cr, obj, id, field, values, user=None, context=None):
382 obj = obj.pool.get(self._obj)
385 act[2][self._fields_id] = id
386 obj.create(cr, user, act[2], context=context)
388 obj.write(cr, user, [act[1]], act[2], context=context)
390 obj.unlink(cr, user, [act[1]], context=context)
392 obj.datas[act[1]][self._fields_id] = False
394 obj.datas[act[1]] = id
396 for o in obj.datas.values():
397 if o[self._fields_id] == id:
398 o[self._fields_id] = False
400 for id2 in (act[2] or []):
401 obj.datas[id2][self._fields_id] = id
403 def search_memory(self, cr, obj, args, name, value, offset=0, limit=None, uid=None, operator='like', context=None):
404 raise _('Not Implemented')
406 def get(self, cr, obj, ids, name, user=None, offset=0, context=None, values=None):
414 ids2 = obj.pool.get(self._obj).search(cr, user, [(self._fields_id, 'in', ids)], limit=self._limit)
415 for r in obj.pool.get(self._obj)._read_flat(cr, user, ids2, [self._fields_id], context=context, load='_classic_write'):
416 res[r[self._fields_id]].append(r['id'])
419 def set(self, cr, obj, id, field, values, user=None, context=None):
424 _table = obj.pool.get(self._obj)._table
425 obj = obj.pool.get(self._obj)
428 act[2][self._fields_id] = id
429 obj.create(cr, user, act[2], context=context)
431 obj.write(cr, user, [act[1]], act[2], context=context)
433 obj.unlink(cr, user, [act[1]], context=context)
435 cr.execute('update '+_table+' set '+self._fields_id+'=null where id=%s', (act[1],))
437 cr.execute('update '+_table+' set '+self._fields_id+'=%s where id=%s', (id, act[1]))
439 cr.execute('update '+_table+' set '+self._fields_id+'=null where '+self._fields_id+'=%s', (id,))
445 cr.execute('update '+_table+' set '+self._fields_id+'=NULL where '+self._fields_id+'=%s and id not in ('+','.join(map(str, ids2))+')', (id,))
447 cr.execute('update '+_table+' set '+self._fields_id+'=%s where id in ('+','.join(map(str, act[2]))+')', (id,))
449 def search(self, cr, obj, args, name, value, offset=0, limit=None, uid=None, operator='like'):
450 return obj.pool.get(self._obj).name_search(cr, uid, value, self._domain, offset, limit)
454 # Values: (0, 0, { fields }) create
455 # (1, ID, { fields }) modification
460 # (6, ?, ids) set a list of links
462 class many2many(_column):
463 _classic_read = False
464 _classic_write = False
467 def __init__(self, obj, rel, id1, id2, string='unknown', limit=None, **args):
468 _column.__init__(self, string=string, **args)
471 raise Exception(_('The second argument of the many2many field %s must be a SQL table !'\
472 'You used %s, which is not a valid SQL table name.')% (string,rel))
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 %s',
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 (%s,%s)', (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 + '=%s and '+ self._id2 + '=%s', (id, act[1]))
523 cr.execute('insert into '+self._rel+' ('+self._id1+','+self._id2+') values (%s,%s)', (id, act[1]))
525 cr.execute('update '+self._rel+' set '+self._id2+'=null where '+self._id2+'=%s', (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+'=%s AND '+self._id2+' IN (SELECT '+self._rel+'.'+self._id2+' FROM '+self._rel+', '+obj._table+' WHERE '+self._rel+'.'+self._id1+'=%s 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 (%s, %s)', (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._classic_read = True
599 self._classic_write = True
601 self._symbol_get=lambda x:x and str(x)
604 self._symbol_c = float._symbol_c
605 self._symbol_f = float._symbol_f
606 self._symbol_set = float._symbol_set
608 def search(self, cr, uid, obj, name, args):
609 if not self._fnct_search:
610 #CHECKME: should raise an exception
612 return self._fnct_search(obj, cr, uid, obj, name, args)
614 def get(self, cr, obj, ids, name, user=None, context=None, values=None):
621 res = self._fnct(obj, cr, user, ids, name, self._arg, context)
623 res = self._fnct(cr, obj._table, ids, name, self._arg, context)
625 if self._type == 'binary' and context.get('bin_size', False):
626 # convert the data returned by the function with the size of that data...
627 res = dict(map(lambda (x, y): (x, tools.human_size(len(y))), res.items()))
630 def set(self, cr, obj, id, name, value, user=None, context=None):
634 self._fnct_inv(obj, cr, user, id, name, value, self._fnct_inv_arg, context)
636 # ---------------------------------------------------------
638 # ---------------------------------------------------------
640 class related(function):
642 def _fnct_search(self, tobj, cr, uid, obj=None, name=None, domain=None, context={}):
643 self._field_get2(cr, uid, obj, context)
647 if type(sarg) in [type([]), type( (1,) )]:
648 where = [(self._arg[i], 'in', sarg)]
650 where = [(self._arg[i], '=', sarg)]
652 where = map(lambda x: (self._arg[i],x[1], x[2]), domain)
654 sarg = obj.pool.get(self._relations[i]['object']).search(cr, uid, where, context=context)
656 return [(self._arg[0], 'in', sarg)]
658 def _fnct_write(self,obj,cr, uid, ids, field_name, values, args, context=None):
659 if values and field_name:
660 self._field_get2(cr, uid, obj, context)
663 if type(ids) != type([]):
665 objlst = obj.browse(cr, uid, ids)
670 for i in range(len(self.arg)):
671 field_detail = self._relations[i]
672 relation = field_detail['object']
673 if not t_data[self.arg[i]]:
676 if field_detail['type'] in ('one2many', 'many2many'):
678 t_data = t_data[self.arg[i]][0]
681 t_data = t_data[self.arg[i]]
683 obj.pool.get(field_detail['object']).write(cr,uid,[t_id],{args[-1]:values})
685 def _fnct_read(self, obj, cr, uid, ids, field_name, args, context=None):
686 self._field_get2(cr, uid, obj, context)
687 if not ids: return {}
689 res = {}.fromkeys(ids, False)
690 objlst = obj.browse(cr, uid, ids)
696 for i in range(len(self.arg)):
697 field_detail = self._relations[i]
698 relation = field_detail['object']
700 if not t_data[self.arg[i]]:
706 if field_detail['type'] in ('one2many', 'many2many'):
707 t_data = t_data[self.arg[i]][0]
709 t_data = t_data[self.arg[i]]
710 if type(t_data) == type(objlst[0]):
711 res[data.id] = t_data.id
713 res[data.id] = t_data
715 if self._type=='many2one':
716 ids = filter(None, res.values())
718 ng = dict(obj.pool.get(self._obj).name_get(cr, uid, ids, context=context))
721 res[r] = (res[r], ng[res[r]])
724 def __init__(self, *arg, **args):
727 super(related, self).__init__(self._fnct_read, arg, self._fnct_write, fnct_inv_arg=arg, method=True, fnct_search=self._fnct_search, **args)
729 def _field_get2(self, cr, uid, obj, context={}):
733 for i in range(len(self._arg)):
734 f = obj.pool.get(obj_name).fields_get(cr, uid, [self._arg[i]], context=context)[self._arg[i]]
735 self._relations.append({
740 if f.get('relation',False):
741 obj_name = f['relation']
742 self._relations[-1]['relation'] = f['relation']
744 # ---------------------------------------------------------
746 # ---------------------------------------------------------
747 class serialized(_column):
748 def __init__(self, string='unknown', serialize_func=repr, deserialize_func=eval, type='text', **args):
749 self._serialize_func = serialize_func
750 self._deserialize_func = deserialize_func
752 self._symbol_set = (self._symbol_c, self._serialize_func)
753 self._symbol_get = self._deserialize_func
754 super(serialized, self).__init__(string=string, **args)
757 class property(function):
759 def _fnct_write(self, obj, cr, uid, id, prop, id_val, val, context=None):
763 definition_id = self._field_get(cr, uid, obj._name, prop)
765 property = obj.pool.get('ir.property')
766 nid = property.search(cr, uid, [('fields_id', '=', definition_id),
767 ('res_id', '=', obj._name+','+str(id))])
769 cr.execute('DELETE FROM ir_property WHERE id=%s', (nid.pop(),))
771 nid = property.search(cr, uid, [('fields_id', '=', definition_id),
772 ('res_id', '=', False)])
775 default_val = property.browse(cr, uid, nid[0], context).value
777 company_id = obj.pool.get('res.users').company_get(cr, uid, uid)
779 newval = (id_val and obj_dest+','+str(id_val)) or False
780 if (newval != default_val) and newval:
781 propdef = obj.pool.get('ir.model.fields').browse(cr, uid,
782 definition_id, context=context)
783 res = property.create(cr, uid, {
784 'name': propdef.name,
786 'res_id': obj._name+','+str(id),
787 'company_id': company_id,
788 'fields_id': definition_id
792 def _fnct_read(self, obj, cr, uid, ids, prop, val, context=None):
795 property = obj.pool.get('ir.property')
796 definition_id = self._field_get(cr, uid, obj._name, prop)
798 nid = property.search(cr, uid, [('fields_id', '=', definition_id),
799 ('res_id', '=', False)])
802 d = property.browse(cr, uid, nid[0], context).value
803 default_val = (d and int(d.split(',')[1])) or False
805 vids = [obj._name + ',' + str(id) for id in ids]
806 nids = property.search(cr, uid, [('fields_id', '=', definition_id),
807 ('res_id', 'in', vids)])
811 res[id] = default_val
812 for prop in property.browse(cr, uid, nids):
813 res[int(prop.res_id.split(',')[1])] = (prop.value and \
814 int(prop.value.split(',')[1])) or False
816 obj = obj.pool.get(self._obj)
817 names = dict(obj.name_get(cr, uid, filter(None, res.values()), context))
819 if res[r] and res[r] in names:
820 res[r] = (res[r], names[res[r]])
825 def _field_get(self, cr, uid, model_name, prop):
826 if not self.field_id.get(cr.dbname):
827 cr.execute('SELECT id \
828 FROM ir_model_fields \
829 WHERE name=%s AND model=%s', (prop, model_name))
831 self.field_id[cr.dbname] = res and res[0]
832 return self.field_id[cr.dbname]
834 def __init__(self, obj_prop, **args):
836 function.__init__(self, self._fnct_read, False, self._fnct_write,
837 (obj_prop, ), **args)
843 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: