bin/osv/expression.py

   1 #!/usr/bin/env python
   2 # -*- coding: utf-8 -*-
   3 ##############################################################################
   4 #
   5 #    OpenERP, Open Source Management Solution
   6 #    Copyright (C) 2004-2009 Tiny SPRL (<http://tiny.be>).
   7 #
   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.
  12 #
  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.
  17 #
  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/>.
  20 #
  21 ##############################################################################
  22
  23 from tools import flatten, reverse_enumerate
  24 import fields
  25
  26
  27 class expression(object):
  28     """
  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
  33     """
  34
  35     def _is_operator(self, element):
  36         return isinstance(element, (str, unicode)) and element in ['&', '|', '!']
  37
  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))
  45
  46     def __execute_recursive_in(self, cr, s, f, w, ids, op, type):
  47         # todo: merge into parent query as sub-query
  48         res = []
  49         if ids:
  50             if op in ['<','>','>=','<=']:
  51                 cr.execute('SELECT "%s"'    \
  52                                '  FROM "%s"'    \
  53                                ' WHERE "%s" %s %%s' % (s, f, w, op), (ids[0],))
  54                 res.extend([r[0] for r in cr.fetchall()])
  55             else:
  56                 for i in range(0, len(ids), cr.IN_MAX):
  57                     subids = ids[i:i+cr.IN_MAX]
  58                     cr.execute('SELECT "%s"'    \
  59                                '  FROM "%s"'    \
  60                                '  WHERE "%s" IN %%s' % (s, f, w),(tuple(subids),))
  61                     res.extend([r[0] for r in cr.fetchall()])
  62         else:
  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()])
  66         return res
  67
  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,))
  72         self.__exp = 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()
  75         self.__joins = []
  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
  78
  79     @property
  80     def exp(self):
  81         return self.__exp[:]
  82
  83     def parse(self, cr, uid, table, context):
  84         """ transform the leafs of the expression """
  85         if not self.__exp:
  86             return self
  87
  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)]
  92                 doms = []
  93                 for o in table.browse(cr, uid, ids, context=context):
  94                     if doms:
  95                         doms.insert(0, '|')
  96                     doms += ['&', ('parent_left', '<', o.parent_right), ('parent_left', '>=', o.parent_left)]
  97                 if prefix:
  98                     return [(left, 'in', table.search(cr, uid, doms, context=context))]
  99                 return doms
 100             else:
 101                 def rg(ids, table, parent):
 102                     if not ids:
 103                         return []
 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))]
 107
 108         self.__main_table = table
 109         self.__all_tables.add(table)
 110
 111         i = -1
 112         while i + 1<len(self.__exp):
 113             i += 1
 114             e = self.__exp[i]
 115             if self._is_operator(e) or e == self.__DUMMY_LEAF:
 116                 continue
 117             left, operator, right = e
 118             operator = operator.lower()
 119             working_table = table
 120             main_table = table
 121             fargs = left.split('.', 1)
 122             if fargs[0] in table._inherit_fields:
 123                 while True:
 124                     field = main_table._columns.get(fargs[0], False)
 125                     if field:
 126                         working_table = main_table
 127                         self.__field_tables[i] = working_table
 128                         break
 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
 134
 135             field = working_table._columns.get(fargs[0], False)
 136             if not field:
 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:]
 140                 continue
 141
 142             field_obj = table.pool.get(field._obj)
 143             if len(fargs) > 1:
 144                 if field._type == 'many2one':
 145                     right = field_obj.search(cr, uid, [(fargs[1], operator, right)], context=context)
 146                     self.__exp[i] = (fargs[0], 'in', right)
 147                 # Making search easier when there is a left operand as field.o2m or field.m2m
 148                 if field._type in ['many2many','one2many']:
 149                     right = field_obj.search(cr, uid, [(fargs[1], operator, right)], context=context)
 150                     right1 = table.search(cr, uid, [(fargs[0],'in', right)], context=context)
 151                     self.__exp[i] = ('id', 'in', right1)
 152                 continue
 153
 154             if field._properties and ((not field.store) or field._fnct_search):
 155                 # this is a function field
 156                 if not field._fnct_search:
 157                     # the function field doesn't provide a search function and doesn't store
 158                     # values in the database, so we must ignore it : we generate a dummy leaf
 159                     self.__exp[i] = self.__DUMMY_LEAF
 160                 else:
 161                     subexp = field.search(cr, uid, table, left, [self.__exp[i]], context=context)
 162                     # we assume that the expression is valid
 163                     # we create a dummy leaf for forcing the parsing of the resulting expression
 164                     self.__exp[i] = '&'
 165                     self.__exp.insert(i + 1, self.__DUMMY_LEAF)
 166                     for j, se in enumerate(subexp):
 167                         self.__exp.insert(i + 2 + j, se)
 168             # else, the value of the field is store in the database, so we search on it
 169
 170             elif field._type == 'one2many':
 171                 # Applying recursivity on field(one2many)
 172                 if operator == 'child_of':
 173                     if isinstance(right, basestring):
 174                         ids2 = [x[0] for x in field_obj.name_search(cr, uid, right, [], 'like', context=context, limit=None)]
 175                     else:
 176                         ids2 = list(right)
 177                     if field._obj != working_table._name:
 178                         dom = _rec_get(ids2, field_obj, left=left, prefix=field._obj)
 179                     else:
 180                         dom = _rec_get(ids2, working_table, parent=left)
 181                     self.__exp = self.__exp[:i] + dom + self.__exp[i+1:]
 182
 183                 else:
 184                     call_null = True
 185
 186                     if right:
 187                         if isinstance(right, basestring):
 188                             ids2 = [x[0] for x in field_obj.name_search(cr, uid, right, [], operator, context=context, limit=None)]
 189                             if ids2:
 190                                 operator = 'in'
 191                         else:
 192                             if not isinstance(right,list):
 193                                 ids2 = [right]
 194                             else:
 195                                 ids2 = right
 196                         if not ids2:
 197                             if operator in ['like','ilike','in','=']:
 198                                 #no result found with given search criteria
 199                                 call_null = False
 200                                 self.__exp[i] = ('id','=',0)
 201                             else:
 202                                 call_null = True
 203                                 operator = 'in' # operator changed because ids are directly related to main object
 204                         else:
 205                             call_null = False
 206                             o2m_op = 'in'
 207                             if operator in  ['not like','not ilike','not in','<>','!=']:
 208                                 o2m_op = 'not in'
 209                             self.__exp[i] = ('id', o2m_op, self.__execute_recursive_in(cr, field._fields_id, field_obj._table, 'id', ids2, operator, field._type))
 210
 211                     if call_null:
 212                         o2m_op = 'not in'
 213                         if operator in  ['not like','not ilike','not in','<>','!=']:
 214                             o2m_op = 'in'
 215                         self.__exp[i] = ('id', o2m_op, self.__execute_recursive_in(cr, field._fields_id, field_obj._table, 'id', [], operator, field._type) or [0])
 216
 217             elif field._type == 'many2many':
 218                 #FIXME
 219                 if operator == 'child_of':
 220                     if isinstance(right, basestring):
 221                         ids2 = [x[0] for x in field_obj.name_search(cr, uid, right, [], 'like', context=context, limit=None)]
 222                     else:
 223                         ids2 = list(right)
 224
 225                     def _rec_convert(ids):
 226                         if field_obj == table:
 227                             return ids
 228                         return self.__execute_recursive_in(cr, field._id1, field._rel, field._id2, ids, operator, field._type)
 229
 230                     dom = _rec_get(ids2, field_obj)
 231                     ids2 = field_obj.search(cr, uid, dom, context=context)
 232                     self.__exp[i] = ('id', 'in', _rec_convert(ids2))
 233                 else:
 234                     call_null_m2m = True
 235                     if right:
 236                         if isinstance(right, basestring):
 237                             res_ids = [x[0] for x in field_obj.name_search(cr, uid, right, [], operator, context=context)]
 238                             if res_ids:
 239                                 operator = 'in'
 240                         else:
 241                             if not isinstance(right, list):
 242                                 res_ids = [right]
 243                             else:
 244                                 res_ids = right
 245                         if not res_ids:
 246                             if operator in ['like','ilike','in','=']:
 247                                 #no result found with given search criteria
 248                                 call_null_m2m = False
 249                                 self.__exp[i] = ('id','=',0)
 250                             else:
 251                                 call_null_m2m = True
 252                                 operator = 'in' # operator changed because ids are directly related to main object
 253                         else:
 254                             call_null_m2m = False
 255                             m2m_op = 'in'
 256                             if operator in  ['not like','not ilike','not in','<>','!=']:
 257                                 m2m_op = 'not in'
 258
 259                             self.__exp[i] = ('id', m2m_op, self.__execute_recursive_in(cr, field._id1, field._rel, field._id2, res_ids, operator, field._type) or [0])
 260                     if call_null_m2m:
 261                         m2m_op = 'not in'
 262                         if operator in  ['not like','not ilike','not in','<>','!=']:
 263                             m2m_op = 'in'
 264                         self.__exp[i] = ('id', m2m_op, self.__execute_recursive_in(cr, field._id1, field._rel, field._id2, [], operator,  field._type) or [0])
 265
 266             elif field._type == 'many2one':
 267                 if operator == 'child_of':
 268                     if isinstance(right, basestring):
 269                         ids2 = [x[0] for x in field_obj.name_search(cr, uid, right, [], 'like', limit=None)]
 270                     elif isinstance(right, (int, long)):
 271                         ids2 = list([right])
 272                     else:
 273                         ids2 = list(right)
 274
 275                     self.__operator = 'in'
 276                     if field._obj != working_table._name:
 277                         dom = _rec_get(ids2, field_obj, left=left, prefix=field._obj)
 278                     else:
 279                         dom = _rec_get(ids2, working_table, parent=left)
 280                     self.__exp = self.__exp[:i] + dom + self.__exp[i+1:]
 281                 else:
 282                     def _get_expression(field_obj,cr, uid, left, right, operator, context=None):
 283                         if context is None:
 284                             context = {}
 285                         c = context.copy()
 286                         c['active_test'] = False
 287                         #Special treatment to ill-formed domains
 288                         operator = ( operator in ['<','>','<=','>='] ) and 'in' or operator
 289
 290                         dict_op = {'not in':'!=','in':'=','=':'in','!=':'not in','<>':'not in'}
 291                         if isinstance(right,tuple):
 292                             right = list(right)
 293                         if (not isinstance(right,list)) and operator in ['not in','in']:
 294                             operator = dict_op[operator]
 295                         elif isinstance(right,list) and operator in ['<>','!=','=']: #for domain (FIELD,'=',['value1','value2'])
 296                             operator = dict_op[operator]
 297                         res_ids = field_obj.name_search(cr, uid, right, [], operator, limit=None, context=c)
 298                         if not res_ids:
 299                            return ('id','=',0)
 300                         else:
 301                             right = map(lambda x: x[0], res_ids)
 302                             return (left, 'in', right)
 303
 304                     m2o_str = False
 305                     if right:
 306                         if isinstance(right, basestring): # and not isinstance(field, fields.related):
 307                             m2o_str = True
 308                         elif isinstance(right,(list,tuple)):
 309                             m2o_str = True
 310                             for ele in right:
 311                                 if not isinstance(ele, basestring):
 312                                     m2o_str = False
 313                                     break
 314                     else:
 315                         new_op = '='
 316                         if operator in  ['not like','not ilike','not in','<>','!=']:
 317                             new_op = '!='
 318                         #Is it ok to put 'left' and not 'id' ?
 319                         self.__exp[i] = (left,new_op,False)
 320
 321                     if m2o_str:
 322                         self.__exp[i] = _get_expression(field_obj,cr, uid, left, right, operator, context=context)
 323             else:
 324                 # other field type
 325                 # add the time part to datetime field when it's not there:
 326                 if field._type == 'datetime' and self.__exp[i][2] and len(self.__exp[i][2]) == 10:
 327
 328                     self.__exp[i] = list(self.__exp[i])
 329
 330                     if operator in ('>', '>='):
 331                         self.__exp[i][2] += ' 00:00:00'
 332                     elif operator in ('<', '<='):
 333                         self.__exp[i][2] += ' 23:59:59'
 334
 335                     self.__exp[i] = tuple(self.__exp[i])
 336
 337                 if field.translate:
 338                     if operator in ('like', 'ilike', 'not like', 'not ilike'):
 339                         right = '%%%s%%' % right
 340
 341                     operator = operator == '=like' and 'like' or operator
 342
 343                     query1 = '( SELECT res_id'          \
 344                              '    FROM ir_translation'  \
 345                              '   WHERE name = %s'       \
 346                              '     AND lang = %s'       \
 347                              '     AND type = %s'
 348                     instr = ' %s'
 349                     #Covering in,not in operators with operands (%s,%s) ,etc.
 350                     if operator in ['in','not in']:
 351                         instr = ','.join(['%s'] * len(right))
 352                         query1 += '     AND value ' + operator +  ' ' +" (" + instr + ")"   \
 353                              ') UNION ('                \
 354                              '  SELECT id'              \
 355                              '    FROM "' + working_table._table + '"'       \
 356                              '   WHERE "' + left + '" ' + operator + ' ' +" (" + instr + "))"
 357                     else:
 358                         query1 += '     AND value ' + operator + instr +   \
 359                              ') UNION ('                \
 360                              '  SELECT id'              \
 361                              '    FROM "' + working_table._table + '"'       \
 362                              '   WHERE "' + left + '" ' + operator + instr + ")"
 363
 364                     query2 = [working_table._name + ',' + left,
 365                               context.get('lang', False) or 'en_US',
 366                               'model',
 367                               right,
 368                               right,
 369                              ]
 370
 371                     self.__exp[i] = ('id', 'inselect', (query1, query2))
 372
 373         return self
 374
 375     def __leaf_to_sql(self, leaf, table):
 376         if leaf == self.__DUMMY_LEAF:
 377             return ('(1=1)', [])
 378         left, operator, right = leaf
 379
 380         if operator == 'inselect':
 381             query = '(%s.%s in (%s))' % (table._table, left, right[0])
 382             params = right[1]
 383         elif operator in ['in', 'not in']:
 384             params = right and right[:] or []
 385             len_before = len(params)
 386             for i in range(len_before)[::-1]:
 387                 if params[i] == False:
 388                     del params[i]
 389
 390             len_after = len(params)
 391             check_nulls = len_after != len_before
 392             query = '(1=0)'
 393
 394             if len_after:
 395                 if left == 'id':
 396                     instr = ','.join(['%s'] * len_after)
 397                 else:
 398                     instr = ','.join([table._columns[left]._symbol_set[0]] * len_after)
 399                 query = '(%s.%s %s (%s))' % (table._table, left, operator, instr)
 400             else:
 401                 # the case for [field, 'in', []] or [left, 'not in', []]
 402                 if operator == 'in':
 403                     query = '(%s.%s IS NULL)' % (table._table, left)
 404                 else:
 405                     query = '(%s.%s IS NOT NULL)' % (table._table, left)
 406             if check_nulls:
 407                 query = '(%s OR %s.%s IS NULL)' % (query, table._table, left)
 408         else:
 409             params = []
 410
 411             if right == False and (leaf[0] in table._columns)  and table._columns[leaf[0]]._type=="boolean"  and (operator == '='):
 412                 query = '(%s.%s IS NULL or %s.%s = false )' % (table._table, left,table._table, left)
 413             elif (((right == False) and (type(right)==bool)) or (right is None)) and (operator == '='):
 414                 query = '%s.%s IS NULL ' % (table._table, left)
 415             elif right == False and (leaf[0] in table._columns)  and table._columns[leaf[0]]._type=="boolean"  and (operator in ['<>', '!=']):
 416                 query = '(%s.%s IS NOT NULL and %s.%s != false)' % (table._table, left,table._table, left)
 417             elif (((right == False) and (type(right)==bool)) or right is None) and (operator in ['<>', '!=']):
 418                 query = '%s.%s IS NOT NULL' % (table._table, left)
 419             elif (operator == '=?'):
 420                 op = '='
 421                 if (right is False or right is None):
 422                     return ( 'TRUE',[])
 423                 if left in table._columns:
 424                         format = table._columns[left]._symbol_set[0]
 425                         query = '(%s.%s %s %s)' % (table._table, left, op, format)
 426                         params = table._columns[left]._symbol_set[1](right)
 427                 else:
 428                         query = "(%s.%s %s '%%s')" % (table._table, left, op)
 429                         params = right
 430
 431             else:
 432                 if left == 'id':
 433                     query = '%s.id %s %%s' % (table._table, operator)
 434                     params = right
 435                 else:
 436                     like = operator in ('like', 'ilike', 'not like', 'not ilike')
 437
 438                     op = {'=like':'like','=ilike':'ilike'}.get(operator,operator)
 439                     if left in table._columns:
 440                         format = like and '%s' or table._columns[left]._symbol_set[0]
 441                         query = '(%s.%s %s %s)' % (table._table, left, op, format)
 442                     else:
 443                         query = "(%s.%s %s '%s')" % (table._table, left, op, right)
 444
 445                     add_null = False
 446                     if like:
 447                         if isinstance(right, str):
 448                             str_utf8 = right
 449                         elif isinstance(right, unicode):
 450                             str_utf8 = right.encode('utf-8')
 451                         else:
 452                             str_utf8 = str(right)
 453                         params = '%%%s%%' % str_utf8
 454                         add_null = not str_utf8
 455                     elif left in table._columns:
 456                         params = table._columns[left]._symbol_set[1](right)
 457
 458                     if add_null:
 459                         query = '(%s OR %s IS NULL)' % (query, left)
 460
 461         if isinstance(params, basestring):
 462             params = [params]
 463         return (query, params)
 464
 465
 466     def to_sql(self):
 467         stack = []
 468         params = []
 469         for i, e in reverse_enumerate(self.__exp):
 470             if self._is_leaf(e, internal=True):
 471                 table = self.__field_tables.get(i, self.__main_table)
 472                 q, p = self.__leaf_to_sql(e, table)
 473                 params.insert(0, p)
 474                 stack.append(q)
 475             else:
 476                 if e == '!':
 477                     stack.append('(NOT (%s))' % (stack.pop(),))
 478                 else:
 479                     ops = {'&': ' AND ', '|': ' OR '}
 480                     q1 = stack.pop()
 481                     q2 = stack.pop()
 482                     stack.append('(%s %s %s)' % (q1, ops[e], q2,))
 483
 484         query = ' AND '.join(reversed(stack))
 485         joins = ' AND '.join(self.__joins)
 486         if joins:
 487             query = '(%s) AND (%s)' % (joins, query)
 488         return (query, flatten(params))
 489
 490     def get_tables(self):
 491         return ['"%s"' % t._table for t in self.__all_tables]
 492
 493 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4:
 494