2 # -*- coding: utf-8 -*-
3 ##############################################################################
5 # OpenERP, Open Source Management Solution
6 # Copyright (C) 2004-2009 Tiny SPRL (<http://tiny.be>).
8 # This program is free software: you can redistribute it and/or modify
9 # it under the terms of the GNU Affero General Public License as
10 # published by the Free Software Foundation, either version 3 of the
11 # License, or (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 Affero General Public License for more details.
18 # You should have received a copy of the GNU Affero General Public License
19 # along with this program. If not, see <http://www.gnu.org/licenses/>.
21 ##############################################################################
23 from tools import flatten, reverse_enumerate
27 class expression(object):
29 parse a domain expression
30 use a real polish notation
31 leafs are still in a ('foo', '=', 'bar') format
32 For more info: http://christophe-simonis-at-tiny.blogspot.com/2008/08/new-new-domain-notation.html
35 def _is_operator(self, element):
36 return isinstance(element, (str, unicode)) and element in ['&', '|', '!']
38 def _is_leaf(self, element, internal=False):
39 OPS = ('=', '!=', '<>', '<=', '<', '>', '>=', '=?', '=like', '=ilike', 'like', 'not like', 'ilike', 'not ilike', 'in', 'not in', 'child_of')
40 INTERNAL_OPS = OPS + ('inselect',)
41 return (isinstance(element, tuple) or isinstance(element, list)) \
42 and len(element) == 3 \
43 and (((not internal) and element[1] in OPS) \
44 or (internal and element[1] in INTERNAL_OPS))
46 def __execute_recursive_in(self, cr, s, f, w, ids, op, type):
47 # todo: merge into parent query as sub-query
50 if op in ['<','>','>=','<=']:
51 cr.execute('SELECT "%s"' \
53 ' WHERE "%s" %s %%s' % (s, f, w, op), (ids[0],))
54 res.extend([r[0] for r in cr.fetchall()])
56 for i in range(0, len(ids), cr.IN_MAX):
57 subids = ids[i:i+cr.IN_MAX]
58 cr.execute('SELECT "%s"' \
60 ' WHERE "%s" IN %%s' % (s, f, w),(tuple(subids),))
61 res.extend([r[0] for r in cr.fetchall()])
63 cr.execute('SELECT distinct("%s")' \
64 ' FROM "%s" where "%s" is not null' % (s, f, s)),
65 res.extend([r[0] for r in cr.fetchall()])
68 def __init__(self, exp):
69 # check if the expression is valid
70 if not reduce(lambda acc, val: acc and (self._is_operator(val) or self._is_leaf(val)), exp, True):
71 raise ValueError('Bad domain expression: %r' % (exp,))
73 self.__field_tables = {} # used to store the table to use for the sql generation. key = index of the leaf
74 self.__all_tables = set()
76 self.__main_table = None # 'root' table. set by parse()
77 self.__DUMMY_LEAF = (1, '=', 1) # a dummy leaf that must not be parsed or sql generated
83 def parse(self, cr, uid, table, context):
84 """ transform the leafs of the expression """
88 def _rec_get(ids, table, parent=None, left='id', prefix=''):
89 if table._parent_store and (not table.pool._init):
90 # TODO: Improve where joins are implemented for many with '.', replace by:
91 # doms += ['&',(prefix+'.parent_left','<',o.parent_right),(prefix+'.parent_left','>=',o.parent_left)]
93 for o in table.browse(cr, uid, ids, context=context):
96 doms += ['&', ('parent_left', '<', o.parent_right), ('parent_left', '>=', o.parent_left)]
98 return [(left, 'in', table.search(cr, uid, doms, context=context))]
101 def rg(ids, table, parent):
104 ids2 = table.search(cr, uid, [(parent, 'in', ids)], context=context)
105 return ids + rg(ids2, table, parent)
106 return [(left, 'in', rg(ids, table, parent or table._parent_name))]
108 self.__main_table = table
109 self.__all_tables.add(table)
112 while i + 1<len(self.__exp):
115 if self._is_operator(e) or e == self.__DUMMY_LEAF:
117 left, operator, right = e
118 operator = operator.lower()
119 working_table = table
121 fargs = left.split('.', 1)
122 if fargs[0] in table._inherit_fields:
124 field = main_table._columns.get(fargs[0], False)
126 working_table = main_table
127 self.__field_tables[i] = working_table
129 working_table = main_table.pool.get(main_table._inherit_fields[fargs[0]][0])
130 if working_table not in self.__all_tables:
131 self.__joins.append('%s.%s=%s.%s' % (working_table._table, 'id', main_table._table, main_table._inherits[working_table._name]))
132 self.__all_tables.add(working_table)
133 main_table = working_table
135 field = working_table._columns.get(fargs[0], False)
137 if left == 'id' and operator == 'child_of':
138 dom = _rec_get(right, working_table)
139 self.__exp = self.__exp[:i] + dom + self.__exp[i+1:]
142 field_obj = table.pool.get(field._obj)
144 if field._type == 'many2one':
145 right = field_obj.search(cr, uid, [(fargs[1], operator, right)], context=context)
147 self.__exp[i] = ( 'id', '=', 0 )
149 self.__exp[i] = (fargs[0], 'in', right)
150 # Making search easier when there is a left operand as field.o2m or field.m2m
151 if field._type in ['many2many','one2many']:
152 right = field_obj.search(cr, uid, [(fargs[1], operator, right)], context=context)
153 right1 = table.search(cr, uid, [(fargs[0],'in', right)], context=context)
155 self.__exp[i] = ( 'id', '=', 0 )
157 self.__exp[i] = ('id', 'in', right1)
159 if not isinstance(field,fields.property):
162 if field._properties and not field.store:
163 # this is a function field that is not stored
164 if not field._fnct_search:
165 # the function field doesn't provide a search function and doesn't store
166 # values in the database, so we must ignore it : we generate a dummy leaf
167 self.__exp[i] = self.__DUMMY_LEAF
169 subexp = field.search(cr, uid, table, left, [self.__exp[i]], context=context)
171 self.__exp[i] = self.__DUMMY_LEAF
173 # we assume that the expression is valid
174 # we create a dummy leaf for forcing the parsing of the resulting expression
176 self.__exp.insert(i + 1, self.__DUMMY_LEAF)
177 for j, se in enumerate(subexp):
178 self.__exp.insert(i + 2 + j, se)
179 # else, the value of the field is store in the database, so we search on it
181 elif field._type == 'one2many':
182 # Applying recursivity on field(one2many)
183 if operator == 'child_of':
184 if isinstance(right, basestring):
185 ids2 = [x[0] for x in field_obj.name_search(cr, uid, right, [], 'like', context=context, limit=None)]
188 if field._obj != working_table._name:
189 dom = _rec_get(ids2, field_obj, left=left, prefix=field._obj)
191 dom = _rec_get(ids2, working_table, parent=left)
192 self.__exp = self.__exp[:i] + dom + self.__exp[i+1:]
197 if right is not False:
198 if isinstance(right, basestring):
199 ids2 = [x[0] for x in field_obj.name_search(cr, uid, right, [], operator, context=context, limit=None)]
203 if not isinstance(right,list):
208 if operator in ['like','ilike','in','=']:
209 #no result found with given search criteria
211 self.__exp[i] = ('id','=',0)
214 operator = 'in' # operator changed because ids are directly related to main object
218 if operator in ['not like','not ilike','not in','<>','!=']:
220 self.__exp[i] = ('id', o2m_op, self.__execute_recursive_in(cr, field._fields_id, field_obj._table, 'id', ids2, operator, field._type))
224 if operator in ['not like','not ilike','not in','<>','!=']:
226 self.__exp[i] = ('id', o2m_op, self.__execute_recursive_in(cr, field._fields_id, field_obj._table, 'id', [], operator, field._type) or [0])
228 elif field._type == 'many2many':
230 if operator == 'child_of':
231 if isinstance(right, basestring):
232 ids2 = [x[0] for x in field_obj.name_search(cr, uid, right, [], 'like', context=context, limit=None)]
236 def _rec_convert(ids):
237 if field_obj == table:
239 return self.__execute_recursive_in(cr, field._id1, field._rel, field._id2, ids, operator, field._type)
241 dom = _rec_get(ids2, field_obj)
242 ids2 = field_obj.search(cr, uid, dom, context=context)
243 self.__exp[i] = ('id', 'in', _rec_convert(ids2))
246 if right is not False:
247 if isinstance(right, basestring):
248 res_ids = [x[0] for x in field_obj.name_search(cr, uid, right, [], operator, context=context)]
252 if not isinstance(right, list):
257 if operator in ['like','ilike','in','=']:
258 #no result found with given search criteria
259 call_null_m2m = False
260 self.__exp[i] = ('id','=',0)
263 operator = 'in' # operator changed because ids are directly related to main object
265 call_null_m2m = False
267 if operator in ['not like','not ilike','not in','<>','!=']:
270 self.__exp[i] = ('id', m2m_op, self.__execute_recursive_in(cr, field._id1, field._rel, field._id2, res_ids, operator, field._type) or [0])
273 if operator in ['not like','not ilike','not in','<>','!=']:
275 self.__exp[i] = ('id', m2m_op, self.__execute_recursive_in(cr, field._id1, field._rel, field._id2, [], operator, field._type) or [0])
277 elif field._type == 'many2one':
278 if operator == 'child_of':
279 if isinstance(right, basestring):
280 ids2 = [x[0] for x in field_obj.name_search(cr, uid, right, [], 'like', limit=None)]
281 elif isinstance(right, (int, long)):
286 self.__operator = 'in'
287 if field._obj != working_table._name:
288 dom = _rec_get(ids2, field_obj, left=left, prefix=field._obj)
290 dom = _rec_get(ids2, working_table, parent=left)
291 self.__exp = self.__exp[:i] + dom + self.__exp[i+1:]
293 def _get_expression(field_obj,cr, uid, left, right, operator, context=None):
297 c['active_test'] = False
298 #Special treatment to ill-formed domains
299 operator = ( operator in ['<','>','<=','>='] ) and 'in' or operator
301 dict_op = {'not in':'!=','in':'=','=':'in','!=':'not in','<>':'not in'}
302 if isinstance(right,tuple):
304 if (not isinstance(right,list)) and operator in ['not in','in']:
305 operator = dict_op[operator]
306 elif isinstance(right,list) and operator in ['<>','!=','=']: #for domain (FIELD,'=',['value1','value2'])
307 operator = dict_op[operator]
308 res_ids = field_obj.name_search(cr, uid, right, [], operator, limit=None, context=c)
312 right = map(lambda x: x[0], res_ids)
313 return (left, 'in', right)
317 if isinstance(right, basestring): # and not isinstance(field, fields.related):
319 elif isinstance(right,(list,tuple)):
322 if not isinstance(ele, basestring):
327 if operator in ('not in', '!=', '<>'):
328 # (many2one not in []) should return all records
329 self.__exp[i] = self.__DUMMY_LEAF
331 self.__exp[i] = ('id','=',0)
334 if operator in ['not like','not ilike','not in','<>','!=']:
336 #Is it ok to put 'left' and not 'id' ?
337 self.__exp[i] = (left,new_op,False)
340 self.__exp[i] = _get_expression(field_obj,cr, uid, left, right, operator, context=context)
343 # add the time part to datetime field when it's not there:
344 if field._type == 'datetime' and self.__exp[i][2] and len(self.__exp[i][2]) == 10:
346 self.__exp[i] = list(self.__exp[i])
348 if operator in ('>', '>='):
349 self.__exp[i][2] += ' 00:00:00'
350 elif operator in ('<', '<='):
351 self.__exp[i][2] += ' 23:59:59'
353 self.__exp[i] = tuple(self.__exp[i])
356 if operator in ('like', 'ilike', 'not like', 'not ilike'):
357 right = '%%%s%%' % right
359 operator = operator == '=like' and 'like' or operator
361 query1 = '( SELECT res_id' \
362 ' FROM ir_translation' \
367 #Covering in,not in operators with operands (%s,%s) ,etc.
368 if operator in ['in','not in']:
369 instr = ','.join(['%s'] * len(right))
370 query1 += ' AND value ' + operator + ' ' +" (" + instr + ")" \
373 ' FROM "' + working_table._table + '"' \
374 ' WHERE "' + left + '" ' + operator + ' ' +" (" + instr + "))"
376 query1 += ' AND value ' + operator + instr + \
379 ' FROM "' + working_table._table + '"' \
380 ' WHERE "' + left + '" ' + operator + instr + ")"
382 query2 = [working_table._name + ',' + left,
383 context.get('lang', False) or 'en_US',
389 self.__exp[i] = ('id', 'inselect', (query1, query2))
393 def __leaf_to_sql(self, leaf, table):
394 if leaf == self.__DUMMY_LEAF:
396 left, operator, right = leaf
398 if operator == 'inselect':
399 query = '(%s.%s in (%s))' % (table._table, left, right[0])
401 elif operator in ['in', 'not in']:
402 params = right and right[:] or []
403 len_before = len(params)
404 for i in range(len_before)[::-1]:
405 if params[i] == False:
408 len_after = len(params)
409 check_nulls = len_after != len_before
414 instr = ','.join(['%s'] * len_after)
416 instr = ','.join([table._columns[left]._symbol_set[0]] * len_after)
417 query = '(%s.%s %s (%s))' % (table._table, left, operator, instr)
419 # the case for [field, 'in', []] or [left, 'not in', []]
421 query = '(%s.%s IS NULL)' % (table._table, left)
423 query = '(%s.%s IS NOT NULL)' % (table._table, left)
425 query = '(%s OR %s.%s IS NULL)' % (query, table._table, left)
429 if right == False and (leaf[0] in table._columns) and table._columns[leaf[0]]._type=="boolean" and (operator == '='):
430 query = '(%s.%s IS NULL or %s.%s = false )' % (table._table, left,table._table, left)
431 elif (((right == False) and (type(right)==bool)) or (right is None)) and (operator == '='):
432 query = '%s.%s IS NULL ' % (table._table, left)
433 elif right == False and (leaf[0] in table._columns) and table._columns[leaf[0]]._type=="boolean" and (operator in ['<>', '!=']):
434 query = '(%s.%s IS NOT NULL and %s.%s != false)' % (table._table, left,table._table, left)
435 elif (((right == False) and (type(right)==bool)) or right is None) and (operator in ['<>', '!=']):
436 query = '%s.%s IS NOT NULL' % (table._table, left)
437 elif (operator == '=?'):
439 if (right is False or right is None):
441 if left in table._columns:
442 format = table._columns[left]._symbol_set[0]
443 query = '(%s.%s %s %s)' % (table._table, left, op, format)
444 params = table._columns[left]._symbol_set[1](right)
446 query = "(%s.%s %s '%%s')" % (table._table, left, op)
451 query = '%s.id %s %%s' % (table._table, operator)
454 like = operator in ('like', 'ilike', 'not like', 'not ilike')
456 op = {'=like':'like','=ilike':'ilike'}.get(operator,operator)
457 if left in table._columns:
458 format = like and '%s' or table._columns[left]._symbol_set[0]
459 query = '(%s.%s %s %s)' % (table._table, left, op, format)
461 query = "(%s.%s %s '%s')" % (table._table, left, op, right)
465 if isinstance(right, str):
467 elif isinstance(right, unicode):
468 str_utf8 = right.encode('utf-8')
470 str_utf8 = str(right)
471 params = '%%%s%%' % str_utf8
472 add_null = not str_utf8
473 elif left in table._columns:
474 params = table._columns[left]._symbol_set[1](right)
477 query = '(%s OR %s IS NULL)' % (query, left)
479 if isinstance(params, basestring):
481 return (query, params)
487 for i, e in reverse_enumerate(self.__exp):
488 if self._is_leaf(e, internal=True):
489 table = self.__field_tables.get(i, self.__main_table)
490 q, p = self.__leaf_to_sql(e, table)
495 stack.append('(NOT (%s))' % (stack.pop(),))
497 ops = {'&': ' AND ', '|': ' OR '}
500 stack.append('(%s %s %s)' % (q1, ops[e], q2,))
502 query = ' AND '.join(reversed(stack))
503 joins = ' AND '.join(self.__joins)
505 query = '(%s) AND (%s)' % (joins, query)
506 return (query, flatten(params))
508 def get_tables(self):
509 return ['"%s"' % t._table for t in self.__all_tables]
511 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: