1 class ApplicationController < ActionController::Base
2 include ArvadosApiClientHelper
3 include ApplicationHelper
5 respond_to :html, :json, :js
8 ERROR_ACTIONS = [:render_error, :render_not_found]
10 around_filter :thread_clear
11 around_filter :thread_with_mandatory_api_token, except: ERROR_ACTIONS
12 around_filter :thread_with_optional_api_token
13 before_filter :check_user_agreements, except: ERROR_ACTIONS
14 before_filter :check_user_notifications, except: ERROR_ACTIONS
15 before_filter :find_object_by_uuid, except: [:index] + ERROR_ACTIONS
19 rescue_from Exception,
20 :with => :render_exception
21 rescue_from ActiveRecord::RecordNotFound,
22 :with => :render_not_found
23 rescue_from ActionController::RoutingError,
24 :with => :render_not_found
25 rescue_from ActionController::UnknownController,
26 :with => :render_not_found
27 rescue_from ::AbstractController::ActionNotFound,
28 :with => :render_not_found
31 def unprocessable(message=nil)
34 @errors << message if message
35 render_error status: 422
38 def render_error(opts)
39 opts = {status: 500}.merge opts
41 # json must come before html here, so it gets used as the
42 # default format when js is requested by the client. This lets
43 # ajax:error callback parse the response correctly, even though
45 f.json { render opts.merge(json: {success: false, errors: @errors}) }
46 f.html { render opts.merge(controller: 'application', action: 'error') }
50 def render_exception(e)
51 logger.error e.inspect
52 logger.error e.backtrace.collect { |x| x + "\n" }.join('') if e.backtrace
53 if @object.andand.errors.andand.full_messages.andand.any?
54 @errors = @object.errors.full_messages
58 self.render_error status: 422
61 def render_not_found(e=ActionController::RoutingError.new("Path not found"))
62 logger.error e.inspect
63 @errors = ["Path not found"]
64 self.render_error status: 404
67 def find_objects_for_index
70 @limit = params[:limit].to_i
75 @offset = params[:offset].to_i
80 filters = params[:filters]
81 if filters.is_a? String
82 filters = Oj.load filters
87 @objects ||= model_class
88 @objects = @objects.filter(@filters).limit(@limit).offset(@offset)
91 helper_method :next_page_offset
93 if @objects.respond_to?(:result_offset) and
94 @objects.respond_to?(:result_limit) and
95 @objects.respond_to?(:items_available)
96 next_offset = @objects.result_offset + @objects.result_limit
97 if next_offset < @objects.items_available
106 find_objects_for_index if !@objects
108 f.json { render json: @objects }
116 return render_not_found("object not found")
119 f.json { render json: @object.attributes.merge(href: url_for(@object)) }
121 if request.method == 'GET'
124 redirect_to params[:return_to] || @object
132 find_objects_for_index if !@objects
133 render partial: 'choose', locals: {multiple: params[:multiple]}
138 return render_not_found("object not found")
143 @object = model_class.new
147 @updates ||= params[@object.class.to_s.underscore.singularize.to_sym]
148 @updates.keys.each do |attr|
149 if @object.send(attr).is_a? Hash
150 if @updates[attr].is_a? String
151 @updates[attr] = Oj.load @updates[attr]
153 if params[:merge] || params["merge_#{attr}".to_sym]
154 # Merge provided Hash with current Hash, instead of
156 @updates[attr] = @object.send(attr).with_indifferent_access.
157 deep_merge(@updates[attr].with_indifferent_access)
161 if @object.update_attributes @updates
164 self.render_error status: 422
169 @new_resource_attrs ||= params[model_class.to_s.underscore.singularize]
170 @new_resource_attrs ||= {}
171 @new_resource_attrs.reject! { |k,v| k.to_s == 'uuid' }
172 @object ||= model_class.new @new_resource_attrs
180 f.json { render json: @object }
182 redirect_to(params[:return_to] || :back)
187 self.render_error status: 422
192 if Thread.current[:arvados_api_token]
193 Thread.current[:user] ||= User.current
195 logger.error "No API token in Thread"
201 controller_name.classify.constantize
204 def breadcrumb_page_name
205 (@breadcrumb_page_name ||
206 (@object.friendly_link_name if @object.respond_to? :friendly_link_name) ||
215 %w(Attributes Advanced)
220 def redirect_to_login
223 if request.method == 'GET'
224 redirect_to arvados_api_client.arvados_login_url(return_to: request.url)
226 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."
231 @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.']
232 self.render_error status: 422
235 false # For convenience to return from callbacks
238 def using_specific_api_token(api_token)
240 [:arvados_api_token, :user].each do |key|
241 start_values[key] = Thread.current[key]
243 Thread.current[:arvados_api_token] = api_token
244 Thread.current[:user] = nil
248 start_values.each_key { |key| Thread.current[key] = start_values[key] }
252 def find_object_by_uuid
253 if params[:id] and params[:id].match /\D/
254 params[:uuid] = params.delete :id
258 elsif params[:uuid].is_a? String
259 if params[:uuid].empty?
262 if (model_class != Link and
263 resource_class_for_uuid(params[:uuid]) == Link)
264 @name_link = Link.find(params[:uuid])
265 @object = model_class.find(@name_link.head_uuid)
267 @object = model_class.find(params[:uuid])
271 @object = model_class.where(uuid: params[:uuid]).first
276 Thread.current[:arvados_api_token] = nil
277 Thread.current[:user] = nil
278 Rails.cache.delete_matched(/^request_#{Thread.current.object_id}_/)
280 Rails.cache.delete_matched(/^request_#{Thread.current.object_id}_/)
283 def thread_with_api_token(login_optional = false)
285 try_redirect_to_login = true
286 if params[:api_token]
287 try_redirect_to_login = false
288 Thread.current[:arvados_api_token] = params[:api_token]
289 # Before copying the token into session[], do a simple API
290 # call to verify its authenticity.
292 session[:arvados_api_token] = params[:api_token]
293 if !request.format.json? and request.method == 'GET'
294 # Repeat this request with api_token in the (new) session
295 # cookie instead of the query string. This prevents API
296 # tokens from appearing in (and being inadvisedly copied
297 # and pasted from) browser Location bars.
298 redirect_to request.fullpath.sub(%r{([&\?]api_token=)[^&\?]*}, '')
303 @errors = ['Invalid API token']
304 self.render_error status: 401
306 elsif session[:arvados_api_token]
307 # In this case, the token must have already verified at some
308 # point, but it might have been revoked since. We'll try
309 # using it, and catch the exception if it doesn't work.
310 try_redirect_to_login = false
311 Thread.current[:arvados_api_token] = session[:arvados_api_token]
314 rescue ArvadosApiClient::NotLoggedInException
315 try_redirect_to_login = true
318 logger.debug "No token received, session is #{session.inspect}"
320 if try_redirect_to_login
321 unless login_optional
324 # login is optional for this route so go on to the regular controller
325 Thread.current[:arvados_api_token] = nil
330 # Remove token in case this Thread is used for anything else.
331 Thread.current[:arvados_api_token] = nil
335 def thread_with_mandatory_api_token
336 thread_with_api_token do
341 # This runs after thread_with_mandatory_api_token in the filter chain.
342 def thread_with_optional_api_token
343 if Thread.current[:arvados_api_token]
344 # We are already inside thread_with_mandatory_api_token.
347 # We skipped thread_with_mandatory_api_token. Use the optional version.
348 thread_with_api_token(true) do
356 Link.where(uuid: 'just-verifying-my-api-token')
358 rescue ArvadosApiClient::NotLoggedInException
363 def ensure_current_user_is_admin
364 unless current_user and current_user.is_admin
365 @errors = ['Permission denied']
366 self.render_error status: 401
370 def check_user_agreements
371 if current_user && !current_user.is_active && current_user.is_invited
372 signatures = UserAgreement.signatures
373 @signed_ua_uuids = UserAgreement.signatures.map &:head_uuid
374 @required_user_agreements = UserAgreement.all.map do |ua|
375 if not @signed_ua_uuids.index ua.uuid
376 Collection.find(ua.uuid)
379 if @required_user_agreements.empty?
380 # No agreements to sign. Perhaps we just need to ask?
381 current_user.activate
382 if !current_user.is_active
383 logger.warn "#{current_user.uuid.inspect}: " +
384 "No user agreements to sign, but activate failed!"
387 if !current_user.is_active
388 render 'user_agreements/index'
395 return Rails.configuration.arvados_theme
398 @@notification_tests = []
400 @@notification_tests.push lambda { |controller, current_user|
401 AuthorizedKey.limit(1).where(authorized_user_uuid: current_user.uuid).each do
404 return lambda { |view|
405 view.render partial: 'notifications/ssh_key_notification'
409 #@@notification_tests.push lambda { |controller, current_user|
410 # Job.limit(1).where(created_by: current_user.uuid).each do
413 # return lambda { |view|
414 # view.render partial: 'notifications/jobs_notification'
418 @@notification_tests.push lambda { |controller, current_user|
419 Collection.limit(1).where(created_by: current_user.uuid).each do
422 return lambda { |view|
423 view.render partial: 'notifications/collections_notification'
427 @@notification_tests.push lambda { |controller, current_user|
428 PipelineInstance.limit(1).where(created_by: current_user.uuid).each do
431 return lambda { |view|
432 view.render partial: 'notifications/pipelines_notification'
436 def check_user_notifications
437 @notification_count = 0
441 @showallalerts = false
442 @@notification_tests.each do |t|
443 a = t.call(self, current_user)
445 @notification_count += 1
446 @notifications.push a
451 if @notification_count == 0
452 @notification_count = ''
456 helper_method :my_folders
458 return @my_folders if @my_folders
461 Group.filter([['group_class','=','folder']]).each do |g|
462 root_of[g.uuid] = g.owner_uuid
468 root_of = root_of.each_with_object({}) do |(child, parent), h|
470 h[child] = root_of[parent]
477 @my_folders = @my_folders.select do |g|
478 root_of[g.uuid] == current_user.uuid