debian-mirror-gitlab/app/finders/group_members_finder.rb

90 lines
2.7 KiB
Ruby
Raw Normal View History

2018-12-05 23:21:45 +05:30
# frozen_string_literal: true
2019-10-12 21:52:04 +05:30
class GroupMembersFinder < UnionFinder
2022-03-02 08:16:31 +05:30
RELATIONS = %i(direct inherited descendants shared_from_groups).freeze
2021-02-22 17:27:13 +05:30
DEFAULT_RELATIONS = %i(direct inherited).freeze
2021-10-27 15:23:28 +05:30
INVALID_RELATION_TYPE_ERROR_MSG = "is not a valid relation type. Valid relation types are #{RELATIONS.join(', ')}."
2021-02-22 17:27:13 +05:30
2021-06-08 01:23:25 +05:30
RELATIONS_DESCRIPTIONS = {
direct: 'Members in the group itself',
inherited: "Members in the group's ancestor groups",
2022-03-02 08:16:31 +05:30
descendants: "Members in the group's subgroups",
shared_from_groups: "Invited group's members"
2021-06-08 01:23:25 +05:30
}.freeze
2020-04-22 19:07:51 +05:30
include CreatedAtFilter
2020-03-13 15:44:24 +05:30
# Params can be any of the following:
# two_factor: string. 'enabled' or 'disabled' are returning different set of data, other values are not effective.
# sort: string
# search: string
2020-04-22 19:07:51 +05:30
# created_after: datetime
# created_before: datetime
attr_reader :params
2020-03-13 15:44:24 +05:30
2020-04-22 19:07:51 +05:30
def initialize(group, user = nil, params: {})
2017-08-17 22:00:37 +05:30
@group = group
2020-03-13 15:44:24 +05:30
@user = user
2020-04-22 19:07:51 +05:30
@params = params
2017-08-17 22:00:37 +05:30
end
2021-02-22 17:27:13 +05:30
def execute(include_relations: DEFAULT_RELATIONS)
2021-04-29 21:17:54 +05:30
groups = groups_by_relations(include_relations)
members = all_group_members(groups).distinct_on_user_with_max_access_level
2017-08-17 22:00:37 +05:30
2020-04-22 19:07:51 +05:30
filter_members(members)
2017-08-17 22:00:37 +05:30
end
2020-03-13 15:44:24 +05:30
private
attr_reader :user, :group
2021-04-29 21:17:54 +05:30
def groups_by_relations(include_relations)
2021-10-27 15:23:28 +05:30
check_relation_arguments!(include_relations)
2022-03-02 08:16:31 +05:30
related_groups = []
related_groups << Group.by_id(group.id) if include_relations&.include?(:direct)
related_groups << group.ancestors if include_relations&.include?(:inherited)
related_groups << group.descendants if include_relations&.include?(:descendants)
related_groups << group.shared_with_groups.public_or_visible_to_user(user) if include_relations&.include?(:shared_from_groups)
find_union(related_groups, Group)
2021-04-29 21:17:54 +05:30
end
2020-04-22 19:07:51 +05:30
def filter_members(members)
2020-03-13 15:44:24 +05:30
members = members.search(params[:search]) if params[:search].present?
members = members.sort_by_attribute(params[:sort]) if params[:sort].present?
2020-10-24 23:57:45 +05:30
if params[:two_factor].present? && can_manage_members
2020-03-13 15:44:24 +05:30
members = members.filter_by_2fa(params[:two_factor])
end
2020-04-22 19:07:51 +05:30
by_created_at(members)
2020-03-13 15:44:24 +05:30
end
def can_manage_members
Ability.allowed?(user, :admin_group_member, group)
end
2021-01-03 14:25:43 +05:30
def group_members_list
group.members
end
2021-04-29 21:17:54 +05:30
def all_group_members(groups)
members_of_groups(groups).non_minimal_access
2021-01-03 14:25:43 +05:30
end
2021-04-29 21:17:54 +05:30
def members_of_groups(groups)
GroupMember.non_request.of_groups(groups)
2021-01-03 14:25:43 +05:30
end
2021-10-27 15:23:28 +05:30
def check_relation_arguments!(include_relations)
unless include_relations & RELATIONS == include_relations
raise ArgumentError, "#{(include_relations - RELATIONS).first} #{INVALID_RELATION_TYPE_ERROR_MSG}"
end
end
2017-08-17 22:00:37 +05:30
end
2019-12-04 20:38:33 +05:30
2021-06-08 01:23:25 +05:30
GroupMembersFinder.prepend_mod_with('GroupMembersFinder')