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):
62 _symbol_f = _symbol_set
63 _symbol_set = (_symbol_c, _symbol_f)
66 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):
67 self.states = states or {}
69 self.readonly = readonly
70 self.required = required
72 self.help = args.get('help', '')
73 self.priority = priority
74 self.change_default = change_default
75 self.ondelete = ondelete
76 self.translate = translate
77 self._domain = domain or []
78 self._context = context
85 setattr(self, a, args[a])
90 def set(self, cr, obj, id, name, value, user=None, context=None):
91 cr.execute('update '+obj._table+' set '+name+'='+self._symbol_set[0]+' where id=%s', (self._symbol_set[1](value), id))
93 def set_memory(self, cr, obj, id, name, value, user=None, context=None):
94 raise Exception(_('Not implemented set_memory method !'))
96 def get_memory(self, cr, obj, ids, name, user=None, context=None, values=None):
97 raise Exception(_('Not implemented get_memory method !'))
99 def get(self, cr, obj, ids, name, user=None, offset=0, context=None, values=None):
100 raise Exception(_('undefined get method !'))
102 def search(self, cr, obj, args, name, value, offset=0, limit=None, uid=None):
103 ids = obj.search(cr, uid, args+self._domain+[(name, 'ilike', value)], offset, limit)
104 res = obj.read(cr, uid, ids, [name])
105 return [x[name] for x in res]
107 def search_memory(self, cr, obj, args, name, value, offset=0, limit=None, uid=None, context=None):
108 raise Exception(_('Not implemented search_memory method !'))
111 # ---------------------------------------------------------
113 # ---------------------------------------------------------
114 class boolean(_column):
117 _symbol_f = lambda x: x and 'True' or 'False'
118 _symbol_set = (_symbol_c, _symbol_f)
121 class integer_big(_column):
122 _type = 'integer_big'
124 _symbol_f = lambda x: int(x or 0)
125 _symbol_set = (_symbol_c, _symbol_f)
127 class integer(_column):
130 _symbol_f = lambda x: int(x or 0)
131 _symbol_set = (_symbol_c, _symbol_f)
134 class reference(_column):
137 def __init__(self, string, selection, size, **args):
138 _column.__init__(self, string=string, size=size, selection=selection, **args)
144 def __init__(self, string, size, **args):
145 _column.__init__(self, string=string, size=size, **args)
146 self._symbol_set = (self._symbol_c, self._symbol_set_char)
148 # takes a string (encoded in utf8) and returns a string (encoded in utf8)
149 def _symbol_set_char(self, symb):
151 # * we need to remove the "symb==False" from the next line BUT
152 # for now too many things rely on this broken behavior
153 # * the symb==None test should be common to all data types
154 if symb == None or symb == False:
157 # we need to convert the string to a unicode object to be able
158 # to evaluate its length (and possibly truncate it) reliably
159 u_symb = tools.ustr(symb)
161 return u_symb[:self.size].encode('utf8')
169 class float(_column):
172 _symbol_f = lambda x: __builtin__.float(x or 0.0)
173 _symbol_set = (_symbol_c, _symbol_f)
175 def __init__(self, string='unknown', digits=None, **args):
176 _column.__init__(self, string=string, **args)
184 class datetime(_column):
192 class binary(_column):
195 _symbol_f = lambda symb: symb and Binary(symb) or None
196 _symbol_set = (_symbol_c, _symbol_f)
197 _symbol_get = lambda self, x: x and str(x)
199 _classic_read = False
202 def __init__(self, string='unknown', filters=None, **args):
203 _column.__init__(self, string=string, **args)
204 self.filters = filters
206 def get_memory(self, cr, obj, ids, name, user=None, context=None, values=None):
218 if context.get('bin_size', False) and val:
219 res[i] = tools.human_size(long(val))
227 class selection(_column):
230 def __init__(self, selection, string='unknown', **args):
231 _column.__init__(self, string=string, **args)
232 self.selection = selection
234 # ---------------------------------------------------------
236 # ---------------------------------------------------------
239 # Values: (0, 0, { fields }) create
240 # (1, ID, { fields }) modification
241 # (2, ID) remove (delete)
242 # (3, ID) unlink one (target id or target of relation)
244 # (5) unlink all (only valid for one2many)
246 #CHECKME: dans la pratique c'est quoi la syntaxe utilisee pour le 5? (5) ou (5, 0)?
247 class one2one(_column):
248 _classic_read = False
249 _classic_write = True
252 def __init__(self, obj, string='unknown', **args):
253 warnings.warn("The one2one field doesn't work anymore", DeprecationWarning)
254 _column.__init__(self, string=string, **args)
257 def set(self, cr, obj_src, id, field, act, user=None, context=None):
260 obj = obj_src.pool.get(self._obj)
261 self._table = obj_src.pool.get(self._obj)._table
263 id_new = obj.create(cr, user, act[1])
264 cr.execute('update '+obj_src._table+' set '+field+'=%s where id=%s', (id_new, id))
266 cr.execute('select '+field+' from '+obj_src._table+' where id=%s', (act[0],))
267 id = cr.fetchone()[0]
268 obj.write(cr, user, [id], act[1], context=context)
270 def search(self, cr, obj, args, name, value, offset=0, limit=None, uid=None):
271 return obj.pool.get(self._obj).search(cr, uid, args+self._domain+[('name', 'like', value)], offset, limit)
274 class many2one(_column):
275 _classic_read = False
276 _classic_write = True
279 _symbol_f = lambda x: x or None
280 _symbol_set = (_symbol_c, _symbol_f)
282 def __init__(self, obj, string='unknown', **args):
283 _column.__init__(self, string=string, **args)
286 def set_memory(self, cr, obj, id, field, values, user=None, context=None):
287 obj.datas.setdefault(id, {})
288 obj.datas[id][field] = values
290 def get_memory(self, cr, obj, ids, name, user=None, context=None, values=None):
293 result[id] = obj.datas[id][name]
296 def get(self, cr, obj, ids, name, user=None, context=None, values=None):
303 res[r['id']] = r[name]
305 res.setdefault(id, '')
306 obj = obj.pool.get(self._obj)
307 # build a dictionary of the form {'id_of_distant_resource': name_of_distant_resource}
308 from orm import except_orm
310 names = dict(obj.name_get(cr, user, filter(None, res.values()), context))
313 iids = filter(None, res.values())
315 names[iiid] = '// Access Denied //'
318 if res[r] and res[r] in names:
319 res[r] = (res[r], names[res[r]])
324 def set(self, cr, obj_src, id, field, values, user=None, context=None):
327 obj = obj_src.pool.get(self._obj)
328 self._table = obj_src.pool.get(self._obj)._table
329 if type(values) == type([]):
332 id_new = obj.create(cr, act[2])
333 cr.execute('update '+obj_src._table+' set '+field+'=%s where id=%s', (id_new, id))
335 obj.write(cr, [act[1]], act[2], context=context)
337 cr.execute('delete from '+self._table+' where id=%s', (act[1],))
338 elif act[0] == 3 or act[0] == 5:
339 cr.execute('update '+obj_src._table+' set '+field+'=null where id=%s', (id,))
341 cr.execute('update '+obj_src._table+' set '+field+'=%s where id=%s', (act[1], id))
344 cr.execute('update '+obj_src._table+' set '+field+'=%s where id=%s', (values, id))
346 cr.execute('update '+obj_src._table+' set '+field+'=null where id=%s', (id,))
348 def search(self, cr, obj, args, name, value, offset=0, limit=None, uid=None):
349 return obj.pool.get(self._obj).search(cr, uid, args+self._domain+[('name', 'like', value)], offset, limit)
352 class one2many(_column):
353 _classic_read = False
354 _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):
370 context = context.copy()
371 context.update(self._context)
377 ids2 = obj.pool.get(self._obj).search(cr, user, [(self._fields_id, 'in', ids)], limit=self._limit, context=context)
378 for r in obj.pool.get(self._obj).read(cr, user, ids2, [self._fields_id], context=context, load='_classic_write'):
379 if r[self._fields_id] in res:
380 res[r[self._fields_id]].append(r['id'])
383 def set_memory(self, cr, obj, id, field, values, user=None, context=None):
387 context = context.copy()
388 context.update(self._context)
391 obj = obj.pool.get(self._obj)
394 act[2][self._fields_id] = id
395 obj.create(cr, user, act[2], context=context)
397 obj.write(cr, user, [act[1]], act[2], context=context)
399 obj.unlink(cr, user, [act[1]], context=context)
401 obj.datas[act[1]][self._fields_id] = False
403 obj.datas[act[1]] = id
405 for o in obj.datas.values():
406 if o[self._fields_id] == id:
407 o[self._fields_id] = False
409 for id2 in (act[2] or []):
410 obj.datas[id2][self._fields_id] = id
412 def search_memory(self, cr, obj, args, name, value, offset=0, limit=None, uid=None, operator='like', context=None):
413 raise _('Not Implemented')
415 def get(self, cr, obj, ids, name, user=None, offset=0, context=None, values=None):
419 context = context.copy()
420 context.update(self._context)
426 ids2 = obj.pool.get(self._obj).search(cr, user, [(self._fields_id, 'in', ids)], limit=self._limit, context=context)
427 for r in obj.pool.get(self._obj)._read_flat(cr, user, ids2, [self._fields_id], context=context, load='_classic_write'):
428 res[r[self._fields_id]].append(r['id'])
431 def set(self, cr, obj, id, field, values, user=None, context=None):
436 context = context.copy()
437 context.update(self._context)
438 context['no_store_function'] = True
441 _table = obj.pool.get(self._obj)._table
442 obj = obj.pool.get(self._obj)
445 act[2][self._fields_id] = id
446 id_new = obj.create(cr, user, act[2], context=context)
447 result += obj._store_get_values(cr, user, [id_new], act[2].keys(), context)
449 obj.write(cr, user, [act[1]], act[2], context=context)
451 obj.unlink(cr, user, [act[1]], context=context)
453 cr.execute('update '+_table+' set '+self._fields_id+'=null where id=%s', (act[1],))
455 cr.execute('update '+_table+' set '+self._fields_id+'=%s where id=%s', (id, act[1]))
457 cr.execute('update '+_table+' set '+self._fields_id+'=null where '+self._fields_id+'=%s', (id,))
459 obj.write(cr, user, act[2], {self._fields_id:id}, context=context or {})
461 cr.execute('select id from '+_table+' where '+self._fields_id+'=%s and id not in ('+','.join(map(str, ids2))+')', (id,))
462 ids3 = map(lambda x:x[0], cr.fetchall())
463 obj.write(cr, user, ids3, {self._fields_id:False}, context=context or {})
466 def search(self, cr, obj, args, name, value, offset=0, limit=None, uid=None, operator='like'):
467 return obj.pool.get(self._obj).name_search(cr, uid, value, self._domain, offset, limit)
471 # Values: (0, 0, { fields }) create
472 # (1, ID, { fields }) modification
477 # (6, ?, ids) set a list of links
479 class many2many(_column):
480 _classic_read = False
481 _classic_write = False
485 def __init__(self, obj, rel, id1, id2, string='unknown', limit=None, **args):
486 _column.__init__(self, string=string, **args)
489 raise Exception(_('The second argument of the many2many field %s must be a SQL table !'\
490 'You used %s, which is not a valid SQL table name.')% (string,rel))
496 def get(self, cr, obj, ids, name, user=None, offset=0, context=None, values=None):
506 ids_s = ','.join(map(str, ids))
507 limit_str = self._limit is not None and ' limit %d' % self._limit or ''
508 obj = obj.pool.get(self._obj)
510 d1, d2 = obj.pool.get('ir.rule').domain_get(cr, user, obj._name)
514 cr.execute('SELECT '+self._rel+'.'+self._id2+','+self._rel+'.'+self._id1+' \
515 FROM '+self._rel+' , '+obj._table+' \
516 WHERE '+self._rel+'.'+self._id1+' in ('+ids_s+') \
517 AND '+self._rel+'.'+self._id2+' = '+obj._table+'.id '+d1
518 +limit_str+' order by '+obj._table+'.'+obj._order+' offset %s',
520 for r in cr.fetchall():
521 res[r[1]].append(r[0])
524 def set(self, cr, obj, id, name, values, user=None, context=None):
529 obj = obj.pool.get(self._obj)
531 if not (isinstance(act, list) or isinstance(act, tuple)) or not act:
534 idnew = obj.create(cr, user, act[2])
535 cr.execute('insert into '+self._rel+' ('+self._id1+','+self._id2+') values (%s,%s)', (id, idnew))
537 obj.write(cr, user, [act[1]], act[2], context=context)
539 obj.unlink(cr, user, [act[1]], context=context)
541 cr.execute('delete from '+self._rel+' where ' + self._id1 + '=%s and '+ self._id2 + '=%s', (id, act[1]))
543 cr.execute('insert into '+self._rel+' ('+self._id1+','+self._id2+') values (%s,%s)', (id, act[1]))
545 cr.execute('update '+self._rel+' set '+self._id2+'=null where '+self._id2+'=%s', (id,))
548 d1, d2 = obj.pool.get('ir.rule').domain_get(cr, user, obj._name)
551 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)
553 for act_nbr in act[2]:
554 cr.execute('insert into '+self._rel+' ('+self._id1+','+self._id2+') values (%s, %s)', (id, act_nbr))
557 # TODO: use a name_search
559 def search(self, cr, obj, args, name, value, offset=0, limit=None, uid=None, operator='like'):
560 return obj.pool.get(self._obj).search(cr, uid, args+self._domain+[('name', operator, value)], offset, limit)
562 def get_memory(self, cr, obj, ids, name, user=None, offset=0, context=None, values=None):
565 result[id] = obj.datas[id].get(name, [])
568 def set_memory(self, cr, obj, id, name, values, user=None, context=None):
572 # TODO: use constants instead of these magic numbers
574 raise _('Not Implemented')
576 raise _('Not Implemented')
578 raise _('Not Implemented')
580 raise _('Not Implemented')
582 raise _('Not Implemented')
584 raise _('Not Implemented')
586 obj.datas[id][name] = act[2]
589 # ---------------------------------------------------------
591 # ---------------------------------------------------------
592 class function(_column):
593 _classic_read = False
594 _classic_write = False
600 # multi: compute several fields in one call
602 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):
603 _column.__init__(self, **args)
605 self._method = method
607 self._fnct_inv = fnct_inv
610 if 'relation' in args:
611 self._obj = args['relation']
614 self.digits = args['digits']
618 self._fnct_inv_arg = fnct_inv_arg
622 self._fnct_search = fnct_search
625 self._classic_read = True
626 self._classic_write = True
628 self._symbol_get=lambda x:x and str(x)
631 self._symbol_c = float._symbol_c
632 self._symbol_f = float._symbol_f
633 self._symbol_set = float._symbol_set
635 def search(self, cr, uid, obj, name, args):
636 if not self._fnct_search:
637 #CHECKME: should raise an exception
639 return self._fnct_search(obj, cr, uid, obj, name, args)
641 def get(self, cr, obj, ids, name, user=None, context=None, values=None):
648 res = self._fnct(obj, cr, user, ids, name, self._arg, context)
650 res = self._fnct(cr, obj._table, ids, name, self._arg, context)
652 if self._type == "many2one" :
653 # Filtering only integer/long values if passed
654 res_ids = [x for x in res.values() if x and isinstance(x, (int,long))]
657 obj_model = obj.pool.get(self._obj)
658 dict_names = dict(obj_model.name_get(cr, user, res_ids, context))
660 if res[r] and res[r] in dict_names:
661 res[r] = (res[r], dict_names[res[r]])
663 if self._type == 'binary' and context.get('bin_size', False):
664 # convert the data returned by the function with the size of that data...
665 res = dict(map(lambda (x, y): (x, tools.human_size(len(y or ''))), res.items()))
669 def set(self, cr, obj, id, name, value, user=None, context=None):
673 self._fnct_inv(obj, cr, user, id, name, value, self._fnct_inv_arg, context)
676 # ---------------------------------------------------------
678 # ---------------------------------------------------------
680 class related(function):
682 def _fnct_search(self, tobj, cr, uid, obj=None, name=None, domain=None, context={}):
683 self._field_get2(cr, uid, obj, context)
687 if type(sarg) in [type([]), type( (1,) )]:
688 where = [(self._arg[i], 'in', sarg)]
690 where = [(self._arg[i], '=', sarg)]
692 where = map(lambda x: (self._arg[i],x[1], x[2]), domain)
694 sarg = obj.pool.get(self._relations[i]['object']).search(cr, uid, where, context=context)
696 return [(self._arg[0], 'in', sarg)]
698 def _fnct_write(self,obj,cr, uid, ids, field_name, values, args, context=None):
699 if values and field_name:
700 self._field_get2(cr, uid, obj, context)
703 if type(ids) != type([]):
705 objlst = obj.browse(cr, uid, ids)
710 for i in range(len(self.arg)):
711 field_detail = self._relations[i]
712 relation = field_detail['object']
713 if not t_data[self.arg[i]]:
716 if field_detail['type'] in ('one2many', 'many2many'):
717 if self._type != "many2one":
719 t_data = t_data[self.arg[i]][0]
722 t_data = t_data[self.arg[i]]
724 obj.pool.get(field_detail['object']).write(cr,uid,[t_id],{args[-1]:values}, context=context)
726 def _fnct_read(self, obj, cr, uid, ids, field_name, args, context=None):
727 self._field_get2(cr, uid, obj, context)
728 if not ids: return {}
730 res = {}.fromkeys(ids, False)
731 objlst = obj.browse(cr, uid, ids)
737 for i in range(len(self.arg)):
738 field_detail = self._relations[i]
739 relation = field_detail['object']
741 if not t_data[self.arg[i]]:
747 if field_detail['type'] in ('one2many', 'many2many') and i != len(self.arg) - 1:
748 t_data = t_data[self.arg[i]][0]
750 t_data = t_data[self.arg[i]]
751 if type(t_data) == type(objlst[0]):
752 res[data.id] = t_data.id
754 res[data.id] = t_data
756 if self._type=='many2one':
757 ids = filter(None, res.values())
759 ng = dict(obj.pool.get(self._obj).name_get(cr, uid, ids, context=context))
762 res[r] = (res[r], ng[res[r]])
763 elif self._type in ('one2many', 'many2many'):
766 res[r] = [x.id for x in res[r]]
771 def __init__(self, *arg, **args):
774 super(related, self).__init__(self._fnct_read, arg, self._fnct_write, fnct_inv_arg=arg, method=True, fnct_search=self._fnct_search, **args)
776 def _field_get2(self, cr, uid, obj, context={}):
780 for i in range(len(self._arg)):
781 f = obj.pool.get(obj_name).fields_get(cr, uid, [self._arg[i]], context=context)[self._arg[i]]
782 self._relations.append({
787 if f.get('relation',False):
788 obj_name = f['relation']
789 self._relations[-1]['relation'] = f['relation']
791 # ---------------------------------------------------------
793 # ---------------------------------------------------------
794 class serialized(_column):
795 def __init__(self, string='unknown', serialize_func=repr, deserialize_func=eval, type='text', **args):
796 self._serialize_func = serialize_func
797 self._deserialize_func = deserialize_func
799 self._symbol_set = (self._symbol_c, self._serialize_func)
800 self._symbol_get = self._deserialize_func
801 super(serialized, self).__init__(string=string, **args)
804 class property(function):
806 def _fnct_write(self, obj, cr, uid, id, prop, id_val, val, context=None):
810 definition_id = self._field_get(cr, uid, obj._name, prop)
812 property = obj.pool.get('ir.property')
813 nid = property.search(cr, uid, [('fields_id', '=', definition_id),
814 ('res_id', '=', obj._name+','+str(id))])
816 cr.execute('DELETE FROM ir_property WHERE id=%s', (nid.pop(),))
818 nid = property.search(cr, uid, [('fields_id', '=', definition_id),
819 ('res_id', '=', False)])
822 default_val = property.browse(cr, uid, nid[0], context).value
824 company_id = obj.pool.get('res.users').company_get(cr, uid, uid)
826 newval = (id_val and obj_dest+','+str(id_val)) or False
827 if (newval != default_val) and newval:
828 propdef = obj.pool.get('ir.model.fields').browse(cr, uid,
829 definition_id, context=context)
830 res = property.create(cr, uid, {
831 'name': propdef.name,
833 'res_id': obj._name+','+str(id),
834 'company_id': company_id,
835 'fields_id': definition_id
839 def _fnct_read(self, obj, cr, uid, ids, prop, val, context=None):
842 property = obj.pool.get('ir.property')
843 definition_id = self._field_get(cr, uid, obj._name, prop)
845 nid = property.search(cr, uid, [('fields_id', '=', definition_id),
846 ('res_id', '=', False)])
849 d = property.browse(cr, uid, nid[0], context).value
850 default_val = (d and int(d.split(',')[1])) or False
852 vids = [obj._name + ',' + str(id) for id in ids]
853 nids = property.search(cr, uid, [('fields_id', '=', definition_id),
854 ('res_id', 'in', vids)])
858 res[id] = default_val
859 for prop in property.browse(cr, uid, nids):
860 res[int(prop.res_id.split(',')[1])] = (prop.value and \
861 int(prop.value.split(',')[1])) or False
863 obj = obj.pool.get(self._obj)
865 to_check = res.values()
866 if default_val and default_val not in to_check:
867 to_check += [default_val]
868 existing_ids = obj.search(cr, uid, [('id', 'in', to_check)])
870 for id, res_id in res.items():
871 if res_id not in existing_ids:
872 cr.execute('DELETE FROM ir_property WHERE value=%s', ((obj._name+','+str(res_id)),))
873 res[id] = default_val
875 names = dict(obj.name_get(cr, uid, existing_ids, context))
877 if res[r] and res[r] in names:
878 res[r] = (res[r], names[res[r]])
883 def _field_get(self, cr, uid, model_name, prop):
884 if not self.field_id.get(cr.dbname):
885 cr.execute('SELECT id \
886 FROM ir_model_fields \
887 WHERE name=%s AND model=%s', (prop, model_name))
889 self.field_id[cr.dbname] = res and res[0]
890 return self.field_id[cr.dbname]
892 def __init__(self, obj_prop, **args):
894 function.__init__(self, self._fnct_read, False, self._fnct_write,
895 (obj_prop, ), **args)
901 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: