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