Merge branch '3570-crunch-race' closes #3570

[arvados.git] / services / api / lib / record_filters.rb

diff --git a/services/api/lib/record_filters.rb b/services/api/lib/record_filters.rb
index 6750797f518a362a220bd2d151127bacd4daccc6..f31875b47d9fc6cf3bfcee4932c426b2fe5c6b29 100644 (file)
--- a/services/api/lib/record_filters.rb
+++ b/services/api/lib/record_filters.rb
@@ -1,52 +1,100 @@
+# Mixin module providing a method to convert filters into a list of SQL
+# fragments suitable to be fed to ActiveRecord #where.
+#
 # Expects:
-#   @where
-#   @filters
-#   +model_class+
+#   model_class
 # Operates on:
 #   @objects
 module RecordFilters
 
-  def record_filters filters
+  # Input:
+  # +filters+        array of conditions, each being [column, operator, operand]
+  # +ar_table_name+  name of SQL table
+  #
+  # Output:
+  # Hash with two keys:
+  # :cond_out  array of SQL fragments for each filter expression
+  # :param_out  array of values for parameter substitution in cond_out
+  def record_filters filters, ar_table_name
     cond_out = []
     param_out = []
-    if filters.is_a? Array and filters.any?
-      filters.each do |attr, operator, operand|
-        if !model_class.searchable_columns(operator).index attr.to_s
-          raise ArgumentError.new("Invalid attribute '#{attr}' in condition")
-        end
-        case operator.downcase
-        when '=', '<', '<=', '>', '>=', 'like'
-          if operand.is_a? String
-            cond_out << "#{table_name}.#{attr} #{operator} ?"
-            if (# any operator that operates on value rather than
-                # representation:
-                operator.match(/[<=>]/) and
-                model_class.attribute_column(attr).type == :datetime)
-              operand = Time.parse operand
+
+    filters.each do |filter|
+      attr, operator, operand = filter
+      if !filter.is_a? Array
+        raise ArgumentError.new("Invalid element in filters array: #{filter.inspect} is not an array")
+      elsif !operator.is_a? String
+        raise ArgumentError.new("Invalid operator '#{operator}' (#{operator.class}) in filter")
+      elsif !model_class.searchable_columns(operator).index attr.to_s
+        raise ArgumentError.new("Invalid attribute '#{attr}' in filter")
+      end
+      case operator.downcase
+      when '=', '<', '<=', '>', '>=', '!=', 'like'
+        attr_type = model_class.attribute_column(attr).type
+        operator = '<>' if operator == '!='
+        if operand.is_a? String
+          if attr_type == :boolean
+            if not ['=', '<>'].include?(operator)
+              raise ArgumentError.new("Invalid operator '#{operator}' for " \
+                                      "boolean attribute '#{attr}'")
+            end
+            case operand.downcase
+            when '1', 't', 'true', 'y', 'yes'
+              operand = true
+            when '0', 'f', 'false', 'n', 'no'
+              operand = false
+            else
+              raise ArgumentError("Invalid operand '#{operand}' for " \
+                                  "boolean attribute '#{attr}'")
             end
-            param_out << operand
           end
-        when 'in'
-          if operand.is_a? Array
-            cond_out << "#{table_name}.#{attr} IN (?)"
-            param_out << operand
+          cond_out << "#{ar_table_name}.#{attr} #{operator} ?"
+          if (# any operator that operates on value rather than
+              # representation:
+              operator.match(/[<=>]/) and (attr_type == :datetime))
+            operand = Time.parse operand
           end
-        when 'is_a'
-          operand = [operand] unless operand.is_a? Array
-          cond = []
-          operand.each do |op|
-              cl = ArvadosModel::kind_class op
-              if cl
-                cond << "#{table_name}.#{attr} like ?"
-                param_out << cl.uuid_like_pattern
-              else
-                cond << "1=0"
-              end
+          param_out << operand
+        elsif operand.nil? and operator == '='
+          cond_out << "#{ar_table_name}.#{attr} is null"
+        elsif operand.nil? and operator == '<>'
+          cond_out << "#{ar_table_name}.#{attr} is not null"
+        elsif (attr_type == :boolean) and ['=', '<>'].include?(operator) and
+            [true, false].include?(operand)
+          cond_out << "#{ar_table_name}.#{attr} #{operator} ?"
+          param_out << operand
+        else
+          raise ArgumentError.new("Invalid operand type '#{operand.class}' "\
+                                  "for '#{operator}' operator in filters")
+        end
+      when 'in', 'not in'
+        if operand.is_a? Array
+          cond_out << "#{ar_table_name}.#{attr} #{operator} (?)"
+          param_out << operand
+          if operator == 'not in' and not operand.include?(nil)
+            # explicitly allow NULL
+            cond_out[-1] = "(#{cond_out[-1]} OR #{ar_table_name}.#{attr} IS NULL)"
+          end
+        else
+          raise ArgumentError.new("Invalid operand type '#{operand.class}' "\
+                                  "for '#{operator}' operator in filters")
+        end
+      when 'is_a'
+        operand = [operand] unless operand.is_a? Array
+        cond = []
+        operand.each do |op|
+          cl = ArvadosModel::kind_class op
+          if cl
+            cond << "#{ar_table_name}.#{attr} like ?"
+            param_out << cl.uuid_like_pattern
+          else
+            cond << "1=0"
           end
-          cond_out << cond.join(' OR ')
         end
+        cond_out << cond.join(' OR ')
       end
     end
+
     {:cond_out => cond_out, :param_out => param_out}
   end