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 :set_cache_buster
16 before_filter :accept_uuid_as_id_param, except: ERROR_ACTIONS
17 before_filter :check_user_agreements, except: ERROR_ACTIONS
18 before_filter :check_user_profile, except: ERROR_ACTIONS
19 before_filter :check_user_notifications, except: ERROR_ACTIONS
20 before_filter :load_filters_and_paging_params, except: ERROR_ACTIONS
21 before_filter :find_object_by_uuid, except: [:create, :index, :choose] + ERROR_ACTIONS
25 rescue_from(ActiveRecord::RecordNotFound,
26 ActionController::RoutingError,
27 ActionController::UnknownController,
28 AbstractController::ActionNotFound,
29 with: :render_not_found)
30 rescue_from(Exception,
31 ActionController::UrlGenerationError,
32 with: :render_exception)
36 response.headers["Cache-Control"] = "no-cache, no-store, max-age=0, must-revalidate"
37 response.headers["Pragma"] = "no-cache"
38 response.headers["Expires"] = "Fri, 01 Jan 1990 00:00:00 GMT"
41 def unprocessable(message=nil)
44 @errors << message if message
45 render_error status: 422
48 def render_error(opts={})
51 # json must come before html here, so it gets used as the
52 # default format when js is requested by the client. This lets
53 # ajax:error callback parse the response correctly, even though
55 f.json { render opts.merge(json: {success: false, errors: @errors}) }
56 f.html { render({action: 'error'}.merge(opts)) }
60 def render_exception(e)
61 logger.error e.inspect
62 logger.error e.backtrace.collect { |x| x + "\n" }.join('') if e.backtrace
63 err_opts = {status: 422}
64 if e.is_a?(ArvadosApiClient::ApiError)
65 err_opts.merge!(action: 'api_error', locals: {api_error: e})
66 @errors = e.api_response[:errors]
67 elsif @object.andand.errors.andand.full_messages.andand.any?
68 @errors = @object.errors.full_messages
72 # Make user information available on the error page, falling back to the
73 # session cache if the API server is unavailable.
75 load_api_token(session[:arvados_api_token])
76 rescue ArvadosApiClient::ApiError
77 unless session[:user].nil?
79 Thread.current[:user] = User.new(session[:user])
80 rescue ArvadosApiClient::ApiError
81 # This can happen if User's columns are unavailable. Nothing to do.
85 # Preload projects trees for the template. If that's not doable, set empty
86 # trees so error page rendering can proceed. (It's easier to rescue the
87 # exception here than in a template.)
88 unless current_user.nil?
91 rescue ArvadosApiClient::ApiError
92 # Fall back to the default-setting code later.
95 @my_project_tree ||= []
96 @shared_project_tree ||= []
97 render_error(err_opts)
100 def render_not_found(e=ActionController::RoutingError.new("Path not found"))
101 logger.error e.inspect
102 @errors = ["Path not found"]
103 set_thread_api_token do
104 self.render_error(action: '404', status: 404)
110 # The order can be left empty to allow it to default.
111 # Or it can be a comma separated list of real database column names, one per model.
112 # Column names should always be qualified by a table name and a direction is optional, defaulting to asc
113 # (e.g. "collections.name" or "collections.name desc").
114 # If a column name is specified, that table will be sorted by that column.
115 # If there are objects from different models that will be shown (such as in Jobs and Pipelines tab),
116 # then a sort column name can optionally be specified for each model, passed as an comma-separated list (e.g. "jobs.script, pipeline_instances.name")
117 # Currently only one sort column name and direction can be specified for each model.
118 def load_filters_and_paging_params
119 if params[:order].blank?
120 @order = 'created_at desc'
121 elsif params[:order].is_a? Array
122 @order = params[:order]
125 @order = JSON.load(params[:order])
127 @order = params[:order].split(',')
130 @order = [@order] unless @order.is_a? Array
134 @limit = params[:limit].to_i
139 @offset = params[:offset].to_i
144 filters = params[:filters]
145 if filters.is_a? String
146 filters = Oj.load filters
147 elsif filters.is_a? Array
148 filters = filters.collect do |filter|
149 if filter.is_a? String
150 # Accept filters[]=["foo","=","bar"]
153 # Accept filters=[["foo","=","bar"]]
158 # After this, params[:filters] can be trusted to be an array of arrays:
159 params[:filters] = filters
164 def find_objects_for_index
165 @objects ||= model_class
166 @objects = @objects.filter(@filters).limit(@limit).offset(@offset)
171 f.json { render json: @objects }
174 render_pane params[:tab_pane]
183 helper_method :render_pane
184 def render_pane tab_pane, opts={}
186 partial: 'show_' + tab_pane.downcase,
188 comparable: self.respond_to?(:compare),
191 }.merge(opts[:locals] || {})
194 render_to_string render_opts
201 find_objects_for_index if !@objects
205 helper_method :next_page_offset
206 def next_page_offset objects=nil
210 if objects.respond_to?(:result_offset) and
211 objects.respond_to?(:result_limit) and
212 objects.respond_to?(:items_available)
213 next_offset = objects.result_offset + objects.result_limit
214 if next_offset < objects.items_available
222 helper_method :next_page_href
223 def next_page_href with_params={}
225 url_for with_params.merge(offset: next_page_offset)
231 return render_not_found("object not found")
235 extra_attrs = { href: url_for(action: :show, id: @object) }
236 @object.textile_attributes.each do |textile_attr|
237 extra_attrs.merge!({ "#{textile_attr}Textile" => view_context.render_markup(@object.attributes[textile_attr]) })
239 render json: @object.attributes.merge(extra_attrs)
242 if params['tab_pane']
243 render_pane(if params['tab_pane'].is_a? Hash then params['tab_pane']["name"] else params['tab_pane'] end)
244 elsif request.method.in? ['GET', 'HEAD']
247 redirect_to params[:return_to] || @object
255 params[:limit] ||= 40
259 find_objects_for_index if !@objects
261 content: render_to_string(partial: "choose_rows.html",
263 next_page_href: next_page_href(partial: params[:partial])
268 find_objects_for_index if !@objects
269 render partial: 'choose', locals: {multiple: params[:multiple]}
276 return render_not_found("object not found")
281 @object = model_class.new
285 @updates ||= params[@object.resource_param_name.to_sym]
286 @updates.keys.each do |attr|
287 if @object.send(attr).is_a? Hash
288 if @updates[attr].is_a? String
289 @updates[attr] = Oj.load @updates[attr]
291 if params[:merge] || params["merge_#{attr}".to_sym]
292 # Merge provided Hash with current Hash, instead of
294 @updates[attr] = @object.send(attr).with_indifferent_access.
295 deep_merge(@updates[attr].with_indifferent_access)
299 if @object.update_attributes @updates
302 self.render_error status: 422
307 @new_resource_attrs ||= params[model_class.to_s.underscore.singularize]
308 @new_resource_attrs ||= {}
309 @new_resource_attrs.reject! { |k,v| k.to_s == 'uuid' }
310 @object ||= model_class.new @new_resource_attrs, params["options"]
313 f.json { render json: @object.attributes.merge(href: url_for(action: :show, id: @object)) }
320 self.render_error status: 422
324 # Clone the given object, merging any attribute values supplied as
325 # with a create action.
327 @new_resource_attrs ||= params[model_class.to_s.underscore.singularize]
328 @new_resource_attrs ||= {}
329 @object = @object.dup
330 @object.update_attributes @new_resource_attrs
331 if not @new_resource_attrs[:name] and @object.respond_to? :name
332 if @object.name and @object.name != ''
333 @object.name = "Copy of #{@object.name}"
345 f.json { render json: @object }
347 redirect_to(params[:return_to] || :back)
352 self.render_error status: 422
357 Thread.current[:user]
361 controller_name.classify.constantize
364 def breadcrumb_page_name
365 (@breadcrumb_page_name ||
366 (@object.friendly_link_name if @object.respond_to? :friendly_link_name) ||
375 %w(Attributes Advanced)
380 def strip_token_from_path(path)
381 path.sub(/([\?&;])api_token=[^&;]*[&;]?/, '\1')
384 def redirect_to_login
387 if request.method.in? ['GET', 'HEAD']
388 redirect_to arvados_api_client.arvados_login_url(return_to: strip_token_from_path(request.url))
390 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."
395 @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.']
396 self.render_error status: 422
399 false # For convenience to return from callbacks
402 def using_specific_api_token(api_token, opts={})
404 [:arvados_api_token, :user].each do |key|
405 start_values[key] = Thread.current[key]
407 if opts.fetch(:load_user, true)
408 load_api_token(api_token)
410 Thread.current[:arvados_api_token] = api_token
411 Thread.current[:user] = nil
416 start_values.each_key { |key| Thread.current[key] = start_values[key] }
421 def accept_uuid_as_id_param
422 if params[:id] and params[:id].match /\D/
423 params[:uuid] = params.delete :id
427 def find_object_by_uuid
431 elsif not params[:uuid].is_a?(String)
432 @object = model_class.where(uuid: params[:uuid]).first
433 elsif params[:uuid].empty?
435 elsif (model_class != Link and
436 resource_class_for_uuid(params[:uuid]) == Link)
437 @name_link = Link.find(params[:uuid])
438 @object = model_class.find(@name_link.head_uuid)
440 @object = model_class.find(params[:uuid])
442 rescue ArvadosApiClient::NotFoundException, RuntimeError => error
443 if error.is_a?(RuntimeError) and (error.message !~ /^argument to find\(/)
446 render_not_found(error)
453 Rails.cache.delete_matched(/^request_#{Thread.current.object_id}_/)
455 Rails.cache.delete_matched(/^request_#{Thread.current.object_id}_/)
458 # Set up the thread with the given API token and associated user object.
459 def load_api_token(new_token)
460 Thread.current[:arvados_api_token] = new_token
462 Thread.current[:user] = nil
464 Thread.current[:user] = User.current
468 # If there's a valid api_token parameter, set up the session with that
469 # user's information. Return true if the method redirects the request
470 # (usually a post-login redirect); false otherwise.
471 def setup_user_session
472 return false unless params[:api_token]
473 Thread.current[:arvados_api_token] = params[:api_token]
476 rescue ArvadosApiClient::NotLoggedInException
477 false # We may redirect to login, or not, based on the current action.
479 session[:arvados_api_token] = params[:api_token]
480 # If we later have trouble contacting the API server, we still want
481 # to be able to render basic user information in the UI--see
482 # render_exception above. We store that in the session here. This is
483 # not intended to be used as a general-purpose cache. See #2891.
487 first_name: user.first_name,
488 last_name: user.last_name,
489 is_active: user.is_active,
490 is_admin: user.is_admin,
494 if !request.format.json? and request.method.in? ['GET', 'HEAD']
495 # Repeat this request with api_token in the (new) session
496 # cookie instead of the query string. This prevents API
497 # tokens from appearing in (and being inadvisedly copied
498 # and pasted from) browser Location bars.
499 redirect_to strip_token_from_path(request.fullpath)
505 Thread.current[:arvados_api_token] = nil
509 # Save the session API token in thread-local storage, and yield.
510 # This method also takes care of session setup if the request
511 # provides a valid api_token parameter.
512 # If a token is unavailable or expired, the block is still run, with
514 def set_thread_api_token
515 if Thread.current[:arvados_api_token]
516 yield # An API token has already been found - pass it through.
518 elsif setup_user_session
519 return # A new session was set up and received a response.
523 load_api_token(session[:arvados_api_token])
525 rescue ArvadosApiClient::NotLoggedInException
526 # If we got this error with a token, it must've expired.
527 # Retry the request without a token.
528 unless Thread.current[:arvados_api_token].nil?
533 # Remove token in case this Thread is used for anything else.
538 # Redirect to login/welcome if client provided expired API token (or none at all)
539 def require_thread_api_token
540 if Thread.current[:arvados_api_token]
542 elsif session[:arvados_api_token]
543 # Expired session. Clear it before refreshing login so that,
544 # if this login procedure fails, we end up showing the "please
545 # log in" page instead of getting stuck in a redirect loop.
546 session.delete :arvados_api_token
549 redirect_to welcome_users_path(return_to: request.fullpath)
553 def ensure_current_user_is_admin
554 unless current_user and current_user.is_admin
555 @errors = ['Permission denied']
556 self.render_error status: 401
560 helper_method :unsigned_user_agreements
561 def unsigned_user_agreements
562 @signed_ua_uuids ||= UserAgreement.signatures.map &:head_uuid
563 @unsigned_user_agreements ||= UserAgreement.all.map do |ua|
564 if not @signed_ua_uuids.index ua.uuid
565 Collection.find(ua.uuid)
570 def check_user_agreements
571 if current_user && !current_user.is_active
572 if not current_user.is_invited
573 return redirect_to inactive_users_path(return_to: request.fullpath)
575 if unsigned_user_agreements.empty?
576 # No agreements to sign. Perhaps we just need to ask?
577 current_user.activate
578 if !current_user.is_active
579 logger.warn "#{current_user.uuid.inspect}: " +
580 "No user agreements to sign, but activate failed!"
583 if !current_user.is_active
584 redirect_to user_agreements_path(return_to: request.fullpath)
590 def check_user_profile
591 if request.method.downcase != 'get' || params[:partial] ||
592 params[:tab_pane] || params[:action_method] ||
593 params[:action] == 'setup_popup'
597 if missing_required_profile?
598 redirect_to profile_user_path(current_user.uuid, return_to: request.fullpath)
603 helper_method :missing_required_profile?
604 def missing_required_profile?
605 missing_required = false
607 profile_config = Rails.configuration.user_profile_form_fields
608 if current_user && profile_config
609 current_user_profile = current_user.prefs[:profile]
610 profile_config.kind_of?(Array) && profile_config.andand.each do |entry|
612 if !current_user_profile ||
613 !current_user_profile[entry['key'].to_sym] ||
614 current_user_profile[entry['key'].to_sym].empty?
615 missing_required = true
626 return Rails.configuration.arvados_theme
629 @@notification_tests = []
631 @@notification_tests.push lambda { |controller, current_user|
632 AuthorizedKey.limit(1).where(authorized_user_uuid: current_user.uuid).each do
635 return lambda { |view|
636 view.render partial: 'notifications/ssh_key_notification'
640 @@notification_tests.push lambda { |controller, current_user|
641 Collection.limit(1).where(created_by: current_user.uuid).each do
644 return lambda { |view|
645 view.render partial: 'notifications/collections_notification'
649 @@notification_tests.push lambda { |controller, current_user|
650 PipelineInstance.limit(1).where(created_by: current_user.uuid).each do
653 return lambda { |view|
654 view.render partial: 'notifications/pipelines_notification'
658 def check_user_notifications
659 return if params['tab_pane']
661 @notification_count = 0
664 if current_user.andand.is_active
665 @showallalerts = false
666 @@notification_tests.each do |t|
667 a = t.call(self, current_user)
669 @notification_count += 1
670 @notifications.push a
675 if @notification_count == 0
676 @notification_count = ''
680 helper_method :all_projects
682 @all_projects ||= Group.
683 filter([['group_class','=','project']]).order('name')
686 helper_method :my_projects
688 return @my_projects if @my_projects
691 all_projects.each do |g|
692 root_of[g.uuid] = g.owner_uuid
698 root_of = root_of.each_with_object({}) do |(child, parent), h|
700 h[child] = root_of[parent]
707 @my_projects = @my_projects.select do |g|
708 root_of[g.uuid] == current_user.uuid
712 helper_method :projects_shared_with_me
713 def projects_shared_with_me
714 my_project_uuids = my_projects.collect &:uuid
715 all_projects.reject { |x| x.uuid.in? my_project_uuids }
718 helper_method :recent_jobs_and_pipelines
719 def recent_jobs_and_pipelines
721 PipelineInstance.limit(10)).
723 (x.finished_at || x.started_at rescue nil) || x.modified_at || x.created_at
727 helper_method :running_pipelines
728 def running_pipelines
729 pi = PipelineInstance.order(["started_at asc", "created_at asc"]).filter([["state", "in", ["RunningOnServer", "RunningOnClient"]]])
732 pl.components.each do |k,v|
733 if v.is_a? Hash and v[:job]
734 jobs[v[:job][:uuid]] = {}
740 Job.filter([["uuid", "in", jobs.keys]]).each do |j|
745 pl.components.each do |k,v|
746 if v.is_a? Hash and v[:job]
747 v[:job] = jobs[v[:job][:uuid]]
756 helper_method :finished_pipelines
757 def finished_pipelines lim
758 PipelineInstance.limit(lim).order(["finished_at desc"]).filter([["state", "in", ["Complete", "Failed", "Paused"]], ["finished_at", "!=", nil]])
761 helper_method :recent_collections
762 def recent_collections lim
763 c = Collection.limit(lim).order(["modified_at desc"]).filter([["owner_uuid", "is_a", "arvados#group"]])
765 Group.filter([["uuid", "in", c.map(&:owner_uuid)]]).each do |g|
768 {collections: c, owners: own}
771 helper_method :my_project_tree
777 helper_method :shared_project_tree
778 def shared_project_tree
783 def build_project_trees
784 return if @my_project_tree and @shared_project_tree
785 parent_of = {current_user.uuid => 'me'}
786 all_projects.each do |ob|
787 parent_of[ob.uuid] = ob.owner_uuid
789 children_of = {false => [], 'me' => [current_user]}
790 all_projects.each do |ob|
791 if ob.owner_uuid != current_user.uuid and
792 not parent_of.has_key? ob.owner_uuid
793 parent_of[ob.uuid] = false
795 children_of[parent_of[ob.uuid]] ||= []
796 children_of[parent_of[ob.uuid]] << ob
798 buildtree = lambda do |children_of, root_uuid=false|
800 children_of[root_uuid].andand.each do |ob|
801 tree[ob] = buildtree.call(children_of, ob.uuid)
805 sorted_paths = lambda do |tree, depth=0|
807 tree.keys.sort_by { |ob|
808 ob.is_a?(String) ? ob : ob.friendly_link_name
810 paths << {object: ob, depth: depth}
811 paths += sorted_paths.call tree[ob], depth+1
816 sorted_paths.call buildtree.call(children_of, 'me')
817 @shared_project_tree =
818 sorted_paths.call({'Projects shared with me' =>
819 buildtree.call(children_of, false)})
822 helper_method :get_object
824 if @get_object.nil? and @objects
825 @get_object = @objects.each_with_object({}) do |object, h|
826 h[object.uuid] = object
833 helper_method :project_breadcrumbs
834 def project_breadcrumbs
836 current = @name_link || @object
838 # Halt if a group ownership loop is detected. API should refuse
839 # to produce this state, but it could still arise from a race
840 # condition when group ownership changes between our find()
842 break if crumbs.collect(&:uuid).include? current.uuid
844 if current.is_a?(Group) and current.group_class == 'project'
845 crumbs.prepend current
847 if current.is_a? Link
848 current = Group.find?(current.tail_uuid)
850 current = Group.find?(current.owner_uuid)
856 helper_method :current_project_uuid
857 def current_project_uuid
858 if @object.is_a? Group and @object.group_class == 'project'
860 elsif @name_link.andand.tail_uuid
862 elsif @object and resource_class_for_uuid(@object.owner_uuid) == Group
869 # helper method to get links for given object or uuid
870 helper_method :links_for_object
871 def links_for_object object_or_uuid
872 raise ArgumentError, 'No input argument' unless object_or_uuid
873 preload_links_for_objects([object_or_uuid])
874 uuid = object_or_uuid.is_a?(String) ? object_or_uuid : object_or_uuid.uuid
875 @all_links_for[uuid] ||= []
878 # helper method to preload links for given objects and uuids
879 helper_method :preload_links_for_objects
880 def preload_links_for_objects objects_and_uuids
881 @all_links_for ||= {}
883 raise ArgumentError, 'Argument is not an array' unless objects_and_uuids.is_a? Array
884 return @all_links_for if objects_and_uuids.empty?
886 uuids = objects_and_uuids.collect { |x| x.is_a?(String) ? x : x.uuid }
888 # if already preloaded for all of these uuids, return
889 if not uuids.select { |x| @all_links_for[x].nil? }.any?
890 return @all_links_for
894 @all_links_for[x] = []
897 # TODO: make sure we get every page of results from API server
898 Link.filter([['head_uuid', 'in', uuids]]).each do |link|
899 @all_links_for[link.head_uuid] << link
904 # helper method to get a certain number of objects of a specific type
905 # this can be used to replace any uses of: "dataclass.limit(n)"
906 helper_method :get_n_objects_of_class
907 def get_n_objects_of_class dataclass, size
908 @objects_map_for ||= {}
910 raise ArgumentError, 'Argument is not a data class' unless dataclass.is_a? Class and dataclass < ArvadosBase
911 raise ArgumentError, 'Argument is not a valid limit size' unless (size && size>0)
913 # if the objects_map_for has a value for this dataclass, and the
914 # size used to retrieve those objects is equal, return it
915 size_key = "#{dataclass.name}_size"
916 if @objects_map_for[dataclass.name] && @objects_map_for[size_key] &&
917 (@objects_map_for[size_key] == size)
918 return @objects_map_for[dataclass.name]
921 @objects_map_for[size_key] = size
922 @objects_map_for[dataclass.name] = dataclass.limit(size)
925 # helper method to get collections for the given uuid
926 helper_method :collections_for_object
927 def collections_for_object uuid
928 raise ArgumentError, 'No input argument' unless uuid
929 preload_collections_for_objects([uuid])
930 @all_collections_for[uuid] ||= []
933 # helper method to preload collections for the given uuids
934 helper_method :preload_collections_for_objects
935 def preload_collections_for_objects uuids
936 @all_collections_for ||= {}
938 raise ArgumentError, 'Argument is not an array' unless uuids.is_a? Array
939 return @all_collections_for if uuids.empty?
941 # if already preloaded for all of these uuids, return
942 if not uuids.select { |x| @all_collections_for[x].nil? }.any?
943 return @all_collections_for
947 @all_collections_for[x] = []
950 # TODO: make sure we get every page of results from API server
951 Collection.where(uuid: uuids).each do |collection|
952 @all_collections_for[collection.uuid] << collection
957 # helper method to get log collections for the given log
958 helper_method :log_collections_for_object
959 def log_collections_for_object log
960 raise ArgumentError, 'No input argument' unless log
962 preload_log_collections_for_objects([log])
965 fixup = /([a-f0-9]{32}\+\d+)(\+?.*)/.match(log)
966 if fixup && fixup.size>1
970 @all_log_collections_for[uuid] ||= []
973 # helper method to preload collections for the given uuids
974 helper_method :preload_log_collections_for_objects
975 def preload_log_collections_for_objects logs
976 @all_log_collections_for ||= {}
978 raise ArgumentError, 'Argument is not an array' unless logs.is_a? Array
979 return @all_log_collections_for if logs.empty?
983 fixup = /([a-f0-9]{32}\+\d+)(\+?.*)/.match(log)
984 if fixup && fixup.size>1
991 # if already preloaded for all of these uuids, return
992 if not uuids.select { |x| @all_log_collections_for[x].nil? }.any?
993 return @all_log_collections_for
997 @all_log_collections_for[x] = []
1000 # TODO: make sure we get every page of results from API server
1001 Collection.where(uuid: uuids).each do |collection|
1002 @all_log_collections_for[collection.uuid] << collection
1004 @all_log_collections_for
1007 # helper method to get object of a given dataclass and uuid
1008 helper_method :object_for_dataclass
1009 def object_for_dataclass dataclass, uuid
1010 raise ArgumentError, 'No input argument dataclass' unless (dataclass && uuid)
1011 preload_objects_for_dataclass(dataclass, [uuid])
1015 # helper method to preload objects for given dataclass and uuids
1016 helper_method :preload_objects_for_dataclass
1017 def preload_objects_for_dataclass dataclass, uuids
1020 raise ArgumentError, 'Argument is not a data class' unless dataclass.is_a? Class
1021 raise ArgumentError, 'Argument is not an array' unless uuids.is_a? Array
1023 return @objects_for if uuids.empty?
1025 # if already preloaded for all of these uuids, return
1026 if not uuids.select { |x| @objects_for[x].nil? }.any?
1030 dataclass.where(uuid: uuids).each do |obj|
1031 @objects_for[obj.uuid] = obj
1036 def wiselinks_layout