1 # Copyright (C) The Arvados Authors. All rights reserved.
3 # SPDX-License-Identifier: AGPL-3.0
7 class Arvados::V1::GroupsController < ApplicationController
8 include TrashableController
10 skip_before_filter :find_object_by_uuid, only: :shared
11 skip_before_filter :render_404_if_no_object, only: :shared
13 def self._index_requires_parameters
17 type: 'boolean', required: false, description: "Include items whose is_trashed attribute is true."
22 def self._contents_requires_parameters
23 params = _index_requires_parameters.
26 type: 'string', required: false, default: nil
29 type: 'boolean', required: false, description: 'Include contents from child groups recursively.'
32 params.delete(:select)
36 def render_404_if_no_object
37 if params[:action] == 'contents'
45 elsif (@object = User.where(uuid: params[:uuid]).first)
46 # "Home" pseudo-project
57 load_searchable_objects
59 :kind => "arvados#objectList",
64 :items_available => @items_available,
65 :items => @objects.as_api_response(nil)
70 # The purpose of this endpoint is to return the toplevel set of
71 # groups which are *not* reachable through a direct ownership
72 # chain of projects starting from the current user account. In
73 # other words, groups which to which access was granted via a
74 # permission link or chain of links.
76 # This also returns (in the "included" field) the objects that own
77 # those projects (users or non-project groups).
79 # select groups that are readable by current user AND
80 # the owner_uuid is a user (but not the current user) OR
81 # the owner_uuid is not readable by the current user
82 # the owner_uuid is a group but group_class is not a project
84 # The intended use of this endpoint is to support clients which
85 # wish to browse those projects which are visible to the user but
86 # are not part of the "home" project.
88 load_limit_offset_order_params
91 read_parent_check = if current_user.is_admin
94 "NOT EXISTS(SELECT 1 FROM #{PERMISSION_VIEW} WHERE "+
95 "user_uuid=(:user_uuid) AND target_uuid=groups.owner_uuid AND perm_level >= 1) OR "
98 @objects = Group.readable_by(*@read_users).where("groups.owner_uuid IN (SELECT users.uuid FROM users WHERE users.uuid != (:user_uuid)) OR "+
100 "EXISTS(SELECT 1 FROM groups as gp where gp.uuid=groups.owner_uuid and gp.group_class != 'project')",
101 user_uuid: current_user.uuid)
102 apply_where_limit_order_params
104 owners = @objects.map(&:owner_uuid).to_a
106 if params["include"] == "owner_uuid"
108 [Group, User].each do |klass|
109 @extra_included += klass.readable_by(*@read_users).where(uuid: owners).to_a
116 def self._shared_requires_parameters
117 rp = self._index_requires_parameters
118 rp[:include] = { type: 'string', required: false }
124 def load_searchable_objects
128 # Reload the orders param, this time without prefixing unqualified
129 # columns ("name" => "groups.name"). Here, unqualified orders
130 # apply to each table being searched, not "groups".
131 load_limit_offset_order_params(fill_table_names: false)
133 # Trick apply_where_limit_order_params into applying suitable
134 # per-table values. *_all are the real ones we'll apply to the
138 # save the orders from the current request as determined by load_param,
139 # but otherwise discard them because we're going to be getting objects
141 request_orders = @orders.clone
144 request_filters = @filters
147 Job, PipelineInstance, PipelineTemplate, ContainerRequest, Workflow,
149 Human, Specimen, Trait]
151 table_names = Hash[klasses.collect { |k| [k, k.table_name] }]
153 disabled_methods = Rails.configuration.disable_api_methods
154 avail_klasses = table_names.select{|k, t| !disabled_methods.include?(t+'.index')}
155 klasses = avail_klasses.keys
157 request_filters.each do |col, op, val|
158 if col.index('.') && !table_names.values.include?(col.split('.', 2)[0])
159 raise ArgumentError.new("Invalid attribute '#{col}' in filter")
164 request_filters.each do |col,op,val|
166 (val.is_a?(Array) ? val : [val]).each do |type|
167 type = type.split('#')[-1]
168 type[0] = type[0].capitalize
169 wanted_klasses << type
176 if params['recursive']
177 filter_by_owner[:owner_uuid] = [@object.uuid] + @object.descendant_project_uuids
179 filter_by_owner[:owner_uuid] = @object.uuid
183 seen_last_class = false
184 klasses.each do |klass|
185 @offset = 0 if seen_last_class # reset offset for the new next type being processed
187 # if current klass is same as params['last_object_class'], mark that fact
188 seen_last_class = true if((params['count'].andand.==('none')) and
189 (params['last_object_class'].nil? or
190 params['last_object_class'].empty? or
191 params['last_object_class'] == klass.to_s))
193 # if klasses are specified, skip all other klass types
194 next if wanted_klasses.any? and !wanted_klasses.include?(klass.to_s)
196 # don't reprocess klass types that were already seen
197 next if params['count'] == 'none' and !seen_last_class
199 # don't process rest of object types if we already have needed number of objects
200 break if params['count'] == 'none' and all_objects.size >= limit_all
202 # If the currently requested orders specifically match the
203 # table_name for the current klass, apply that order.
204 # Otherwise, order by recency.
206 request_orders.andand.find { |r| r =~ /^#{klass.table_name}\./i || r !~ /\./ } ||
207 klass.default_orders.join(", ")
210 where_conds = filter_by_owner
211 if klass == Collection
212 @select = klass.selectable_attributes - ["manifest_text"]
214 where_conds = where_conds.merge(group_class: "project")
217 @filters = request_filters.map do |col, op, val|
220 elsif (col = col.split('.', 2))[0] == klass.table_name
227 @objects = klass.readable_by(*@read_users, {:include_trash => params[:include_trash]}).
228 order(request_order).where(where_conds)
230 klass_limit = limit_all - all_objects.count
232 apply_where_limit_order_params klass
233 klass_object_list = object_list(model_class: klass)
234 klass_items_available = klass_object_list[:items_available] || 0
235 @items_available += klass_items_available
236 @offset = [@offset - klass_items_available, 0].max
237 all_objects += klass_object_list[:items]
239 if klass_object_list[:limit] < klass_limit
240 # object_list() had to reduce @limit to comply with
241 # max_index_database_read. From now on, we'll do all queries
242 # with limit=0 and just accumulate items_available.
243 limit_all = all_objects.count
247 @objects = all_objects