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)
93 f.json { render json: @objects }
96 comparable = self.respond_to? :compare
97 render(partial: 'show_' + params['tab_pane'].downcase,
98 locals: { comparable: comparable, objects: @objects })
108 find_objects_for_index if !@objects
112 helper_method :next_page_offset
114 if @objects.respond_to?(:result_offset) and
115 @objects.respond_to?(:result_limit) and
116 @objects.respond_to?(:items_available)
117 next_offset = @objects.result_offset + @objects.result_limit
118 if next_offset < @objects.items_available
128 return render_not_found("object not found")
131 f.json { render json: @object.attributes.merge(href: url_for(@object)) }
133 if params['tab_pane']
134 comparable = self.respond_to? :compare
135 render(partial: 'show_' + params['tab_pane'].downcase,
136 locals: { comparable: comparable, objects: @objects })
137 elsif request.method.in? ['GET', 'HEAD']
140 redirect_to params[:return_to] || @object
148 params[:limit] ||= 20
149 find_objects_for_index if !@objects
154 content: render_to_string(partial: "choose_rows.html",
157 multiple: params[:multiple]
159 next_page_href: @next_page_href
164 render partial: 'choose', locals: {multiple: params[:multiple]}
171 return render_not_found("object not found")
176 @object = model_class.new
180 @updates ||= params[@object.resource_param_name.to_sym]
181 @updates.keys.each do |attr|
182 if @object.send(attr).is_a? Hash
183 if @updates[attr].is_a? String
184 @updates[attr] = Oj.load @updates[attr]
186 if params[:merge] || params["merge_#{attr}".to_sym]
187 # Merge provided Hash with current Hash, instead of
189 @updates[attr] = @object.send(attr).with_indifferent_access.
190 deep_merge(@updates[attr].with_indifferent_access)
194 if @object.update_attributes @updates
197 self.render_error status: 422
202 @new_resource_attrs ||= params[model_class.to_s.underscore.singularize]
203 @new_resource_attrs ||= {}
204 @new_resource_attrs.reject! { |k,v| k.to_s == 'uuid' }
205 @object ||= model_class.new @new_resource_attrs, params["options"]
208 f.json { render json: @object.attributes.merge(href: url_for(@object)) }
215 self.render_error status: 422
219 # Clone the given object, merging any attribute values supplied as
220 # with a create action.
222 @new_resource_attrs ||= params[model_class.to_s.underscore.singularize]
223 @new_resource_attrs ||= {}
224 @object = @object.dup
225 @object.update_attributes @new_resource_attrs
226 if not @new_resource_attrs[:name] and @object.respond_to? :name
227 if @object.name and @object.name != ''
228 @object.name = "Copy of #{@object.name}"
230 @object.name = "Copy of unnamed #{@object.class_for_display.downcase}"
240 f.json { render json: @object }
242 redirect_to(params[:return_to] || :back)
247 self.render_error status: 422
252 return Thread.current[:user] if Thread.current[:user]
254 if Thread.current[:arvados_api_token]
256 if session[:user][:is_active] != true
257 Thread.current[:user] = User.current
259 Thread.current[:user] = User.new(session[:user])
262 Thread.current[:user] = User.current
265 logger.error "No API token in Thread"
271 controller_name.classify.constantize
274 def breadcrumb_page_name
275 (@breadcrumb_page_name ||
276 (@object.friendly_link_name if @object.respond_to? :friendly_link_name) ||
285 %w(Attributes Advanced)
290 def redirect_to_login
293 if request.method.in? ['GET', 'HEAD']
294 redirect_to arvados_api_client.arvados_login_url(return_to: request.url)
296 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."
301 @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.']
302 self.render_error status: 422
305 false # For convenience to return from callbacks
308 def using_specific_api_token(api_token)
310 [:arvados_api_token, :user].each do |key|
311 start_values[key] = Thread.current[key]
313 Thread.current[:arvados_api_token] = api_token
314 Thread.current[:user] = nil
318 start_values.each_key { |key| Thread.current[key] = start_values[key] }
322 def find_object_by_uuid
323 if params[:id] and params[:id].match /\D/
324 params[:uuid] = params.delete :id
328 elsif params[:uuid].is_a? String
329 if params[:uuid].empty?
332 if (model_class != Link and
333 resource_class_for_uuid(params[:uuid]) == Link)
334 @name_link = Link.find(params[:uuid])
335 @object = model_class.find(@name_link.head_uuid)
337 @object = model_class.find(params[:uuid])
341 @object = model_class.where(uuid: params[:uuid]).first
346 Thread.current[:arvados_api_token] = nil
347 Thread.current[:user] = nil
348 Rails.cache.delete_matched(/^request_#{Thread.current.object_id}_/)
350 Rails.cache.delete_matched(/^request_#{Thread.current.object_id}_/)
353 def thread_with_api_token(login_optional = false)
355 try_redirect_to_login = true
356 if params[:api_token]
357 try_redirect_to_login = false
358 Thread.current[:arvados_api_token] = params[:api_token]
359 # Before copying the token into session[], do a simple API
360 # call to verify its authenticity.
362 session[:arvados_api_token] = params[:api_token]
367 first_name: u.first_name,
368 last_name: u.last_name,
369 is_active: u.is_active,
370 is_admin: u.is_admin,
373 if !request.format.json? and request.method.in? ['GET', 'HEAD']
374 # Repeat this request with api_token in the (new) session
375 # cookie instead of the query string. This prevents API
376 # tokens from appearing in (and being inadvisedly copied
377 # and pasted from) browser Location bars.
378 redirect_to request.fullpath.sub(%r{([&\?]api_token=)[^&\?]*}, '')
383 @errors = ['Invalid API token']
384 self.render_error status: 401
386 elsif session[:arvados_api_token]
387 # In this case, the token must have already verified at some
388 # point, but it might have been revoked since. We'll try
389 # using it, and catch the exception if it doesn't work.
390 try_redirect_to_login = false
391 Thread.current[:arvados_api_token] = session[:arvados_api_token]
394 rescue ArvadosApiClient::NotLoggedInException
395 try_redirect_to_login = true
398 logger.debug "No token received, session is #{session.inspect}"
400 if try_redirect_to_login
401 unless login_optional
404 # login is optional for this route so go on to the regular controller
405 Thread.current[:arvados_api_token] = nil
410 # Remove token in case this Thread is used for anything else.
411 Thread.current[:arvados_api_token] = nil
415 def thread_with_mandatory_api_token
416 thread_with_api_token(true) do
417 if Thread.current[:arvados_api_token]
419 elsif session[:arvados_api_token]
420 # Expired session. Clear it before refreshing login so that,
421 # if this login procedure fails, we end up showing the "please
422 # log in" page instead of getting stuck in a redirect loop.
423 session.delete :arvados_api_token
426 render 'users/welcome'
431 # This runs after thread_with_mandatory_api_token in the filter chain.
432 def thread_with_optional_api_token
433 if Thread.current[:arvados_api_token]
434 # We are already inside thread_with_mandatory_api_token.
437 # We skipped thread_with_mandatory_api_token. Use the optional version.
438 thread_with_api_token(true) do
446 Link.where(uuid: 'just-verifying-my-api-token')
448 rescue ArvadosApiClient::NotLoggedInException
453 def ensure_current_user_is_admin
454 unless current_user and current_user.is_admin
455 @errors = ['Permission denied']
456 self.render_error status: 401
460 def check_user_agreements
461 if current_user && !current_user.is_active
462 if not current_user.is_invited
463 return render 'users/inactive'
465 signatures = UserAgreement.signatures
466 @signed_ua_uuids = UserAgreement.signatures.map &:head_uuid
467 @required_user_agreements = UserAgreement.all.map do |ua|
468 if not @signed_ua_uuids.index ua.uuid
469 Collection.find(ua.uuid)
472 if @required_user_agreements.empty?
473 # No agreements to sign. Perhaps we just need to ask?
474 current_user.activate
475 if !current_user.is_active
476 logger.warn "#{current_user.uuid.inspect}: " +
477 "No user agreements to sign, but activate failed!"
480 if !current_user.is_active
481 render 'user_agreements/index'
488 return Rails.configuration.arvados_theme
491 @@notification_tests = []
493 @@notification_tests.push lambda { |controller, current_user|
494 AuthorizedKey.limit(1).where(authorized_user_uuid: current_user.uuid).each do
497 return lambda { |view|
498 view.render partial: 'notifications/ssh_key_notification'
502 #@@notification_tests.push lambda { |controller, current_user|
503 # Job.limit(1).where(created_by: current_user.uuid).each do
506 # return lambda { |view|
507 # view.render partial: 'notifications/jobs_notification'
511 @@notification_tests.push lambda { |controller, current_user|
512 Collection.limit(1).where(created_by: current_user.uuid).each do
515 return lambda { |view|
516 view.render partial: 'notifications/collections_notification'
520 @@notification_tests.push lambda { |controller, current_user|
521 PipelineInstance.limit(1).where(created_by: current_user.uuid).each do
524 return lambda { |view|
525 view.render partial: 'notifications/pipelines_notification'
529 def check_user_notifications
530 return if params['tab_pane']
532 @notification_count = 0
536 @showallalerts = false
537 @@notification_tests.each do |t|
538 a = t.call(self, current_user)
540 @notification_count += 1
541 @notifications.push a
546 if @notification_count == 0
547 @notification_count = ''
551 helper_method :all_projects
553 @all_projects ||= Group.filter([['group_class','in',['project','folder']]])
556 helper_method :my_projects
558 return @my_projects if @my_projects
561 all_projects.each do |g|
562 root_of[g.uuid] = g.owner_uuid
568 root_of = root_of.each_with_object({}) do |(child, parent), h|
570 h[child] = root_of[parent]
577 @my_projects = @my_projects.select do |g|
578 root_of[g.uuid] == current_user.uuid
582 helper_method :projects_shared_with_me
583 def projects_shared_with_me
584 my_project_uuids = my_projects.collect &:uuid
585 all_projects.reject { |x| x.uuid.in? my_project_uuids }
588 helper_method :recent_jobs_and_pipelines
589 def recent_jobs_and_pipelines
590 in_my_projects = ['owner_uuid','in',my_projects.collect(&:uuid)]
591 (Job.limit(10).filter([in_my_projects]) |
592 PipelineInstance.limit(10).filter([in_my_projects])).
594 x.finished_at || x.started_at || x.created_at rescue x.created_at
598 helper_method :get_object
600 if @get_object.nil? and @objects
601 @get_object = @objects.each_with_object({}) do |object, h|
602 h[object.uuid] = object
609 helper_method :project_breadcrumbs
610 def project_breadcrumbs
612 current = @name_link || @object
614 if current.is_a?(Group) and current.group_class.in?(['project','folder'])
615 crumbs.prepend current
617 if current.is_a? Link
618 current = Group.find?(current.tail_uuid)
620 current = Group.find?(current.owner_uuid)
626 helper_method :current_project_uuid
627 def current_project_uuid
628 if @object.is_a? Group and @object.group_class.in?(['project','folder'])
630 elsif @name_link.andand.tail_uuid
632 elsif @object and resource_class_for_uuid(@object.owner_uuid) == Group
639 # helper method to get links for given object or uuid
640 helper_method :links_for_object
641 def links_for_object object_or_uuid
642 raise ArgumentError, 'No input argument' unless object_or_uuid
643 preload_links_for_objects([object_or_uuid])
644 uuid = object_or_uuid.is_a?(String) ? object_or_uuid : object_or_uuid.uuid
645 @all_links_for[uuid] ||= []
648 # helper method to preload links for given objects and uuids
649 helper_method :preload_links_for_objects
650 def preload_links_for_objects objects_and_uuids
651 @all_links_for ||= {}
653 raise ArgumentError, 'Argument is not an array' unless objects_and_uuids.is_a? Array
654 return @all_links_for if objects_and_uuids.empty?
656 uuids = objects_and_uuids.collect { |x| x.is_a?(String) ? x : x.uuid }
658 # if already preloaded for all of these uuids, return
659 if not uuids.select { |x| @all_links_for[x].nil? }.any?
660 return @all_links_for
664 @all_links_for[x] = []
667 # TODO: make sure we get every page of results from API server
668 Link.filter([['head_uuid', 'in', uuids]]).each do |link|
669 @all_links_for[link.head_uuid] << link
674 # helper method to get a certain number of objects of a specific type
675 # this can be used to replace any uses of: "dataclass.limit(n)"
676 helper_method :get_n_objects_of_class
677 def get_n_objects_of_class dataclass, size
678 @objects_map_for ||= {}
680 raise ArgumentError, 'Argument is not a data class' unless dataclass.is_a? Class
681 raise ArgumentError, 'Argument is not a valid limit size' unless (size && size>0)
683 # if the objects_map_for has a value for this dataclass, and the
684 # size used to retrieve those objects is equal, return it
685 size_key = "#{dataclass.name}_size"
686 if @objects_map_for[dataclass.name] && @objects_map_for[size_key] &&
687 (@objects_map_for[size_key] == size)
688 return @objects_map_for[dataclass.name]
691 @objects_map_for[size_key] = size
692 @objects_map_for[dataclass.name] = dataclass.limit(size)
695 # helper method to get collections for the given uuid
696 helper_method :collections_for_object
697 def collections_for_object uuid
698 raise ArgumentError, 'No input argument' unless uuid
699 preload_collections_for_objects([uuid])
700 @all_collections_for[uuid] ||= []
703 # helper method to preload collections for the given uuids
704 helper_method :preload_collections_for_objects
705 def preload_collections_for_objects uuids
706 @all_collections_for ||= {}
708 raise ArgumentError, 'Argument is not an array' unless uuids.is_a? Array
709 return @all_collections_for if uuids.empty?
711 # if already preloaded for all of these uuids, return
712 if not uuids.select { |x| @all_collections_for[x].nil? }.any?
713 return @all_collections_for
717 @all_collections_for[x] = []
720 # TODO: make sure we get every page of results from API server
721 Collection.where(uuid: uuids).each do |collection|
722 @all_collections_for[collection.uuid] << collection
727 # helper method to get log collections for the given log
728 helper_method :log_collections_for_object
729 def log_collections_for_object log
730 raise ArgumentError, 'No input argument' unless log
732 preload_log_collections_for_objects([log])
735 fixup = /([a-f0-9]{32}\+\d+)(\+?.*)/.match(log)
736 if fixup && fixup.size>1
740 @all_log_collections_for[uuid] ||= []
743 # helper method to preload collections for the given uuids
744 helper_method :preload_log_collections_for_objects
745 def preload_log_collections_for_objects logs
746 @all_log_collections_for ||= {}
748 raise ArgumentError, 'Argument is not an array' unless logs.is_a? Array
749 return @all_log_collections_for if logs.empty?
753 fixup = /([a-f0-9]{32}\+\d+)(\+?.*)/.match(log)
754 if fixup && fixup.size>1
761 # if already preloaded for all of these uuids, return
762 if not uuids.select { |x| @all_log_collections_for[x].nil? }.any?
763 return @all_log_collections_for
767 @all_log_collections_for[x] = []
770 # TODO: make sure we get every page of results from API server
771 Collection.where(uuid: uuids).each do |collection|
772 @all_log_collections_for[collection.uuid] << collection
774 @all_log_collections_for
777 # helper method to get object of a given dataclass and uuid
778 helper_method :object_for_dataclass
779 def object_for_dataclass dataclass, uuid
780 raise ArgumentError, 'No input argument dataclass' unless (dataclass && uuid)
781 preload_objects_for_dataclass(dataclass, [uuid])
785 # helper method to preload objects for given dataclass and uuids
786 helper_method :preload_objects_for_dataclass
787 def preload_objects_for_dataclass dataclass, uuids
790 raise ArgumentError, 'Argument is not a data class' unless dataclass.is_a? Class
791 raise ArgumentError, 'Argument is not an array' unless uuids.is_a? Array
793 return @objects_for if uuids.empty?
795 # if already preloaded for all of these uuids, return
796 if not uuids.select { |x| @objects_for[x].nil? }.any?
800 dataclass.where(uuid: uuids).each do |obj|
801 @objects_for[obj.uuid] = obj