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