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