diff options
Diffstat (limited to 'app/finders/group_descendants_finder.rb')
| -rw-r--r-- | app/finders/group_descendants_finder.rb | 153 |
1 files changed, 153 insertions, 0 deletions
diff --git a/app/finders/group_descendants_finder.rb b/app/finders/group_descendants_finder.rb new file mode 100644 index 00000000000..1a5f6063437 --- /dev/null +++ b/app/finders/group_descendants_finder.rb @@ -0,0 +1,153 @@ +# GroupDescendantsFinder +# +# Used to find and filter all subgroups and projects of a passed parent group +# visible to a specified user. +# +# When passing a `filter` param, the search is performed over all nested levels +# of the `parent_group`. All ancestors for a search result are loaded +# +# Arguments: +# current_user: The user for which the children should be visible +# parent_group: The group to find children of +# params: +# Supports all params that the `ProjectsFinder` and `GroupProjectsFinder` +# support. +# +# filter: string - is aliased to `search` for consistency with the frontend +# archived: string - `only` or `true`. +# `non_archived` is passed to the `ProjectFinder`s if none +# was given. +class GroupDescendantsFinder + attr_reader :current_user, :parent_group, :params + + def initialize(current_user: nil, parent_group:, params: {}) + @current_user = current_user + @parent_group = parent_group + @params = params.reverse_merge(non_archived: params[:archived].blank?) + end + + def execute + # The children array might be extended with the ancestors of projects when + # filtering. In that case, take the maximum so the array does not get limited + # Otherwise, allow paginating through all results + # + all_required_elements = children + all_required_elements |= ancestors_for_projects if params[:filter] + total_count = [all_required_elements.size, paginator.total_count].max + + Kaminari.paginate_array(all_required_elements, total_count: total_count) + end + + def has_children? + projects.any? || subgroups.any? + end + + private + + def children + @children ||= paginator.paginate(params[:page]) + end + + def paginator + @paginator ||= Gitlab::MultiCollectionPaginator.new(subgroups, projects, + per_page: params[:per_page]) + end + + def direct_child_groups + GroupsFinder.new(current_user, + parent: parent_group, + all_available: true).execute + end + + def all_visible_descendant_groups + groups_table = Group.arel_table + visible_to_user = groups_table[:visibility_level] + .in(Gitlab::VisibilityLevel.levels_for_user(current_user)) + if current_user + authorized_groups = GroupsFinder.new(current_user, + all_available: false) + .execute.as('authorized') + authorized_to_user = groups_table.project(1).from(authorized_groups) + .where(authorized_groups[:id].eq(groups_table[:id])) + .exists + visible_to_user = visible_to_user.or(authorized_to_user) + end + + hierarchy_for_parent + .descendants + .where(visible_to_user) + end + + def subgroups_matching_filter + all_visible_descendant_groups + .search(params[:filter]) + end + + # When filtering we want all to preload all the ancestors upto the specified + # parent group. + # + # - root + # - subgroup + # - nested-group + # - project + # + # So when searching 'project', on the 'subgroup' page we want to preload + # 'nested-group' but not 'subgroup' or 'root' + def ancestors_for_groups(base_for_ancestors) + Gitlab::GroupHierarchy.new(base_for_ancestors) + .base_and_ancestors(upto: parent_group.id) + end + + def ancestors_for_projects + projects_to_load_ancestors_of = projects.where.not(namespace: parent_group) + groups_to_load_ancestors_of = Group.where(id: projects_to_load_ancestors_of.select(:namespace_id)) + ancestors_for_groups(groups_to_load_ancestors_of) + .with_selects_for_list(archived: params[:archived]) + end + + def subgroups + return Group.none unless Group.supports_nested_groups? + + # When filtering subgroups, we want to find all matches withing the tree of + # descendants to show to the user + groups = if params[:filter] + ancestors_for_groups(subgroups_matching_filter) + else + direct_child_groups + end + groups.with_selects_for_list(archived: params[:archived]).order_by(sort) + end + + def direct_child_projects + GroupProjectsFinder.new(group: parent_group, current_user: current_user, params: params) + .execute + end + + # Finds all projects nested under `parent_group` or any of its descendant + # groups + def projects_matching_filter + projects_nested_in_group = Project.where(namespace_id: hierarchy_for_parent.base_and_descendants.select(:id)) + params_with_search = params.merge(search: params[:filter]) + + ProjectsFinder.new(params: params_with_search, + current_user: current_user, + project_ids_relation: projects_nested_in_group).execute + end + + def projects + projects = if params[:filter] + projects_matching_filter + else + direct_child_projects + end + projects.with_route.order_by(sort) + end + + def sort + params.fetch(:sort, 'id_asc') + end + + def hierarchy_for_parent + @hierarchy ||= Gitlab::GroupHierarchy.new(Group.where(id: parent_group.id)) + end +end |