1 # Copyright (C) The Arvados Authors. All rights reserved.
3 # SPDX-License-Identifier: AGPL-3.0
6 require 'request_error'
8 module ApiTemplateOverride
9 def allowed_to_render?(fieldset, field, model, options)
10 return false if !super
12 options[:select].include? field.to_s
19 class ActsAsApi::ApiTemplate
20 prepend ApiTemplateOverride
25 class ApplicationController < ActionController::Base
26 include ThemesForRails::ActionController
27 include CurrentApiClient
34 ERROR_ACTIONS = [:render_error, :render_not_found]
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
44 before_action :catch_redirect_hint
45 before_action :load_required_parameters
46 before_action :load_limit_offset_order_params, only: [:index, :contents]
47 before_action :load_select_param
48 before_action(:find_object_by_uuid,
49 except: [:index, :create, :update] + ERROR_ACTIONS)
50 before_action :find_object_for_update, only: [:update]
51 before_action :load_where_param, only: [:index, :contents]
52 before_action :load_filters_param, only: [:index, :contents]
53 before_action :find_objects_for_index, :only => :index
54 before_action(:set_nullable_attrs_to_null, only: [:update, :create])
55 before_action :reload_object_before_update, :only => :update
56 before_action(:render_404_if_no_object,
57 except: [:index, :create] + ERROR_ACTIONS)
58 before_action :only_admin_can_bypass_federation
60 attr_writer :resource_attrs
63 rescue_from(Exception,
64 ArvadosModel::PermissionDeniedError,
65 :with => :render_error)
66 rescue_from(ActiveRecord::RecordNotFound,
67 ActionController::RoutingError,
68 AbstractController::ActionNotFound,
69 :with => :render_not_found)
80 @response_resource_name = nil
85 def default_url_options
87 if Rails.configuration.Services.Controller.ExternalURL != URI("")
88 exturl = Rails.configuration.Services.Controller.ExternalURL
89 options[:host] = exturl.host
90 options[:port] = exturl.port
91 options[:protocol] = exturl.scheme
97 if params[:eager] and params[:eager] != '0' and params[:eager] != 0 and params[:eager] != ''
98 @objects.each(&:eager_load_associations)
104 send_json @object.as_api_response(nil, select: @select)
108 @object = model_class.new resource_attrs
110 if @object.respond_to?(:name) && params[:ensure_unique_name]
111 @object.save_with_unique_name!
120 attrs_to_update = resource_attrs.reject { |k,v|
121 [:kind, :etag, :href].index k
123 @object.update_attributes! attrs_to_update
132 def catch_redirect_hint
134 if params.has_key?('redirect_to') then
135 session[:redirect_to] = params[:redirect_to]
140 def render_404_if_no_object
141 render_not_found "Object not found" if !@object
144 def only_admin_can_bypass_federation
145 unless !params[:bypass_federation] || current_user.andand.is_admin
146 send_error("The bypass_federation parameter is only permitted when current user is admin", status: 403)
151 logger.error e.inspect
152 if e.respond_to? :backtrace and e.backtrace
153 # This will be cleared by lograge after adding it to the log.
154 # Usually lograge would get the exceptions, but in our case we're catching
155 # all of them with exception handlers that cannot re-raise them because they
156 # don't get propagated.
157 Thread.current[:exception] = e.inspect
158 Thread.current[:backtrace] = e.backtrace.collect { |x| x + "\n" }.join('')
160 if (@object.respond_to? :errors and
161 @object.errors.andand.full_messages.andand.any?)
162 errors = @object.errors.full_messages
163 logger.error errors.inspect
167 status = e.respond_to?(:http_status) ? e.http_status : 422
168 send_error(*errors, status: status)
171 def render_not_found(e=ActionController::RoutingError.new("Path not found"))
172 logger.error e.inspect
173 send_error("Path not found", status: 404)
177 send_json ({accepted: true}), status: 202
182 def bool_param(pname)
183 if params.include?(pname)
184 if params[pname].is_a?(Boolean)
187 logger.warn "Warning: received non-boolean value #{params[pname].inspect} for boolean parameter #{pname} on #{self.class.inspect}, treating as false."
193 def send_error(*args)
194 if args.last.is_a? Hash
199 err[:errors] ||= args
200 err[:errors].map! do |err|
201 err += " (#{request.request_id})"
203 err[:error_token] = [Time.now.utc.to_i, "%08x" % rand(16 ** 8)].join("+")
204 status = err.delete(:status) || 422
205 logger.error "Error #{err[:error_token]}: #{status}"
206 send_json err, status: status
209 def send_json response, opts={}
210 # The obvious render(json: ...) forces a slow JSON encoder. See
211 # #3021 and commit logs. Might be fixed in Rails 4.1.
213 plain: SafeJSON.dump(response).html_safe,
214 content_type: 'application/json'
218 def find_objects_for_index
219 @objects ||= model_class.readable_by(*@read_users, {
220 :include_trash => (bool_param(:include_trash) || 'untrash' == action_name),
221 :include_old_versions => bool_param(:include_old_versions)
223 apply_where_limit_order_params
226 def apply_filters model_class=nil
227 model_class ||= self.model_class
228 @objects = model_class.apply_filters(@objects, @filters)
231 def apply_where_limit_order_params model_class=nil
232 model_class ||= self.model_class
233 apply_filters model_class
235 ar_table_name = @objects.table_name
236 if @where.is_a? Hash and @where.any?
238 @where.each do |attr,value|
239 if attr.to_s == 'any'
240 if value.is_a?(Array) and
241 value.length == 2 and
242 value[0] == 'contains' then
244 model_class.searchable_columns('ilike').each do |column|
245 # Including owner_uuid in an "any column" search will
246 # probably just return a lot of false positives.
247 next if column == 'owner_uuid'
248 ilikes << "#{ar_table_name}.#{column} ilike ?"
249 conditions << "%#{value[1]}%"
252 conditions[0] << ' and (' + ilikes.join(' or ') + ')'
255 elsif attr.to_s.match(/^[a-z][_a-z0-9]+$/) and
256 model_class.columns.collect(&:name).index(attr.to_s)
258 conditions[0] << " and #{ar_table_name}.#{attr} is ?"
260 elsif value.is_a? Array
261 if value[0] == 'contains' and value.length == 2
262 conditions[0] << " and #{ar_table_name}.#{attr} like ?"
263 conditions << "%#{value[1]}%"
265 conditions[0] << " and #{ar_table_name}.#{attr} in (?)"
268 elsif value.is_a? String or value.is_a? Integer or value == true or value == false
269 conditions[0] << " and #{ar_table_name}.#{attr}=?"
271 elsif value.is_a? Hash
272 # Not quite the same thing as "equal?" but better than nothing?
275 conditions[0] << " and #{ar_table_name}.#{attr} ilike ?"
276 conditions << "%#{k}%#{v}%"
282 if conditions.length > 1
283 conditions[0].sub!(/^1=1 and /, '')
290 unless action_name.in? %w(create update destroy)
291 # Map attribute names in @select to real column names, resolve
292 # those to fully-qualified SQL column names, and pass the
293 # resulting string to the select method.
294 columns_list = model_class.columns_for_attributes(@select).
295 map { |s| "#{ar_table_name}.#{ActiveRecord::Base.connection.quote_column_name s}" }
296 @objects = @objects.select(columns_list.join(", "))
299 # This information helps clients understand what they're seeing
300 # (Workbench always expects it), but they can't select it explicitly
301 # because it's not an SQL column. Always add it.
302 # (This is harmless, given that clients can deduce what they're
303 # looking at by the returned UUID anyway.)
306 @objects = @objects.order(@orders.join ", ") if @orders.any?
307 @objects = @objects.limit(@limit)
308 @objects = @objects.offset(@offset)
309 @objects = @objects.distinct() if @distinct
312 # limit_database_read ensures @objects (which must be an
313 # ActiveRelation) does not return too many results to fit in memory,
314 # by previewing the results and calling @objects.limit() if
316 def limit_database_read(model_class:)
317 return if @limit == 0 || @limit == 1
318 model_class ||= self.model_class
319 limit_columns = model_class.limit_index_columns_read
320 limit_columns &= model_class.columns_for_attributes(@select) if @select
321 return if limit_columns.empty?
322 model_class.transaction do
323 limit_query = @objects.
324 except(:select, :distinct).
325 select("(%s) as read_length" %
326 limit_columns.map { |s| "octet_length(#{model_class.table_name}.#{s})" }.join(" + "))
329 limit_query.each do |record|
331 read_total += record.read_length.to_i
332 if read_total >= Rails.configuration.API.MaxIndexDatabaseRead
333 new_limit -= 1 if new_limit > 1
336 elsif new_limit >= @limit
340 @objects = @objects.limit(@limit)
341 # Force @objects to run its query inside this transaction.
342 @objects.each { |_| break }
347 return @attrs if @attrs
348 @attrs = params[resource_name]
351 elsif @attrs.is_a? String
352 @attrs = Oj.strict_load @attrs, symbol_keys: true
354 unless [Hash, ActionController::Parameters].include? @attrs.class
355 message = "No #{resource_name}"
356 if resource_name.index('_')
357 message << " (or #{resource_name.camelcase(:lower)})"
359 message << " hash provided with request"
360 raise ArgumentError.new(message)
362 %w(created_at modified_by_client_uuid modified_by_user_uuid modified_at).each do |x|
363 @attrs.delete x.to_sym
365 @attrs = @attrs.symbolize_keys if @attrs.is_a? ActiveSupport::HashWithIndifferentAccess
372 if current_api_client_authorization
373 @read_auths << current_api_client_authorization
375 # Load reader tokens if this is a read request.
376 # If there are too many reader tokens, assume the request is malicious
378 if request.get? and params[:reader_tokens] and
379 params[:reader_tokens].size < 100
380 secrets = params[:reader_tokens].map { |t|
381 if t.is_a? String and t.starts_with? "v2/"
387 @read_auths += ApiClientAuthorization
389 .where('api_token IN (?) AND
390 (expires_at IS NULL OR expires_at > CURRENT_TIMESTAMP)',
394 @read_auths.select! { |auth| auth.scopes_allow_request? request }
395 @read_users = @read_auths.map(&:user).uniq
400 respond_to do |format|
401 format.json { send_error("Not logged in", status: 401) }
402 format.html { redirect_to '/login' }
409 unless current_user and current_user.is_admin
410 send_error("Forbidden", status: 403)
414 def require_auth_scope
415 unless current_user && @read_auths.any? { |auth| auth.user.andand.uuid == current_user.uuid }
416 if require_login != false
417 send_error("Forbidden", status: 403)
423 def set_current_request_id
424 Rails.logger.tagged(request.request_id) do
429 def append_info_to_payload(payload)
431 payload[:request_id] = request.request_id
432 payload[:client_ipaddr] = @remote_ip
433 payload[:client_auth] = current_api_client_authorization.andand.uuid || nil
436 def disable_api_methods
437 if Rails.configuration.API.DisabledAPIs[controller_name + "." + action_name]
438 send_error("Disabled", status: 404)
443 response.headers['Access-Control-Allow-Origin'] = '*'
444 response.headers['Access-Control-Allow-Methods'] = 'GET, HEAD, PUT, POST, DELETE'
445 response.headers['Access-Control-Allow-Headers'] = 'Authorization, Content-Type'
446 response.headers['Access-Control-Max-Age'] = '86486400'
449 def respond_with_json_by_default
450 html_index = request.accepts.index(Mime[:html])
451 if html_index.nil? or request.accepts[0...html_index].include?(Mime[:json])
452 request.format = :json
457 controller_name.classify.constantize
460 def resource_name # params[] key used by client
461 controller_name.singularize
468 def find_object_for_update
469 find_object_by_uuid(with_lock: true)
472 def find_object_by_uuid(with_lock: false)
473 if params[:id] and params[:id].match(/\D/)
474 params[:uuid] = params.delete :id
476 @where = { uuid: params[:uuid] }
482 find_objects_for_index
483 if with_lock && Rails.configuration.API.LockBeforeUpdate
484 @object = @objects.lock.first
486 @object = @objects.first
490 def nullable_attributes
494 # Go code may send empty values (ie: empty string instead of NULL) that
495 # should be translated to NULL on the database.
496 def set_nullable_attrs_to_null
497 nullify_attrs(resource_attrs.to_hash).each do |k, v|
498 resource_attrs[k] = v
502 def nullify_attrs(a = {})
503 new_attrs = a.to_hash.symbolize_keys
504 (new_attrs.keys & nullable_attributes).each do |attr|
505 val = new_attrs[attr]
506 if (val.class == Integer && val == 0) || (val.class == String && val == "")
507 new_attrs[attr] = nil
513 def reload_object_before_update
514 # This is necessary to prevent an ActiveRecord::ReadOnlyRecord
515 # error when updating an object which was retrieved using a join.
516 if @object.andand.readonly?
517 @object = model_class.find_by_uuid(@objects.first.uuid)
521 def load_json_value(hash, key, must_be_class=nil)
522 return if hash[key].nil?
525 if val.is_a? ActionController::Parameters
526 val = val.to_unsafe_hash
527 elsif val.is_a? String
528 val = SafeJSON.load(val)
531 # When assigning a Hash to an ActionController::Parameters and then
532 # retrieve it, we get another ActionController::Parameters instead of
533 # a Hash. This doesn't happen with other types. This is why 'val' is
534 # being used to do type checking below.
535 if must_be_class and !val.is_a? must_be_class
536 raise TypeError.new("parameter #{key.to_s} must be a #{must_be_class.to_s}")
540 def self.accept_attribute_as_json(attr, must_be_class=nil)
541 before_action lambda { accept_attribute_as_json attr, must_be_class }
543 accept_attribute_as_json :properties, Hash
544 accept_attribute_as_json :info, Hash
545 def accept_attribute_as_json(attr, must_be_class)
546 if params[resource_name] and [Hash, ActionController::Parameters].include?(resource_attrs.class)
547 if resource_attrs[attr].is_a? Hash
548 # Convert symbol keys to strings (in hashes provided by
550 resource_attrs[attr] = resource_attrs[attr].
551 with_indifferent_access.to_hash
553 load_json_value(resource_attrs, attr, must_be_class)
558 def self.accept_param_as_json(key, must_be_class=nil)
559 prepend_before_action lambda { load_json_value(params, key, must_be_class) }
561 accept_param_as_json :reader_tokens, Array
563 def object_list(model_class:)
564 if @objects.respond_to?(:except)
565 limit_database_read(model_class: model_class)
568 :kind => "arvados##{(@response_resource_name || resource_name).camelize(:lower)}List",
573 :items => @objects.as_api_response(nil, {select: @select})
576 list[:included] = @extra_included.as_api_response(nil, {select: @select})
579 when nil, '', 'exact'
580 if @objects.respond_to? :except
581 list[:items_available] = @objects.
582 except(:limit).except(:offset).
583 count(@distinct ? :id : '*')
587 raise ArgumentError.new("count parameter must be 'exact' or 'none'")
593 send_json object_list(model_class: self.model_class)
597 # Caveat: this is highly dependent on the proxy setup. YMMV.
598 if request.headers.key?('HTTP_X_REAL_IP') then
599 # We're behind a reverse proxy
600 @remote_ip = request.headers['HTTP_X_REAL_IP']
602 # Hopefully, we are not!
603 @remote_ip = request.env['REMOTE_ADDR']
607 def load_required_parameters
608 (self.class.send "_#{params[:action]}_requires_parameters" rescue {}).
610 if info[:required] and not params.include?(key)
611 raise ArgumentError.new("#{key} parameter is required")
612 elsif info[:type] == 'boolean'
613 # Make sure params[key] is either true or false -- not a
614 # string, not nil, etc.
615 if not params.include?(key)
616 params[key] = info[:default] || false
617 elsif [false, 'false', '0', 0].include? params[key]
619 elsif [true, 'true', '1', 1].include? params[key]
622 raise TypeError.new("#{key} parameter must be a boolean, true or false")
629 def self._create_requires_parameters
633 description: "Attributes of the new object to return in the response.",
636 ensure_unique_name: {
638 description: "Adjust name to ensure uniqueness instead of returning an error on (owner_uuid, name) collision.",
645 description: "Create object on a remote federated cluster instead of the current one.",
652 def self._update_requires_parameters
656 description: "Attributes of the updated object to return in the response.",
662 def self._show_requires_parameters
666 description: "Attributes of the object to return in the response.",
672 def self._index_requires_parameters
674 filters: { type: 'array', required: false },
675 where: { type: 'object', required: false },
676 order: { type: 'array', required: false },
679 description: "Attributes of each object to return in the response.",
682 distinct: { type: 'boolean', required: false, default: false },
683 limit: { type: 'integer', required: false, default: DEFAULT_LIMIT },
684 offset: { type: 'integer', required: false, default: 0 },
685 count: { type: 'string', required: false, default: 'exact' },
688 description: "List objects on a remote federated cluster instead of the current one.",
695 description: 'bypass federation behavior, list items from local instance database only'
702 response = opts.first[:json]
703 if response.is_a?(Hash) &&
705 Thread.current[:request_starttime]
706 response[:_profile] = {
707 request_time: Time.now - Thread.current[:request_starttime]