services/api/app/controllers/application_controller.rb

   1 # Copyright (C) The Arvados Authors. All rights reserved.
   2 #
   3 # SPDX-License-Identifier: AGPL-3.0
   4
   5 require 'safe_json'
   6 require 'request_error'
   7
   8 module ApiTemplateOverride
   9   def allowed_to_render?(fieldset, field, model, options)
  10     return false if !super
  11     if options[:select]
  12       options[:select].include? field.to_s
  13     else
  14       true
  15     end
  16   end
  17 end
  18
  19 class ActsAsApi::ApiTemplate
  20   prepend ApiTemplateOverride
  21 end
  22
  23 require 'load_param'
  24
  25 class ApplicationController < ActionController::Base
  26   include ThemesForRails::ActionController
  27   include CurrentApiClient
  28   include LoadParam
  29   include DbCurrentTime
  30
  31   respond_to :json
  32   protect_from_forgery
  33
  34   ERROR_ACTIONS = [:render_error, :render_not_found]
  35
  36   around_action :set_current_request_id
  37   before_action :disable_api_methods
  38   before_action :set_cors_headers
  39   before_action :respond_with_json_by_default
  40   before_action :remote_ip
  41   before_action :load_read_auths
  42   before_action :require_auth_scope, except: ERROR_ACTIONS
  43
  44   before_action :catch_redirect_hint
  45   before_action(:find_object_by_uuid,
  46                 except: [:index, :create] + ERROR_ACTIONS)
  47   before_action :load_required_parameters
  48   before_action :load_limit_offset_order_params, only: [:index, :contents]
  49   before_action :load_where_param, only: [:index, :contents]
  50   before_action :load_filters_param, only: [:index, :contents]
  51   before_action :find_objects_for_index, :only => :index
  52   before_action :reload_object_before_update, :only => :update
  53   before_action(:render_404_if_no_object,
  54                 except: [:index, :create] + ERROR_ACTIONS)
  55
  56   theme Rails.configuration.arvados_theme
  57
  58   attr_writer :resource_attrs
  59
  60   begin
  61     rescue_from(Exception,
  62                 ArvadosModel::PermissionDeniedError,
  63                 :with => :render_error)
  64     rescue_from(ActiveRecord::RecordNotFound,
  65                 ActionController::RoutingError,
  66                 ActionController::UnknownController,
  67                 AbstractController::ActionNotFound,
  68                 :with => :render_not_found)
  69   end
  70
  71   def initialize *args
  72     super
  73     @object = nil
  74     @objects = nil
  75     @offset = nil
  76     @limit = nil
  77     @select = nil
  78     @distinct = nil
  79     @response_resource_name = nil
  80     @attrs = nil
  81     @extra_included = nil
  82   end
  83
  84   def default_url_options
  85     options = {}
  86     if Rails.configuration.host
  87       options[:host] = Rails.configuration.host
  88     end
  89     if Rails.configuration.port
  90       options[:port] = Rails.configuration.port
  91     end
  92     if Rails.configuration.protocol
  93       options[:protocol] = Rails.configuration.protocol
  94     end
  95     options
  96   end
  97
  98   def index
  99     if params[:eager] and params[:eager] != '0' and params[:eager] != 0 and params[:eager] != ''
 100       @objects.each(&:eager_load_associations)
 101     end
 102     render_list
 103   end
 104
 105   def show
 106     send_json @object.as_api_response(nil, select: @select)
 107   end
 108
 109   def create
 110     @object = model_class.new resource_attrs
 111
 112     if @object.respond_to?(:name) && params[:ensure_unique_name]
 113       @object.save_with_unique_name!
 114     else
 115       @object.save!
 116     end
 117
 118     show
 119   end
 120
 121   def update
 122     attrs_to_update = resource_attrs.reject { |k,v|
 123       [:kind, :etag, :href].index k
 124     }
 125     @object.update_attributes! attrs_to_update
 126     show
 127   end
 128
 129   def destroy
 130     @object.destroy
 131     show
 132   end
 133
 134   def catch_redirect_hint
 135     if !current_user
 136       if params.has_key?('redirect_to') then
 137         session[:redirect_to] = params[:redirect_to]
 138       end
 139     end
 140   end
 141
 142   def render_404_if_no_object
 143     render_not_found "Object not found" if !@object
 144   end
 145
 146   def render_error(e)
 147     logger.error e.inspect
 148     if !e.is_a? RequestError and (e.respond_to? :backtrace and e.backtrace)
 149       logger.error e.backtrace.collect { |x| x + "\n" }.join('')
 150     end
 151     if (@object.respond_to? :errors and
 152         @object.errors.andand.full_messages.andand.any?)
 153       errors = @object.errors.full_messages
 154       logger.error errors.inspect
 155     else
 156       errors = [e.inspect]
 157     end
 158     status = e.respond_to?(:http_status) ? e.http_status : 422
 159     send_error(*errors, status: status)
 160   end
 161
 162   def render_not_found(e=ActionController::RoutingError.new("Path not found"))
 163     logger.error e.inspect
 164     send_error("Path not found", status: 404)
 165   end
 166
 167   def render_accepted
 168     send_json ({accepted: true}), status: 202
 169   end
 170
 171   protected
 172
 173   def send_error(*args)
 174     if args.last.is_a? Hash
 175       err = args.pop
 176     else
 177       err = {}
 178     end
 179     err[:errors] ||= args
 180     err[:error_token] = [Time.now.utc.to_i, "%08x" % rand(16 ** 8)].join("+")
 181     status = err.delete(:status) || 422
 182     logger.error "Error #{err[:error_token]}: #{status}"
 183     send_json err, status: status
 184   end
 185
 186   def send_json response, opts={}
 187     # The obvious render(json: ...) forces a slow JSON encoder. See
 188     # #3021 and commit logs. Might be fixed in Rails 4.1.
 189     render({
 190              plain: SafeJSON.dump(response).html_safe,
 191              content_type: 'application/json'
 192            }.merge opts)
 193   end
 194
 195   def find_objects_for_index
 196     @objects ||= model_class.readable_by(*@read_users, {
 197       :include_trash => (params[:include_trash] || 'untrash' == action_name),
 198       :include_old_versions => params[:include_old_versions]
 199     })
 200     apply_where_limit_order_params
 201   end
 202
 203   def apply_filters model_class=nil
 204     model_class ||= self.model_class
 205     @objects = model_class.apply_filters(@objects, @filters)
 206   end
 207
 208   def apply_where_limit_order_params model_class=nil
 209     model_class ||= self.model_class
 210     apply_filters model_class
 211
 212     ar_table_name = @objects.table_name
 213     if @where.is_a? Hash and @where.any?
 214       conditions = ['1=1']
 215       @where.each do |attr,value|
 216         if attr.to_s == 'any'
 217           if value.is_a?(Array) and
 218               value.length == 2 and
 219               value[0] == 'contains' then
 220             ilikes = []
 221             model_class.searchable_columns('ilike').each do |column|
 222               # Including owner_uuid in an "any column" search will
 223               # probably just return a lot of false positives.
 224               next if column == 'owner_uuid'
 225               ilikes << "#{ar_table_name}.#{column} ilike ?"
 226               conditions << "%#{value[1]}%"
 227             end
 228             if ilikes.any?
 229               conditions[0] << ' and (' + ilikes.join(' or ') + ')'
 230             end
 231           end
 232         elsif attr.to_s.match(/^[a-z][_a-z0-9]+$/) and
 233             model_class.columns.collect(&:name).index(attr.to_s)
 234           if value.nil?
 235             conditions[0] << " and #{ar_table_name}.#{attr} is ?"
 236             conditions << nil
 237           elsif value.is_a? Array
 238             if value[0] == 'contains' and value.length == 2
 239               conditions[0] << " and #{ar_table_name}.#{attr} like ?"
 240               conditions << "%#{value[1]}%"
 241             else
 242               conditions[0] << " and #{ar_table_name}.#{attr} in (?)"
 243               conditions << value
 244             end
 245           elsif value.is_a? String or value.is_a? Fixnum or value == true or value == false
 246             conditions[0] << " and #{ar_table_name}.#{attr}=?"
 247             conditions << value
 248           elsif value.is_a? Hash
 249             # Not quite the same thing as "equal?" but better than nothing?
 250             value.each do |k,v|
 251               if v.is_a? String
 252                 conditions[0] << " and #{ar_table_name}.#{attr} ilike ?"
 253                 conditions << "%#{k}%#{v}%"
 254               end
 255             end
 256           end
 257         end
 258       end
 259       if conditions.length > 1
 260         conditions[0].sub!(/^1=1 and /, '')
 261         @objects = @objects.
 262           where(*conditions)
 263       end
 264     end
 265
 266     if @select
 267       unless action_name.in? %w(create update destroy)
 268         # Map attribute names in @select to real column names, resolve
 269         # those to fully-qualified SQL column names, and pass the
 270         # resulting string to the select method.
 271         columns_list = model_class.columns_for_attributes(@select).
 272           map { |s| "#{ar_table_name}.#{ActiveRecord::Base.connection.quote_column_name s}" }
 273         @objects = @objects.select(columns_list.join(", "))
 274       end
 275
 276       # This information helps clients understand what they're seeing
 277       # (Workbench always expects it), but they can't select it explicitly
 278       # because it's not an SQL column.  Always add it.
 279       # (This is harmless, given that clients can deduce what they're
 280       # looking at by the returned UUID anyway.)
 281       @select |= ["kind"]
 282     end
 283     @objects = @objects.order(@orders.join ", ") if @orders.any?
 284     @objects = @objects.limit(@limit)
 285     @objects = @objects.offset(@offset)
 286     @objects = @objects.distinct(@distinct) if not @distinct.nil?
 287   end
 288
 289   # limit_database_read ensures @objects (which must be an
 290   # ActiveRelation) does not return too many results to fit in memory,
 291   # by previewing the results and calling @objects.limit() if
 292   # necessary.
 293   def limit_database_read(model_class:)
 294     return if @limit == 0 || @limit == 1
 295     model_class ||= self.model_class
 296     limit_columns = model_class.limit_index_columns_read
 297     limit_columns &= model_class.columns_for_attributes(@select) if @select
 298     return if limit_columns.empty?
 299     model_class.transaction do
 300       limit_query = @objects.
 301         except(:select, :distinct).
 302         select("(%s) as read_length" %
 303                limit_columns.map { |s| "octet_length(#{model_class.table_name}.#{s})" }.join(" + "))
 304       new_limit = 0
 305       read_total = 0
 306       limit_query.each do |record|
 307         new_limit += 1
 308         read_total += record.read_length.to_i
 309         if read_total >= Rails.configuration.max_index_database_read
 310           new_limit -= 1 if new_limit > 1
 311           @limit = new_limit
 312           break
 313         elsif new_limit >= @limit
 314           break
 315         end
 316       end
 317       @objects = @objects.limit(@limit)
 318       # Force @objects to run its query inside this transaction.
 319       @objects.each { |_| break }
 320     end
 321   end
 322
 323   def resource_attrs
 324     return @attrs if @attrs
 325     @attrs = params[resource_name]
 326     if @attrs.nil?
 327       @attrs = {}
 328     elsif @attrs.is_a? String
 329       @attrs = Oj.strict_load @attrs, symbol_keys: true
 330     end
 331     unless [Hash, ActionController::Parameters].include? @attrs.class
 332       message = "No #{resource_name}"
 333       if resource_name.index('_')
 334         message << " (or #{resource_name.camelcase(:lower)})"
 335       end
 336       message << " hash provided with request"
 337       raise ArgumentError.new(message)
 338     end
 339     %w(created_at modified_by_client_uuid modified_by_user_uuid modified_at).each do |x|
 340       @attrs.delete x.to_sym
 341     end
 342     @attrs = @attrs.symbolize_keys if @attrs.is_a? HashWithIndifferentAccess
 343     @attrs
 344   end
 345
 346   # Authentication
 347   def load_read_auths
 348     @read_auths = []
 349     if current_api_client_authorization
 350       @read_auths << current_api_client_authorization
 351     end
 352     # Load reader tokens if this is a read request.
 353     # If there are too many reader tokens, assume the request is malicious
 354     # and ignore it.
 355     if request.get? and params[:reader_tokens] and
 356       params[:reader_tokens].size < 100
 357       secrets = params[:reader_tokens].map { |t|
 358         if t.is_a? String and t.starts_with? "v2/"
 359           t.split("/")[2]
 360         else
 361           t
 362         end
 363       }
 364       @read_auths += ApiClientAuthorization
 365         .includes(:user)
 366         .where('api_token IN (?) AND
 367                 (expires_at IS NULL OR expires_at > CURRENT_TIMESTAMP)',
 368                secrets)
 369         .to_a
 370     end
 371     @read_auths.select! { |auth| auth.scopes_allow_request? request }
 372     @read_users = @read_auths.map(&:user).uniq
 373   end
 374
 375   def require_login
 376     if not current_user
 377       respond_to do |format|
 378         format.json { send_error("Not logged in", status: 401) }
 379         format.html { redirect_to '/auth/joshid' }
 380       end
 381       false
 382     end
 383   end
 384
 385   def admin_required
 386     unless current_user and current_user.is_admin
 387       send_error("Forbidden", status: 403)
 388     end
 389   end
 390
 391   def require_auth_scope
 392     unless current_user && @read_auths.any? { |auth| auth.user.andand.uuid == current_user.uuid }
 393       if require_login != false
 394         send_error("Forbidden", status: 403)
 395       end
 396       false
 397     end
 398   end
 399
 400   def set_current_request_id
 401     req_id = request.headers['X-Request-Id']
 402     if !req_id || req_id.length < 1 || req_id.length > 1024
 403       # Client-supplied ID is either missing or too long to be
 404       # considered friendly.
 405       req_id = "req-" + Random::DEFAULT.rand(2**128).to_s(36)[0..19]
 406     end
 407     response.headers['X-Request-Id'] = Thread.current[:request_id] = req_id
 408     Rails.logger.tagged(req_id) do
 409       yield
 410     end
 411     Thread.current[:request_id] = nil
 412   end
 413
 414   def append_info_to_payload(payload)
 415     super
 416     payload[:request_id] = response.headers['X-Request-Id']
 417     payload[:client_ipaddr] = @remote_ip
 418     payload[:client_auth] = current_api_client_authorization.andand.uuid || nil
 419   end
 420
 421   def disable_api_methods
 422     if Rails.configuration.disable_api_methods.
 423         include?(controller_name + "." + action_name)
 424       send_error("Disabled", status: 404)
 425     end
 426   end
 427
 428   def set_cors_headers
 429     response.headers['Access-Control-Allow-Origin'] = '*'
 430     response.headers['Access-Control-Allow-Methods'] = 'GET, HEAD, PUT, POST, DELETE'
 431     response.headers['Access-Control-Allow-Headers'] = 'Authorization, Content-Type'
 432     response.headers['Access-Control-Max-Age'] = '86486400'
 433   end
 434
 435   def respond_with_json_by_default
 436     html_index = request.accepts.index(Mime[:html])
 437     if html_index.nil? or request.accepts[0...html_index].include?(Mime[:json])
 438       request.format = :json
 439     end
 440   end
 441
 442   def model_class
 443     controller_name.classify.constantize
 444   end
 445
 446   def resource_name             # params[] key used by client
 447     controller_name.singularize
 448   end
 449
 450   def table_name
 451     controller_name
 452   end
 453
 454   def find_object_by_uuid
 455     if params[:id] and params[:id].match(/\D/)
 456       params[:uuid] = params.delete :id
 457     end
 458     @where = { uuid: params[:uuid] }
 459     @offset = 0
 460     @limit = 1
 461     @orders = []
 462     @filters = []
 463     @objects = nil
 464     find_objects_for_index
 465     @object = @objects.first
 466   end
 467
 468   def reload_object_before_update
 469     # This is necessary to prevent an ActiveRecord::ReadOnlyRecord
 470     # error when updating an object which was retrieved using a join.
 471     if @object.andand.readonly?
 472       @object = model_class.find_by_uuid(@objects.first.uuid)
 473     end
 474   end
 475
 476   def load_json_value(hash, key, must_be_class=nil)
 477     if hash[key].is_a? String
 478       hash[key] = SafeJSON.load(hash[key])
 479       if must_be_class and !hash[key].is_a? must_be_class
 480         raise TypeError.new("parameter #{key.to_s} must be a #{must_be_class.to_s}")
 481       end
 482     end
 483   end
 484
 485   def self.accept_attribute_as_json(attr, must_be_class=nil)
 486     before_action lambda { accept_attribute_as_json attr, must_be_class }
 487   end
 488   accept_attribute_as_json :properties, Hash
 489   accept_attribute_as_json :info, Hash
 490   def accept_attribute_as_json(attr, must_be_class)
 491     if params[resource_name] and resource_attrs.is_a? Hash
 492       if resource_attrs[attr].is_a? Hash
 493         # Convert symbol keys to strings (in hashes provided by
 494         # resource_attrs)
 495         resource_attrs[attr] = resource_attrs[attr].
 496           with_indifferent_access.to_hash
 497       else
 498         load_json_value(resource_attrs, attr, must_be_class)
 499       end
 500     end
 501   end
 502
 503   def self.accept_param_as_json(key, must_be_class=nil)
 504     prepend_before_action lambda { load_json_value(params, key, must_be_class) }
 505   end
 506   accept_param_as_json :reader_tokens, Array
 507
 508   def object_list(model_class:)
 509     if @objects.respond_to?(:except)
 510       limit_database_read(model_class: model_class)
 511     end
 512     list = {
 513       :kind  => "arvados##{(@response_resource_name || resource_name).camelize(:lower)}List",
 514       :etag => "",
 515       :self_link => "",
 516       :offset => @offset,
 517       :limit => @limit,
 518       :items => @objects.as_api_response(nil, {select: @select})
 519     }
 520     if @extra_included
 521       list[:included] = @extra_included.as_api_response(nil, {select: @select})
 522     end
 523     case params[:count]
 524     when nil, '', 'exact'
 525       if @objects.respond_to? :except
 526         list[:items_available] = @objects.
 527           except(:limit).except(:offset).
 528           distinct.count(:id)
 529       end
 530     when 'none'
 531     else
 532       raise ArgumentError.new("count parameter must be 'exact' or 'none'")
 533     end
 534     list
 535   end
 536
 537   def render_list
 538     send_json object_list(model_class: self.model_class)
 539   end
 540
 541   def remote_ip
 542     # Caveat: this is highly dependent on the proxy setup. YMMV.
 543     if request.headers.key?('HTTP_X_REAL_IP') then
 544       # We're behind a reverse proxy
 545       @remote_ip = request.headers['HTTP_X_REAL_IP']
 546     else
 547       # Hopefully, we are not!
 548       @remote_ip = request.env['REMOTE_ADDR']
 549     end
 550   end
 551
 552   def load_required_parameters
 553     (self.class.send "_#{params[:action]}_requires_parameters" rescue {}).
 554       each do |key, info|
 555       if info[:required] and not params.include?(key)
 556         raise ArgumentError.new("#{key} parameter is required")
 557       elsif info[:type] == 'boolean'
 558         # Make sure params[key] is either true or false -- not a
 559         # string, not nil, etc.
 560         if not params.include?(key)
 561           params[key] = info[:default]
 562         elsif [false, 'false', '0', 0].include? params[key]
 563           params[key] = false
 564         elsif [true, 'true', '1', 1].include? params[key]
 565           params[key] = true
 566         else
 567           raise TypeError.new("#{key} parameter must be a boolean, true or false")
 568         end
 569       end
 570     end
 571     true
 572   end
 573
 574   def self._create_requires_parameters
 575     {
 576       ensure_unique_name: {
 577         type: "boolean",
 578         description: "Adjust name to ensure uniqueness instead of returning an error on (owner_uuid, name) collision.",
 579         location: "query",
 580         required: false,
 581         default: false
 582       },
 583       cluster_id: {
 584         type: 'string',
 585         description: "Create object on a remote federated cluster instead of the current one.",
 586         location: "query",
 587         required: false,
 588       },
 589     }
 590   end
 591
 592   def self._update_requires_parameters
 593     {}
 594   end
 595
 596   def self._index_requires_parameters
 597     {
 598       filters: { type: 'array', required: false },
 599       where: { type: 'object', required: false },
 600       order: { type: 'array', required: false },
 601       select: { type: 'array', required: false },
 602       distinct: { type: 'boolean', required: false },
 603       limit: { type: 'integer', required: false, default: DEFAULT_LIMIT },
 604       offset: { type: 'integer', required: false, default: 0 },
 605       count: { type: 'string', required: false, default: 'exact' },
 606       cluster_id: {
 607         type: 'string',
 608         description: "List objects on a remote federated cluster instead of the current one.",
 609         location: "query",
 610         required: false,
 611       },
 612     }
 613   end
 614
 615   def client_accepts_plain_text_stream
 616     (request.headers['Accept'].split(' ') &
 617      ['text/plain', '*/*']).count > 0
 618   end
 619
 620   def render *opts
 621     if opts.first
 622       response = opts.first[:json]
 623       if response.is_a?(Hash) &&
 624           params[:_profile] &&
 625           Thread.current[:request_starttime]
 626         response[:_profile] = {
 627           request_time: Time.now - Thread.current[:request_starttime]
 628         }
 629       end
 630     end
 631     super(*opts)
 632   end
 633 end