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, context=None, values=None):
106 raise Exception(_('Not implemented get_memory method !'))
108 def get(self, cr, obj, ids, name, 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)
207 class selection(_column):
210 def __init__(self, selection, string='unknown', **args):
211 _column.__init__(self, string=string, **args)
212 self.selection = selection
214 # ---------------------------------------------------------
216 # ---------------------------------------------------------
219 # Values: (0, 0, { fields }) create
220 # (1, ID, { fields }) modification
221 # (2, ID) remove (delete)
222 # (3, ID) unlink one (target id or target of relation)
224 # (5) unlink all (only valid for one2many)
226 #CHECKME: dans la pratique c'est quoi la syntaxe utilisee pour le 5? (5) ou (5, 0)?
227 class one2one(_column):
228 _classic_read = False
229 _classic_write = True
232 def __init__(self, obj, string='unknown', **args):
233 warnings.warn("The one2one field doesn't work anymore", DeprecationWarning)
234 _column.__init__(self, string=string, **args)
237 def set(self, cr, obj_src, id, field, act, user=None, context=None):
240 obj = obj_src.pool.get(self._obj)
241 self._table = obj_src.pool.get(self._obj)._table
243 id_new = obj.create(cr, user, act[1])
244 cr.execute('update '+obj_src._table+' set '+field+'=%d where id=%d', (id_new, id))
246 cr.execute('select '+field+' from '+obj_src._table+' where id=%d', (act[0],))
247 id = cr.fetchone()[0]
248 obj.write(cr, user, [id], act[1], context=context)
250 def search(self, cr, obj, args, name, value, offset=0, limit=None, uid=None):
251 return obj.pool.get(self._obj).search(cr, uid, args+self._domain+[('name', 'like', value)], offset, limit)
254 class many2one(_column):
255 _classic_read = False
256 _classic_write = True
259 def __init__(self, obj, string='unknown', **args):
260 _column.__init__(self, string=string, **args)
264 # TODO: speed improvement
266 # name is the name of the relation field
267 def get_memory(self, cr, obj, ids, name, user=None, context=None, values=None):
270 result[id] = obj.datas[id][name]
273 def get(self, cr, obj, ids, name, user=None, context=None, values=None):
280 res[r['id']] = r[name]
282 res.setdefault(id, '')
283 obj = obj.pool.get(self._obj)
284 # build a dictionary of the form {'id_of_distant_resource': name_of_distant_resource}
285 from orm import except_orm
287 names = dict(obj.name_get(cr, user, filter(None, res.values()), context))
291 iids = filter(None, res.values())
292 cr.execute('select id,'+obj._rec_name+' from '+obj._table+' where id in ('+','.join(map(str, iids))+')')
293 for res22 in cr.fetchall():
294 names[res22[0]] = res22[1]
297 if res[r] and res[r] in names:
298 res[r] = (res[r], names[res[r]])
303 def set(self, cr, obj_src, id, field, values, user=None, context=None):
306 obj = obj_src.pool.get(self._obj)
307 self._table = obj_src.pool.get(self._obj)._table
308 if type(values)==type([]):
311 id_new = obj.create(cr, act[2])
312 cr.execute('update '+obj_src._table+' set '+field+'=%d where id=%d', (id_new, id))
314 obj.write(cr, [act[1]], act[2], context=context)
316 cr.execute('delete from '+self._table+' where id=%d', (act[1],))
317 elif act[0] == 3 or act[0] == 5:
318 cr.execute('update '+obj_src._table+' set '+field+'=null where id=%d', (id,))
320 cr.execute('update '+obj_src._table+' set '+field+'=%d where id=%d', (act[1], id))
323 cr.execute('update '+obj_src._table+' set '+field+'=%d where id=%d', (values, id))
325 cr.execute('update '+obj_src._table+' set '+field+'=null where id=%d', (id,))
327 def search(self, cr, obj, args, name, value, offset=0, limit=None, uid=None):
328 return obj.pool.get(self._obj).search(cr, uid, args+self._domain+[('name', 'like', value)], offset, limit)
331 class one2many(_column):
332 _classic_read = False
333 _classic_write = False
336 def __init__(self, obj, fields_id, string='unknown', limit=None, **args):
337 _column.__init__(self, string=string, **args)
339 self._fields_id = fields_id
341 #one2many can't be used as condition for defaults
342 assert(self.change_default != True)
344 def get_memory(self, cr, obj, ids, name, user=None, offset=0, context=None, values=None):
352 ids2 = obj.pool.get(self._obj).search(cr, user, [(self._fields_id, 'in', ids)], limit=self._limit)
353 for r in obj.pool.get(self._obj).read(cr, user, ids2, [self._fields_id], context=context, load='_classic_write'):
354 if r[self._fields_id] in res:
355 res[r[self._fields_id]].append(r['id'])
358 def set_memory(self, cr, obj, id, field, values, user=None, context=None):
363 obj = obj.pool.get(self._obj)
366 act[2][self._fields_id] = id
367 obj.create(cr, user, act[2], context=context)
369 obj.write(cr, user, [act[1]], act[2], context=context)
371 obj.unlink(cr, user, [act[1]], context=context)
373 obj.datas[act[1]][self._fields_id] = False
375 obj.datas[act[1]] = id
377 for o in obj.datas.values():
378 if o[self._fields_id] == id:
379 o[self._fields_id] = False
381 for id2 in (act[2] or []):
382 obj.datas[id2][self._fields_id] = id
384 def search_memory(self, cr, obj, args, name, value, offset=0, limit=None, uid=None, operator='like', context=None):
385 raise _('Not Implemented')
387 def get(self, cr, obj, ids, name, user=None, offset=0, context=None, values=None):
395 ids2 = obj.pool.get(self._obj).search(cr, user, [(self._fields_id, 'in', ids)], limit=self._limit)
396 for r in obj.pool.get(self._obj)._read_flat(cr, user, ids2, [self._fields_id], context=context, load='_classic_write'):
397 res[r[self._fields_id]].append(r['id'])
400 def set(self, cr, obj, id, field, values, user=None, context=None):
405 _table = obj.pool.get(self._obj)._table
406 obj = obj.pool.get(self._obj)
409 act[2][self._fields_id] = id
410 obj.create(cr, user, act[2], context=context)
412 obj.write(cr, user, [act[1]], act[2], context=context)
414 obj.unlink(cr, user, [act[1]], context=context)
416 cr.execute('update '+_table+' set '+self._fields_id+'=null where id=%d', (act[1],))
418 cr.execute('update '+_table+' set '+self._fields_id+'=%d where id=%d', (id, act[1]))
420 cr.execute('update '+_table+' set '+self._fields_id+'=null where '+self._fields_id+'=%d', (id,))
426 cr.execute('update '+_table+' set '+self._fields_id+'=NULL where '+self._fields_id+'=%d and id not in ('+','.join(map(str, ids2))+')', (id,))
428 cr.execute('update '+_table+' set '+self._fields_id+'=%d where id in ('+','.join(map(str, act[2]))+')', (id,))
430 def search(self, cr, obj, args, name, value, offset=0, limit=None, uid=None, operator='like'):
431 return obj.pool.get(self._obj).name_search(cr, uid, value, self._domain, offset, limit)
435 # Values: (0, 0, { fields }) create
436 # (1, ID, { fields }) modification
441 # (6, ?, ids) set a list of links
443 class many2many(_column):
444 _classic_read = False
445 _classic_write = False
448 def __init__(self, obj, rel, id1, id2, string='unknown', limit=None, **args):
449 _column.__init__(self, string=string, **args)
456 def get(self, cr, obj, ids, name, user=None, offset=0, context=None, values=None):
466 ids_s = ','.join(map(str, ids))
467 limit_str = self._limit is not None and ' limit %d' % self._limit or ''
468 obj = obj.pool.get(self._obj)
470 d1, d2 = obj.pool.get('ir.rule').domain_get(cr, user, obj._name)
474 cr.execute('SELECT '+self._rel+'.'+self._id2+','+self._rel+'.'+self._id1+' \
475 FROM '+self._rel+' , '+obj._table+' \
476 WHERE '+self._rel+'.'+self._id1+' in ('+ids_s+') \
477 AND '+self._rel+'.'+self._id2+' = '+obj._table+'.id '+d1
478 +limit_str+' order by '+obj._table+'.'+obj._order+' offset %d',
480 for r in cr.fetchall():
481 res[r[1]].append(r[0])
484 def set(self, cr, obj, id, name, values, user=None, context=None):
489 obj = obj.pool.get(self._obj)
492 idnew = obj.create(cr, user, act[2])
493 cr.execute('insert into '+self._rel+' ('+self._id1+','+self._id2+') values (%d,%d)', (id, idnew))
495 obj.write(cr, user, [act[1]], act[2], context=context)
497 obj.unlink(cr, user, [act[1]], context=context)
499 cr.execute('delete from '+self._rel+' where ' + self._id1 + '=%d and '+ self._id2 + '=%d', (id, act[1]))
501 cr.execute('insert into '+self._rel+' ('+self._id1+','+self._id2+') values (%d,%d)', (id, act[1]))
503 cr.execute('update '+self._rel+' set '+self._id2+'=null where '+self._id2+'=%d', (id,))
506 d1, d2 = obj.pool.get('ir.rule').domain_get(cr, user, obj._name)
509 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)
511 for act_nbr in act[2]:
512 cr.execute('insert into '+self._rel+' ('+self._id1+','+self._id2+') values (%d, %d)', (id, act_nbr))
515 # TODO: use a name_search
517 def search(self, cr, obj, args, name, value, offset=0, limit=None, uid=None, operator='like'):
518 return obj.pool.get(self._obj).search(cr, uid, args+self._domain+[('name', operator, value)], offset, limit)
520 def get_memory(self, cr, obj, ids, name, user=None, offset=0, context=None, values=None):
523 result[id] = obj.datas[id].get(name, [])
526 def set_memory(self, cr, obj, id, name, values, user=None, context=None):
530 # TODO: use constants instead of these magic numbers
532 raise _('Not Implemented')
534 raise _('Not Implemented')
536 raise _('Not Implemented')
538 raise _('Not Implemented')
540 raise _('Not Implemented')
542 raise _('Not Implemented')
544 obj.datas[id][name] = act[2]
547 # ---------------------------------------------------------
549 # ---------------------------------------------------------
550 class function(_column):
551 _classic_read = False
552 _classic_write = False
557 # multi: compute several fields in one call
559 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):
560 _column.__init__(self, **args)
562 self._method = method
564 self._fnct_inv = fnct_inv
567 if 'relation' in args:
568 self._obj = args['relation']
569 self._fnct_inv_arg = fnct_inv_arg
573 self._fnct_search = fnct_search
576 self._symbol_c = '%f'
577 self._symbol_f = lambda x: __builtin__.float(x or 0.0)
578 self._symbol_set = (self._symbol_c, self._symbol_f)
580 def search(self, cr, uid, obj, name, args):
581 if not self._fnct_search:
582 #CHECKME: should raise an exception
584 return self._fnct_search(obj, cr, uid, obj, name, args)
586 def get(self, cr, obj, ids, name, user=None, context=None, values=None):
593 return self._fnct(obj, cr, user, ids, name, self._arg, context)
595 return self._fnct(cr, obj._table, ids, name, self._arg, context)
597 def set(self, cr, obj, id, name, value, user=None, context=None):
601 self._fnct_inv(obj, cr, user, id, name, value, self._fnct_inv_arg, context)
604 # ---------------------------------------------------------
606 # ---------------------------------------------------------
607 class serialized(_column):
608 def __init__(self, string='unknown', serialize_func=repr, deserialize_func=eval, type='text', **args):
609 self._serialize_func = serialize_func
610 self._deserialize_func = deserialize_func
612 self._symbol_set = (self._symbol_c, self._serialize_func)
613 self._symbol_get = self._deserialize_func
614 super(serialized, self).__init__(string=string, **args)
617 class property(function):
619 def _fnct_write(self, obj, cr, uid, id, prop, id_val, val, context=None):
623 definition_id = self._field_get(cr, uid, obj._name, prop)
625 property = obj.pool.get('ir.property')
626 nid = property.search(cr, uid, [('fields_id', '=', definition_id),
627 ('res_id', '=', obj._name+','+str(id))])
629 cr.execute('DELETE FROM ir_property WHERE id=%d', (nid.pop(),))
631 nid = property.search(cr, uid, [('fields_id', '=', definition_id),
632 ('res_id', '=', False)])
635 default_val = property.browse(cr, uid, nid[0], context).value
637 company_id = obj.pool.get('res.users').company_get(cr, uid, uid)
639 newval = (id_val and obj_dest+','+str(id_val)) or False
640 if (newval != default_val) and newval:
641 propdef = obj.pool.get('ir.model.fields').browse(cr, uid,
642 definition_id, context=context)
643 res = property.create(cr, uid, {
644 'name': propdef.name,
646 'res_id': obj._name+','+str(id),
647 'company_id': company_id,
648 'fields_id': definition_id
652 def _fnct_read(self, obj, cr, uid, ids, prop, val, context=None):
655 property = obj.pool.get('ir.property')
656 definition_id = self._field_get(cr, uid, obj._name, prop)
658 nid = property.search(cr, uid, [('fields_id', '=', definition_id),
659 ('res_id', '=', False)])
662 d = property.browse(cr, uid, nid[0], context).value
663 default_val = (d and int(d.split(',')[1])) or False
665 vids = [obj._name + ',' + str(id) for id in ids]
666 nids = property.search(cr, uid, [('fields_id', '=', definition_id),
667 ('res_id', 'in', vids)])
671 res[id] = default_val
672 for prop in property.browse(cr, uid, nids):
673 res[int(prop.res_id.split(',')[1])] = (prop.value and \
674 int(prop.value.split(',')[1])) or False
676 obj = obj.pool.get(self._obj)
677 names = dict(obj.name_get(cr, uid, filter(None, res.values()), context))
679 if res[r] and res[r] in names:
680 res[r] = (res[r], names[res[r]])
685 def _field_get(self, cr, uid, model_name, prop):
686 if not self.field_id.get(cr.dbname):
687 cr.execute('SELECT id \
688 FROM ir_model_fields \
689 WHERE name=%s AND model=%s', (prop, model_name))
691 self.field_id[cr.dbname] = res and res[0]
692 return self.field_id[cr.dbname]
694 def __init__(self, obj_prop, **args):
696 function.__init__(self, self._fnct_read, False, self._fnct_write,
697 (obj_prop, ), **args)
703 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: