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 :find_objects_for_index, :only => :index
14 before_filter :find_object_by_uuid, :except => [:index, :create,
17 before_filter :reload_object_before_update, :only => :update
18 before_filter :render_404_if_no_object, except: [:index, :create,
22 attr_accessor :resource_attrs
26 if params[:eager] and params[:eager] != '0' and params[:eager] != 0 and params[:eager] != ''
27 @objects.each(&:eager_load_associations)
33 render json: @object.as_api_response
37 @object = model_class.new resource_attrs
46 attrs_to_update = resource_attrs.reject { |k,v|
47 [:kind, :etag, :href].index k
49 if @object.update_attributes attrs_to_update
61 def catch_redirect_hint
63 if params.has_key?('redirect_to') then
64 session[:redirect_to] = params[:redirect_to]
70 rescue_from Exception,
71 :with => :render_error
72 rescue_from ActiveRecord::RecordNotFound,
73 :with => :render_not_found
74 rescue_from ActionController::RoutingError,
75 :with => :render_not_found
76 rescue_from ActionController::UnknownController,
77 :with => :render_not_found
78 rescue_from AbstractController::ActionNotFound,
79 :with => :render_not_found
80 rescue_from ArvadosModel::PermissionDeniedError,
81 :with => :render_error
84 def render_404_if_no_object
85 render_not_found "Object not found" if !@object
89 logger.error e.inspect
90 if e.respond_to? :backtrace and e.backtrace
91 logger.error e.backtrace.collect { |x| x + "\n" }.join('')
93 if @object and @object.errors and @object.errors.full_messages and not @object.errors.full_messages.empty?
94 errors = @object.errors.full_messages
98 status = e.respond_to?(:http_status) ? e.http_status : 422
99 render json: { errors: errors }, status: status
102 def render_not_found(e=ActionController::RoutingError.new("Path not found"))
103 logger.error e.inspect
104 render json: { errors: ["Path not found"] }, status: 404
110 if params[:where].nil? or params[:where] == ""
112 elsif params[:where].is_a? Hash
113 @where = params[:where]
114 elsif params[:where].is_a? String
116 @where = Oj.load(params[:where], symbol_keys: true)
118 raise ArgumentError.new("Could not parse \"where\" param as an object")
123 def find_objects_for_index
124 @objects ||= model_class.readable_by(current_user)
127 @where.each do |attr,value|
129 if value.is_a?(Array) and
130 value.length == 2 and
131 value[0] == 'contains' and
132 model_class.columns.collect(&:name).index('name') then
134 model_class.searchable_columns.each do |column|
135 ilikes << "#{table_name}.#{column} ilike ?"
136 conditions << "%#{value[1]}%"
139 conditions[0] << ' and (' + ilikes.join(' or ') + ')'
142 elsif attr.to_s.match(/^[a-z][_a-z0-9]+$/) and
143 model_class.columns.collect(&:name).index(attr.to_s)
145 conditions[0] << " and #{table_name}.#{attr} is ?"
147 elsif value.is_a? Array
148 if value[0] == 'contains' and value.length == 2
149 conditions[0] << " and #{table_name}.#{attr} like ?"
150 conditions << "%#{value[1]}%"
152 conditions[0] << " and #{table_name}.#{attr} in (?)"
155 elsif value.is_a? String or value.is_a? Fixnum or value == true or value == false
156 conditions[0] << " and #{table_name}.#{attr}=?"
158 elsif value.is_a? Hash
159 # Not quite the same thing as "equal?" but better than nothing?
162 conditions[0] << " and #{table_name}.#{attr} ilike ?"
163 conditions << "%#{k}%#{v}%"
169 if conditions.length > 1
170 conditions[0].sub!(/^1=1 and /, '')
177 @objects = @objects.limit(params[:limit].to_i)
179 raise ArgumentError.new("Invalid value for limit parameter")
182 @objects = @objects.limit(100)
186 params[:order].split(',').each do |order|
187 attr, direction = order.strip.split " "
189 if attr.match /^[a-z][_a-z0-9]+$/ and
190 model_class.columns.collect(&:name).index(attr) and
191 ['asc','desc'].index direction.downcase
192 orders << "#{table_name}.#{attr} #{direction.downcase}"
197 orders << "#{table_name}.modified_at desc"
199 @objects = @objects.order(orders.join ", ")
203 return @attrs if @attrs
204 @attrs = params[resource_name]
205 if @attrs.is_a? String
206 @attrs = Oj.load @attrs, symbol_keys: true
208 unless @attrs.is_a? Hash
209 message = "No #{resource_name}"
210 if resource_name.index('_')
211 message << " (or #{resource_name.camelcase(:lower)})"
213 message << " hash provided with request"
214 raise ArgumentError.new(message)
216 %w(created_at modified_by_client_uuid modified_by_user_uuid modified_at).each do |x|
217 @attrs.delete x.to_sym
219 @attrs = @attrs.symbolize_keys if @attrs.is_a? HashWithIndifferentAccess
228 respond_to do |format|
230 render :json => { errors: ['Not logged in'] }.to_json, status: 401
233 redirect_to '/auth/joshid'
241 unless current_user and current_user.is_admin
242 render :json => { errors: ['Forbidden'] }.to_json, status: 403
246 def require_auth_scope_all
247 require_login and require_auth_scope(['all'])
250 def require_auth_scope(ok_scopes)
251 unless current_api_client_auth_has_scope(ok_scopes)
252 render :json => { errors: ['Forbidden'] }.to_json, status: 403
256 def thread_with_auth_info
257 Thread.current[:request_starttime] = Time.now
258 Thread.current[:api_url_base] = root_url.sub(/\/$/,'') + '/arvados/v1'
262 api_client_auth = nil
264 params[:api_token] ||
265 params[:oauth_token] ||
266 request.headers["Authorization"].andand.match(/OAuth2 ([a-z0-9]+)/).andand[1]
268 api_client_auth = ApiClientAuthorization.
269 includes(:api_client, :user).
270 where('api_token=? and (expires_at is null or expires_at > CURRENT_TIMESTAMP)', supplied_token).
272 if api_client_auth.andand.user
273 session[:user_id] = api_client_auth.user.id
274 session[:api_client_uuid] = api_client_auth.api_client.andand.uuid
275 session[:api_client_authorization_id] = api_client_auth.id
276 user = api_client_auth.user
277 api_client = api_client_auth.api_client
279 elsif session[:user_id]
280 user = User.find(session[:user_id]) rescue nil
281 api_client = ApiClient.
282 where('uuid=?',session[:api_client_uuid]).
284 if session[:api_client_authorization_id] then
285 api_client_auth = ApiClientAuthorization.
286 find session[:api_client_authorization_id]
289 Thread.current[:api_client_ip_address] = remote_ip
290 Thread.current[:api_client_authorization] = api_client_auth
291 Thread.current[:api_client_uuid] = api_client.andand.uuid
292 Thread.current[:api_client] = api_client
293 Thread.current[:user] = user
295 api_client_auth.last_used_at = Time.now
296 api_client_auth.last_used_by_ip_address = remote_ip
297 api_client_auth.save validate: false
301 Thread.current[:api_client_ip_address] = nil
302 Thread.current[:api_client_authorization] = nil
303 Thread.current[:api_client_uuid] = nil
304 Thread.current[:api_client] = nil
305 Thread.current[:user] = nil
311 controller_name.classify.constantize
314 def resource_name # params[] key used by client
315 controller_name.singularize
322 def find_object_by_uuid
323 if params[:id] and params[:id].match /\D/
324 params[:uuid] = params.delete :id
326 @where = { uuid: params[:uuid] }
327 find_objects_for_index
328 @object = @objects.first
331 def reload_object_before_update
332 # This is necessary to prevent an ActiveRecord::ReadOnlyRecord
333 # error when updating an object which was retrieved using a join.
334 if @object.andand.readonly?
335 @object = model_class.find_by_uuid(@objects.first.uuid)
339 def self.accept_attribute_as_json(attr, force_class=nil)
340 before_filter lambda { accept_attribute_as_json attr, force_class }
342 accept_attribute_as_json :properties, Hash
343 accept_attribute_as_json :info, Hash
344 def accept_attribute_as_json(attr, force_class)
345 if params[resource_name] and resource_attrs.is_a? Hash
346 if resource_attrs[attr].is_a? String
347 resource_attrs[attr] = Oj.load(resource_attrs[attr],
349 if force_class and !resource_attrs[attr].is_a? force_class
350 raise TypeError.new("#{resource_name}[#{attr.to_s}] must be a #{force_class.to_s}")
352 elsif resource_attrs[attr].is_a? Hash
353 # Convert symbol keys to strings (in hashes provided by
355 resource_attrs[attr] = resource_attrs[attr].
356 with_indifferent_access.to_hash
363 :kind => "arvados##{(@response_resource_name || resource_name).camelize(:lower)}List",
366 :next_page_token => "",
368 :items => @objects.as_api_response(nil)
370 if @objects.respond_to? :except
371 @object_list[:items_available] = @objects.except(:limit).count
373 render json: @object_list
377 # Caveat: this is highly dependent on the proxy setup. YMMV.
378 if request.headers.has_key?('HTTP_X_REAL_IP') then
379 # We're behind a reverse proxy
380 @remote_ip = request.headers['HTTP_X_REAL_IP']
382 # Hopefully, we are not!
383 @remote_ip = request.env['REMOTE_ADDR']
387 def self._index_requires_parameters
389 where: { type: 'object', required: false },
390 order: { type: 'string', required: false }
394 def client_accepts_plain_text_stream
395 (request.headers['Accept'].split(' ') &
396 ['text/plain', '*/*']).count > 0
401 response = opts.first[:json]
402 if response.is_a?(Hash) &&
404 Thread.current[:request_starttime]
405 response[:_profile] = {
406 request_time: Time.now - Thread.current[:request_starttime]