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 :load_filters_and_paging_params, except: ERROR_ACTIONS
20 before_filter :find_object_by_uuid, except: [:create, :index, :choose] + ERROR_ACTIONS
24 rescue_from(ActiveRecord::RecordNotFound,
25 ActionController::RoutingError,
26 ActionController::UnknownController,
27 AbstractController::ActionNotFound,
28 with: :render_not_found)
29 rescue_from(Exception,
30 ActionController::UrlGenerationError,
31 with: :render_exception)
35 response.headers["Cache-Control"] = "no-cache, no-store, max-age=0, must-revalidate"
36 response.headers["Pragma"] = "no-cache"
37 response.headers["Expires"] = "Fri, 01 Jan 1990 00:00:00 GMT"
40 def unprocessable(message=nil)
43 @errors << message if message
44 render_error status: 422
47 def render_error(opts={})
48 # Helpers can rely on the presence of @errors to know they're
49 # being used in an error page.
53 # json must come before html here, so it gets used as the
54 # default format when js is requested by the client. This lets
55 # ajax:error callback parse the response correctly, even though
57 f.json { render opts.merge(json: {success: false, errors: @errors}) }
58 f.html { render({action: 'error'}.merge(opts)) }
62 def render_exception(e)
63 logger.error e.inspect
64 logger.error e.backtrace.collect { |x| x + "\n" }.join('') if e.backtrace
65 err_opts = {status: 422}
66 if e.is_a?(ArvadosApiClient::ApiError)
67 err_opts.merge!(action: 'api_error', locals: {api_error: e})
68 @errors = e.api_response[:errors]
69 elsif @object.andand.errors.andand.full_messages.andand.any?
70 @errors = @object.errors.full_messages
74 # Make user information available on the error page, falling back to the
75 # session cache if the API server is unavailable.
77 load_api_token(session[:arvados_api_token])
78 rescue ArvadosApiClient::ApiError
79 unless session[:user].nil?
81 Thread.current[:user] = User.new(session[:user])
82 rescue ArvadosApiClient::ApiError
83 # This can happen if User's columns are unavailable. Nothing to do.
87 # Preload projects trees for the template. If that's not doable, set empty
88 # trees so error page rendering can proceed. (It's easier to rescue the
89 # exception here than in a template.)
90 unless current_user.nil?
93 rescue ArvadosApiClient::ApiError
94 # Fall back to the default-setting code later.
97 @starred_projects ||= []
98 @my_project_tree ||= []
99 @shared_project_tree ||= []
100 render_error(err_opts)
103 def render_not_found(e=ActionController::RoutingError.new("Path not found"))
104 logger.error e.inspect
105 @errors = ["Path not found"]
106 set_thread_api_token do
107 self.render_error(action: '404', status: 404)
113 # The order can be left empty to allow it to default.
114 # Or it can be a comma separated list of real database column names, one per model.
115 # Column names should always be qualified by a table name and a direction is optional, defaulting to asc
116 # (e.g. "collections.name" or "collections.name desc").
117 # If a column name is specified, that table will be sorted by that column.
118 # If there are objects from different models that will be shown (such as in Jobs and Pipelines tab),
119 # 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")
120 # Currently only one sort column name and direction can be specified for each model.
121 def load_filters_and_paging_params
122 if params[:order].blank?
123 @order = 'created_at desc'
124 elsif params[:order].is_a? Array
125 @order = params[:order]
128 @order = JSON.load(params[:order])
130 @order = params[:order].split(',')
133 @order = [@order] unless @order.is_a? Array
137 @limit = params[:limit].to_i
142 @offset = params[:offset].to_i
147 filters = params[:filters]
148 if filters.is_a? String
149 filters = Oj.load filters
150 elsif filters.is_a? Array
151 filters = filters.collect do |filter|
152 if filter.is_a? String
153 # Accept filters[]=["foo","=","bar"]
156 # Accept filters=[["foo","=","bar"]]
161 # After this, params[:filters] can be trusted to be an array of arrays:
162 params[:filters] = filters
167 def find_objects_for_index
168 @objects ||= model_class
169 @objects = @objects.filter(@filters).limit(@limit).offset(@offset)
170 @objects.fetch_multiple_pages(false)
177 @next_page_href = next_page_href(partial: params[:partial], filters: @filters.to_json)
179 content: render_to_string(partial: "show_#{params[:partial]}",
181 next_page_href: @next_page_href
184 render json: @objects
189 render_pane params[:tab_pane]
198 helper_method :render_pane
199 def render_pane tab_pane, opts={}
201 partial: 'show_' + tab_pane.downcase,
203 comparable: self.respond_to?(:compare),
206 }.merge(opts[:locals] || {})
209 render_to_string render_opts
216 find_objects_for_index if !@objects
220 helper_method :next_page_offset
221 def next_page_offset objects=nil
225 if objects.respond_to?(:result_offset) and
226 objects.respond_to?(:result_limit) and
227 objects.respond_to?(:items_available)
228 next_offset = objects.result_offset + objects.result_limit
229 if next_offset < objects.items_available
237 helper_method :next_page_href
238 def next_page_href with_params={}
240 url_for with_params.merge(offset: next_page_offset)
246 return render_not_found("object not found")
250 extra_attrs = { href: url_for(action: :show, id: @object) }
251 @object.textile_attributes.each do |textile_attr|
252 extra_attrs.merge!({ "#{textile_attr}Textile" => view_context.render_markup(@object.attributes[textile_attr]) })
254 render json: @object.attributes.merge(extra_attrs)
257 if params['tab_pane']
258 render_pane(if params['tab_pane'].is_a? Hash then params['tab_pane']["name"] else params['tab_pane'] end)
259 elsif request.request_method.in? ['GET', 'HEAD']
262 redirect_to (params[:return_to] ||
263 polymorphic_url(@object,
264 anchor: params[:redirect_to_anchor]))
271 def redirect_to uri, *args
273 if not uri.is_a? String
274 uri = polymorphic_url(uri)
276 render json: {href: uri}
283 params[:limit] ||= 40
287 find_objects_for_index if !@objects
289 content: render_to_string(partial: "choose_rows.html",
291 next_page_href: next_page_href(partial: params[:partial])
296 find_objects_for_index if !@objects
297 render partial: 'choose', locals: {multiple: params[:multiple]}
304 return render_not_found("object not found")
309 @object = model_class.new
313 @updates ||= params[@object.resource_param_name.to_sym]
314 @updates.keys.each do |attr|
315 if @object.send(attr).is_a? Hash
316 if @updates[attr].is_a? String
317 @updates[attr] = Oj.load @updates[attr]
319 if params[:merge] || params["merge_#{attr}".to_sym]
320 # Merge provided Hash with current Hash, instead of
322 @updates[attr] = @object.send(attr).with_indifferent_access.
323 deep_merge(@updates[attr].with_indifferent_access)
327 if @object.update_attributes @updates
330 self.render_error status: 422
335 @new_resource_attrs ||= params[model_class.to_s.underscore.singularize]
336 @new_resource_attrs ||= {}
337 @new_resource_attrs.reject! { |k,v| k.to_s == 'uuid' }
338 @object ||= model_class.new @new_resource_attrs, params["options"]
343 render_error status: 422
347 # Clone the given object, merging any attribute values supplied as
348 # with a create action.
350 @new_resource_attrs ||= params[model_class.to_s.underscore.singularize]
351 @new_resource_attrs ||= {}
352 @object = @object.dup
353 @object.update_attributes @new_resource_attrs
354 if not @new_resource_attrs[:name] and @object.respond_to? :name
355 if @object.name and @object.name != ''
356 @object.name = "Copy of #{@object.name}"
368 f.json { render json: @object }
370 redirect_to(params[:return_to] || :back)
375 self.render_error status: 422
380 Thread.current[:user]
384 controller_name.classify.constantize
387 def breadcrumb_page_name
388 (@breadcrumb_page_name ||
389 (@object.friendly_link_name if @object.respond_to? :friendly_link_name) ||
398 %w(Attributes Advanced)
402 @user_is_manager = false
405 if @object.uuid != current_user.andand.uuid
407 @share_links = Link.permissions_for(@object)
408 @user_is_manager = true
409 rescue ArvadosApiClient::AccessForbiddenException,
410 ArvadosApiClient::NotFoundException
416 if not params[:uuids].andand.any?
417 @errors = ["No user/group UUIDs specified to share with."]
418 return render_error(status: 422)
420 results = {"success" => [], "errors" => []}
421 params[:uuids].each do |shared_uuid|
423 Link.create(tail_uuid: shared_uuid, link_class: "permission",
424 name: "can_read", head_uuid: @object.uuid)
425 rescue ArvadosApiClient::ApiError => error
426 error_list = error.api_response.andand[:errors]
427 if error_list.andand.any?
428 results["errors"] += error_list.map { |e| "#{shared_uuid}: #{e}" }
430 error_code = error.api_status || "Bad status"
431 results["errors"] << "#{shared_uuid}: #{error_code} response"
434 results["success"] << shared_uuid
437 if results["errors"].empty?
438 results.delete("errors")
444 f.json { render(json: results, status: status) }
449 links = Link.where(tail_uuid: current_user.uuid,
450 head_uuid: @object.uuid,
453 if params['status'] == 'create'
454 # create 'star' link if one does not already exist
455 if !links.andand.any?
456 dst = Link.new(owner_uuid: @object.uuid,
457 tail_uuid: current_user.uuid,
458 head_uuid: @object.uuid,
463 else # delete any existing 'star' links
474 helper_method :is_starred
476 links = Link.where(tail_uuid: current_user.uuid,
477 head_uuid: @object.uuid,
480 return links.andand.any?
485 helper_method :strip_token_from_path
486 def strip_token_from_path(path)
487 path.sub(/([\?&;])api_token=[^&;]*[&;]?/, '\1')
490 def redirect_to_login
491 if request.xhr? or request.format.json?
492 @errors = ['You are not logged in. Most likely your session has timed out and you need to log in again.']
493 render_error status: 401
494 elsif request.method.in? ['GET', 'HEAD']
495 redirect_to arvados_api_client.arvados_login_url(return_to: strip_token_from_path(request.url))
497 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."
500 false # For convenience to return from callbacks
503 def using_specific_api_token(api_token, opts={})
505 [:arvados_api_token, :user].each do |key|
506 start_values[key] = Thread.current[key]
508 if opts.fetch(:load_user, true)
509 load_api_token(api_token)
511 Thread.current[:arvados_api_token] = api_token
512 Thread.current[:user] = nil
517 start_values.each_key { |key| Thread.current[key] = start_values[key] }
522 def accept_uuid_as_id_param
523 if params[:id] and params[:id].match /\D/
524 params[:uuid] = params.delete :id
528 def find_object_by_uuid
532 elsif not params[:uuid].is_a?(String)
533 @object = model_class.where(uuid: params[:uuid]).first
534 elsif params[:uuid].empty?
536 elsif (model_class != Link and
537 resource_class_for_uuid(params[:uuid]) == Link)
538 @name_link = Link.find(params[:uuid])
539 @object = model_class.find(@name_link.head_uuid)
541 @object = model_class.find(params[:uuid])
543 rescue ArvadosApiClient::NotFoundException, ArvadosApiClient::NotLoggedInException, RuntimeError => error
544 if error.is_a?(RuntimeError) and (error.message !~ /^argument to find\(/)
547 render_not_found(error)
554 Rails.cache.delete_matched(/^request_#{Thread.current.object_id}_/)
556 Rails.cache.delete_matched(/^request_#{Thread.current.object_id}_/)
559 # Set up the thread with the given API token and associated user object.
560 def load_api_token(new_token)
561 Thread.current[:arvados_api_token] = new_token
563 Thread.current[:user] = nil
565 Thread.current[:user] = User.current
569 # If there's a valid api_token parameter, set up the session with that
570 # user's information. Return true if the method redirects the request
571 # (usually a post-login redirect); false otherwise.
572 def setup_user_session
573 return false unless params[:api_token]
574 Thread.current[:arvados_api_token] = params[:api_token]
577 rescue ArvadosApiClient::NotLoggedInException
578 false # We may redirect to login, or not, based on the current action.
580 session[:arvados_api_token] = params[:api_token]
581 # If we later have trouble contacting the API server, we still want
582 # to be able to render basic user information in the UI--see
583 # render_exception above. We store that in the session here. This is
584 # not intended to be used as a general-purpose cache. See #2891.
588 first_name: user.first_name,
589 last_name: user.last_name,
590 is_active: user.is_active,
591 is_admin: user.is_admin,
595 if !request.format.json? and request.method.in? ['GET', 'HEAD']
596 # Repeat this request with api_token in the (new) session
597 # cookie instead of the query string. This prevents API
598 # tokens from appearing in (and being inadvisedly copied
599 # and pasted from) browser Location bars.
600 redirect_to strip_token_from_path(request.fullpath)
606 Thread.current[:arvados_api_token] = nil
610 # Save the session API token in thread-local storage, and yield.
611 # This method also takes care of session setup if the request
612 # provides a valid api_token parameter.
613 # If a token is unavailable or expired, the block is still run, with
615 def set_thread_api_token
616 if Thread.current[:arvados_api_token]
617 yield # An API token has already been found - pass it through.
619 elsif setup_user_session
620 return # A new session was set up and received a response.
624 load_api_token(session[:arvados_api_token])
626 rescue ArvadosApiClient::NotLoggedInException
627 # If we got this error with a token, it must've expired.
628 # Retry the request without a token.
629 unless Thread.current[:arvados_api_token].nil?
634 # Remove token in case this Thread is used for anything else.
639 # Redirect to login/welcome if client provided expired API token (or
641 def require_thread_api_token
642 if Thread.current[:arvados_api_token]
644 elsif session[:arvados_api_token]
645 # Expired session. Clear it before refreshing login so that,
646 # if this login procedure fails, we end up showing the "please
647 # log in" page instead of getting stuck in a redirect loop.
648 session.delete :arvados_api_token
651 # If we redirect to the welcome page, the browser will handle
652 # the 302 by itself and the client code will end up rendering
653 # the "welcome" page in some content area where it doesn't make
654 # sense. Instead, we send 401 ("authenticate and try again" or
655 # "display error", depending on how smart the client side is).
656 @errors = ['You are not logged in.']
657 render_error status: 401
659 redirect_to welcome_users_path(return_to: request.fullpath)
663 def ensure_current_user_is_admin
665 @errors = ['Not logged in']
666 render_error status: 401
667 elsif not current_user.is_admin
668 @errors = ['Permission denied']
669 render_error status: 403
673 helper_method :unsigned_user_agreements
674 def unsigned_user_agreements
675 @signed_ua_uuids ||= UserAgreement.signatures.map &:head_uuid
676 @unsigned_user_agreements ||= UserAgreement.all.map do |ua|
677 if not @signed_ua_uuids.index ua.uuid
678 Collection.find(ua.uuid)
683 def check_user_agreements
684 if current_user && !current_user.is_active
685 if not current_user.is_invited
686 return redirect_to inactive_users_path(return_to: request.fullpath)
688 if unsigned_user_agreements.empty?
689 # No agreements to sign. Perhaps we just need to ask?
690 current_user.activate
691 if !current_user.is_active
692 logger.warn "#{current_user.uuid.inspect}: " +
693 "No user agreements to sign, but activate failed!"
696 if !current_user.is_active
697 redirect_to user_agreements_path(return_to: request.fullpath)
703 def check_user_profile
704 return true if !current_user
705 if request.method.downcase != 'get' || params[:partial] ||
706 params[:tab_pane] || params[:action_method] ||
707 params[:action] == 'setup_popup'
711 if missing_required_profile?
712 redirect_to profile_user_path(current_user.uuid, return_to: request.fullpath)
717 helper_method :missing_required_profile?
718 def missing_required_profile?
719 missing_required = false
721 profile_config = Rails.configuration.user_profile_form_fields
722 if current_user && profile_config
723 current_user_profile = current_user.prefs[:profile]
724 profile_config.kind_of?(Array) && profile_config.andand.each do |entry|
726 if !current_user_profile ||
727 !current_user_profile[entry['key'].to_sym] ||
728 current_user_profile[entry['key'].to_sym].empty?
729 missing_required = true
740 return Rails.configuration.arvados_theme
743 @@notification_tests = []
745 @@notification_tests.push lambda { |controller, current_user|
746 return nil if Rails.configuration.shell_in_a_box_url
747 AuthorizedKey.limit(1).where(authorized_user_uuid: current_user.uuid).each do
750 return lambda { |view|
751 view.render partial: 'notifications/ssh_key_notification'
755 @@notification_tests.push lambda { |controller, current_user|
756 Collection.limit(1).where(created_by: current_user.uuid).each do
759 return lambda { |view|
760 view.render partial: 'notifications/collections_notification'
764 @@notification_tests.push lambda { |controller, current_user|
765 PipelineInstance.limit(1).where(created_by: current_user.uuid).each do
768 return lambda { |view|
769 view.render partial: 'notifications/pipelines_notification'
773 helper_method :user_notifications
774 def user_notifications
775 return [] if @errors or not current_user.andand.is_active
776 @notifications ||= @@notification_tests.map do |t|
777 t.call(self, current_user)
781 helper_method :all_projects
783 @all_projects ||= Group.
784 filter([['group_class','=','project']]).order('name')
787 helper_method :my_projects
789 return @my_projects if @my_projects
792 all_projects.each do |g|
793 root_of[g.uuid] = g.owner_uuid
799 root_of = root_of.each_with_object({}) do |(child, parent), h|
801 h[child] = root_of[parent]
808 @my_projects = @my_projects.select do |g|
809 root_of[g.uuid] == current_user.uuid
813 helper_method :projects_shared_with_me
814 def projects_shared_with_me
815 my_project_uuids = my_projects.collect &:uuid
816 all_projects.reject { |x| x.uuid.in? my_project_uuids }
819 helper_method :recent_jobs_and_pipelines
820 def recent_jobs_and_pipelines
822 PipelineInstance.limit(10)).
824 (x.finished_at || x.started_at rescue nil) || x.modified_at || x.created_at
828 helper_method :running_pipelines
829 def running_pipelines
830 pi = PipelineInstance.order(["started_at asc", "created_at asc"]).filter([["state", "in", ["RunningOnServer", "RunningOnClient"]]])
833 pl.components.each do |k,v|
834 if v.is_a? Hash and v[:job]
835 jobs[v[:job][:uuid]] = {}
841 Job.filter([["uuid", "in", jobs.keys]]).each do |j|
846 pl.components.each do |k,v|
847 if v.is_a? Hash and v[:job]
848 v[:job] = jobs[v[:job][:uuid]]
857 helper_method :finished_pipelines
858 def finished_pipelines lim
859 PipelineInstance.limit(lim).order(["finished_at desc"]).filter([["state", "in", ["Complete", "Failed", "Paused"]], ["finished_at", "!=", nil]])
862 helper_method :recent_collections
863 def recent_collections lim
864 c = Collection.limit(lim).order(["modified_at desc"]).filter([["owner_uuid", "is_a", "arvados#group"]])
866 Group.filter([["uuid", "in", c.map(&:owner_uuid)]]).each do |g|
869 {collections: c, owners: own}
872 helper_method :my_starred_projects
873 def my_starred_projects
874 return if @starred_projects
875 links = Link.filter([['tail_uuid', '=', current_user.uuid],
876 ['link_class', '=', 'star'],
877 ['head_uuid', 'is_a', 'arvados#group']]).select(%w(head_uuid))
878 uuids =links.collect { |x| x.head_uuid }
879 starred_projects = Group.filter([['uuid', 'in', uuids]]).order('name')
880 @starred_projects = starred_projects.results
883 helper_method :my_project_tree
889 helper_method :shared_project_tree
890 def shared_project_tree
895 def build_project_trees
896 return if @my_project_tree and @shared_project_tree
897 parent_of = {current_user.uuid => 'me'}
898 all_projects.each do |ob|
899 parent_of[ob.uuid] = ob.owner_uuid
901 children_of = {false => [], 'me' => [current_user]}
902 all_projects.each do |ob|
903 if ob.owner_uuid != current_user.uuid and
904 not parent_of.has_key? ob.owner_uuid
905 parent_of[ob.uuid] = false
907 children_of[parent_of[ob.uuid]] ||= []
908 children_of[parent_of[ob.uuid]] << ob
910 buildtree = lambda do |children_of, root_uuid=false|
912 children_of[root_uuid].andand.each do |ob|
913 tree[ob] = buildtree.call(children_of, ob.uuid)
917 sorted_paths = lambda do |tree, depth=0|
919 tree.keys.sort_by { |ob|
920 ob.is_a?(String) ? ob : ob.friendly_link_name
922 paths << {object: ob, depth: depth}
923 paths += sorted_paths.call tree[ob], depth+1
928 sorted_paths.call buildtree.call(children_of, 'me')
929 @shared_project_tree =
930 sorted_paths.call({'Projects shared with me' =>
931 buildtree.call(children_of, false)})
934 helper_method :get_object
936 if @get_object.nil? and @objects
937 @get_object = @objects.each_with_object({}) do |object, h|
938 h[object.uuid] = object
945 helper_method :project_breadcrumbs
946 def project_breadcrumbs
948 current = @name_link || @object
950 # Halt if a group ownership loop is detected. API should refuse
951 # to produce this state, but it could still arise from a race
952 # condition when group ownership changes between our find()
954 break if crumbs.collect(&:uuid).include? current.uuid
956 if current.is_a?(Group) and current.group_class == 'project'
957 crumbs.prepend current
959 if current.is_a? Link
960 current = Group.find?(current.tail_uuid)
962 current = Group.find?(current.owner_uuid)
968 helper_method :current_project_uuid
969 def current_project_uuid
970 if @object.is_a? Group and @object.group_class == 'project'
972 elsif @name_link.andand.tail_uuid
974 elsif @object and resource_class_for_uuid(@object.owner_uuid) == Group
981 # helper method to get links for given object or uuid
982 helper_method :links_for_object
983 def links_for_object object_or_uuid
984 raise ArgumentError, 'No input argument' unless object_or_uuid
985 preload_links_for_objects([object_or_uuid])
986 uuid = object_or_uuid.is_a?(String) ? object_or_uuid : object_or_uuid.uuid
987 @all_links_for[uuid] ||= []
990 # helper method to preload links for given objects and uuids
991 helper_method :preload_links_for_objects
992 def preload_links_for_objects objects_and_uuids
993 @all_links_for ||= {}
995 raise ArgumentError, 'Argument is not an array' unless objects_and_uuids.is_a? Array
996 return @all_links_for if objects_and_uuids.empty?
998 uuids = objects_and_uuids.collect { |x| x.is_a?(String) ? x : x.uuid }
1000 # if already preloaded for all of these uuids, return
1001 if not uuids.select { |x| @all_links_for[x].nil? }.any?
1002 return @all_links_for
1006 @all_links_for[x] = []
1009 # TODO: make sure we get every page of results from API server
1010 Link.filter([['head_uuid', 'in', uuids]]).each do |link|
1011 @all_links_for[link.head_uuid] << link
1016 # helper method to get a certain number of objects of a specific type
1017 # this can be used to replace any uses of: "dataclass.limit(n)"
1018 helper_method :get_n_objects_of_class
1019 def get_n_objects_of_class dataclass, size
1020 @objects_map_for ||= {}
1022 raise ArgumentError, 'Argument is not a data class' unless dataclass.is_a? Class and dataclass < ArvadosBase
1023 raise ArgumentError, 'Argument is not a valid limit size' unless (size && size>0)
1025 # if the objects_map_for has a value for this dataclass, and the
1026 # size used to retrieve those objects is equal, return it
1027 size_key = "#{dataclass.name}_size"
1028 if @objects_map_for[dataclass.name] && @objects_map_for[size_key] &&
1029 (@objects_map_for[size_key] == size)
1030 return @objects_map_for[dataclass.name]
1033 @objects_map_for[size_key] = size
1034 @objects_map_for[dataclass.name] = dataclass.limit(size)
1037 # helper method to get collections for the given uuid
1038 helper_method :collections_for_object
1039 def collections_for_object uuid
1040 raise ArgumentError, 'No input argument' unless uuid
1041 preload_collections_for_objects([uuid])
1042 @all_collections_for[uuid] ||= []
1045 # helper method to preload collections for the given uuids
1046 helper_method :preload_collections_for_objects
1047 def preload_collections_for_objects uuids
1048 @all_collections_for ||= {}
1050 raise ArgumentError, 'Argument is not an array' unless uuids.is_a? Array
1051 return @all_collections_for if uuids.empty?
1053 # if already preloaded for all of these uuids, return
1054 if not uuids.select { |x| @all_collections_for[x].nil? }.any?
1055 return @all_collections_for
1059 @all_collections_for[x] = []
1062 # TODO: make sure we get every page of results from API server
1063 Collection.where(uuid: uuids).each do |collection|
1064 @all_collections_for[collection.uuid] << collection
1066 @all_collections_for
1069 # helper method to get log collections for the given log
1070 helper_method :log_collections_for_object
1071 def log_collections_for_object log
1072 raise ArgumentError, 'No input argument' unless log
1074 preload_log_collections_for_objects([log])
1077 fixup = /([a-f0-9]{32}\+\d+)(\+?.*)/.match(log)
1078 if fixup && fixup.size>1
1082 @all_log_collections_for[uuid] ||= []
1085 # helper method to preload collections for the given uuids
1086 helper_method :preload_log_collections_for_objects
1087 def preload_log_collections_for_objects logs
1088 @all_log_collections_for ||= {}
1090 raise ArgumentError, 'Argument is not an array' unless logs.is_a? Array
1091 return @all_log_collections_for if logs.empty?
1095 fixup = /([a-f0-9]{32}\+\d+)(\+?.*)/.match(log)
1096 if fixup && fixup.size>1
1103 # if already preloaded for all of these uuids, return
1104 if not uuids.select { |x| @all_log_collections_for[x].nil? }.any?
1105 return @all_log_collections_for
1109 @all_log_collections_for[x] = []
1112 # TODO: make sure we get every page of results from API server
1113 Collection.where(uuid: uuids).each do |collection|
1114 @all_log_collections_for[collection.uuid] << collection
1116 @all_log_collections_for
1119 # Helper method to get one collection for the given portable_data_hash
1120 # This is used to determine if a pdh is readable by the current_user
1121 helper_method :collection_for_pdh
1122 def collection_for_pdh pdh
1123 raise ArgumentError, 'No input argument' unless pdh
1124 preload_for_pdhs([pdh])
1125 @all_pdhs_for[pdh] ||= []
1128 # Helper method to preload one collection each for the given pdhs
1129 # This is used to determine if a pdh is readable by the current_user
1130 helper_method :preload_for_pdhs
1131 def preload_for_pdhs pdhs
1132 @all_pdhs_for ||= {}
1134 raise ArgumentError, 'Argument is not an array' unless pdhs.is_a? Array
1135 return @all_pdhs_for if pdhs.empty?
1137 # if already preloaded for all of these pdhs, return
1138 if not pdhs.select { |x| @all_pdhs_for[x].nil? }.any?
1139 return @all_pdhs_for
1143 @all_pdhs_for[x] = []
1146 Collection.select(%w(portable_data_hash)).where(portable_data_hash: pdhs).distinct().each do |collection|
1147 @all_pdhs_for[collection.portable_data_hash] << collection
1152 # helper method to get object of a given dataclass and uuid
1153 helper_method :object_for_dataclass
1154 def object_for_dataclass dataclass, uuid
1155 raise ArgumentError, 'No input argument dataclass' unless (dataclass && uuid)
1156 preload_objects_for_dataclass(dataclass, [uuid])
1160 # helper method to preload objects for given dataclass and uuids
1161 helper_method :preload_objects_for_dataclass
1162 def preload_objects_for_dataclass dataclass, uuids
1165 raise ArgumentError, 'Argument is not a data class' unless dataclass.is_a? Class
1166 raise ArgumentError, 'Argument is not an array' unless uuids.is_a? Array
1168 return @objects_for if uuids.empty?
1170 # if already preloaded for all of these uuids, return
1171 if not uuids.select { |x| !@objects_for.include?(x) }.any?
1175 # preset all uuids to nil
1177 @objects_for[x] = nil
1179 dataclass.where(uuid: uuids).each do |obj|
1180 @objects_for[obj.uuid] = obj
1185 def wiselinks_layout