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