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