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
86 self.group_name = False
93 setattr(self, a, args[a])
95 warnings.warn("The relate attribute doesn't work anymore, use act_window tag instead", DeprecationWarning)
100 def set(self, cr, obj, id, name, value, user=None, context=None):
101 cr.execute('update '+obj._table+' set '+name+'='+self._symbol_set[0]+' where id=%d', (self._symbol_set[1](value), id))
103 def set_memory(self, cr, obj, id, name, value, user=None, context=None):
104 raise Exception(_('Not implemented set_memory method !'))
106 def get_memory(self, cr, obj, ids, name, context=None, values=None):
107 raise Exception(_('Not implemented get_memory method !'))
109 def get(self, cr, obj, ids, name, context=None, values=None):
110 raise Exception(_('undefined get method !'))
112 def search(self, cr, obj, args, name, value, offset=0, limit=None, uid=None):
113 ids = obj.search(cr, uid, args+self._domain+[(name, 'ilike', value)], offset, limit)
114 res = obj.read(cr, uid, ids, [name])
115 return [x[name] for x in res]
117 def search_memory(self, cr, obj, args, name, value, offset=0, limit=None, uid=None, context=None):
118 raise Exception(_('Not implemented search_memory method !'))
121 # ---------------------------------------------------------
123 # ---------------------------------------------------------
124 class boolean(_column):
127 _symbol_f = lambda x: x and 'True' or 'False'
128 _symbol_set = (_symbol_c, _symbol_f)
131 class integer(_column):
134 _symbol_f = lambda x: int(x or 0)
135 _symbol_set = (_symbol_c, _symbol_f)
138 class reference(_column):
141 def __init__(self, string, selection, size, **args):
142 _column.__init__(self, string=string, size=size, selection=selection, **args)
148 def __init__(self, string, size, **args):
149 _column.__init__(self, string=string, size=size, **args)
150 self._symbol_set = (self._symbol_c, self._symbol_set_char)
152 # takes a string (encoded in utf8) and returns a string (encoded in utf8)
153 def _symbol_set_char(self, symb):
155 # * we need to remove the "symb==False" from the next line BUT
156 # for now too many things rely on this broken behavior
157 # * the symb==None test should be common to all data types
158 if symb == None or symb == False:
161 # we need to convert the string to a unicode object to be able
162 # to evaluate its length (and possibly truncate it) reliably
163 if isinstance(symb, str):
164 u_symb = unicode(symb, 'utf8')
165 elif isinstance(symb, unicode):
168 u_symb = unicode(symb)
169 return u_symb.encode('utf8')[:self.size]
178 class float(_column):
181 _symbol_f = lambda x: __builtin__.float(x or 0.0)
182 _symbol_set = (_symbol_c, _symbol_f)
184 def __init__(self, string='unknown', digits=None, **args):
185 _column.__init__(self, string=string, **args)
193 class datetime(_column):
201 class binary(_column):
204 _symbol_f = lambda symb: symb and psycopg.Binary(symb) or None
205 _symbol_set = (_symbol_c, _symbol_f)
208 class selection(_column):
211 def __init__(self, selection, string='unknown', **args):
212 _column.__init__(self, string=string, **args)
213 self.selection = selection
215 # ---------------------------------------------------------
217 # ---------------------------------------------------------
220 # Values: (0, 0, { fields }) create
221 # (1, ID, { fields }) modification
222 # (2, ID) remove (delete)
223 # (3, ID) unlink one (target id or target of relation)
225 # (5) unlink all (only valid for one2many)
227 #CHECKME: dans la pratique c'est quoi la syntaxe utilisee pour le 5? (5) ou (5, 0)?
228 class one2one(_column):
229 _classic_read = False
230 _classic_write = True
233 def __init__(self, obj, string='unknown', **args):
234 warnings.warn("The one2one field doesn't work anymore", DeprecationWarning)
235 _column.__init__(self, string=string, **args)
238 def set(self, cr, obj_src, id, field, act, user=None, context=None):
241 obj = obj_src.pool.get(self._obj)
242 self._table = obj_src.pool.get(self._obj)._table
244 id_new = obj.create(cr, user, act[1])
245 cr.execute('update '+obj_src._table+' set '+field+'=%d where id=%d', (id_new, id))
247 cr.execute('select '+field+' from '+obj_src._table+' where id=%d', (act[0],))
248 id = cr.fetchone()[0]
249 obj.write(cr, user, [id], act[1], context=context)
251 def search(self, cr, obj, args, name, value, offset=0, limit=None, uid=None):
252 return obj.pool.get(self._obj).search(cr, uid, args+self._domain+[('name', 'like', value)], offset, limit)
255 class many2one(_column):
256 _classic_read = False
257 _classic_write = True
260 def __init__(self, obj, string='unknown', **args):
261 _column.__init__(self, string=string, **args)
265 # TODO: speed improvement
267 # name is the name of the relation field
268 def get_memory(self, cr, obj, ids, name, user=None, context=None, values=None):
271 result[id] = obj.datas[id][name]
274 def get(self, cr, obj, ids, name, user=None, context=None, values=None):
281 res[r['id']] = r[name]
283 res.setdefault(id, '')
284 obj = obj.pool.get(self._obj)
285 # build a dictionary of the form {'id_of_distant_resource': name_of_distant_resource}
286 from orm import except_orm
288 names = dict(obj.name_get(cr, user, filter(None, res.values()), context))
292 iids = filter(None, res.values())
293 cr.execute('select id,'+obj._rec_name+' from '+obj._table+' where id in ('+','.join(map(str, iids))+')')
294 for res22 in cr.fetchall():
295 names[res22[0]] = res22[1]
298 if res[r] and res[r] in names:
299 res[r] = (res[r], names[res[r]])
304 def set(self, cr, obj_src, id, field, values, user=None, context=None):
307 obj = obj_src.pool.get(self._obj)
308 self._table = obj_src.pool.get(self._obj)._table
309 if type(values)==type([]):
312 id_new = obj.create(cr, act[2])
313 cr.execute('update '+obj_src._table+' set '+field+'=%d where id=%d', (id_new, id))
315 obj.write(cr, [act[1]], act[2], context=context)
317 cr.execute('delete from '+self._table+' where id=%d', (act[1],))
318 elif act[0] == 3 or act[0] == 5:
319 cr.execute('update '+obj_src._table+' set '+field+'=null where id=%d', (id,))
321 cr.execute('update '+obj_src._table+' set '+field+'=%d where id=%d', (act[1], id))
324 cr.execute('update '+obj_src._table+' set '+field+'=%d where id=%d', (values, id))
326 cr.execute('update '+obj_src._table+' set '+field+'=null where id=%d', (id,))
328 def search(self, cr, obj, args, name, value, offset=0, limit=None, uid=None):
329 return obj.pool.get(self._obj).search(cr, uid, args+self._domain+[('name', 'like', value)], offset, limit)
332 class one2many(_column):
333 _classic_read = False
334 _classic_write = False
337 def __init__(self, obj, fields_id, string='unknown', limit=None, **args):
338 _column.__init__(self, string=string, **args)
340 self._fields_id = fields_id
342 #one2many can't be used as condition for defaults
343 assert(self.change_default != True)
345 def get_memory(self, cr, obj, ids, name, user=None, offset=0, context=None, values=None):
353 ids2 = obj.pool.get(self._obj).search(cr, user, [(self._fields_id, 'in', ids)], limit=self._limit)
354 for r in obj.pool.get(self._obj).read(cr, user, ids2, [self._fields_id], context=context, load='_classic_write'):
355 if r[self._fields_id] in res:
356 res[r[self._fields_id]].append(r['id'])
359 def set_memory(self, cr, obj, id, field, values, user=None, context=None):
364 obj = obj.pool.get(self._obj)
367 act[2][self._fields_id] = id
368 obj.create(cr, user, act[2], context=context)
370 obj.write(cr, user, [act[1]], act[2], context=context)
372 obj.unlink(cr, user, [act[1]], context=context)
374 obj.datas[act[1]][self._fields_id] = False
376 obj.datas[act[1]] = id
378 for o in obj.datas.values():
379 if o[self._fields_id] == id:
380 o[self._fields_id] = False
382 for id2 in (act[2] or []):
383 obj.datas[id2][self._fields_id] = id
385 def search_memory(self, cr, obj, args, name, value, offset=0, limit=None, uid=None, operator='like', context=None):
386 raise _('Not Implemented')
388 def get(self, cr, obj, ids, name, user=None, offset=0, context=None, values=None):
396 ids2 = obj.pool.get(self._obj).search(cr, user, [(self._fields_id, 'in', ids)], limit=self._limit)
397 for r in obj.pool.get(self._obj)._read_flat(cr, user, ids2, [self._fields_id], context=context, load='_classic_write'):
398 res[r[self._fields_id]].append(r['id'])
401 def set(self, cr, obj, id, field, values, user=None, context=None):
406 _table = obj.pool.get(self._obj)._table
407 obj = obj.pool.get(self._obj)
410 act[2][self._fields_id] = id
411 obj.create(cr, user, act[2], context=context)
413 obj.write(cr, user, [act[1]], act[2], context=context)
415 obj.unlink(cr, user, [act[1]], context=context)
417 cr.execute('update '+_table+' set '+self._fields_id+'=null where id=%d', (act[1],))
419 cr.execute('update '+_table+' set '+self._fields_id+'=%d where id=%d', (id, act[1]))
421 cr.execute('update '+_table+' set '+self._fields_id+'=null where '+self._fields_id+'=%d', (id,))
427 cr.execute('update '+_table+' set '+self._fields_id+'=NULL where '+self._fields_id+'=%d and id not in ('+','.join(map(str, ids2))+')', (id,))
429 cr.execute('update '+_table+' set '+self._fields_id+'=%d where id in ('+','.join(map(str, act[2]))+')', (id,))
431 def search(self, cr, obj, args, name, value, offset=0, limit=None, uid=None, operator='like'):
432 return obj.pool.get(self._obj).name_search(cr, uid, value, self._domain, offset, limit)
436 # Values: (0, 0, { fields }) create
437 # (1, ID, { fields }) modification
442 # (6, ?, ids) set a list of links
444 class many2many(_column):
445 _classic_read = False
446 _classic_write = False
449 def __init__(self, obj, rel, id1, id2, string='unknown', limit=None, **args):
450 _column.__init__(self, string=string, **args)
457 def get(self, cr, obj, ids, name, user=None, offset=0, context=None, values=None):
467 ids_s = ','.join(map(str, ids))
468 limit_str = self._limit is not None and ' limit %d' % self._limit or ''
469 obj = obj.pool.get(self._obj)
471 d1, d2 = obj.pool.get('ir.rule').domain_get(cr, user, obj._name)
475 cr.execute('SELECT '+self._rel+'.'+self._id2+','+self._rel+'.'+self._id1+' \
476 FROM '+self._rel+' , '+obj._table+' \
477 WHERE '+self._rel+'.'+self._id1+' in ('+ids_s+') \
478 AND '+self._rel+'.'+self._id2+' = '+obj._table+'.id '+d1
479 +limit_str+' order by '+obj._table+'.'+obj._order+' offset %d',
481 for r in cr.fetchall():
482 res[r[1]].append(r[0])
485 def set(self, cr, obj, id, name, values, user=None, context=None):
490 obj = obj.pool.get(self._obj)
493 idnew = obj.create(cr, user, act[2])
494 cr.execute('insert into '+self._rel+' ('+self._id1+','+self._id2+') values (%d,%d)', (id, idnew))
496 obj.write(cr, user, [act[1]], act[2], context=context)
498 obj.unlink(cr, user, [act[1]], context=context)
500 cr.execute('delete from '+self._rel+' where ' + self._id1 + '=%d and '+ self._id2 + '=%d', (id, act[1]))
502 cr.execute('insert into '+self._rel+' ('+self._id1+','+self._id2+') values (%d,%d)', (id, act[1]))
504 cr.execute('update '+self._rel+' set '+self._id2+'=null where '+self._id2+'=%d', (id,))
507 d1, d2 = obj.pool.get('ir.rule').domain_get(cr, user, obj._name)
510 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)
512 for act_nbr in act[2]:
513 cr.execute('insert into '+self._rel+' ('+self._id1+','+self._id2+') values (%d, %d)', (id, act_nbr))
516 # TODO: use a name_search
518 def search(self, cr, obj, args, name, value, offset=0, limit=None, uid=None, operator='like'):
519 return obj.pool.get(self._obj).search(cr, uid, args+self._domain+[('name', operator, value)], offset, limit)
521 def get_memory(self, cr, obj, ids, name, user=None, offset=0, context=None, values=None):
524 result[id] = obj.datas[id].get(name, [])
527 def set_memory(self, cr, obj, id, name, values, user=None, context=None):
531 # TODO: use constants instead of these magic numbers
533 raise _('Not Implemented')
535 raise _('Not Implemented')
537 raise _('Not Implemented')
539 raise _('Not Implemented')
541 raise _('Not Implemented')
543 raise _('Not Implemented')
545 obj.datas[id][name] = act[2]
548 # ---------------------------------------------------------
550 # ---------------------------------------------------------
551 class function(_column):
552 _classic_read = False
553 _classic_write = False
558 # multi: compute several fields in one call
560 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):
561 _column.__init__(self, **args)
563 self._method = method
565 self._fnct_inv = fnct_inv
568 if 'relation' in args:
569 self._obj = args['relation']
570 self._fnct_inv_arg = fnct_inv_arg
574 self._fnct_search = fnct_search
577 self._symbol_c = '%f'
578 self._symbol_f = lambda x: __builtin__.float(x or 0.0)
579 self._symbol_set = (self._symbol_c, self._symbol_f)
581 def search(self, cr, uid, obj, name, args):
582 if not self._fnct_search:
583 #CHECKME: should raise an exception
585 return self._fnct_search(obj, cr, uid, obj, name, args)
587 def get(self, cr, obj, ids, name, user=None, context=None, values=None):
594 return self._fnct(obj, cr, user, ids, name, self._arg, context)
596 return self._fnct(cr, obj._table, ids, name, self._arg, context)
598 def set(self, cr, obj, id, name, value, user=None, context=None):
602 self._fnct_inv(obj, cr, user, id, name, value, self._fnct_inv_arg, context)
605 # ---------------------------------------------------------
607 # ---------------------------------------------------------
608 class serialized(_column):
609 def __init__(self, string='unknown', serialize_func=repr, deserialize_func=eval, type='text', **args):
610 self._serialize_func = serialize_func
611 self._deserialize_func = deserialize_func
613 self._symbol_set = (self._symbol_c, self._serialize_func)
614 self._symbol_get = self._deserialize_func
615 super(serialized, self).__init__(string=string, **args)
618 class property(function):
620 def _fnct_write(self, obj, cr, uid, id, prop, id_val, val, context=None):
624 definition_id = self._field_get(cr, uid, obj._name, prop)
626 property = obj.pool.get('ir.property')
627 nid = property.search(cr, uid, [('fields_id', '=', definition_id),
628 ('res_id', '=', obj._name+','+str(id))])
630 cr.execute('DELETE FROM ir_property WHERE id=%d', (nid.pop(),))
632 nid = property.search(cr, uid, [('fields_id', '=', definition_id),
633 ('res_id', '=', False)])
636 default_val = property.browse(cr, uid, nid[0], context).value
638 company_id = obj.pool.get('res.users').company_get(cr, uid, uid)
640 newval = (id_val and obj_dest+','+str(id_val)) or False
641 if (newval != default_val) and newval:
642 propdef = obj.pool.get('ir.model.fields').browse(cr, uid,
643 definition_id, context=context)
644 res = property.create(cr, uid, {
645 'name': propdef.name,
647 'res_id': obj._name+','+str(id),
648 'company_id': company_id,
649 'fields_id': definition_id
653 def _fnct_read(self, obj, cr, uid, ids, prop, val, context=None):
656 property = obj.pool.get('ir.property')
657 definition_id = self._field_get(cr, uid, obj._name, prop)
659 nid = property.search(cr, uid, [('fields_id', '=', definition_id),
660 ('res_id', '=', False)])
663 d = property.browse(cr, uid, nid[0], context).value
664 default_val = (d and int(d.split(',')[1])) or False
666 vids = [obj._name + ',' + str(id) for id in ids]
667 nids = property.search(cr, uid, [('fields_id', '=', definition_id),
668 ('res_id', 'in', vids)])
672 res[id] = default_val
673 for prop in property.browse(cr, uid, nids):
674 res[int(prop.res_id.split(',')[1])] = (prop.value and \
675 int(prop.value.split(',')[1])) or False
677 obj = obj.pool.get(self._obj)
678 names = dict(obj.name_get(cr, uid, filter(None, res.values()), context))
680 if res[r] and res[r] in names:
681 res[r] = (res[r], names[res[r]])
686 def _field_get(self, cr, uid, model_name, prop):
687 if not self.field_id.get(cr.dbname):
688 cr.execute('SELECT id \
689 FROM ir_model_fields \
690 WHERE name=%s AND model=%s', (prop, model_name))
692 self.field_id[cr.dbname] = res and res[0]
693 return self.field_id[cr.dbname]
695 def __init__(self, obj_prop, **args):
697 function.__init__(self, self._fnct_read, False, self._fnct_write,
698 (obj_prop, ), **args)
704 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: