X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/e537bd8dd1ac786164f192374e0d076bdc0327f3..784e112f3fcad487c9f359413fb0dcd8b09c3edb:/services/api/app/controllers/application_controller.rb diff --git a/services/api/app/controllers/application_controller.rb b/services/api/app/controllers/application_controller.rb index 1368eeb3e7..fe5598e0dc 100644 --- a/services/api/app/controllers/application_controller.rb +++ b/services/api/app/controllers/application_controller.rb @@ -1,3 +1,16 @@ +module ApiTemplateOverride + def allowed_to_render?(fieldset, field, model, options) + if options[:select] + return options[:select].include? field.to_s + end + super + end +end + +class ActsAsApi::ApiTemplate + prepend ApiTemplateOverride +end + require 'load_param' require 'record_filters' @@ -7,31 +20,34 @@ class ApplicationController < ActionController::Base include LoadParam include RecordFilters + ERROR_ACTIONS = [:render_error, :render_not_found] + + respond_to :json protect_from_forgery + before_filter :respond_with_json_by_default before_filter :remote_ip - before_filter :require_auth_scope_all, :except => :render_not_found - before_filter :catch_redirect_hint + before_filter :load_read_auths + before_filter :require_auth_scope, except: ERROR_ACTIONS - before_filter :find_object_by_uuid, :except => [:index, :create, - :render_error, - :render_not_found] - before_filter :load_limit_offset_order_params, only: [:index, :owned_items] - before_filter :load_where_param, only: [:index, :owned_items] - before_filter :load_filters_param, only: [:index, :owned_items] + before_filter :catch_redirect_hint + before_filter(:find_object_by_uuid, + except: [:index, :create] + ERROR_ACTIONS) + before_filter :load_limit_offset_order_params, only: [:index, :contents] + before_filter :load_where_param, only: [:index, :contents] + before_filter :load_filters_param, only: [:index, :contents] before_filter :find_objects_for_index, :only => :index before_filter :reload_object_before_update, :only => :update - before_filter :render_404_if_no_object, except: [:index, :create, - :render_error, - :render_not_found] + before_filter(:render_404_if_no_object, + except: [:index, :create] + ERROR_ACTIONS) theme :select_theme attr_accessor :resource_attrs def index - @objects.uniq!(&:id) + @objects.uniq!(&:id) if @select.nil? or @select.include? "id" if params[:eager] and params[:eager] != '0' and params[:eager] != 0 and params[:eager] != '' @objects.each(&:eager_load_associations) end @@ -61,75 +77,6 @@ class ApplicationController < ActionController::Base show end - def self._owned_items_requires_parameters - _index_requires_parameters. - merge({ - include_linked: { - type: 'boolean', required: false, default: false - }, - }) - end - - def owned_items - all_objects = [] - all_available = 0 - - # Trick apply_where_limit_order_params into applying suitable - # per-table values. *_all are the real ones we'll apply to the - # aggregate set. - limit_all = @limit - offset_all = @offset - @orders = [] - - ArvadosModel.descendants. - reject(&:abstract_class?). - sort_by(&:to_s). - each do |klass| - case klass.to_s - # We might expect klass==Link etc. here, but we would be - # disappointed: when Rails reloads model classes, we get two - # distinct classes called Link which do not equal each - # other. But we can still rely on klass.to_s to be "Link". - when 'ApiClientAuthorization' - # Do not want. - else - @objects = klass.readable_by(current_user) - cond_sql = "#{klass.table_name}.owner_uuid = ?" - cond_params = [@object.uuid] - if params[:include_linked] - @objects = @objects. - joins("LEFT JOIN links mng_links"\ - " ON mng_links.link_class=#{klass.sanitize 'permission'}"\ - " AND mng_links.name=#{klass.sanitize 'can_manage'}"\ - " AND mng_links.tail_uuid=#{klass.sanitize @object.uuid}"\ - " AND mng_links.head_uuid=#{klass.table_name}.uuid") - cond_sql += " OR mng_links.uuid IS NOT NULL" - end - @objects = @objects.where(cond_sql, *cond_params).order(:uuid) - @limit = limit_all - all_objects.count - apply_where_limit_order_params - items_available = @objects. - except(:limit).except(:offset). - count(:id, distinct: true) - all_available += items_available - @offset = [@offset - items_available, 0].max - - all_objects += @objects.to_a - end - end - @objects = all_objects || [] - @object_list = { - :kind => "arvados#objectList", - :etag => "", - :self_link => "", - :offset => offset_all, - :limit => limit_all, - :items_available => all_available, - :items => @objects.as_api_response(nil) - } - render json: @object_list - end - def catch_redirect_hint if !current_user if params.has_key?('redirect_to') then @@ -179,18 +126,21 @@ class ApplicationController < ActionController::Base protected def find_objects_for_index - @objects ||= model_class.readable_by(current_user) + @objects ||= model_class.readable_by(*@read_users) apply_where_limit_order_params end - def apply_where_limit_order_params - ar_table_name = @objects.table_name - - ft = record_filters @filters, ar_table_name + def apply_filters + ft = record_filters @filters, @objects.table_name if ft[:cond_out].any? @objects = @objects.where(ft[:cond_out].join(' AND '), *ft[:param_out]) end + end + + def apply_where_limit_order_params + apply_filters + ar_table_name = @objects.table_name if @where.is_a? Hash and @where.any? conditions = ['1=1'] @where.each do |attr,value| @@ -200,6 +150,9 @@ class ApplicationController < ActionController::Base value[0] == 'contains' then ilikes = [] model_class.searchable_columns('ilike').each do |column| + # Including owner_uuid in an "any column" search will + # probably just return a lot of false positives. + next if column == 'owner_uuid' ilikes << "#{ar_table_name}.#{column} ilike ?" conditions << "%#{value[1]}%" end @@ -241,9 +194,11 @@ class ApplicationController < ActionController::Base end end + @objects = @objects.select(@select.map { |s| "#{table_name}.#{ActiveRecord::Base.connection.quote_column_name s.to_s}" }.join ", ") if @select @objects = @objects.order(@orders.join ", ") if @orders.any? @objects = @objects.limit(@limit) @objects = @objects.offset(@offset) + @objects = @objects.uniq(@distinct) if not @distinct.nil? end def resource_attrs @@ -268,15 +223,34 @@ class ApplicationController < ActionController::Base end # Authentication + def load_read_auths + @read_auths = [] + if current_api_client_authorization + @read_auths << current_api_client_authorization + end + # Load reader tokens if this is a read request. + # If there are too many reader tokens, assume the request is malicious + # and ignore it. + if request.get? and params[:reader_tokens] and + params[:reader_tokens].size < 100 + @read_auths += ApiClientAuthorization + .includes(:user) + .where('api_token IN (?) AND + (expires_at IS NULL OR expires_at > CURRENT_TIMESTAMP)', + params[:reader_tokens]) + .all + end + @read_auths.select! { |auth| auth.scopes_allow_request? request } + @read_users = @read_auths.map { |auth| auth.user }.uniq + end + def require_login - if current_user - true - else + if not current_user respond_to do |format| format.json { render :json => { errors: ['Not logged in'] }.to_json, status: 401 } - format.html { + format.html { redirect_to '/auth/joshid' } end @@ -290,13 +264,19 @@ class ApplicationController < ActionController::Base end end - def require_auth_scope_all - require_login and require_auth_scope(['all']) + def require_auth_scope + if @read_auths.empty? + if require_login != false + render :json => { errors: ['Forbidden'] }.to_json, status: 403 + end + false + end end - def require_auth_scope(ok_scopes) - unless current_api_client_auth_has_scope(ok_scopes) - render :json => { errors: ['Forbidden'] }.to_json, status: 403 + def respond_with_json_by_default + html_index = request.accepts.index(Mime::HTML) + if html_index.nil? or request.accepts[0...html_index].include?(Mime::JSON) + request.format = :json end end @@ -334,28 +314,38 @@ class ApplicationController < ActionController::Base end end - def self.accept_attribute_as_json(attr, force_class=nil) - before_filter lambda { accept_attribute_as_json attr, force_class } + def load_json_value(hash, key, must_be_class=nil) + if hash[key].is_a? String + hash[key] = Oj.load(hash[key], symbol_keys: false) + if must_be_class and !hash[key].is_a? must_be_class + raise TypeError.new("parameter #{key.to_s} must be a #{must_be_class.to_s}") + end + end + end + + def self.accept_attribute_as_json(attr, must_be_class=nil) + before_filter lambda { accept_attribute_as_json attr, must_be_class } end accept_attribute_as_json :properties, Hash accept_attribute_as_json :info, Hash - def accept_attribute_as_json(attr, force_class) + def accept_attribute_as_json(attr, must_be_class) if params[resource_name] and resource_attrs.is_a? Hash - if resource_attrs[attr].is_a? String - resource_attrs[attr] = Oj.load(resource_attrs[attr], - symbol_keys: false) - if force_class and !resource_attrs[attr].is_a? force_class - raise TypeError.new("#{resource_name}[#{attr.to_s}] must be a #{force_class.to_s}") - end - elsif resource_attrs[attr].is_a? Hash + if resource_attrs[attr].is_a? Hash # Convert symbol keys to strings (in hashes provided by # resource_attrs) resource_attrs[attr] = resource_attrs[attr]. with_indifferent_access.to_hash + else + load_json_value(resource_attrs, attr, must_be_class) end end end + def self.accept_param_as_json(key, must_be_class=nil) + prepend_before_filter lambda { load_json_value(params, key, must_be_class) } + end + accept_param_as_json :reader_tokens, Array + def render_list @object_list = { :kind => "arvados##{(@response_resource_name || resource_name).camelize(:lower)}List", @@ -363,7 +353,7 @@ class ApplicationController < ActionController::Base :self_link => "", :offset => @offset, :limit => @limit, - :items => @objects.as_api_response(nil) + :items => @objects.as_api_response(nil, {select: @select}) } if @objects.respond_to? :except @object_list[:items_available] = @objects. @@ -388,7 +378,9 @@ class ApplicationController < ActionController::Base { filters: { type: 'array', required: false }, where: { type: 'object', required: false }, - order: { type: 'string', required: false }, + order: { type: 'array', required: false }, + select: { type: 'array', required: false }, + distinct: { type: 'boolean', required: false }, limit: { type: 'integer', required: false, default: DEFAULT_LIMIT }, offset: { type: 'integer', required: false, default: 0 }, }