3 module ApiTemplateOverride
4 def allowed_to_render?(fieldset, field, model, options)
7 options[:select].include? field.to_s
14 class ActsAsApi::ApiTemplate
15 prepend ApiTemplateOverride
20 class ApplicationController < ActionController::Base
21 include CurrentApiClient
22 include ThemesForRails::ActionController
29 ERROR_ACTIONS = [:render_error, :render_not_found]
31 before_filter :disable_api_methods
32 before_filter :set_cors_headers
33 before_filter :respond_with_json_by_default
34 before_filter :remote_ip
35 before_filter :load_read_auths
36 before_filter :require_auth_scope, except: ERROR_ACTIONS
38 before_filter :catch_redirect_hint
39 before_filter(:find_object_by_uuid,
40 except: [:index, :create] + ERROR_ACTIONS)
41 before_filter :load_required_parameters
42 before_filter :load_limit_offset_order_params, only: [:index, :contents]
43 before_filter :load_where_param, only: [:index, :contents]
44 before_filter :load_filters_param, only: [:index, :contents]
45 before_filter :find_objects_for_index, :only => :index
46 before_filter :reload_object_before_update, :only => :update
47 before_filter(:render_404_if_no_object,
48 except: [:index, :create] + ERROR_ACTIONS)
52 attr_writer :resource_attrs
55 rescue_from(Exception,
56 ArvadosModel::PermissionDeniedError,
57 :with => :render_error)
58 rescue_from(ActiveRecord::RecordNotFound,
59 ActionController::RoutingError,
60 ActionController::UnknownController,
61 AbstractController::ActionNotFound,
62 :with => :render_not_found)
73 @response_resource_name = nil
77 def default_url_options
78 if Rails.configuration.host
79 {:host => Rails.configuration.host}
86 @objects.uniq!(&:id) if @select.nil? or @select.include? "id"
87 if params[:eager] and params[:eager] != '0' and params[:eager] != 0 and params[:eager] != ''
88 @objects.each(&:eager_load_associations)
94 send_json @object.as_api_response(nil, select: @select)
98 @object = model_class.new resource_attrs
100 if @object.respond_to?(:name) && params[:ensure_unique_name]
101 @object.save_with_unique_name!
110 attrs_to_update = resource_attrs.reject { |k,v|
111 [:kind, :etag, :href].index k
113 @object.update_attributes! attrs_to_update
122 def catch_redirect_hint
124 if params.has_key?('redirect_to') then
125 session[:redirect_to] = params[:redirect_to]
130 def render_404_if_no_object
131 render_not_found "Object not found" if !@object
135 logger.error e.inspect
136 if e.respond_to? :backtrace and e.backtrace
137 logger.error e.backtrace.collect { |x| x + "\n" }.join('')
139 if (@object.respond_to? :errors and
140 @object.errors.andand.full_messages.andand.any?)
141 errors = @object.errors.full_messages
142 logger.error errors.inspect
146 status = e.respond_to?(:http_status) ? e.http_status : 422
147 send_error(*errors, status: status)
150 def render_not_found(e=ActionController::RoutingError.new("Path not found"))
151 logger.error e.inspect
152 send_error("Path not found", status: 404)
157 def send_error(*args)
158 if args.last.is_a? Hash
163 err[:errors] ||= args
164 err[:error_token] = [Time.now.utc.to_i, "%08x" % rand(16 ** 8)].join("+")
165 status = err.delete(:status) || 422
166 logger.error "Error #{err[:error_token]}: #{status}"
167 send_json err, status: status
170 def send_json response, opts={}
171 # The obvious render(json: ...) forces a slow JSON encoder. See
172 # #3021 and commit logs. Might be fixed in Rails 4.1.
174 text: SafeJSON.dump(response).html_safe,
175 content_type: 'application/json'
179 def self.limit_index_columns_read
180 # This method returns a list of column names.
181 # If an index request reads that column from the database,
182 # find_objects_for_index will only fetch objects until it reads
183 # max_index_database_read bytes of data from those columns.
187 def find_objects_for_index
188 @objects ||= model_class.readable_by(*@read_users)
189 apply_where_limit_order_params
190 limit_database_read if (action_name == "index")
193 def apply_filters model_class=nil
194 model_class ||= self.model_class
195 @objects = model_class.apply_filters(@objects, @filters)
198 def apply_where_limit_order_params model_class=nil
199 model_class ||= self.model_class
200 apply_filters model_class
202 ar_table_name = @objects.table_name
203 if @where.is_a? Hash and @where.any?
205 @where.each do |attr,value|
206 if attr.to_s == 'any'
207 if value.is_a?(Array) and
208 value.length == 2 and
209 value[0] == 'contains' then
211 model_class.searchable_columns('ilike').each do |column|
212 # Including owner_uuid in an "any column" search will
213 # probably just return a lot of false positives.
214 next if column == 'owner_uuid'
215 ilikes << "#{ar_table_name}.#{column} ilike ?"
216 conditions << "%#{value[1]}%"
219 conditions[0] << ' and (' + ilikes.join(' or ') + ')'
222 elsif attr.to_s.match(/^[a-z][_a-z0-9]+$/) and
223 model_class.columns.collect(&:name).index(attr.to_s)
225 conditions[0] << " and #{ar_table_name}.#{attr} is ?"
227 elsif value.is_a? Array
228 if value[0] == 'contains' and value.length == 2
229 conditions[0] << " and #{ar_table_name}.#{attr} like ?"
230 conditions << "%#{value[1]}%"
232 conditions[0] << " and #{ar_table_name}.#{attr} in (?)"
235 elsif value.is_a? String or value.is_a? Fixnum or value == true or value == false
236 conditions[0] << " and #{ar_table_name}.#{attr}=?"
238 elsif value.is_a? Hash
239 # Not quite the same thing as "equal?" but better than nothing?
242 conditions[0] << " and #{ar_table_name}.#{attr} ilike ?"
243 conditions << "%#{k}%#{v}%"
249 if conditions.length > 1
250 conditions[0].sub!(/^1=1 and /, '')
257 unless action_name.in? %w(create update destroy)
258 # Map attribute names in @select to real column names, resolve
259 # those to fully-qualified SQL column names, and pass the
260 # resulting string to the select method.
261 columns_list = model_class.columns_for_attributes(@select).
262 map { |s| "#{ar_table_name}.#{ActiveRecord::Base.connection.quote_column_name s}" }
263 @objects = @objects.select(columns_list.join(", "))
266 # This information helps clients understand what they're seeing
267 # (Workbench always expects it), but they can't select it explicitly
268 # because it's not an SQL column. Always add it.
269 # (This is harmless, given that clients can deduce what they're
270 # looking at by the returned UUID anyway.)
273 @objects = @objects.order(@orders.join ", ") if @orders.any?
274 @objects = @objects.limit(@limit)
275 @objects = @objects.offset(@offset)
276 @objects = @objects.uniq(@distinct) if not @distinct.nil?
279 def limit_database_read
280 limit_columns = self.class.limit_index_columns_read
281 limit_columns &= model_class.columns_for_attributes(@select) if @select
282 return if limit_columns.empty?
283 model_class.transaction do
284 limit_query = @objects.
286 select("(%s) as read_length" %
287 limit_columns.map { |s| "octet_length(#{s})" }.join(" + "))
290 limit_query.each do |record|
292 read_total += record.read_length.to_i
293 if read_total >= Rails.configuration.max_index_database_read
294 new_limit -= 1 if new_limit > 1
296 elsif new_limit >= @limit
301 @objects = @objects.limit(@limit)
302 # Force @objects to run its query inside this transaction.
303 @objects.each { |_| break }
308 return @attrs if @attrs
309 @attrs = params[resource_name]
310 if @attrs.is_a? String
311 @attrs = Oj.strict_load @attrs, symbol_keys: true
313 unless @attrs.is_a? Hash
314 message = "No #{resource_name}"
315 if resource_name.index('_')
316 message << " (or #{resource_name.camelcase(:lower)})"
318 message << " hash provided with request"
319 raise ArgumentError.new(message)
321 %w(created_at modified_by_client_uuid modified_by_user_uuid modified_at).each do |x|
322 @attrs.delete x.to_sym
324 @attrs = @attrs.symbolize_keys if @attrs.is_a? HashWithIndifferentAccess
331 if current_api_client_authorization
332 @read_auths << current_api_client_authorization
334 # Load reader tokens if this is a read request.
335 # If there are too many reader tokens, assume the request is malicious
337 if request.get? and params[:reader_tokens] and
338 params[:reader_tokens].size < 100
339 @read_auths += ApiClientAuthorization
341 .where('api_token IN (?) AND
342 (expires_at IS NULL OR expires_at > CURRENT_TIMESTAMP)',
343 params[:reader_tokens])
346 @read_auths.select! { |auth| auth.scopes_allow_request? request }
347 @read_users = @read_auths.map { |auth| auth.user }.uniq
352 respond_to do |format|
353 format.json { send_error("Not logged in", status: 401) }
354 format.html { redirect_to '/auth/joshid' }
361 unless current_user and current_user.is_admin
362 send_error("Forbidden", status: 403)
366 def require_auth_scope
367 if @read_auths.empty?
368 if require_login != false
369 send_error("Forbidden", status: 403)
375 def disable_api_methods
376 if Rails.configuration.disable_api_methods.
377 include?(controller_name + "." + action_name)
378 send_error("Disabled", status: 404)
383 response.headers['Access-Control-Allow-Origin'] = '*'
384 response.headers['Access-Control-Allow-Methods'] = 'GET, HEAD, PUT, POST, DELETE'
385 response.headers['Access-Control-Allow-Headers'] = 'Authorization'
386 response.headers['Access-Control-Max-Age'] = '86486400'
389 def respond_with_json_by_default
390 html_index = request.accepts.index(Mime::HTML)
391 if html_index.nil? or request.accepts[0...html_index].include?(Mime::JSON)
392 request.format = :json
397 controller_name.classify.constantize
400 def resource_name # params[] key used by client
401 controller_name.singularize
408 def find_object_by_uuid
409 if params[:id] and params[:id].match(/\D/)
410 params[:uuid] = params.delete :id
412 @where = { uuid: params[:uuid] }
418 find_objects_for_index
419 @object = @objects.first
422 def reload_object_before_update
423 # This is necessary to prevent an ActiveRecord::ReadOnlyRecord
424 # error when updating an object which was retrieved using a join.
425 if @object.andand.readonly?
426 @object = model_class.find_by_uuid(@objects.first.uuid)
430 def load_json_value(hash, key, must_be_class=nil)
431 if hash[key].is_a? String
432 hash[key] = SafeJSON.load(hash[key])
433 if must_be_class and !hash[key].is_a? must_be_class
434 raise TypeError.new("parameter #{key.to_s} must be a #{must_be_class.to_s}")
439 def self.accept_attribute_as_json(attr, must_be_class=nil)
440 before_filter lambda { accept_attribute_as_json attr, must_be_class }
442 accept_attribute_as_json :properties, Hash
443 accept_attribute_as_json :info, Hash
444 def accept_attribute_as_json(attr, must_be_class)
445 if params[resource_name] and resource_attrs.is_a? Hash
446 if resource_attrs[attr].is_a? Hash
447 # Convert symbol keys to strings (in hashes provided by
449 resource_attrs[attr] = resource_attrs[attr].
450 with_indifferent_access.to_hash
452 load_json_value(resource_attrs, attr, must_be_class)
457 def self.accept_param_as_json(key, must_be_class=nil)
458 prepend_before_filter lambda { load_json_value(params, key, must_be_class) }
460 accept_param_as_json :reader_tokens, Array
464 :kind => "arvados##{(@response_resource_name || resource_name).camelize(:lower)}List",
469 :items => @objects.as_api_response(nil, {select: @select})
472 when nil, '', 'exact'
473 if @objects.respond_to? :except
474 list[:items_available] = @objects.
475 except(:limit).except(:offset).
476 count(:id, distinct: true)
480 raise ArgumentError.new("count parameter must be 'exact' or 'none'")
486 send_json object_list
490 # Caveat: this is highly dependent on the proxy setup. YMMV.
491 if request.headers.has_key?('HTTP_X_REAL_IP') then
492 # We're behind a reverse proxy
493 @remote_ip = request.headers['HTTP_X_REAL_IP']
495 # Hopefully, we are not!
496 @remote_ip = request.env['REMOTE_ADDR']
500 def load_required_parameters
501 (self.class.send "_#{params[:action]}_requires_parameters" rescue {}).
503 if info[:required] and not params.include?(key)
504 raise ArgumentError.new("#{key} parameter is required")
505 elsif info[:type] == 'boolean'
506 # Make sure params[key] is either true or false -- not a
507 # string, not nil, etc.
508 if not params.include?(key)
509 params[key] = info[:default]
510 elsif [false, 'false', '0', 0].include? params[key]
512 elsif [true, 'true', '1', 1].include? params[key]
515 raise TypeError.new("#{key} parameter must be a boolean, true or false")
522 def self._create_requires_parameters
524 ensure_unique_name: {
526 description: "Adjust name to ensure uniqueness instead of returning an error on (owner_uuid, name) collision.",
534 def self._index_requires_parameters
536 filters: { type: 'array', required: false },
537 where: { type: 'object', required: false },
538 order: { type: 'array', required: false },
539 select: { type: 'array', required: false },
540 distinct: { type: 'boolean', required: false },
541 limit: { type: 'integer', required: false, default: DEFAULT_LIMIT },
542 offset: { type: 'integer', required: false, default: 0 },
543 count: { type: 'string', required: false, default: 'exact' },
547 def client_accepts_plain_text_stream
548 (request.headers['Accept'].split(' ') &
549 ['text/plain', '*/*']).count > 0
554 response = opts.first[:json]
555 if response.is_a?(Hash) &&
557 Thread.current[:request_starttime]
558 response[:_profile] = {
559 request_time: Time.now - Thread.current[:request_starttime]
567 return Rails.configuration.arvados_theme