1 class ApplicationController < ActionController::Base
2 include CurrentApiClient
6 around_filter :thread_with_auth_info, :except => [:render_error, :render_not_found]
8 before_filter :remote_ip
9 before_filter :require_auth_scope_all, :except => :render_not_found
10 before_filter :catch_redirect_hint
12 before_filter :load_where_param, :only => :index
13 before_filter :load_filters_param, :only => :index
14 before_filter :find_objects_for_index, :only => :index
15 before_filter :find_object_by_uuid, :except => [:index, :create,
18 before_filter :reload_object_before_update, :only => :update
19 before_filter :render_404_if_no_object, except: [:index, :create,
23 attr_accessor :resource_attrs
27 if params[:eager] and params[:eager] != '0' and params[:eager] != 0 and params[:eager] != ''
28 @objects.each(&:eager_load_associations)
34 render json: @object.as_api_response
38 @object = model_class.new resource_attrs
44 attrs_to_update = resource_attrs.reject { |k,v|
45 [:kind, :etag, :href].index k
47 @object.update_attributes! attrs_to_update
56 def catch_redirect_hint
58 if params.has_key?('redirect_to') then
59 session[:redirect_to] = params[:redirect_to]
65 rescue_from Exception,
66 :with => :render_error
67 rescue_from ActiveRecord::RecordNotFound,
68 :with => :render_not_found
69 rescue_from ActionController::RoutingError,
70 :with => :render_not_found
71 rescue_from ActionController::UnknownController,
72 :with => :render_not_found
73 rescue_from AbstractController::ActionNotFound,
74 :with => :render_not_found
75 rescue_from ArvadosModel::PermissionDeniedError,
76 :with => :render_error
79 def render_404_if_no_object
80 render_not_found "Object not found" if !@object
84 logger.error e.inspect
85 if e.respond_to? :backtrace and e.backtrace
86 logger.error e.backtrace.collect { |x| x + "\n" }.join('')
88 if @object and @object.errors and @object.errors.full_messages and not @object.errors.full_messages.empty?
89 errors = @object.errors.full_messages
93 status = e.respond_to?(:http_status) ? e.http_status : 422
94 render json: { errors: errors }, status: status
97 def render_not_found(e=ActionController::RoutingError.new("Path not found"))
98 logger.error e.inspect
99 render json: { errors: ["Path not found"] }, status: 404
105 if params[:where].nil? or params[:where] == ""
107 elsif params[:where].is_a? Hash
108 @where = params[:where]
109 elsif params[:where].is_a? String
111 @where = Oj.load(params[:where])
112 raise unless @where.is_a? Hash
114 raise ArgumentError.new("Could not parse \"where\" param as an object")
117 @where = @where.with_indifferent_access
120 def load_filters_param
121 if params[:filters].is_a? Array
122 @filters = params[:filters]
123 elsif params[:filters].is_a? String
125 @filters = Oj.load params[:filters]
126 raise unless @filters.is_a? Array
128 raise ArgumentError.new("Could not parse \"filters\" param as an array")
133 def find_objects_for_index
134 @objects ||= model_class.readable_by(current_user)
135 apply_where_limit_order_params
138 def apply_where_limit_order_params
139 if @filters.is_a? Array and @filters.any?
142 @filters.each do |attr, operator, operand|
143 if !model_class.searchable_columns.index attr.to_s
144 raise ArgumentError.new("Invalid attribute '#{attr}' in condition")
146 case operator.downcase
147 when '=', '<', '<=', '>', '>=', 'like'
148 if operand.is_a? String
149 cond_out << "#{table_name}.#{attr} #{operator} ?"
150 if (# any operator that operates on value rather than
152 operator.match(/[<=>]/) and
153 model_class.attribute_column(attr).type == :datetime)
154 operand = Time.parse operand
159 if operand.is_a? Array
160 cond_out << "#{table_name}.#{attr} IN (?)"
164 operand = [operand] unless operand.is_a? Array
167 cl = ArvadosModel::kind_class op
169 cond << "#{table_name}.#{attr} like ?"
170 param_out << cl.uuid_like_pattern
175 cond_out << cond.join(' OR ')
179 @objects = @objects.where(cond_out.join(' AND '), *param_out)
182 if @where.is_a? Hash and @where.any?
184 @where.each do |attr,value|
186 if value.is_a?(Array) and
187 value.length == 2 and
188 value[0] == 'contains' and
189 model_class.columns.collect(&:name).index('name') then
191 model_class.searchable_columns.each do |column|
192 ilikes << "#{table_name}.#{column} ilike ?"
193 conditions << "%#{value[1]}%"
196 conditions[0] << ' and (' + ilikes.join(' or ') + ')'
199 elsif attr.to_s.match(/^[a-z][_a-z0-9]+$/) and
200 model_class.columns.collect(&:name).index(attr.to_s)
202 conditions[0] << " and #{table_name}.#{attr} is ?"
204 elsif value.is_a? Array
205 if value[0] == 'contains' and value.length == 2
206 conditions[0] << " and #{table_name}.#{attr} like ?"
207 conditions << "%#{value[1]}%"
209 conditions[0] << " and #{table_name}.#{attr} in (?)"
212 elsif value.is_a? String or value.is_a? Fixnum or value == true or value == false
213 conditions[0] << " and #{table_name}.#{attr}=?"
215 elsif value.is_a? Hash
216 # Not quite the same thing as "equal?" but better than nothing?
219 conditions[0] << " and #{table_name}.#{attr} ilike ?"
220 conditions << "%#{k}%#{v}%"
226 if conditions.length > 1
227 conditions[0].sub!(/^1=1 and /, '')
235 @limit = params[:limit].to_i
237 raise ArgumentError.new("Invalid value for limit parameter")
242 @objects = @objects.limit(@limit)
248 @objects = @objects.offset(params[:offset].to_i)
249 @offset = params[:offset].to_i
251 raise ArgumentError.new("Invalid value for limit parameter")
259 params[:order].split(',').each do |order|
260 attr, direction = order.strip.split " "
262 if attr.match /^[a-z][_a-z0-9]+$/ and
263 model_class.columns.collect(&:name).index(attr) and
264 ['asc','desc'].index direction.downcase
265 orders << "#{table_name}.#{attr} #{direction.downcase}"
270 orders << "#{table_name}.modified_at desc"
272 @objects = @objects.order(orders.join ", ")
276 return @attrs if @attrs
277 @attrs = params[resource_name]
278 if @attrs.is_a? String
279 @attrs = Oj.load @attrs, symbol_keys: true
281 unless @attrs.is_a? Hash
282 message = "No #{resource_name}"
283 if resource_name.index('_')
284 message << " (or #{resource_name.camelcase(:lower)})"
286 message << " hash provided with request"
287 raise ArgumentError.new(message)
289 %w(created_at modified_by_client_uuid modified_by_user_uuid modified_at).each do |x|
290 @attrs.delete x.to_sym
292 @attrs = @attrs.symbolize_keys if @attrs.is_a? HashWithIndifferentAccess
301 respond_to do |format|
303 render :json => { errors: ['Not logged in'] }.to_json, status: 401
306 redirect_to '/auth/joshid'
314 unless current_user and current_user.is_admin
315 render :json => { errors: ['Forbidden'] }.to_json, status: 403
319 def require_auth_scope_all
320 require_login and require_auth_scope(['all'])
323 def require_auth_scope(ok_scopes)
324 unless current_api_client_auth_has_scope(ok_scopes)
325 render :json => { errors: ['Forbidden'] }.to_json, status: 403
329 def thread_with_auth_info
330 Thread.current[:request_starttime] = Time.now
331 Thread.current[:api_url_base] = root_url.sub(/\/$/,'') + '/arvados/v1'
335 api_client_auth = nil
337 params[:api_token] ||
338 params[:oauth_token] ||
339 request.headers["Authorization"].andand.match(/OAuth2 ([a-z0-9]+)/).andand[1]
341 api_client_auth = ApiClientAuthorization.
342 includes(:api_client, :user).
343 where('api_token=? and (expires_at is null or expires_at > CURRENT_TIMESTAMP)', supplied_token).
345 if api_client_auth.andand.user
346 session[:user_id] = api_client_auth.user.id
347 session[:api_client_uuid] = api_client_auth.api_client.andand.uuid
348 session[:api_client_authorization_id] = api_client_auth.id
349 user = api_client_auth.user
350 api_client = api_client_auth.api_client
352 elsif session[:user_id]
353 user = User.find(session[:user_id]) rescue nil
354 api_client = ApiClient.
355 where('uuid=?',session[:api_client_uuid]).
357 if session[:api_client_authorization_id] then
358 api_client_auth = ApiClientAuthorization.
359 find session[:api_client_authorization_id]
362 Thread.current[:api_client_ip_address] = remote_ip
363 Thread.current[:api_client_authorization] = api_client_auth
364 Thread.current[:api_client_uuid] = api_client.andand.uuid
365 Thread.current[:api_client] = api_client
366 Thread.current[:user] = user
368 api_client_auth.last_used_at = Time.now
369 api_client_auth.last_used_by_ip_address = remote_ip
370 api_client_auth.save validate: false
374 Thread.current[:api_client_ip_address] = nil
375 Thread.current[:api_client_authorization] = nil
376 Thread.current[:api_client_uuid] = nil
377 Thread.current[:api_client] = nil
378 Thread.current[:user] = nil
384 controller_name.classify.constantize
387 def resource_name # params[] key used by client
388 controller_name.singularize
395 def find_object_by_uuid
396 if params[:id] and params[:id].match /\D/
397 params[:uuid] = params.delete :id
399 @where = { uuid: params[:uuid] }
400 find_objects_for_index
401 @object = @objects.first
404 def reload_object_before_update
405 # This is necessary to prevent an ActiveRecord::ReadOnlyRecord
406 # error when updating an object which was retrieved using a join.
407 if @object.andand.readonly?
408 @object = model_class.find_by_uuid(@objects.first.uuid)
412 def self.accept_attribute_as_json(attr, force_class=nil)
413 before_filter lambda { accept_attribute_as_json attr, force_class }
415 accept_attribute_as_json :properties, Hash
416 accept_attribute_as_json :info, Hash
417 def accept_attribute_as_json(attr, force_class)
418 if params[resource_name] and resource_attrs.is_a? Hash
419 if resource_attrs[attr].is_a? String
420 resource_attrs[attr] = Oj.load(resource_attrs[attr],
422 if force_class and !resource_attrs[attr].is_a? force_class
423 raise TypeError.new("#{resource_name}[#{attr.to_s}] must be a #{force_class.to_s}")
425 elsif resource_attrs[attr].is_a? Hash
426 # Convert symbol keys to strings (in hashes provided by
428 resource_attrs[attr] = resource_attrs[attr].
429 with_indifferent_access.to_hash
436 :kind => "arvados##{(@response_resource_name || resource_name).camelize(:lower)}List",
441 :items => @objects.as_api_response(nil)
443 if @objects.respond_to? :except
444 @object_list[:items_available] = @objects.except(:limit).except(:offset).count
446 render json: @object_list
450 # Caveat: this is highly dependent on the proxy setup. YMMV.
451 if request.headers.has_key?('HTTP_X_REAL_IP') then
452 # We're behind a reverse proxy
453 @remote_ip = request.headers['HTTP_X_REAL_IP']
455 # Hopefully, we are not!
456 @remote_ip = request.env['REMOTE_ADDR']
460 def self._index_requires_parameters
462 filters: { type: 'array', required: false },
463 where: { type: 'object', required: false },
464 order: { type: 'string', required: false }
468 def client_accepts_plain_text_stream
469 (request.headers['Accept'].split(' ') &
470 ['text/plain', '*/*']).count > 0
475 response = opts.first[:json]
476 if response.is_a?(Hash) &&
478 Thread.current[:request_starttime]
479 response[:_profile] = {
480 request_time: Time.now - Thread.current[:request_starttime]