X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/3fb0f46498300eca6a97db88d76c33f855f5166c..c2aceca339ec3a6f3d853865cebd0efe348ff518:/services/api/lib/load_param.rb diff --git a/services/api/lib/load_param.rb b/services/api/lib/load_param.rb index 718aaeaf69..7119eb2348 100644 --- a/services/api/lib/load_param.rb +++ b/services/api/lib/load_param.rb @@ -1,3 +1,7 @@ +# Copyright (C) The Arvados Authors. All rights reserved. +# +# SPDX-License-Identifier: AGPL-3.0 + # Mixin module for reading out query parameters from request params. # # Expects: @@ -13,11 +17,11 @@ module LoadParam def load_where_param if params[:where].nil? or params[:where] == "" @where = {} - elsif params[:where].is_a? Hash + elsif [Hash, ActionController::Parameters].include? params[:where].class @where = params[:where] elsif params[:where].is_a? String begin - @where = Oj.load(params[:where]) + @where = SafeJSON.load(params[:where]) raise unless @where.is_a? Hash rescue raise ArgumentError.new("Could not parse \"where\" param as an object") @@ -33,7 +37,7 @@ module LoadParam @filters += params[:filters] elsif params[:filters].is_a? String and !params[:filters].empty? begin - f = Oj.load params[:filters] + f = SafeJSON.load(params[:filters]) if not f.nil? raise unless f.is_a? Array @filters += f @@ -46,13 +50,13 @@ module LoadParam # Load params[:limit], params[:offset] and params[:order] # into @limit, @offset, @orders - def load_limit_offset_order_params + def load_limit_offset_order_params(fill_table_names: true) if params[:limit] unless params[:limit].to_s.match(/^\d+$/) raise ArgumentError.new("Invalid value for limit parameter") end @limit = [params[:limit].to_i, - Rails.configuration.max_items_per_response].min + Rails.configuration.API.MaxItemsPerResponse].min else @limit = DEFAULT_LIMIT end @@ -72,7 +76,7 @@ module LoadParam (case params[:order] when String if params[:order].starts_with? '[' - od = Oj.load(params[:order]) + od = SafeJSON.load(params[:order]) raise unless od.is_a? Array od else @@ -92,11 +96,15 @@ module LoadParam # has used set_table_name to use an alternate table name from the Rails standard. # I could not find a perfect way to handle this well, but ActiveRecord::Base.send(:descendants) # would be a place to start if this ever becomes necessary. - 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}" - elsif attr.match /^([a-z][_a-z0-9]+)\.([a-z][_a-z0-9]+)$/ and + if (attr.match(/^[a-z][_a-z0-9]+$/) && + model_class.columns.collect(&:name).index(attr) && + ['asc','desc'].index(direction.downcase)) + if fill_table_names + @orders << "#{table_name}.#{attr} #{direction.downcase}" + else + @orders << "#{attr} #{direction.downcase}" + end + elsif attr.match(/^([a-z][_a-z0-9]+)\.([a-z][_a-z0-9]+)$/) and ['asc','desc'].index(direction.downcase) and ActiveRecord::Base.connection.tables.include?($1) and $1.classify.constantize.columns.collect(&:name).index($2) @@ -111,15 +119,39 @@ module LoadParam # (e.g., [] or ['owner_uuid desc']), fall back on the default # orders to ensure repeating the same request (possibly with # different limit/offset) will return records in the same order. - @orders += model_class.default_orders + # + # Clean up the resulting list of orders such that no column + # uselessly appears twice (Postgres might not optimize this out + # for us) and no columns uselessly appear after a unique column + # (Postgres does not optimize this out for us; as of 9.2, "order + # by id, modified_at desc, uuid" is slow but "order by id" is + # fast). + orders_given_and_default = @orders + model_class.default_orders + order_cols_used = {} + @orders = [] + orders_given_and_default.each do |order| + otablecol = order.split(' ')[0] + + next if order_cols_used[otablecol] + order_cols_used[otablecol] = true + + @orders << order + + otable, ocol = otablecol.split('.') + if otable == table_name and model_class.unique_columns.include?(ocol) + # we already have a full ordering; subsequent entries would be + # superfluous + break + end + end case params[:select] when Array @select = params[:select] when String begin - @select = Oj.load params[:select] - raise unless @select.is_a? Array or @select.nil? + @select = SafeJSON.load(params[:select]) + raise unless @select.is_a? Array or @select.nil? or !@select rescue raise ArgumentError.new("Could not parse \"select\" param as an array") end @@ -129,8 +161,9 @@ module LoadParam # Any ordering columns must be selected when doing select, # otherwise it is an SQL error, so filter out invaliding orderings. @orders.select! { |o| + col, _ = o.split # match select column against order array entry - @select.select { |s| /^#{table_name}.#{s}( (asc|desc))?$/.match o }.any? + @select.select { |s| col == "#{table_name}.#{s}" }.any? } end