1 class ApplicationController < ActionController::Base
2 include ArvadosApiClientHelper
4 respond_to :html, :json, :js
7 ERROR_ACTIONS = [:render_error, :render_not_found]
9 around_filter :thread_clear
10 around_filter :thread_with_mandatory_api_token, except: ERROR_ACTIONS
11 around_filter :thread_with_optional_api_token
12 before_filter :check_user_agreements, except: ERROR_ACTIONS
13 before_filter :check_user_notifications, except: ERROR_ACTIONS
14 before_filter :find_object_by_uuid, except: [:index] + ERROR_ACTIONS
18 rescue_from Exception,
19 :with => :render_exception
20 rescue_from ActiveRecord::RecordNotFound,
21 :with => :render_not_found
22 rescue_from ActionController::RoutingError,
23 :with => :render_not_found
24 rescue_from ActionController::UnknownController,
25 :with => :render_not_found
26 rescue_from ::AbstractController::ActionNotFound,
27 :with => :render_not_found
30 def unprocessable(message=nil)
33 @errors << message if message
34 render_error status: 422
37 def render_error(opts)
38 opts = {status: 500}.merge opts
40 # json must come before html here, so it gets used as the
41 # default format when js is requested by the client. This lets
42 # ajax:error callback parse the response correctly, even though
44 f.json { render opts.merge(json: {success: false, errors: @errors}) }
45 f.html { render opts.merge(controller: 'application', action: 'error') }
49 def render_exception(e)
50 logger.error e.inspect
51 logger.error e.backtrace.collect { |x| x + "\n" }.join('') if e.backtrace
52 if @object.andand.errors.andand.full_messages.andand.any?
53 @errors = @object.errors.full_messages
57 self.render_error status: 422
60 def render_not_found(e=ActionController::RoutingError.new("Path not found"))
61 logger.error e.inspect
62 @errors = ["Path not found"]
63 self.render_error status: 404
68 f.json { render json: @objects }
71 comparable = self.respond_to? :compare
72 render(partial: 'show_' + params['tab_pane'].downcase,
73 locals: { comparable: comparable, objects: @objects })
85 @limit = params[:limit].to_i
90 @offset = params[:offset].to_i
95 filters = params[:filters]
96 if filters.is_a? String
97 filters = Oj.load filters
102 @objects ||= model_class
103 @objects = @objects.filter(@filters).limit(@limit).offset(@offset).all
109 return render_not_found("object not found")
112 f.json { render json: @object.attributes.merge(href: url_for(@object)) }
114 if params['tab_pane']
115 comparable = self.respond_to? :compare
116 render(partial: 'show_' + params['tab_pane'].downcase,
117 locals: { comparable: comparable, objects: @objects })
119 if request.method == 'GET'
122 redirect_to params[:return_to] || @object
132 return render_not_found("object not found")
137 @object = model_class.new
141 @updates ||= params[@object.class.to_s.underscore.singularize.to_sym]
142 @updates.keys.each do |attr|
143 if @object.send(attr).is_a? Hash
144 if @updates[attr].is_a? String
145 @updates[attr] = Oj.load @updates[attr]
147 if params[:merge] || params["merge_#{attr}".to_sym]
148 # Merge provided Hash with current Hash, instead of
150 @updates[attr] = @object.send(attr).with_indifferent_access.
151 deep_merge(@updates[attr].with_indifferent_access)
155 if @object.update_attributes @updates
158 self.render_error status: 422
163 @new_resource_attrs ||= params[model_class.to_s.underscore.singularize]
164 @new_resource_attrs ||= {}
165 @new_resource_attrs.reject! { |k,v| k.to_s == 'uuid' }
166 @object ||= model_class.new @new_resource_attrs, params["options"]
169 f.json { render json: @object.attributes.merge(href: url_for(@object)) }
176 self.render_error status: 422
183 f.json { render json: @object }
185 redirect_to(params[:return_to] || :back)
190 self.render_error status: 422
195 return Thread.current[:user] if Thread.current[:user]
197 if Thread.current[:arvados_api_token]
199 if session[:user][:is_active] != true
200 Thread.current[:user] = User.current
202 Thread.current[:user] = User.new(session[:user])
205 Thread.current[:user] = User.current
208 logger.error "No API token in Thread"
214 controller_name.classify.constantize
217 def breadcrumb_page_name
218 (@breadcrumb_page_name ||
219 (@object.friendly_link_name if @object.respond_to? :friendly_link_name) ||
228 %w(Attributes Metadata JSON API)
233 def redirect_to_login
236 if request.method == 'GET'
237 redirect_to arvados_api_client.arvados_login_url(return_to: request.url)
239 flash[:error] = "Either you are not logged in, or your session has timed out. I can't automatically log you in and re-attempt this request."
244 @errors = ['You do not seem to be logged in. You did not supply an API token with this request, and your session (if any) has timed out.']
245 self.render_error status: 422
248 false # For convenience to return from callbacks
251 def using_specific_api_token(api_token)
253 [:arvados_api_token, :user].each do |key|
254 start_values[key] = Thread.current[key]
256 Thread.current[:arvados_api_token] = api_token
257 Thread.current[:user] = nil
261 start_values.each_key { |key| Thread.current[key] = start_values[key] }
265 def find_object_by_uuid
266 if params[:id] and params[:id].match /\D/
267 params[:uuid] = params.delete :id
271 elsif params[:uuid].is_a? String
272 if params[:uuid].empty?
275 @object = model_class.find(params[:uuid])
278 @object = model_class.where(uuid: params[:uuid]).first
283 Thread.current[:arvados_api_token] = nil
284 Thread.current[:user] = nil
285 Rails.cache.delete_matched(/^request_#{Thread.current.object_id}_/)
287 Rails.cache.delete_matched(/^request_#{Thread.current.object_id}_/)
290 def thread_with_api_token(login_optional = false)
292 try_redirect_to_login = true
293 if params[:api_token]
294 try_redirect_to_login = false
295 Thread.current[:arvados_api_token] = params[:api_token]
296 # Before copying the token into session[], do a simple API
297 # call to verify its authenticity.
299 session[:arvados_api_token] = params[:api_token]
304 first_name: u.first_name,
305 last_name: u.last_name,
306 is_active: u.is_active,
307 is_admin: u.is_admin,
310 if !request.format.json? and request.method == 'GET'
311 # Repeat this request with api_token in the (new) session
312 # cookie instead of the query string. This prevents API
313 # tokens from appearing in (and being inadvisedly copied
314 # and pasted from) browser Location bars.
315 redirect_to request.fullpath.sub(%r{([&\?]api_token=)[^&\?]*}, '')
320 @errors = ['Invalid API token']
321 self.render_error status: 401
323 elsif session[:arvados_api_token]
324 # In this case, the token must have already verified at some
325 # point, but it might have been revoked since. We'll try
326 # using it, and catch the exception if it doesn't work.
327 try_redirect_to_login = false
328 Thread.current[:arvados_api_token] = session[:arvados_api_token]
331 rescue ArvadosApiClient::NotLoggedInException
332 try_redirect_to_login = true
335 logger.debug "No token received, session is #{session.inspect}"
337 if try_redirect_to_login
338 unless login_optional
341 # login is optional for this route so go on to the regular controller
342 Thread.current[:arvados_api_token] = nil
347 # Remove token in case this Thread is used for anything else.
348 Thread.current[:arvados_api_token] = nil
352 def thread_with_mandatory_api_token
353 thread_with_api_token do
358 # This runs after thread_with_mandatory_api_token in the filter chain.
359 def thread_with_optional_api_token
360 if Thread.current[:arvados_api_token]
361 # We are already inside thread_with_mandatory_api_token.
364 # We skipped thread_with_mandatory_api_token. Use the optional version.
365 thread_with_api_token(true) do
373 Link.where(uuid: 'just-verifying-my-api-token')
375 rescue ArvadosApiClient::NotLoggedInException
380 def ensure_current_user_is_admin
381 unless current_user and current_user.is_admin
382 @errors = ['Permission denied']
383 self.render_error status: 401
387 def check_user_agreements
388 if current_user && !current_user.is_active && current_user.is_invited
389 signatures = UserAgreement.signatures
390 @signed_ua_uuids = UserAgreement.signatures.map &:head_uuid
391 @required_user_agreements = UserAgreement.all.map do |ua|
392 if not @signed_ua_uuids.index ua.uuid
393 Collection.find(ua.uuid)
396 if @required_user_agreements.empty?
397 # No agreements to sign. Perhaps we just need to ask?
398 current_user.activate
399 if !current_user.is_active
400 logger.warn "#{current_user.uuid.inspect}: " +
401 "No user agreements to sign, but activate failed!"
404 if !current_user.is_active
405 render 'user_agreements/index'
412 return Rails.configuration.arvados_theme
415 @@notification_tests = []
417 @@notification_tests.push lambda { |controller, current_user|
418 AuthorizedKey.limit(1).where(authorized_user_uuid: current_user.uuid).each do
421 return lambda { |view|
422 view.render partial: 'notifications/ssh_key_notification'
426 #@@notification_tests.push lambda { |controller, current_user|
427 # Job.limit(1).where(created_by: current_user.uuid).each do
430 # return lambda { |view|
431 # view.render partial: 'notifications/jobs_notification'
435 @@notification_tests.push lambda { |controller, current_user|
436 Collection.limit(1).where(created_by: current_user.uuid).each do
439 return lambda { |view|
440 view.render partial: 'notifications/collections_notification'
444 @@notification_tests.push lambda { |controller, current_user|
445 PipelineInstance.limit(1).where(created_by: current_user.uuid).each do
448 return lambda { |view|
449 view.render partial: 'notifications/pipelines_notification'
453 def check_user_notifications
454 return if params['tab_pane']
456 @notification_count = 0
460 @showallalerts = false
461 @@notification_tests.each do |t|
462 a = t.call(self, current_user)
464 @notification_count += 1
465 @notifications.push a
470 if @notification_count == 0
471 @notification_count = ''
475 helper_method :my_folders
477 return @my_folders if @my_folders
480 Group.filter([['group_class','=','folder']]).each do |g|
481 root_of[g.uuid] = g.owner_uuid
487 root_of = root_of.each_with_object({}) do |(child, parent), h|
489 h[child] = root_of[parent]
496 @my_folders = @my_folders.select do |g|
497 root_of[g.uuid] == current_user.uuid