1 class ApplicationController < ActionController::Base
2 include CurrentApiClient
5 around_filter :thread_with_auth_info, :except => [:render_error, :render_not_found]
7 before_filter :remote_ip
8 before_filter :require_auth_scope_all, :except => :render_not_found
9 before_filter :catch_redirect_hint
11 before_filter :load_where_param, :only => :index
12 before_filter :find_objects_for_index, :only => :index
13 before_filter :find_object_by_uuid, :except => [:index, :create]
14 before_filter :reload_object_before_update, :only => :update
16 attr_accessor :resource_attrs
20 if params[:eager] and params[:eager] != '0' and params[:eager] != 0 and params[:eager] != ''
21 @objects.each(&:eager_load_associations)
28 render json: @object.as_api_response
30 render_not_found("object not found")
35 @object = model_class.new resource_attrs
42 return render_not_found("object not found")
44 attrs_to_update = resource_attrs.reject { |k,v|
45 [:kind, :etag, :href].index k
47 if @object.update_attributes attrs_to_update
50 render json: { errors: @object.errors.full_messages }, status: 422
59 def catch_redirect_hint
61 if params.has_key?('redirect_to') then
62 session[:redirect_to] = params[:redirect_to]
68 rescue_from Exception,
69 :with => :render_error
70 rescue_from ActiveRecord::RecordNotFound,
71 :with => :render_not_found
72 rescue_from ActionController::RoutingError,
73 :with => :render_not_found
74 rescue_from ActionController::UnknownController,
75 :with => :render_not_found
76 rescue_from AbstractController::ActionNotFound,
77 :with => :render_not_found
78 rescue_from ArvadosModel::PermissionDeniedError,
79 :with => :render_error
83 logger.error e.inspect
84 logger.error e.backtrace.collect { |x| x + "\n" }.join('') if e.backtrace
85 if @object and @object.errors and @object.errors.full_messages and not @object.errors.full_messages.empty?
86 errors = @object.errors.full_messages
90 status = e.respond_to?(:http_status) ? e.http_status : 422
91 render json: { errors: errors }, status: status
94 def render_not_found(e=ActionController::RoutingError.new("Path not found"))
95 logger.error e.inspect
96 render json: { errors: ["Path not found"] }, status: 404
102 if params[:where].nil? or params[:where] == ""
104 elsif params[:where].is_a? Hash
105 @where = params[:where]
106 elsif params[:where].is_a? String
108 @where = Oj.load(params[:where], symbol_keys: true)
110 raise ArgumentError.new("Could not parse \"where\" param as an object")
115 def find_objects_for_index
116 uuid_list = [current_user.uuid, *current_user.groups_i_can(:read)]
117 sanitized_uuid_list = uuid_list.
118 collect { |uuid| model_class.sanitize(uuid) }.join(', ')
119 or_references_me = ''
120 if model_class == Link and current_user
121 or_references_me = "OR (#{table_name}.link_class in (#{model_class.sanitize 'permission'}, #{model_class.sanitize 'resources'}) AND #{model_class.sanitize current_user.uuid} IN (#{table_name}.head_uuid, #{table_name}.tail_uuid))"
123 @objects ||= model_class.
124 joins("LEFT JOIN links permissions ON permissions.head_uuid in (#{table_name}.owner_uuid, #{table_name}.uuid) AND permissions.tail_uuid in (#{sanitized_uuid_list}) AND permissions.link_class='permission'").
125 where("?=? OR #{table_name}.owner_uuid in (?) OR #{table_name}.uuid=? OR permissions.head_uuid IS NOT NULL #{or_references_me}",
126 true, current_user.is_admin,
131 @where.each do |attr,value|
133 if value.is_a?(Array) and
134 value[0] == 'contains' and
135 model_class.columns.collect(&:name).index('name') then
137 model_class.searchable_columns.each do |column|
138 ilikes << "#{table_name}.#{column} ilike ?"
139 conditions << "%#{value[1]}%"
142 conditions[0] << ' and (' + ilikes.join(' or ') + ')'
145 elsif attr.to_s.match(/^[a-z][_a-z0-9]+$/) and
146 model_class.columns.collect(&:name).index(attr.to_s)
148 conditions[0] << " and #{table_name}.#{attr} is ?"
150 elsif value.is_a? Array
151 conditions[0] << " and #{table_name}.#{attr} in (?)"
153 elsif value.is_a? String or value.is_a? Fixnum or value == true or value == false
154 conditions[0] << " and #{table_name}.#{attr}=?"
156 elsif value.is_a? Hash
157 # Not quite the same thing as "equal?" but better than nothing?
160 conditions[0] << " and #{table_name}.#{attr} ilike ?"
161 conditions << "%#{k}%#{v}%"
167 if conditions.length > 1
168 conditions[0].sub!(/^1=1 and /, '')
175 @objects = @objects.limit(params[:limit].to_i)
177 raise ArgumentError.new("Invalid value for limit parameter")
180 @objects = @objects.limit(100)
184 params[:order].split(',').each do |order|
185 attr, direction = order.strip.split " "
187 if attr.match /^[a-z][_a-z0-9]+$/ and
188 model_class.columns.collect(&:name).index(attr) and
189 ['asc','desc'].index direction.downcase
190 orders << "#{table_name}.#{attr} #{direction.downcase}"
195 orders << "#{table_name}.modified_at desc"
197 @objects = @objects.order(orders.join ", ")
201 return @attrs if @attrs
202 @attrs = params[resource_name]
203 if @attrs.is_a? String
204 @attrs = Oj.load @attrs, symbol_keys: true
206 unless @attrs.is_a? Hash
207 message = "No #{resource_name}"
208 if resource_name.index('_')
209 message << " (or #{resource_name.camelcase(:lower)})"
211 message << " hash provided with request"
212 raise ArgumentError.new(message)
214 %w(created_at modified_by_client_uuid modified_by_user_uuid modified_at).each do |x|
215 @attrs.delete x.to_sym
225 respond_to do |format|
227 render :json => { errors: ['Not logged in'] }.to_json, status: 401
230 redirect_to '/auth/joshid'
238 unless current_user and current_user.is_admin
239 render :json => { errors: ['Forbidden'] }.to_json, status: 403
243 def require_auth_scope_all
244 require_login and require_auth_scope(['all'])
247 def require_auth_scope(ok_scopes)
248 unless current_api_client_auth_has_scope(ok_scopes)
249 render :json => { errors: ['Forbidden'] }.to_json, status: 403
253 def thread_with_auth_info
254 Thread.current[:request_starttime] = Time.now
255 Thread.current[:api_url_base] = root_url.sub(/\/$/,'') + '/arvados/v1'
259 api_client_auth = nil
261 params[:api_token] ||
262 params[:oauth_token] ||
263 request.headers["Authorization"].andand.match(/OAuth2 ([a-z0-9]+)/).andand[1]
265 api_client_auth = ApiClientAuthorization.
266 includes(:api_client, :user).
267 where('api_token=? and (expires_at is null or expires_at > now())', supplied_token).
269 if api_client_auth.andand.user
270 session[:user_id] = api_client_auth.user.id
271 session[:api_client_uuid] = api_client_auth.api_client.andand.uuid
272 session[:api_client_authorization_id] = api_client_auth.id
273 user = api_client_auth.user
274 api_client = api_client_auth.api_client
276 elsif session[:user_id]
277 user = User.find(session[:user_id]) rescue nil
278 api_client = ApiClient.
279 where('uuid=?',session[:api_client_uuid]).
281 if session[:api_client_authorization_id] then
282 api_client_auth = ApiClientAuthorization.
283 find session[:api_client_authorization_id]
286 Thread.current[:api_client_ip_address] = remote_ip
287 Thread.current[:api_client_authorization] = api_client_auth
288 Thread.current[:api_client_uuid] = api_client.andand.uuid
289 Thread.current[:api_client] = api_client
290 Thread.current[:user] = user
292 api_client_auth.last_used_at = Time.now
293 api_client_auth.last_used_by_ip_address = remote_ip
294 api_client_auth.save validate: false
298 Thread.current[:api_client_ip_address] = nil
299 Thread.current[:api_client_authorization] = nil
300 Thread.current[:api_client_uuid] = nil
301 Thread.current[:api_client] = nil
302 Thread.current[:user] = nil
308 controller_name.classify.constantize
311 def resource_name # params[] key used by client
312 controller_name.singularize
319 def find_object_by_uuid
320 if params[:id] and params[:id].match /\D/
321 params[:uuid] = params.delete :id
323 @where = { uuid: params[:uuid] }
324 find_objects_for_index
325 @object = @objects.first
328 def reload_object_before_update
329 # This is necessary to prevent an ActiveRecord::ReadOnlyRecord
330 # error when updating an object which was retrieved using a join.
331 if @object.andand.readonly?
332 @object = model_class.find_by_uuid(@objects.first.uuid)
336 def self.accept_attribute_as_json(attr, force_class=nil)
337 before_filter lambda { accept_attribute_as_json attr, force_class }
339 def accept_attribute_as_json(attr, force_class)
340 if params[resource_name].is_a? Hash
341 if params[resource_name][attr].is_a? String
342 params[resource_name][attr] = Oj.load(params[resource_name][attr],
344 if force_class and !params[resource_name][attr].is_a? force_class
345 raise TypeError.new("#{resource_name}[#{attr.to_s}] must be a #{force_class.to_s}")
353 :kind => "arvados##{(@response_resource_name || resource_name).camelize(:lower)}List",
356 :next_page_token => "",
358 :items => @objects.as_api_response(nil)
360 if @objects.respond_to? :except
361 @object_list[:items_available] = @objects.except(:limit).count
363 render json: @object_list
367 # Caveat: this is highly dependent on the proxy setup. YMMV.
368 if request.headers.has_key?('HTTP_X_REAL_IP') then
369 # We're behind a reverse proxy
370 @remote_ip = request.headers['HTTP_X_REAL_IP']
372 # Hopefully, we are not!
373 @remote_ip = request.env['REMOTE_ADDR']
377 def self._index_requires_parameters
379 where: { type: 'object', required: false },
380 order: { type: 'string', required: false }
384 def client_accepts_plain_text_stream
385 (request.headers['Accept'].split(' ') &
386 ['text/plain', '*/*']).count > 0
390 response = opts.first[:json]
391 if response.is_a?(Hash) &&
393 Thread.current[:request_starttime]
394 response[:_profile] = {
395 request_time: Time.now - Thread.current[:request_starttime]