1 # Copyright (C) The Arvados Authors. All rights reserved.
3 # SPDX-License-Identifier: AGPL-3.0
7 module ApiTemplateOverride
8 def allowed_to_render?(fieldset, field, model, options)
11 options[:select].include? field.to_s
18 class ActsAsApi::ApiTemplate
19 prepend ApiTemplateOverride
24 class ApplicationController < ActionController::Base
25 include ThemesForRails::ActionController
26 include CurrentApiClient
33 ERROR_ACTIONS = [:render_error, :render_not_found]
35 before_filter :disable_api_methods
36 before_filter :set_cors_headers
37 before_filter :respond_with_json_by_default
38 before_filter :remote_ip
39 before_filter :load_read_auths
40 before_filter :require_auth_scope, except: ERROR_ACTIONS
42 before_filter :catch_redirect_hint
43 before_filter(:find_object_by_uuid,
44 except: [:index, :create] + ERROR_ACTIONS)
45 before_filter :load_required_parameters
46 before_filter :load_limit_offset_order_params, only: [:index, :contents]
47 before_filter :load_where_param, only: [:index, :contents]
48 before_filter :load_filters_param, only: [:index, :contents]
49 before_filter :find_objects_for_index, :only => :index
50 before_filter :reload_object_before_update, :only => :update
51 before_filter(:render_404_if_no_object,
52 except: [:index, :create] + ERROR_ACTIONS)
54 theme Rails.configuration.arvados_theme
56 attr_writer :resource_attrs
59 rescue_from(Exception,
60 ArvadosModel::PermissionDeniedError,
61 :with => :render_error)
62 rescue_from(ActiveRecord::RecordNotFound,
63 ActionController::RoutingError,
64 ActionController::UnknownController,
65 AbstractController::ActionNotFound,
66 :with => :render_not_found)
77 @response_resource_name = nil
81 def default_url_options
82 if Rails.configuration.host
83 {:host => Rails.configuration.host}
90 if @select.nil? || @select.include?("id")
91 @objects = @objects.uniq(&:id)
93 if params[:eager] and params[:eager] != '0' and params[:eager] != 0 and params[:eager] != ''
94 @objects.each(&:eager_load_associations)
100 send_json @object.as_api_response(nil, select: @select)
104 @object = model_class.new resource_attrs
106 if @object.respond_to?(:name) && params[:ensure_unique_name]
107 @object.save_with_unique_name!
116 attrs_to_update = resource_attrs.reject { |k,v|
117 [:kind, :etag, :href].index k
119 @object.update_attributes! attrs_to_update
128 def catch_redirect_hint
130 if params.has_key?('redirect_to') then
131 session[:redirect_to] = params[:redirect_to]
136 def render_404_if_no_object
137 render_not_found "Object not found" if !@object
141 logger.error e.inspect
142 if e.respond_to? :backtrace and e.backtrace
143 logger.error e.backtrace.collect { |x| x + "\n" }.join('')
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
152 status = e.respond_to?(:http_status) ? e.http_status : 422
153 send_error(*errors, status: status)
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)
163 def send_error(*args)
164 if args.last.is_a? Hash
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
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.
180 text: SafeJSON.dump(response).html_safe,
181 content_type: 'application/json'
185 def find_objects_for_index
186 @objects ||= model_class.readable_by(*@read_users)
187 apply_where_limit_order_params
190 def apply_filters model_class=nil
191 model_class ||= self.model_class
192 @objects = model_class.apply_filters(@objects, @filters)
195 def apply_where_limit_order_params model_class=nil
196 model_class ||= self.model_class
197 apply_filters model_class
199 ar_table_name = @objects.table_name
200 if @where.is_a? Hash and @where.any?
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
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]}%"
216 conditions[0] << ' and (' + ilikes.join(' or ') + ')'
219 elsif attr.to_s.match(/^[a-z][_a-z0-9]+$/) and
220 model_class.columns.collect(&:name).index(attr.to_s)
222 conditions[0] << " and #{ar_table_name}.#{attr} is ?"
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]}%"
229 conditions[0] << " and #{ar_table_name}.#{attr} in (?)"
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}=?"
235 elsif value.is_a? Hash
236 # Not quite the same thing as "equal?" but better than nothing?
239 conditions[0] << " and #{ar_table_name}.#{attr} ilike ?"
240 conditions << "%#{k}%#{v}%"
246 if conditions.length > 1
247 conditions[0].sub!(/^1=1 and /, '')
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(", "))
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.)
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?
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
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(" + "))
293 limit_query.each do |record|
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
300 elsif new_limit >= @limit
304 @objects = @objects.limit(@limit)
305 # Force @objects to run its query inside this transaction.
306 @objects.each { |_| break }
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
316 unless @attrs.is_a? Hash
317 message = "No #{resource_name}"
318 if resource_name.index('_')
319 message << " (or #{resource_name.camelcase(:lower)})"
321 message << " hash provided with request"
322 raise ArgumentError.new(message)
324 %w(created_at modified_by_client_uuid modified_by_user_uuid modified_at).each do |x|
325 @attrs.delete x.to_sym
327 @attrs = @attrs.symbolize_keys if @attrs.is_a? HashWithIndifferentAccess
334 if current_api_client_authorization
335 @read_auths << current_api_client_authorization
337 # Load reader tokens if this is a read request.
338 # If there are too many reader tokens, assume the request is malicious
340 if request.get? and params[:reader_tokens] and
341 params[:reader_tokens].size < 100
342 @read_auths += ApiClientAuthorization
344 .where('api_token IN (?) AND
345 (expires_at IS NULL OR expires_at > CURRENT_TIMESTAMP)',
346 params[:reader_tokens])
349 @read_auths.select! { |auth| auth.scopes_allow_request? request }
350 @read_users = @read_auths.map { |auth| auth.user }.uniq
355 respond_to do |format|
356 format.json { send_error("Not logged in", status: 401) }
357 format.html { redirect_to '/auth/joshid' }
364 unless current_user and current_user.is_admin
365 send_error("Forbidden", status: 403)
369 def require_auth_scope
370 if @read_auths.empty?
371 if require_login != false
372 send_error("Forbidden", status: 403)
378 def disable_api_methods
379 if Rails.configuration.disable_api_methods.
380 include?(controller_name + "." + action_name)
381 send_error("Disabled", status: 404)
386 response.headers['Access-Control-Allow-Origin'] = '*'
387 response.headers['Access-Control-Allow-Methods'] = 'GET, HEAD, PUT, POST, DELETE'
388 response.headers['Access-Control-Allow-Headers'] = 'Authorization'
389 response.headers['Access-Control-Max-Age'] = '86486400'
392 def respond_with_json_by_default
393 html_index = request.accepts.index(Mime::HTML)
394 if html_index.nil? or request.accepts[0...html_index].include?(Mime::JSON)
395 request.format = :json
400 controller_name.classify.constantize
403 def resource_name # params[] key used by client
404 controller_name.singularize
411 def find_object_by_uuid
412 if params[:id] and params[:id].match(/\D/)
413 params[:uuid] = params.delete :id
415 @where = { uuid: params[:uuid] }
421 find_objects_for_index
422 @object = @objects.first
425 def reload_object_before_update
426 # This is necessary to prevent an ActiveRecord::ReadOnlyRecord
427 # error when updating an object which was retrieved using a join.
428 if @object.andand.readonly?
429 @object = model_class.find_by_uuid(@objects.first.uuid)
433 def load_json_value(hash, key, must_be_class=nil)
434 if hash[key].is_a? String
435 hash[key] = SafeJSON.load(hash[key])
436 if must_be_class and !hash[key].is_a? must_be_class
437 raise TypeError.new("parameter #{key.to_s} must be a #{must_be_class.to_s}")
442 def self.accept_attribute_as_json(attr, must_be_class=nil)
443 before_filter lambda { accept_attribute_as_json attr, must_be_class }
445 accept_attribute_as_json :properties, Hash
446 accept_attribute_as_json :info, Hash
447 def accept_attribute_as_json(attr, must_be_class)
448 if params[resource_name] and resource_attrs.is_a? Hash
449 if resource_attrs[attr].is_a? Hash
450 # Convert symbol keys to strings (in hashes provided by
452 resource_attrs[attr] = resource_attrs[attr].
453 with_indifferent_access.to_hash
455 load_json_value(resource_attrs, attr, must_be_class)
460 def self.accept_param_as_json(key, must_be_class=nil)
461 prepend_before_filter lambda { load_json_value(params, key, must_be_class) }
463 accept_param_as_json :reader_tokens, Array
465 def object_list(model_class:)
466 if @objects.respond_to?(:except)
467 limit_database_read(model_class: model_class)
470 :kind => "arvados##{(@response_resource_name || resource_name).camelize(:lower)}List",
475 :items => @objects.as_api_response(nil, {select: @select})
478 when nil, '', 'exact'
479 if @objects.respond_to? :except
480 list[:items_available] = @objects.
481 except(:limit).except(:offset).
482 count(:id, distinct: true)
486 raise ArgumentError.new("count parameter must be 'exact' or 'none'")
492 send_json object_list(model_class: self.model_class)
496 # Caveat: this is highly dependent on the proxy setup. YMMV.
497 if request.headers.key?('HTTP_X_REAL_IP') then
498 # We're behind a reverse proxy
499 @remote_ip = request.headers['HTTP_X_REAL_IP']
501 # Hopefully, we are not!
502 @remote_ip = request.env['REMOTE_ADDR']
506 def load_required_parameters
507 (self.class.send "_#{params[:action]}_requires_parameters" rescue {}).
509 if info[:required] and not params.include?(key)
510 raise ArgumentError.new("#{key} parameter is required")
511 elsif info[:type] == 'boolean'
512 # Make sure params[key] is either true or false -- not a
513 # string, not nil, etc.
514 if not params.include?(key)
515 params[key] = info[:default]
516 elsif [false, 'false', '0', 0].include? params[key]
518 elsif [true, 'true', '1', 1].include? params[key]
521 raise TypeError.new("#{key} parameter must be a boolean, true or false")
528 def self._create_requires_parameters
530 ensure_unique_name: {
532 description: "Adjust name to ensure uniqueness instead of returning an error on (owner_uuid, name) collision.",
540 def self._index_requires_parameters
542 filters: { type: 'array', required: false },
543 where: { type: 'object', required: false },
544 order: { type: 'array', required: false },
545 select: { type: 'array', required: false },
546 distinct: { type: 'boolean', required: false },
547 limit: { type: 'integer', required: false, default: DEFAULT_LIMIT },
548 offset: { type: 'integer', required: false, default: 0 },
549 count: { type: 'string', required: false, default: 'exact' },
553 def client_accepts_plain_text_stream
554 (request.headers['Accept'].split(' ') &
555 ['text/plain', '*/*']).count > 0
560 response = opts.first[:json]
561 if response.is_a?(Hash) &&
563 Thread.current[:request_starttime]
564 response[:_profile] = {
565 request_time: Time.now - Thread.current[:request_starttime]