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