X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/d6399c117f03f45e83648dca6e23dd7174793253..3bd5f6c3f353059c15eeea51b16b2fdee694d504:/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 77a40713d5..e93c2abb56 100644 --- a/services/api/app/controllers/application_controller.rb +++ b/services/api/app/controllers/application_controller.rb @@ -1,33 +1,37 @@ +require 'load_param' +require 'record_filters' + class ApplicationController < ActionController::Base include CurrentApiClient include ThemesForRails::ActionController + include LoadParam + include RecordFilters + + ERROR_ACTIONS = [:render_error, :render_not_found] respond_to :json protect_from_forgery - around_filter :thread_with_auth_info, :except => [:render_error, :render_not_found] + 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 - DEFAULT_LIMIT = 100 - def index @objects.uniq!(&:id) if params[:eager] and params[:eager] != '0' and params[:eager] != 0 and params[:eager] != '' @@ -59,7 +63,7 @@ class ApplicationController < ActionController::Base show end - def self._owned_items_requires_parameters + def self._contents_requires_parameters _index_requires_parameters. merge({ include_linked: { @@ -68,7 +72,7 @@ class ApplicationController < ActionController::Base }) end - def owned_items + def contents all_objects = [] all_available = 0 @@ -88,22 +92,16 @@ class ApplicationController < ActionController::Base # 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' + when 'ApiClientAuthorization', 'UserAgreement' # Do not want. else - @objects = klass.readable_by(current_user) + @objects = klass.readable_by(*@read_users) 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" + cond_sql += " OR #{klass.table_name}.uuid IN (SELECT head_uuid FROM links WHERE link_class=#{klass.sanitize 'name'} AND links.tail_uuid=#{klass.sanitize @object.uuid})" end - @objects = @objects.where(cond_sql, *cond_params) + @objects = @objects.where(cond_sql, *cond_params).order("#{klass.table_name}.uuid") @limit = limit_all - all_objects.count apply_where_limit_order_params items_available = @objects. @@ -116,10 +114,17 @@ class ApplicationController < ActionController::Base end end @objects = all_objects || [] + @links = Link.where('link_class=? and owner_uuid=?'\ + ' and owner_uuid=tail_uuid'\ + ' and head_uuid in (?)', + 'name', + @object.uuid, + @objects.collect(&:uuid)) @object_list = { :kind => "arvados#objectList", :etag => "", :self_link => "", + :links => @links.as_api_response(nil), :offset => offset_all, :limit => limit_all, :items_available => all_available, @@ -176,123 +181,19 @@ class ApplicationController < ActionController::Base protected - def load_where_param - if params[:where].nil? or params[:where] == "" - @where = {} - elsif params[:where].is_a? Hash - @where = params[:where] - elsif params[:where].is_a? String - begin - @where = Oj.load(params[:where]) - raise unless @where.is_a? Hash - rescue - raise ArgumentError.new("Could not parse \"where\" param as an object") - end - end - @where = @where.with_indifferent_access - end - - def load_filters_param - @filters ||= [] - if params[:filters].is_a? Array - @filters += params[:filters] - elsif params[:filters].is_a? String and !params[:filters].empty? - begin - f = Oj.load params[:filters] - raise unless f.is_a? Array - @filters += f - rescue - raise ArgumentError.new("Could not parse \"filters\" param as an array") - end - end - end - - def load_limit_offset_order_params - if params[:limit] - unless params[:limit].to_s.match(/^\d+$/) - raise ArgumentError.new("Invalid value for limit parameter") - end - @limit = params[:limit].to_i - else - @limit = DEFAULT_LIMIT - end - - if params[:offset] - unless params[:offset].to_s.match(/^\d+$/) - raise ArgumentError.new("Invalid value for offset parameter") - end - @offset = params[:offset].to_i - 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 - end - 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 - if @filters.is_a? Array and @filters.any? - cond_out = [] - param_out = [] - @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 << "#{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 - end - when 'in' - if operand.is_a? Array - cond_out << "#{ar_table_name}.#{attr} IN (?)" - param_out << 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 << "#{ar_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 + + ft = record_filters @filters, ar_table_name + if ft[:cond_out].any? + @objects = @objects.where(ft[:cond_out].join(' AND '), *ft[:param_out]) end + if @where.is_a? Hash and @where.any? conditions = ['1=1'] @where.each do |attr,value| @@ -302,6 +203,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 @@ -370,15 +274,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 @@ -392,72 +315,21 @@ class ApplicationController < ActionController::Base end end - def require_auth_scope_all - require_login and require_auth_scope(['all']) - 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 require_auth_scope + if @read_auths.empty? + if require_login != false + render :json => { errors: ['Forbidden'] }.to_json, status: 403 + end + false end end - def thread_with_auth_info - Thread.current[:request_starttime] = Time.now - Thread.current[:api_url_base] = root_url.sub(/\/$/,'') + '/arvados/v1' - begin - user = nil - api_client = nil - api_client_auth = nil - supplied_token = - params[:api_token] || - params[:oauth_token] || - request.headers["Authorization"].andand.match(/OAuth2 ([a-z0-9]+)/).andand[1] - if supplied_token - api_client_auth = ApiClientAuthorization. - includes(:api_client, :user). - where('api_token=? and (expires_at is null or expires_at > CURRENT_TIMESTAMP)', supplied_token). - first - if api_client_auth.andand.user - session[:user_id] = api_client_auth.user.id - session[:api_client_uuid] = api_client_auth.api_client.andand.uuid - session[:api_client_authorization_id] = api_client_auth.id - user = api_client_auth.user - api_client = api_client_auth.api_client - else - # Token seems valid, but points to a non-existent (deleted?) user. - api_client_auth = nil - end - elsif session[:user_id] - user = User.find(session[:user_id]) rescue nil - api_client = ApiClient. - where('uuid=?',session[:api_client_uuid]). - first rescue nil - if session[:api_client_authorization_id] then - api_client_auth = ApiClientAuthorization. - find session[:api_client_authorization_id] - end - end - Thread.current[:api_client_ip_address] = remote_ip - Thread.current[:api_client_authorization] = api_client_auth - Thread.current[:api_client_uuid] = api_client.andand.uuid - Thread.current[:api_client] = api_client - Thread.current[:user] = user - if api_client_auth - api_client_auth.last_used_at = Time.now - api_client_auth.last_used_by_ip_address = remote_ip - api_client_auth.save validate: false - end - yield - ensure - Thread.current[:api_client_ip_address] = nil - Thread.current[:api_client_authorization] = nil - Thread.current[:api_client_uuid] = nil - Thread.current[:api_client] = nil - Thread.current[:user] = nil + 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 - # /Authentication def model_class controller_name.classify.constantize @@ -493,28 +365,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",