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