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