1 # -*- encoding: utf-8 -*-
2 ##############################################################################
4 # OpenERP, Open Source Management Solution
5 # Copyright (C) 2004-2008 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
38 from psycopg2 import Binary
44 def _symbol_set(symb):
45 if symb == None or symb == False:
47 elif isinstance(symb, unicode):
48 return symb.encode('utf-8')
52 class _column(object):
60 _symbol_f = _symbol_set
61 _symbol_set = (_symbol_c, _symbol_f)
64 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):
65 self.states = states or {}
67 self.readonly = readonly
68 self.required = required
70 self.help = args.get('help', '')
71 self.priority = priority
72 self.change_default = change_default
73 self.ondelete = ondelete
74 self.translate = translate
75 self._domain = domain or []
76 self._context = context
83 setattr(self, a, args[a])
88 def set(self, cr, obj, id, name, value, user=None, context=None):
89 cr.execute('update '+obj._table+' set '+name+'='+self._symbol_set[0]+' where id=%s', (self._symbol_set[1](value), id))
91 def set_memory(self, cr, obj, id, name, value, user=None, context=None):
92 raise Exception(_('Not implemented set_memory method !'))
94 def get_memory(self, cr, obj, ids, name, user=None, context=None, values=None):
95 raise Exception(_('Not implemented get_memory method !'))
97 def get(self, cr, obj, ids, name, user=None, offset=0, context=None, values=None):
98 raise Exception(_('undefined get method !'))
100 def search(self, cr, obj, args, name, value, offset=0, limit=None, uid=None):
101 ids = obj.search(cr, uid, args+self._domain+[(name, 'ilike', value)], offset, limit)
102 res = obj.read(cr, uid, ids, [name])
103 return [x[name] for x in res]
105 def search_memory(self, cr, obj, args, name, value, offset=0, limit=None, uid=None, context=None):
106 raise Exception(_('Not implemented search_memory method !'))
109 # ---------------------------------------------------------
111 # ---------------------------------------------------------
112 class boolean(_column):
115 _symbol_f = lambda x: x and 'True' or 'False'
116 _symbol_set = (_symbol_c, _symbol_f)
119 class integer_big(_column):
120 _type = 'integer_big'
122 _symbol_f = lambda x: int(x or 0)
123 _symbol_set = (_symbol_c, _symbol_f)
125 class integer(_column):
128 _symbol_f = lambda x: int(x or 0)
129 _symbol_set = (_symbol_c, _symbol_f)
132 class reference(_column):
135 def __init__(self, string, selection, size, **args):
136 _column.__init__(self, string=string, size=size, selection=selection, **args)
142 def __init__(self, string, size, **args):
143 _column.__init__(self, string=string, size=size, **args)
144 self._symbol_set = (self._symbol_c, self._symbol_set_char)
146 # takes a string (encoded in utf8) and returns a string (encoded in utf8)
147 def _symbol_set_char(self, symb):
149 # * we need to remove the "symb==False" from the next line BUT
150 # for now too many things rely on this broken behavior
151 # * the symb==None test should be common to all data types
152 if symb == None or symb == False:
155 # we need to convert the string to a unicode object to be able
156 # to evaluate its length (and possibly truncate it) reliably
157 if isinstance(symb, str):
158 u_symb = unicode(symb, 'utf8')
159 elif isinstance(symb, unicode):
162 u_symb = unicode(symb)
163 return u_symb[:self.size].encode('utf8')
171 class float(_column):
174 _symbol_f = lambda x: __builtin__.float(x or 0.0)
175 _symbol_set = (_symbol_c, _symbol_f)
177 def __init__(self, string='unknown', digits=None, **args):
178 _column.__init__(self, string=string, **args)
186 class datetime(_column):
194 class binary(_column):
197 _symbol_f = lambda symb: symb and Binary(symb) or None
198 _symbol_set = (_symbol_c, _symbol_f)
199 _symbol_get = lambda self, x: x and str(x)
201 _classic_read = False
203 def __init__(self, string='unknown', filters=None, **args):
204 _column.__init__(self, string=string, **args)
205 self.filters = filters
207 def get_memory(self, cr, obj, ids, name, user=None, context=None, values=None):
219 if context.get('bin_size', False):
220 res[i] = tools.human_size(val)
228 class selection(_column):
231 def __init__(self, selection, string='unknown', **args):
232 _column.__init__(self, string=string, **args)
233 self.selection = selection
235 # ---------------------------------------------------------
237 # ---------------------------------------------------------
240 # Values: (0, 0, { fields }) create
241 # (1, ID, { fields }) modification
242 # (2, ID) remove (delete)
243 # (3, ID) unlink one (target id or target of relation)
245 # (5) unlink all (only valid for one2many)
247 #CHECKME: dans la pratique c'est quoi la syntaxe utilisee pour le 5? (5) ou (5, 0)?
248 class one2one(_column):
249 _classic_read = False
250 _classic_write = True
253 def __init__(self, obj, string='unknown', **args):
254 warnings.warn("The one2one field doesn't work anymore", DeprecationWarning)
255 _column.__init__(self, string=string, **args)
258 def set(self, cr, obj_src, id, field, act, user=None, context=None):
261 obj = obj_src.pool.get(self._obj)
262 self._table = obj_src.pool.get(self._obj)._table
264 id_new = obj.create(cr, user, act[1])
265 cr.execute('update '+obj_src._table+' set '+field+'=%s where id=%s', (id_new, id))
267 cr.execute('select '+field+' from '+obj_src._table+' where id=%s', (act[0],))
268 id = cr.fetchone()[0]
269 obj.write(cr, user, [id], act[1], context=context)
271 def search(self, cr, obj, args, name, value, offset=0, limit=None, uid=None):
272 return obj.pool.get(self._obj).search(cr, uid, args+self._domain+[('name', 'like', value)], offset, limit)
275 class many2one(_column):
276 _classic_read = False
277 _classic_write = True
280 _symbol_f = lambda x: x or None
281 _symbol_set = (_symbol_c, _symbol_f)
283 def __init__(self, obj, string='unknown', **args):
284 _column.__init__(self, string=string, **args)
287 def set_memory(self, cr, obj, id, field, values, user=None, context=None):
288 obj.datas.setdefault(id, {})
289 obj.datas[id][field] = values
291 def get_memory(self, cr, obj, ids, name, user=None, context=None, values=None):
294 result[id] = obj.datas[id][name]
297 def get(self, cr, obj, ids, name, user=None, context=None, values=None):
304 res[r['id']] = r[name]
306 res.setdefault(id, '')
307 obj = obj.pool.get(self._obj)
308 # build a dictionary of the form {'id_of_distant_resource': name_of_distant_resource}
309 from orm import except_orm
311 names = dict(obj.name_get(cr, user, filter(None, res.values()), context))
315 iids = filter(None, res.values())
316 cr.execute('select id,'+obj._rec_name+' from '+obj._table+' where id in ('+','.join(map(str, iids))+')')
317 for res22 in cr.fetchall():
318 names[res22[0]] = res22[1]
321 if res[r] and res[r] in names:
322 res[r] = (res[r], names[res[r]])
327 def set(self, cr, obj_src, id, field, values, user=None, context=None):
330 obj = obj_src.pool.get(self._obj)
331 self._table = obj_src.pool.get(self._obj)._table
332 if type(values) == type([]):
335 id_new = obj.create(cr, act[2])
336 cr.execute('update '+obj_src._table+' set '+field+'=%s where id=%s', (id_new, id))
338 obj.write(cr, [act[1]], act[2], context=context)
340 cr.execute('delete from '+self._table+' where id=%s', (act[1],))
341 elif act[0] == 3 or act[0] == 5:
342 cr.execute('update '+obj_src._table+' set '+field+'=null where id=%s', (id,))
344 cr.execute('update '+obj_src._table+' set '+field+'=%s where id=%s', (act[1], id))
347 cr.execute('update '+obj_src._table+' set '+field+'=%s where id=%s', (values, id))
349 cr.execute('update '+obj_src._table+' set '+field+'=null where id=%s', (id,))
351 def search(self, cr, obj, args, name, value, offset=0, limit=None, uid=None):
352 return obj.pool.get(self._obj).search(cr, uid, args+self._domain+[('name', 'like', value)], offset, limit)
355 class one2many(_column):
356 _classic_read = False
357 _classic_write = False
360 def __init__(self, obj, fields_id, string='unknown', limit=None, **args):
361 _column.__init__(self, string=string, **args)
363 self._fields_id = fields_id
365 #one2many can't be used as condition for defaults
366 assert(self.change_default != True)
368 def get_memory(self, cr, obj, ids, name, user=None, offset=0, context=None, values=None):
376 ids2 = obj.pool.get(self._obj).search(cr, user, [(self._fields_id, 'in', ids)], limit=self._limit)
377 for r in obj.pool.get(self._obj).read(cr, user, ids2, [self._fields_id], context=context, load='_classic_write'):
378 if r[self._fields_id] in res:
379 res[r[self._fields_id]].append(r['id'])
382 def set_memory(self, cr, obj, id, field, values, user=None, context=None):
387 obj = obj.pool.get(self._obj)
390 act[2][self._fields_id] = id
391 obj.create(cr, user, act[2], context=context)
393 obj.write(cr, user, [act[1]], act[2], context=context)
395 obj.unlink(cr, user, [act[1]], context=context)
397 obj.datas[act[1]][self._fields_id] = False
399 obj.datas[act[1]] = id
401 for o in obj.datas.values():
402 if o[self._fields_id] == id:
403 o[self._fields_id] = False
405 for id2 in (act[2] or []):
406 obj.datas[id2][self._fields_id] = id
408 def search_memory(self, cr, obj, args, name, value, offset=0, limit=None, uid=None, operator='like', context=None):
409 raise _('Not Implemented')
411 def get(self, cr, obj, ids, name, user=None, offset=0, context=None, values=None):
419 ids2 = obj.pool.get(self._obj).search(cr, user, [(self._fields_id, 'in', ids)], limit=self._limit)
420 for r in obj.pool.get(self._obj)._read_flat(cr, user, ids2, [self._fields_id], context=context, load='_classic_write'):
421 res[r[self._fields_id]].append(r['id'])
424 def set(self, cr, obj, id, field, values, user=None, context=None):
429 _table = obj.pool.get(self._obj)._table
430 obj = obj.pool.get(self._obj)
433 act[2][self._fields_id] = id
434 obj.create(cr, user, act[2], context=context)
436 obj.write(cr, user, [act[1]], act[2], context=context)
438 obj.unlink(cr, user, [act[1]], context=context)
440 cr.execute('update '+_table+' set '+self._fields_id+'=null where id=%s', (act[1],))
442 cr.execute('update '+_table+' set '+self._fields_id+'=%s where id=%s', (id, act[1]))
444 cr.execute('update '+_table+' set '+self._fields_id+'=null where '+self._fields_id+'=%s', (id,))
450 cr.execute('update '+_table+' set '+self._fields_id+'=NULL where '+self._fields_id+'=%s and id not in ('+','.join(map(str, ids2))+')', (id,))
452 cr.execute('update '+_table+' set '+self._fields_id+'=%s where id in ('+','.join(map(str, act[2]))+')', (id,))
454 def search(self, cr, obj, args, name, value, offset=0, limit=None, uid=None, operator='like'):
455 return obj.pool.get(self._obj).name_search(cr, uid, value, self._domain, offset, limit)
459 # Values: (0, 0, { fields }) create
460 # (1, ID, { fields }) modification
465 # (6, ?, ids) set a list of links
467 class many2many(_column):
468 _classic_read = False
469 _classic_write = False
472 def __init__(self, obj, rel, id1, id2, string='unknown', limit=None, **args):
473 _column.__init__(self, string=string, **args)
476 raise Exception(_('The second argument of the many2many field %s must be a SQL table !'\
477 'You used %s, which is not a valid SQL table name.')% (string,rel))
483 def get(self, cr, obj, ids, name, user=None, offset=0, context=None, values=None):
493 ids_s = ','.join(map(str, ids))
494 limit_str = self._limit is not None and ' limit %d' % self._limit or ''
495 obj = obj.pool.get(self._obj)
497 d1, d2 = obj.pool.get('ir.rule').domain_get(cr, user, obj._name)
501 cr.execute('SELECT '+self._rel+'.'+self._id2+','+self._rel+'.'+self._id1+' \
502 FROM '+self._rel+' , '+obj._table+' \
503 WHERE '+self._rel+'.'+self._id1+' in ('+ids_s+') \
504 AND '+self._rel+'.'+self._id2+' = '+obj._table+'.id '+d1
505 +limit_str+' order by '+obj._table+'.'+obj._order+' offset %s',
507 for r in cr.fetchall():
508 res[r[1]].append(r[0])
511 def set(self, cr, obj, id, name, values, user=None, context=None):
516 obj = obj.pool.get(self._obj)
519 idnew = obj.create(cr, user, act[2])
520 cr.execute('insert into '+self._rel+' ('+self._id1+','+self._id2+') values (%s,%s)', (id, idnew))
522 obj.write(cr, user, [act[1]], act[2], context=context)
524 obj.unlink(cr, user, [act[1]], context=context)
526 cr.execute('delete from '+self._rel+' where ' + self._id1 + '=%s and '+ self._id2 + '=%s', (id, act[1]))
528 cr.execute('insert into '+self._rel+' ('+self._id1+','+self._id2+') values (%s,%s)', (id, act[1]))
530 cr.execute('update '+self._rel+' set '+self._id2+'=null where '+self._id2+'=%s', (id,))
533 d1, d2 = obj.pool.get('ir.rule').domain_get(cr, user, obj._name)
536 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)
538 for act_nbr in act[2]:
539 cr.execute('insert into '+self._rel+' ('+self._id1+','+self._id2+') values (%s, %s)', (id, act_nbr))
542 # TODO: use a name_search
544 def search(self, cr, obj, args, name, value, offset=0, limit=None, uid=None, operator='like'):
545 return obj.pool.get(self._obj).search(cr, uid, args+self._domain+[('name', operator, value)], offset, limit)
547 def get_memory(self, cr, obj, ids, name, user=None, offset=0, context=None, values=None):
550 result[id] = obj.datas[id].get(name, [])
553 def set_memory(self, cr, obj, id, name, values, user=None, context=None):
557 # TODO: use constants instead of these magic numbers
559 raise _('Not Implemented')
561 raise _('Not Implemented')
563 raise _('Not Implemented')
565 raise _('Not Implemented')
567 raise _('Not Implemented')
569 raise _('Not Implemented')
571 obj.datas[id][name] = act[2]
574 # ---------------------------------------------------------
576 # ---------------------------------------------------------
577 class function(_column):
578 _classic_read = False
579 _classic_write = False
584 # multi: compute several fields in one call
586 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):
587 _column.__init__(self, **args)
589 self._method = method
591 self._fnct_inv = fnct_inv
594 if 'relation' in args:
595 self._obj = args['relation']
596 self._fnct_inv_arg = fnct_inv_arg
600 self._fnct_search = fnct_search
603 self._classic_read = True
604 self._classic_write = True
606 self._symbol_get=lambda x:x and str(x)
609 self._symbol_c = float._symbol_c
610 self._symbol_f = float._symbol_f
611 self._symbol_set = float._symbol_set
613 def search(self, cr, uid, obj, name, args):
614 if not self._fnct_search:
615 #CHECKME: should raise an exception
617 return self._fnct_search(obj, cr, uid, obj, name, args)
619 def get(self, cr, obj, ids, name, user=None, context=None, values=None):
626 res = self._fnct(obj, cr, user, ids, name, self._arg, context)
628 res = self._fnct(cr, obj._table, ids, name, self._arg, context)
630 if self._type == 'binary' and context.get('bin_size', False):
631 # convert the data returned by the function with the size of that data...
632 res = dict(map(lambda (x, y): (x, tools.human_size(len(y))), res.items()))
635 def set(self, cr, obj, id, name, value, user=None, context=None):
639 self._fnct_inv(obj, cr, user, id, name, value, self._fnct_inv_arg, context)
641 # ---------------------------------------------------------
643 # ---------------------------------------------------------
645 class related(function):
647 def _fnct_search(self, tobj, cr, uid, obj=None, name=None, domain=None, context={}):
648 self._field_get2(cr, uid, obj, context)
652 if type(sarg) in [type([]), type( (1,) )]:
653 where = [(self._arg[i], 'in', sarg)]
655 where = [(self._arg[i], '=', sarg)]
657 where = map(lambda x: (self._arg[i],x[1], x[2]), domain)
659 sarg = obj.pool.get(self._relations[i]['object']).search(cr, uid, where, context=context)
661 return [(self._arg[0], 'in', sarg)]
663 def _fnct_write(self,obj,cr, uid, ids, field_name, values, args, context=None):
664 if values and field_name:
665 self._field_get2(cr, uid, obj, context)
668 if type(ids) != type([]):
670 objlst = obj.browse(cr, uid, ids)
675 for i in range(len(self.arg)):
676 field_detail = self._relations[i]
677 relation = field_detail['object']
678 if not t_data[self.arg[i]]:
681 if field_detail['type'] in ('one2many', 'many2many'):
683 t_data = t_data[self.arg[i]][0]
686 t_data = t_data[self.arg[i]]
688 obj.pool.get(field_detail['object']).write(cr,uid,[t_id],{args[-1]:values})
690 def _fnct_read(self, obj, cr, uid, ids, field_name, args, context=None):
691 self._field_get2(cr, uid, obj, context)
692 if not ids: return {}
694 res = {}.fromkeys(ids, False)
695 objlst = obj.browse(cr, uid, ids)
701 for i in range(len(self.arg)):
702 field_detail = self._relations[i]
703 relation = field_detail['object']
705 if not t_data[self.arg[i]]:
711 if field_detail['type'] in ('one2many', 'many2many'):
712 t_data = t_data[self.arg[i]][0]
714 t_data = t_data[self.arg[i]]
715 if type(t_data) == type(objlst[0]):
716 # This should be improved, calling name_get
717 res[data.id] = (t_data.id,t_data.name)
719 res[data.id] = t_data
722 def __init__(self, *arg, **args):
725 super(related, self).__init__(self._fnct_read, arg, self._fnct_write, fnct_inv_arg=arg, method=True, fnct_search=self._fnct_search, **args)
727 def _field_get2(self, cr, uid, obj, context={}):
731 for i in range(len(self._arg)):
732 f = obj.pool.get(obj_name).fields_get(cr, uid, [self._arg[i]], context=context)[self._arg[i]]
733 self._relations.append({
738 if f.get('relation',False):
739 obj_name = f['relation']
740 self._relations[-1]['relation'] = f['relation']
742 # ---------------------------------------------------------
744 # ---------------------------------------------------------
745 class serialized(_column):
746 def __init__(self, string='unknown', serialize_func=repr, deserialize_func=eval, type='text', **args):
747 self._serialize_func = serialize_func
748 self._deserialize_func = deserialize_func
750 self._symbol_set = (self._symbol_c, self._serialize_func)
751 self._symbol_get = self._deserialize_func
752 super(serialized, self).__init__(string=string, **args)
755 class property(function):
757 def _fnct_write(self, obj, cr, uid, id, prop, id_val, val, context=None):
761 definition_id = self._field_get(cr, uid, obj._name, prop)
763 property = obj.pool.get('ir.property')
764 nid = property.search(cr, uid, [('fields_id', '=', definition_id),
765 ('res_id', '=', obj._name+','+str(id))])
767 cr.execute('DELETE FROM ir_property WHERE id=%s', (nid.pop(),))
769 nid = property.search(cr, uid, [('fields_id', '=', definition_id),
770 ('res_id', '=', False)])
773 default_val = property.browse(cr, uid, nid[0], context).value
775 company_id = obj.pool.get('res.users').company_get(cr, uid, uid)
777 newval = (id_val and obj_dest+','+str(id_val)) or False
778 if (newval != default_val) and newval:
779 propdef = obj.pool.get('ir.model.fields').browse(cr, uid,
780 definition_id, context=context)
781 res = property.create(cr, uid, {
782 'name': propdef.name,
784 'res_id': obj._name+','+str(id),
785 'company_id': company_id,
786 'fields_id': definition_id
790 def _fnct_read(self, obj, cr, uid, ids, prop, val, context=None):
793 property = obj.pool.get('ir.property')
794 definition_id = self._field_get(cr, uid, obj._name, prop)
796 nid = property.search(cr, uid, [('fields_id', '=', definition_id),
797 ('res_id', '=', False)])
800 d = property.browse(cr, uid, nid[0], context).value
801 default_val = (d and int(d.split(',')[1])) or False
803 vids = [obj._name + ',' + str(id) for id in ids]
804 nids = property.search(cr, uid, [('fields_id', '=', definition_id),
805 ('res_id', 'in', vids)])
809 res[id] = default_val
810 for prop in property.browse(cr, uid, nids):
811 res[int(prop.res_id.split(',')[1])] = (prop.value and \
812 int(prop.value.split(',')[1])) or False
814 obj = obj.pool.get(self._obj)
815 names = dict(obj.name_get(cr, uid, filter(None, res.values()), context))
817 if res[r] and res[r] in names:
818 res[r] = (res[r], names[res[r]])
823 def _field_get(self, cr, uid, model_name, prop):
824 if not self.field_id.get(cr.dbname):
825 cr.execute('SELECT id \
826 FROM ir_model_fields \
827 WHERE name=%s AND model=%s', (prop, model_name))
829 self.field_id[cr.dbname] = res and res[0]
830 return self.field_id[cr.dbname]
832 def __init__(self, obj_prop, **args):
834 function.__init__(self, self._fnct_read, False, self._fnct_write,
835 (obj_prop, ), **args)
841 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: