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