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