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