services/api/app/controllers/application_controller.rb

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