services/api/lib/record_filters.rb

   1 # Mixin module providing a method to convert filters into a list of SQL
   2 # fragments suitable to be fed to ActiveRecord #where.
   3 #
   4 # Expects:
   5 #   model_class
   6 # Operates on:
   7 #   @objects
   8 module RecordFilters
   9
  10   # Input:
  11   # +filters+        array of conditions, each being [column, operator, operand]
  12   # +model_class+    subclass of ActiveRecord being filtered
  13   #
  14   # Output:
  15   # Hash with two keys:
  16   # :cond_out  array of SQL fragments for each filter expression
  17   # :param_out  array of values for parameter substitution in cond_out
  18   def record_filters filters, model_class
  19     conds_out = []
  20     param_out = []
  21
  22     ar_table_name = model_class.table_name
  23     filters.each do |filter|
  24       attrs_in, operator, operand = filter
  25       if attrs_in == 'any' && operator != '@@'
  26         attrs = model_class.searchable_columns(operator)
  27       elsif attrs_in.is_a? Array
  28         attrs = attrs_in
  29       else
  30         attrs = [attrs_in]
  31       end
  32       if !filter.is_a? Array
  33         raise ArgumentError.new("Invalid element in filters array: #{filter.inspect} is not an array")
  34       elsif !operator.is_a? String
  35         raise ArgumentError.new("Invalid operator '#{operator}' (#{operator.class}) in filter")
  36       end
  37
  38       cond_out = []
  39
  40       if operator == '@@' # full-text-search
  41         if attrs_in != 'any'
  42           raise ArgumentError.new("Full text search on individual columns is not supported")
  43         end
  44         attrs = [] #  skip the generic per-column operator loop below
  45         # Use to_tsquery since plainto_tsquery does not support prefix search.
  46         # Instead split operand and join the words with ' & ' and add ':*' to the last word
  47         # Thus when searched for "some str", objects containing "some" and "str:*" are found.
  48         cond_out << model_class.full_text_tsvector+" @@ to_tsquery(?)"
  49         operand << ':*'
  50         param_out << operand.split.join(' & ')
  51       else
  52        attrs.each do |attr|
  53         if !model_class.searchable_columns(operator).index attr.to_s
  54           raise ArgumentError.new("Invalid attribute '#{attr}' in filter")
  55         end
  56         case operator.downcase
  57         when '=', '<', '<=', '>', '>=', '!=', 'like', 'ilike'
  58           attr_type = model_class.attribute_column(attr).type
  59           operator = '<>' if operator == '!='
  60           if operand.is_a? String
  61             if attr_type == :boolean
  62               if not ['=', '<>'].include?(operator)
  63                 raise ArgumentError.new("Invalid operator '#{operator}' for " \
  64                                         "boolean attribute '#{attr}'")
  65               end
  66               case operand.downcase
  67               when '1', 't', 'true', 'y', 'yes'
  68                 operand = true
  69               when '0', 'f', 'false', 'n', 'no'
  70                 operand = false
  71               else
  72                 raise ArgumentError("Invalid operand '#{operand}' for " \
  73                                     "boolean attribute '#{attr}'")
  74               end
  75             end
  76             cond_out << "#{ar_table_name}.#{attr} #{operator} ?"
  77             if (# any operator that operates on value rather than
  78                 # representation:
  79                 operator.match(/[<=>]/) and (attr_type == :datetime))
  80               operand = Time.parse operand
  81             end
  82             param_out << operand
  83           elsif operand.nil? and operator == '='
  84             cond_out << "#{ar_table_name}.#{attr} is null"
  85           elsif operand.nil? and operator == '<>'
  86             cond_out << "#{ar_table_name}.#{attr} is not null"
  87           elsif (attr_type == :boolean) and ['=', '<>'].include?(operator) and
  88               [true, false].include?(operand)
  89             cond_out << "#{ar_table_name}.#{attr} #{operator} ?"
  90             param_out << operand
  91           else
  92             raise ArgumentError.new("Invalid operand type '#{operand.class}' "\
  93                                     "for '#{operator}' operator in filters")
  94           end
  95         when 'in', 'not in'
  96           if operand.is_a? Array
  97             cond_out << "#{ar_table_name}.#{attr} #{operator} (?)"
  98             param_out << operand
  99             if operator == 'not in' and not operand.include?(nil)
 100               # explicitly allow NULL
 101               cond_out[-1] = "(#{cond_out[-1]} OR #{ar_table_name}.#{attr} IS NULL)"
 102             end
 103           else
 104             raise ArgumentError.new("Invalid operand type '#{operand.class}' "\
 105                                     "for '#{operator}' operator in filters")
 106           end
 107         when 'is_a'
 108           operand = [operand] unless operand.is_a? Array
 109           cond = []
 110           operand.each do |op|
 111             cl = ArvadosModel::kind_class op
 112             if cl
 113               cond << "#{ar_table_name}.#{attr} like ?"
 114               param_out << cl.uuid_like_pattern
 115             else
 116               cond << "1=0"
 117             end
 118           end
 119           cond_out << cond.join(' OR ')
 120         end
 121        end
 122       end
 123       conds_out << cond_out.join(' OR ') if cond_out.any?
 124     end
 125
 126     {:cond_out => conds_out, :param_out => param_out}
 127   end
 128
 129 end