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