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 :set_thread_api_token
12 # Methods that don't require login should
13 # skip_around_filter :require_thread_api_token
14 around_filter :require_thread_api_token, except: ERROR_ACTIONS
15 before_filter :accept_uuid_as_id_param, except: ERROR_ACTIONS
16 before_filter :check_user_agreements, except: ERROR_ACTIONS
17 before_filter :check_user_notifications, except: ERROR_ACTIONS
18 before_filter :load_filters_and_paging_params, except: ERROR_ACTIONS
19 before_filter :find_object_by_uuid, except: [:index, :choose] + ERROR_ACTIONS
23 rescue_from(ActiveRecord::RecordNotFound,
24 ActionController::RoutingError,
25 ActionController::UnknownController,
26 AbstractController::ActionNotFound,
27 with: :render_not_found)
28 rescue_from(Exception,
29 ActionController::UrlGenerationError,
30 with: :render_exception)
33 def unprocessable(message=nil)
36 @errors << message if message
37 render_error status: 422
40 def render_error(opts={})
43 # json must come before html here, so it gets used as the
44 # default format when js is requested by the client. This lets
45 # ajax:error callback parse the response correctly, even though
47 f.json { render opts.merge(json: {success: false, errors: @errors}) }
48 f.html { render({action: 'error'}.merge(opts)) }
52 def render_exception(e)
53 logger.error e.inspect
54 logger.error e.backtrace.collect { |x| x + "\n" }.join('') if e.backtrace
55 err_opts = {status: 422}
56 if e.is_a?(ArvadosApiClient::ApiError)
57 err_opts.merge!(action: 'api_error', locals: {api_error: e})
58 @errors = e.api_response[:errors]
59 elsif @object.andand.errors.andand.full_messages.andand.any?
60 @errors = @object.errors.full_messages
64 # If the user has an active session, and the API server is available,
65 # make user information available on the error page.
67 load_api_token(session[:arvados_api_token])
68 rescue ArvadosApiClient::ApiError
71 # Preload projects trees for the template. If that fails, set empty
72 # trees so error page rendering can proceed. (It's easier to rescue the
73 # exception here than in a template.)
76 rescue ArvadosApiClient::ApiError
77 @my_project_tree ||= []
78 @shared_project_tree ||= []
80 render_error(err_opts)
83 def render_not_found(e=ActionController::RoutingError.new("Path not found"))
84 logger.error e.inspect
85 @errors = ["Path not found"]
86 set_thread_api_token do
87 self.render_error(action: '404', status: 404)
91 def load_filters_and_paging_params
94 @limit = params[:limit].to_i
99 @offset = params[:offset].to_i
104 filters = params[:filters]
105 if filters.is_a? String
106 filters = Oj.load filters
107 elsif filters.is_a? Array
108 filters = filters.collect do |filter|
109 if filter.is_a? String
110 # Accept filters[]=["foo","=","bar"]
113 # Accept filters=[["foo","=","bar"]]
122 def find_objects_for_index
123 @objects ||= model_class
124 @objects = @objects.filter(@filters).limit(@limit).offset(@offset)
129 f.json { render json: @objects }
131 if params['tab_pane']
132 comparable = self.respond_to? :compare
133 render(partial: 'show_' + params['tab_pane'].downcase,
134 locals: { comparable: comparable, objects: @objects })
144 find_objects_for_index if !@objects
148 helper_method :next_page_offset
149 def next_page_offset objects=nil
153 if objects.respond_to?(:result_offset) and
154 objects.respond_to?(:result_limit) and
155 objects.respond_to?(:items_available)
156 next_offset = objects.result_offset + objects.result_limit
157 if next_offset < objects.items_available
165 helper_method :next_page_href
166 def next_page_href with_params={}
168 url_for with_params.merge(offset: next_page_offset)
174 return render_not_found("object not found")
178 extra_attrs = { href: url_for(@object) }
179 @object.textile_attributes.each do |textile_attr|
180 extra_attrs.merge!({ "#{textile_attr}Textile" => view_context.render_content_from_database(@object.attributes[textile_attr]) })
182 render json: @object.attributes.merge(extra_attrs)
185 if params['tab_pane']
186 comparable = self.respond_to? :compare
187 render(partial: 'show_' + params['tab_pane'].downcase,
188 locals: { comparable: comparable, objects: @objects })
189 elsif request.method.in? ['GET', 'HEAD']
192 redirect_to params[:return_to] || @object
200 params[:limit] ||= 40
201 find_objects_for_index if !@objects
206 content: render_to_string(partial: "choose_rows.html",
208 next_page_href: next_page_href(partial: params[:partial])
213 render partial: 'choose', locals: {multiple: params[:multiple]}
220 return render_not_found("object not found")
225 @object = model_class.new
229 @updates ||= params[@object.resource_param_name.to_sym]
230 @updates.keys.each do |attr|
231 if @object.send(attr).is_a? Hash
232 if @updates[attr].is_a? String
233 @updates[attr] = Oj.load @updates[attr]
235 if params[:merge] || params["merge_#{attr}".to_sym]
236 # Merge provided Hash with current Hash, instead of
238 @updates[attr] = @object.send(attr).with_indifferent_access.
239 deep_merge(@updates[attr].with_indifferent_access)
243 if @object.update_attributes @updates
246 self.render_error status: 422
251 @new_resource_attrs ||= params[model_class.to_s.underscore.singularize]
252 @new_resource_attrs ||= {}
253 @new_resource_attrs.reject! { |k,v| k.to_s == 'uuid' }
254 @object ||= model_class.new @new_resource_attrs, params["options"]
257 f.json { render json: @object.attributes.merge(href: url_for(@object)) }
264 self.render_error status: 422
268 # Clone the given object, merging any attribute values supplied as
269 # with a create action.
271 @new_resource_attrs ||= params[model_class.to_s.underscore.singularize]
272 @new_resource_attrs ||= {}
273 @object = @object.dup
274 @object.update_attributes @new_resource_attrs
275 if not @new_resource_attrs[:name] and @object.respond_to? :name
276 if @object.name and @object.name != ''
277 @object.name = "Copy of #{@object.name}"
289 f.json { render json: @object }
291 redirect_to(params[:return_to] || :back)
296 self.render_error status: 422
301 Thread.current[:user]
305 controller_name.classify.constantize
308 def breadcrumb_page_name
309 (@breadcrumb_page_name ||
310 (@object.friendly_link_name if @object.respond_to? :friendly_link_name) ||
319 %w(Attributes Advanced)
324 def strip_token_from_path(path)
325 path.sub(/([\?&;])api_token=[^&;]*[&;]?/, '\1')
328 def redirect_to_login
331 if request.method.in? ['GET', 'HEAD']
332 redirect_to arvados_api_client.arvados_login_url(return_to: strip_token_from_path(request.url))
334 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."
339 @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.']
340 self.render_error status: 422
343 false # For convenience to return from callbacks
346 def using_specific_api_token(api_token)
348 [:arvados_api_token, :user].each do |key|
349 start_values[key] = Thread.current[key]
351 load_api_token(api_token)
355 start_values.each_key { |key| Thread.current[key] = start_values[key] }
360 def accept_uuid_as_id_param
361 if params[:id] and params[:id].match /\D/
362 params[:uuid] = params.delete :id
366 def find_object_by_uuid
370 elsif not params[:uuid].is_a?(String)
371 @object = model_class.where(uuid: params[:uuid]).first
372 elsif params[:uuid].empty?
374 elsif (model_class != Link and
375 resource_class_for_uuid(params[:uuid]) == Link)
376 @name_link = Link.find(params[:uuid])
377 @object = model_class.find(@name_link.head_uuid)
379 @object = model_class.find(params[:uuid])
381 rescue ArvadosApiClient::NotFoundException, RuntimeError => error
382 if error.is_a?(RuntimeError) and (error.message !~ /^argument to find\(/)
385 render_not_found(error)
392 Rails.cache.delete_matched(/^request_#{Thread.current.object_id}_/)
394 Rails.cache.delete_matched(/^request_#{Thread.current.object_id}_/)
397 # Set up the thread with the given API token and associated user object.
398 def load_api_token(new_token)
399 Thread.current[:arvados_api_token] = new_token
401 Thread.current[:user] = nil
402 elsif (new_token == session[:arvados_api_token]) and
403 session[:user].andand[:is_active]
404 Thread.current[:user] = User.new(session[:user])
406 Thread.current[:user] = User.current
410 # If there's a valid api_token parameter, set up the session with that
411 # user's information. Return true if the method redirects the request
412 # (usually a post-login redirect); false otherwise.
413 def setup_user_session
414 return false unless params[:api_token]
415 Thread.current[:arvados_api_token] = params[:api_token]
418 rescue ArvadosApiClient::NotLoggedInException
419 false # We may redirect to login, or not, based on the current action.
421 session[:arvados_api_token] = params[:api_token]
425 first_name: user.first_name,
426 last_name: user.last_name,
427 is_active: user.is_active,
428 is_admin: user.is_admin,
431 if !request.format.json? and request.method.in? ['GET', 'HEAD']
432 # Repeat this request with api_token in the (new) session
433 # cookie instead of the query string. This prevents API
434 # tokens from appearing in (and being inadvisedly copied
435 # and pasted from) browser Location bars.
436 redirect_to strip_token_from_path(request.fullpath)
442 Thread.current[:arvados_api_token] = nil
446 # Save the session API token in thread-local storage, and yield.
447 # This method also takes care of session setup if the request
448 # provides a valid api_token parameter.
449 # If a token is unavailable or expired, the block is still run, with
451 def set_thread_api_token
452 if Thread.current[:arvados_api_token]
453 yield # An API token has already been found - pass it through.
455 elsif setup_user_session
456 return # A new session was set up and received a response.
460 load_api_token(session[:arvados_api_token])
462 rescue ArvadosApiClient::NotLoggedInException
463 # If we got this error with a token, it must've expired.
464 # Retry the request without a token.
465 unless Thread.current[:arvados_api_token].nil?
470 # Remove token in case this Thread is used for anything else.
475 # Reroute this request if an API token is unavailable.
476 def require_thread_api_token
477 if Thread.current[:arvados_api_token]
479 elsif session[:arvados_api_token]
480 # Expired session. Clear it before refreshing login so that,
481 # if this login procedure fails, we end up showing the "please
482 # log in" page instead of getting stuck in a redirect loop.
483 session.delete :arvados_api_token
486 render 'users/welcome'
490 def ensure_current_user_is_admin
491 unless current_user and current_user.is_admin
492 @errors = ['Permission denied']
493 self.render_error status: 401
497 def check_user_agreements
498 if current_user && !current_user.is_active
499 if not current_user.is_invited
500 return render 'users/inactive'
502 signatures = UserAgreement.signatures
503 @signed_ua_uuids = UserAgreement.signatures.map &:head_uuid
504 @required_user_agreements = UserAgreement.all.map do |ua|
505 if not @signed_ua_uuids.index ua.uuid
506 Collection.find(ua.uuid)
509 if @required_user_agreements.empty?
510 # No agreements to sign. Perhaps we just need to ask?
511 current_user.activate
512 if !current_user.is_active
513 logger.warn "#{current_user.uuid.inspect}: " +
514 "No user agreements to sign, but activate failed!"
517 if !current_user.is_active
518 render 'user_agreements/index'
525 return Rails.configuration.arvados_theme
528 @@notification_tests = []
530 @@notification_tests.push lambda { |controller, current_user|
531 AuthorizedKey.limit(1).where(authorized_user_uuid: current_user.uuid).each do
534 return lambda { |view|
535 view.render partial: 'notifications/ssh_key_notification'
539 #@@notification_tests.push lambda { |controller, current_user|
540 # Job.limit(1).where(created_by: current_user.uuid).each do
543 # return lambda { |view|
544 # view.render partial: 'notifications/jobs_notification'
548 @@notification_tests.push lambda { |controller, current_user|
549 Collection.limit(1).where(created_by: current_user.uuid).each do
552 return lambda { |view|
553 view.render partial: 'notifications/collections_notification'
557 @@notification_tests.push lambda { |controller, current_user|
558 PipelineInstance.limit(1).where(created_by: current_user.uuid).each do
561 return lambda { |view|
562 view.render partial: 'notifications/pipelines_notification'
566 def check_user_notifications
567 return if params['tab_pane']
569 @notification_count = 0
573 @showallalerts = false
574 @@notification_tests.each do |t|
575 a = t.call(self, current_user)
577 @notification_count += 1
578 @notifications.push a
583 if @notification_count == 0
584 @notification_count = ''
588 helper_method :all_projects
590 @all_projects ||= Group.
591 filter([['group_class','=','project']]).order('name')
594 helper_method :my_projects
596 return @my_projects if @my_projects
599 all_projects.each do |g|
600 root_of[g.uuid] = g.owner_uuid
606 root_of = root_of.each_with_object({}) do |(child, parent), h|
608 h[child] = root_of[parent]
615 @my_projects = @my_projects.select do |g|
616 root_of[g.uuid] == current_user.uuid
620 helper_method :projects_shared_with_me
621 def projects_shared_with_me
622 my_project_uuids = my_projects.collect &:uuid
623 all_projects.reject { |x| x.uuid.in? my_project_uuids }
626 helper_method :recent_jobs_and_pipelines
627 def recent_jobs_and_pipelines
629 PipelineInstance.limit(10)).
631 (x.finished_at || x.started_at rescue nil) || x.modified_at || x.created_at
635 helper_method :my_project_tree
641 helper_method :shared_project_tree
642 def shared_project_tree
647 def build_project_trees
648 return if @my_project_tree and @shared_project_tree
649 parent_of = {current_user.uuid => 'me'}
650 all_projects.each do |ob|
651 parent_of[ob.uuid] = ob.owner_uuid
653 children_of = {false => [], 'me' => [current_user]}
654 all_projects.each do |ob|
655 if ob.owner_uuid != current_user.uuid and
656 not parent_of.has_key? ob.owner_uuid
657 parent_of[ob.uuid] = false
659 children_of[parent_of[ob.uuid]] ||= []
660 children_of[parent_of[ob.uuid]] << ob
662 buildtree = lambda do |children_of, root_uuid=false|
664 children_of[root_uuid].andand.each do |ob|
665 tree[ob] = buildtree.call(children_of, ob.uuid)
669 sorted_paths = lambda do |tree, depth=0|
671 tree.keys.sort_by { |ob|
672 ob.is_a?(String) ? ob : ob.friendly_link_name
674 paths << {object: ob, depth: depth}
675 paths += sorted_paths.call tree[ob], depth+1
680 sorted_paths.call buildtree.call(children_of, 'me')
681 @shared_project_tree =
682 sorted_paths.call({'Shared with me' =>
683 buildtree.call(children_of, false)})
686 helper_method :get_object
688 if @get_object.nil? and @objects
689 @get_object = @objects.each_with_object({}) do |object, h|
690 h[object.uuid] = object
697 helper_method :project_breadcrumbs
698 def project_breadcrumbs
700 current = @name_link || @object
702 if current.is_a?(Group) and current.group_class == 'project'
703 crumbs.prepend current
705 if current.is_a? Link
706 current = Group.find?(current.tail_uuid)
708 current = Group.find?(current.owner_uuid)
714 helper_method :current_project_uuid
715 def current_project_uuid
716 if @object.is_a? Group and @object.group_class == 'project'
718 elsif @name_link.andand.tail_uuid
720 elsif @object and resource_class_for_uuid(@object.owner_uuid) == Group
727 # helper method to get links for given object or uuid
728 helper_method :links_for_object
729 def links_for_object object_or_uuid
730 raise ArgumentError, 'No input argument' unless object_or_uuid
731 preload_links_for_objects([object_or_uuid])
732 uuid = object_or_uuid.is_a?(String) ? object_or_uuid : object_or_uuid.uuid
733 @all_links_for[uuid] ||= []
736 # helper method to preload links for given objects and uuids
737 helper_method :preload_links_for_objects
738 def preload_links_for_objects objects_and_uuids
739 @all_links_for ||= {}
741 raise ArgumentError, 'Argument is not an array' unless objects_and_uuids.is_a? Array
742 return @all_links_for if objects_and_uuids.empty?
744 uuids = objects_and_uuids.collect { |x| x.is_a?(String) ? x : x.uuid }
746 # if already preloaded for all of these uuids, return
747 if not uuids.select { |x| @all_links_for[x].nil? }.any?
748 return @all_links_for
752 @all_links_for[x] = []
755 # TODO: make sure we get every page of results from API server
756 Link.filter([['head_uuid', 'in', uuids]]).each do |link|
757 @all_links_for[link.head_uuid] << link
762 # helper method to get a certain number of objects of a specific type
763 # this can be used to replace any uses of: "dataclass.limit(n)"
764 helper_method :get_n_objects_of_class
765 def get_n_objects_of_class dataclass, size
766 @objects_map_for ||= {}
768 raise ArgumentError, 'Argument is not a data class' unless dataclass.is_a? Class and dataclass < ArvadosBase
769 raise ArgumentError, 'Argument is not a valid limit size' unless (size && size>0)
771 # if the objects_map_for has a value for this dataclass, and the
772 # size used to retrieve those objects is equal, return it
773 size_key = "#{dataclass.name}_size"
774 if @objects_map_for[dataclass.name] && @objects_map_for[size_key] &&
775 (@objects_map_for[size_key] == size)
776 return @objects_map_for[dataclass.name]
779 @objects_map_for[size_key] = size
780 @objects_map_for[dataclass.name] = dataclass.limit(size)
783 # helper method to get collections for the given uuid
784 helper_method :collections_for_object
785 def collections_for_object uuid
786 raise ArgumentError, 'No input argument' unless uuid
787 preload_collections_for_objects([uuid])
788 @all_collections_for[uuid] ||= []
791 # helper method to preload collections for the given uuids
792 helper_method :preload_collections_for_objects
793 def preload_collections_for_objects uuids
794 @all_collections_for ||= {}
796 raise ArgumentError, 'Argument is not an array' unless uuids.is_a? Array
797 return @all_collections_for if uuids.empty?
799 # if already preloaded for all of these uuids, return
800 if not uuids.select { |x| @all_collections_for[x].nil? }.any?
801 return @all_collections_for
805 @all_collections_for[x] = []
808 # TODO: make sure we get every page of results from API server
809 Collection.where(uuid: uuids).each do |collection|
810 @all_collections_for[collection.uuid] << collection
815 # helper method to get log collections for the given log
816 helper_method :log_collections_for_object
817 def log_collections_for_object log
818 raise ArgumentError, 'No input argument' unless log
820 preload_log_collections_for_objects([log])
823 fixup = /([a-f0-9]{32}\+\d+)(\+?.*)/.match(log)
824 if fixup && fixup.size>1
828 @all_log_collections_for[uuid] ||= []
831 # helper method to preload collections for the given uuids
832 helper_method :preload_log_collections_for_objects
833 def preload_log_collections_for_objects logs
834 @all_log_collections_for ||= {}
836 raise ArgumentError, 'Argument is not an array' unless logs.is_a? Array
837 return @all_log_collections_for if logs.empty?
841 fixup = /([a-f0-9]{32}\+\d+)(\+?.*)/.match(log)
842 if fixup && fixup.size>1
849 # if already preloaded for all of these uuids, return
850 if not uuids.select { |x| @all_log_collections_for[x].nil? }.any?
851 return @all_log_collections_for
855 @all_log_collections_for[x] = []
858 # TODO: make sure we get every page of results from API server
859 Collection.where(uuid: uuids).each do |collection|
860 @all_log_collections_for[collection.uuid] << collection
862 @all_log_collections_for
865 # helper method to get object of a given dataclass and uuid
866 helper_method :object_for_dataclass
867 def object_for_dataclass dataclass, uuid
868 raise ArgumentError, 'No input argument dataclass' unless (dataclass && uuid)
869 preload_objects_for_dataclass(dataclass, [uuid])
873 # helper method to preload objects for given dataclass and uuids
874 helper_method :preload_objects_for_dataclass
875 def preload_objects_for_dataclass dataclass, uuids
878 raise ArgumentError, 'Argument is not a data class' unless dataclass.is_a? Class
879 raise ArgumentError, 'Argument is not an array' unless uuids.is_a? Array
881 return @objects_for if uuids.empty?
883 # if already preloaded for all of these uuids, return
884 if not uuids.select { |x| @objects_for[x].nil? }.any?
888 dataclass.where(uuid: uuids).each do |obj|
889 @objects_for[obj.uuid] = obj