X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/e537bd8dd1ac786164f192374e0d076bdc0327f3..a25971cae157b6bc40037e391db226da36dc9b30:/services/api/lib/record_filters.rb

diff --git a/services/api/lib/record_filters.rb b/services/api/lib/record_filters.rb
index 3f0a845541..350c3802fc 100644
--- a/services/api/lib/record_filters.rb
+++ b/services/api/lib/record_filters.rb
@@ -1,66 +1,137 @@
+# 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, ar_table_name
-    cond_out = []
+  # Input:
+  # +filters+        array of conditions, each being [column, operator, operand]
+  # +model_class+    subclass of ActiveRecord being filtered
+  #
+  # 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, model_class
+    conds_out = []
     param_out = []
 
+    ar_table_name = model_class.table_name
     filters.each do |filter|
-      attr, operator, operand = filter
+      attrs_in, operator, operand = filter
+      if attrs_in == 'any' && operator != '@@'
+        attrs = model_class.searchable_columns(operator)
+      elsif attrs_in.is_a? Array
+        attrs = attrs_in
+      else
+        attrs = [attrs_in]
+      end
       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'
-        if operand.is_a? String
-          cond_out << "#{ar_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
-          end
-          param_out << operand
-        elsif operand.nil? and operator == '='
-          cond_out << "#{ar_table_name}.#{attr} is null"
-        else
-          raise ArgumentError.new("Invalid operand type '#{operand.class}' "\
-                                  "for '#{operator}' operator in filters")
+
+      cond_out = []
+
+      if operator == '@@'
+        # Full-text search
+        if attrs_in != 'any'
+          raise ArgumentError.new("Full text search on individual columns is not supported")
         end
-      when 'in'
         if operand.is_a? Array
-          cond_out << "#{ar_table_name}.#{attr} IN (?)"
-          param_out << operand
-        else
-          raise ArgumentError.new("Invalid operand type '#{operand.class}' "\
-                                  "for '#{operator}' operator in filters")
+          raise ArgumentError.new("Full text search not supported for array operands")
+        end
+
+        # Skip the generic per-column operator loop below
+        attrs = []
+        # Use to_tsquery since plainto_tsquery does not support prefix
+        # search. And, split operand and join the words with ' & '
+        cond_out << model_class.full_text_tsvector+" @@ to_tsquery(?)"
+        param_out << operand.split.join(' & ')
+      end
+      attrs.each do |attr|
+        if !model_class.searchable_columns(operator).index attr.to_s
+          raise ArgumentError.new("Invalid attribute '#{attr}' in filter")
         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
+        case operator.downcase
+        when '=', '<', '<=', '>', '>=', '!=', 'like', 'ilike'
+          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
+            end
+            if operator == '<>'
+              # explicitly allow NULL
+              cond_out << "#{ar_table_name}.#{attr} #{operator} ? OR #{ar_table_name}.#{attr} IS NULL"
+            else
+              cond_out << "#{ar_table_name}.#{attr} #{operator} ?"
+            end
+            if (# any operator that operates on value rather than
+                # representation:
+                operator.match(/[<=>]/) and (attr_type == :datetime))
+              operand = Time.parse operand
+            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
-            cond << "1=0"
+            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
           end
+          cond_out << cond.join(' OR ')
         end
-        cond_out << cond.join(' OR ')
       end
+      conds_out << cond_out.join(' OR ') if cond_out.any?
     end
 
-    {:cond_out => cond_out, :param_out => param_out}
+    {:cond_out => conds_out, :param_out => param_out}
   end
 
 end