X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/04cc77648cc62c73433801475c27ede4ceb76c8b..7a6f2613d38bf9fb99a919b3875d2851a23a253a:/services/api/lib/record_filters.rb

diff --git a/services/api/lib/record_filters.rb b/services/api/lib/record_filters.rb
index fab16bbc1d..9408dcfade 100644
--- a/services/api/lib/record_filters.rb
+++ b/services/api/lib/record_filters.rb
@@ -1,145 +1,114 @@
+# 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 apply_where_limit_order_params
-    if @filters.is_a? Array and @filters.any?
+  # 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|
+      attrs_in, operator, operand = filter
+      if attrs_in == 'any'
+        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")
+      end
       cond_out = []
-      param_out = []
-      @filters.each do |attr, operator, operand|
+      attrs.each do |attr|
         if !model_class.searchable_columns(operator).index attr.to_s
-          raise ArgumentError.new("Invalid attribute '#{attr}' in condition")
+          raise ArgumentError.new("Invalid attribute '#{attr}' in filter")
         end
         case operator.downcase
-        when '=', '<', '<=', '>', '>=', 'like'
+        when '=', '<', '<=', '>', '>=', '!=', 'like', 'ilike'
+          attr_type = model_class.attribute_column(attr).type
+          operator = '<>' if operator == '!='
           if operand.is_a? String
-            cond_out << "#{table_name}.#{attr} #{operator} ?"
+            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
+            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)
+                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
+            raise ArgumentError.new("Invalid operand type '#{operand.class}' "\
+                                    "for '#{operator}' operator in filters")
           end
-        when 'in'
+        when 'in', 'not in'
           if operand.is_a? Array
-            cond_out << "#{table_name}.#{attr} IN (?)"
+            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 << "#{table_name}.#{attr} like ?"
-                param_out << cl.uuid_like_pattern
-              else
-                cond << "1=0"
-              end
-          end
-          cond_out << cond.join(' OR ')
-        end
-      end
-      if cond_out.any?
-        @objects = @objects.where(cond_out.join(' AND '), *param_out)
-      end
-    end
-    if @where.is_a? Hash and @where.any?
-      conditions = ['1=1']
-      @where.each do |attr,value|
-        if attr.to_s == 'any'
-          if value.is_a?(Array) and
-              value.length == 2 and
-              value[0] == 'contains' then
-            ilikes = []
-            model_class.searchable_columns('ilike').each do |column|
-              ilikes << "#{table_name}.#{column} ilike ?"
-              conditions << "%#{value[1]}%"
-            end
-            if ilikes.any?
-              conditions[0] << ' and (' + ilikes.join(' or ') + ')'
-            end
-          end
-        elsif attr.to_s.match(/^[a-z][_a-z0-9]+$/) and
-            model_class.columns.collect(&:name).index(attr.to_s)
-          if value.nil?
-            conditions[0] << " and #{table_name}.#{attr} is ?"
-            conditions << nil
-          elsif value.is_a? Array
-            if value[0] == 'contains' and value.length == 2
-              conditions[0] << " and #{table_name}.#{attr} like ?"
-              conditions << "%#{value[1]}%"
+            cl = ArvadosModel::kind_class op
+            if cl
+              cond << "#{ar_table_name}.#{attr} like ?"
+              param_out << cl.uuid_like_pattern
             else
-              conditions[0] << " and #{table_name}.#{attr} in (?)"
-              conditions << value
-            end
-          elsif value.is_a? String or value.is_a? Fixnum or value == true or value == false
-            conditions[0] << " and #{table_name}.#{attr}=?"
-            conditions << value
-          elsif value.is_a? Hash
-            # Not quite the same thing as "equal?" but better than nothing?
-            value.each do |k,v|
-              if v.is_a? String
-                conditions[0] << " and #{table_name}.#{attr} ilike ?"
-                conditions << "%#{k}%#{v}%"
-              end
+              cond << "1=0"
             end
           end
+          cond_out << cond.join(' OR ')
         end
       end
-      if conditions.length > 1
-        conditions[0].sub!(/^1=1 and /, '')
-        @objects = @objects.
-          where(*conditions)
-      end
-    end
-
-    if params[:limit]
-      begin
-        @limit = params[:limit].to_i
-      rescue
-        raise ArgumentError.new("Invalid value for limit parameter")
-      end
-    else
-      @limit = 100
+      conds_out << cond_out.join(' OR ') if cond_out.any?
     end
-    @objects = @objects.limit(@limit)
 
-    orders = []
-
-    if params[:offset]
-      begin
-        @objects = @objects.offset(params[:offset].to_i)
-        @offset = params[:offset].to_i
-      rescue
-        raise ArgumentError.new("Invalid value for limit parameter")
-      end
-    else
-      @offset = 0
-    end
-
-    orders = []
-    if params[:order]
-      params[:order].split(',').each do |order|
-        attr, direction = order.strip.split " "
-        direction ||= 'asc'
-        if attr.match /^[a-z][_a-z0-9]+$/ and
-            model_class.columns.collect(&:name).index(attr) and
-            ['asc','desc'].index direction.downcase
-          orders << "#{table_name}.#{attr} #{direction.downcase}"
-        end
-      end
-    end
-    if orders.empty?
-      orders << "#{table_name}.modified_at desc"
-    end
-    @objects = @objects.order(orders.join ", ")
+    {:cond_out => conds_out, :param_out => param_out}
   end
 
 end