# frozen_string_literal: true require 'carrierwave/orm/activerecord' class Group < Namespace include Gitlab::ConfigHelper include AfterCommitQueue include AccessRequestable include Avatarable include Referable include SelectForProjectAuthorization include LoadedInGroupList include GroupDescendant include TokenAuthenticatable include WithUploads include Gitlab::Utils::StrongMemoize include GroupAPICompatibility include EachBatch include BulkMemberAccessLoad has_many :all_group_members, -> { where(requested_at: nil) }, dependent: :destroy, as: :source, class_name: 'GroupMember' # rubocop:disable Cop/ActiveRecordDependent has_many :group_members, -> { where(requested_at: nil).where.not(members: { access_level: Gitlab::Access::MINIMAL_ACCESS }) }, dependent: :destroy, as: :source # rubocop:disable Cop/ActiveRecordDependent alias_method :members, :group_members has_many :users, through: :group_members has_many :owners, -> { where(members: { access_level: Gitlab::Access::OWNER }) }, through: :group_members, source: :user has_many :requesters, -> { where.not(requested_at: nil) }, dependent: :destroy, as: :source, class_name: 'GroupMember' # rubocop:disable Cop/ActiveRecordDependent has_many :members_and_requesters, as: :source, class_name: 'GroupMember' has_many :milestones has_many :integrations has_many :shared_group_links, foreign_key: :shared_with_group_id, class_name: 'GroupGroupLink' has_many :shared_with_group_links, foreign_key: :shared_group_id, class_name: 'GroupGroupLink' has_many :shared_groups, through: :shared_group_links, source: :shared_group has_many :shared_with_groups, through: :shared_with_group_links, source: :shared_with_group has_many :project_group_links, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent has_many :shared_projects, through: :project_group_links, source: :project # Overridden on another method # Left here just to be dependent: :destroy has_many :notification_settings, dependent: :destroy, as: :source # rubocop:disable Cop/ActiveRecordDependent has_many :labels, class_name: 'GroupLabel' has_many :variables, class_name: 'Ci::GroupVariable' has_many :daily_build_group_report_results, class_name: 'Ci::DailyBuildGroupReportResult' has_many :custom_attributes, class_name: 'GroupCustomAttribute' has_many :boards has_many :badges, class_name: 'GroupBadge' has_many :cluster_groups, class_name: 'Clusters::Group' has_many :clusters, through: :cluster_groups, class_name: 'Clusters::Cluster' has_many :container_repositories, through: :projects has_many :todos has_one :import_export_upload has_many :import_failures, inverse_of: :group has_one :import_state, class_name: 'GroupImportState', inverse_of: :group has_many :bulk_import_exports, class_name: 'BulkImports::Export', inverse_of: :group has_many :group_deploy_keys_groups, inverse_of: :group has_many :group_deploy_keys, through: :group_deploy_keys_groups has_many :group_deploy_tokens has_many :deploy_tokens, through: :group_deploy_tokens has_many :oauth_applications, class_name: 'Doorkeeper::Application', as: :owner, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent has_one :dependency_proxy_setting, class_name: 'DependencyProxy::GroupSetting' has_many :dependency_proxy_blobs, class_name: 'DependencyProxy::Blob' has_many :dependency_proxy_manifests, class_name: 'DependencyProxy::Manifest' # debian_distributions and associated component_files must be destroyed by ruby code in order to properly remove carrierwave uploads has_many :debian_distributions, class_name: 'Packages::Debian::GroupDistribution', dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent delegate :prevent_sharing_groups_outside_hierarchy, :new_user_signups_cap, to: :namespace_settings accepts_nested_attributes_for :variables, allow_destroy: true validate :visibility_level_allowed_by_projects validate :visibility_level_allowed_by_sub_groups validate :visibility_level_allowed_by_parent validate :two_factor_authentication_allowed validates :variables, nested_attributes_duplicates: { scope: :environment_scope } validates :two_factor_grace_period, presence: true, numericality: { greater_than_or_equal_to: 0 } validates :name, html_safety: true, format: { with: Gitlab::Regex.group_name_regex, message: Gitlab::Regex.group_name_regex_message }, if: :name_changed? add_authentication_token_field :runners_token, encrypted: -> { Feature.enabled?(:groups_tokens_optional_encryption, default_enabled: true) ? :optional : :required } after_create :post_create_hook after_destroy :post_destroy_hook after_save :update_two_factor_requirement after_update :path_changed_hook, if: :saved_change_to_path? scope :with_users, -> { includes(:users) } scope :with_onboarding_progress, -> { joins(:onboarding_progress) } scope :by_id, ->(groups) { where(id: groups) } scope :for_authorized_group_members, -> (user_ids) do joins(:group_members) .where(members: { user_id: user_ids }) .where("access_level >= ?", Gitlab::Access::GUEST) end scope :for_authorized_project_members, -> (user_ids) do joins(projects: :project_authorizations) .where(project_authorizations: { user_id: user_ids }) end class << self def sort_by_attribute(method) if method == 'storage_size_desc' # storage_size is a virtual column so we need to # pass a string to avoid AR adding the table name reorder('storage_size DESC, namespaces.id DESC') else order_by(method) end end def reference_prefix User.reference_prefix end def reference_pattern User.reference_pattern end # WARNING: This method should never be used on its own # please do make sure the number of rows you are filtering is small # enough for this query def public_or_visible_to_user(user) return public_to_user unless user public_for_user = public_to_user_arel(user) visible_for_user = visible_to_user_arel(user) public_or_visible = public_for_user.or(visible_for_user) where(public_or_visible) end def select_for_project_authorization if current_scope.joins_values.include?(:shared_projects) joins('INNER JOIN namespaces project_namespace ON project_namespace.id = projects.namespace_id') .where(project_namespace: { share_with_group_lock: false }) .select("projects.id AS project_id", "LEAST(project_group_links.group_access, members.access_level) AS access_level") else super end end def without_integration(integration) integrations = Integration .select('1') .where("#{Integration.table_name}.group_id = namespaces.id") .where(type: integration.type) where('NOT EXISTS (?)', integrations) end # This method can be used only if all groups have the same top-level # group def preset_root_ancestor_for(groups) return groups if groups.size < 2 root = groups.first.root_ancestor groups.drop(1).each { |group| group.root_ancestor = root } end # Returns the ids of the passed group models where the `emails_disabled` # column is set to true anywhere in the ancestor hierarchy. def ids_with_disabled_email(groups) innner_query = Gitlab::ObjectHierarchy .new(Group.where('id = namespaces_with_emails_disabled.id')) .base_and_ancestors .where(emails_disabled: true) .select('1') .limit(1) group_ids = Namespace .from('(SELECT * FROM namespaces) as namespaces_with_emails_disabled') .where(namespaces_with_emails_disabled: { id: groups }) .where('EXISTS (?)', innner_query) .pluck(:id) Set.new(group_ids) end private def public_to_user_arel(user) self.arel_table[:visibility_level] .in(Gitlab::VisibilityLevel.levels_for_user(user)) end def visible_to_user_arel(user) groups_table = self.arel_table authorized_groups = user.authorized_groups.arel.as('authorized') groups_table.project(1) .from(authorized_groups) .where(authorized_groups[:id].eq(groups_table[:id])) .exists end end # Overrides notification_settings has_many association # This allows to apply notification settings from parent groups # to child groups and projects. def notification_settings(hierarchy_order: nil) source_type = self.class.base_class.name settings = NotificationSetting.where(source_type: source_type, source_id: self_and_ancestors_ids) return settings unless hierarchy_order && self_and_ancestors_ids.length > 1 settings .joins("LEFT JOIN (#{self_and_ancestors(hierarchy_order: hierarchy_order).to_sql}) AS ordered_groups ON notification_settings.source_id = ordered_groups.id") .select('notification_settings.*, ordered_groups.depth AS depth') .order("ordered_groups.depth #{hierarchy_order}") end def notification_settings_for(user, hierarchy_order: nil) notification_settings(hierarchy_order: hierarchy_order).where(user: user) end def packages_feature_enabled? ::Gitlab.config.packages.enabled end def dependency_proxy_feature_available? ::Gitlab.config.dependency_proxy.enabled end def notification_email_for(user) # Finds the closest notification_setting with a `notification_email` notification_settings = notification_settings_for(user, hierarchy_order: :asc) notification_settings.find { |n| n.notification_email.present? }&.notification_email end def to_reference(_from = nil, target_project: nil, full: nil) "#{self.class.reference_prefix}#{full_path}" end def web_url(only_path: nil) Gitlab::UrlBuilder.build(self, only_path: only_path) end def human_name full_name end def visibility_level_allowed_by_parent?(level = self.visibility_level) return true unless parent_id && parent_id.nonzero? level <= parent.visibility_level end def visibility_level_allowed_by_projects?(level = self.visibility_level) !projects.where('visibility_level > ?', level).exists? end def visibility_level_allowed_by_sub_groups?(level = self.visibility_level) !children.where('visibility_level > ?', level).exists? end def visibility_level_allowed?(level = self.visibility_level) visibility_level_allowed_by_parent?(level) && visibility_level_allowed_by_projects?(level) && visibility_level_allowed_by_sub_groups?(level) end def lfs_enabled? return false unless Gitlab.config.lfs.enabled return Gitlab.config.lfs.enabled if self[:lfs_enabled].nil? self[:lfs_enabled] end def owned_by?(user) owners.include?(user) end def add_users(users, access_level, current_user: nil, expires_at: nil) Members::Groups::CreatorService.add_users( # rubocop:todo CodeReuse/ServiceClass self, users, access_level, current_user: current_user, expires_at: expires_at ) end def add_user(user, access_level, current_user: nil, expires_at: nil, ldap: false) Members::Groups::CreatorService.new(self, # rubocop:todo CodeReuse/ServiceClass user, access_level, current_user: current_user, expires_at: expires_at, ldap: ldap) .execute end def add_guest(user, current_user = nil) add_user(user, :guest, current_user: current_user) end def add_reporter(user, current_user = nil) add_user(user, :reporter, current_user: current_user) end def add_developer(user, current_user = nil) add_user(user, :developer, current_user: current_user) end def add_maintainer(user, current_user = nil) add_user(user, :maintainer, current_user: current_user) end def add_owner(user, current_user = nil) add_user(user, :owner, current_user: current_user) end def member?(user, min_access_level = Gitlab::Access::GUEST) return false unless user max_member_access_for_user(user) >= min_access_level end def has_owner?(user) return false unless user members_with_parents.owners.exists?(user_id: user) end def blocked_owners members.blocked.where(access_level: Gitlab::Access::OWNER) end def has_maintainer?(user) return false unless user members_with_parents.maintainers.exists?(user_id: user) end def has_container_repository_including_subgroups? ::ContainerRepository.for_group_and_its_subgroups(self).exists? end # Check if user is a last owner of the group. def last_owner?(user) has_owner?(user) && single_owner? end def member_last_owner?(member) return member.last_owner unless member.last_owner.nil? last_owner?(member.user) end def single_owner? members_with_parents.owners.size == 1 end def single_blocked_owner? blocked_owners.size == 1 end def member_last_blocked_owner?(member) return member.last_blocked_owner unless member.last_blocked_owner.nil? return false if members_with_parents.owners.any? single_blocked_owner? && blocked_owners.exists?(user_id: member.user) end def ldap_synced? false end def post_create_hook Gitlab::AppLogger.info("Group \"#{name}\" was created") system_hook_service.execute_hooks_for(self, :create) end def post_destroy_hook Gitlab::AppLogger.info("Group \"#{name}\" was removed") system_hook_service.execute_hooks_for(self, :destroy) end # rubocop: disable CodeReuse/ServiceClass def system_hook_service SystemHooksService.new end # rubocop: enable CodeReuse/ServiceClass # rubocop: disable CodeReuse/ServiceClass def refresh_members_authorized_projects( blocking: true, priority: UserProjectAccessChangedService::HIGH_PRIORITY, direct_members_only: false ) user_ids = if direct_members_only users_ids_of_direct_members else user_ids_for_project_authorizations end UserProjectAccessChangedService .new(user_ids) .execute(blocking: blocking, priority: priority) end # rubocop: enable CodeReuse/ServiceClass def users_ids_of_direct_members direct_members.pluck(:user_id) end def user_ids_for_project_authorizations members_with_parents.pluck(Arel.sql('DISTINCT members.user_id')) end def self_and_ancestors_ids strong_memoize(:self_and_ancestors_ids) do self_and_ancestors.pluck(:id) end end def self_and_descendants_ids strong_memoize(:self_and_descendants_ids) do self_and_descendants.pluck(:id) end end def direct_members GroupMember.active_without_invites_and_requests .non_minimal_access .where(source_id: id) end def authorizable_members_with_parents source_ids = if has_parent? self_and_ancestors.reorder(nil).select(:id) else id end group_hierarchy_members = GroupMember.where(source_id: source_ids).select(*GroupMember.cached_column_list) GroupMember.from_union([group_hierarchy_members, members_from_self_and_ancestor_group_shares]).authorizable end def members_with_parents # Avoids an unnecessary SELECT when the group has no parents source_ids = if has_parent? self_and_ancestors.reorder(nil).select(:id) else id end group_hierarchy_members = GroupMember.active_without_invites_and_requests .non_minimal_access .where(source_id: source_ids) .select(*GroupMember.cached_column_list) GroupMember.from_union([group_hierarchy_members, members_from_self_and_ancestor_group_shares]) end def members_from_self_and_ancestors_with_effective_access_level members_with_parents.select([:user_id, 'MAX(access_level) AS access_level']) .group(:user_id) end def members_with_descendants GroupMember .active_without_invites_and_requests .where(source_id: self_and_descendants.reorder(nil).select(:id)) end # Returns all members that are part of the group, it's subgroups, and ancestor groups def direct_and_indirect_members GroupMember .active_without_invites_and_requests .where(source_id: self_and_hierarchy.reorder(nil).select(:id)) end def direct_and_indirect_members_with_inactive GroupMember .non_request .non_invite .where(source_id: self_and_hierarchy.reorder(nil).select(:id)) end def users_with_parents User .where(id: members_with_parents.select(:user_id)) .reorder(nil) end def users_with_descendants User .where(id: members_with_descendants.select(:user_id)) .reorder(nil) end # Returns all users that are members of the group because: # 1. They belong to the group # 2. They belong to a project that belongs to the group # 3. They belong to a sub-group or project in such sub-group # 4. They belong to an ancestor group def direct_and_indirect_users User.from_union([ User .where(id: direct_and_indirect_members.select(:user_id)) .reorder(nil), project_users_with_descendants ]) end # Returns all users (also inactive) that are members of the group because: # 1. They belong to the group # 2. They belong to a project that belongs to the group # 3. They belong to a sub-group or project in such sub-group # 4. They belong to an ancestor group def direct_and_indirect_users_with_inactive User.from_union([ User .where(id: direct_and_indirect_members_with_inactive.select(:user_id)) .reorder(nil), project_users_with_descendants ]) end def users_count members.count end # Returns all users that are members of projects # belonging to the current group or sub-groups def project_users_with_descendants User .joins(projects: :group) .where(namespaces: { id: self_and_descendants.select(:id) }) end # Return the highest access level for a user # # A special case is handled here when the user is a GitLab admin # which implies it has "OWNER" access everywhere, but should not # officially appear as a member of a group unless specifically added to it # # @param user [User] # @param only_concrete_membership [Bool] whether require admin concrete membership status def max_member_access_for_user(user, only_concrete_membership: false) return GroupMember::NO_ACCESS unless user return GroupMember::OWNER if user.can_admin_all_resources? && !only_concrete_membership max_member_access([user.id])[user.id] end def mattermost_team_params max_length = 59 { name: path[0..max_length], display_name: name[0..max_length], type: public? ? 'O' : 'I' # Open vs Invite-only } end def ci_variables_for(ref, project, environment: nil) cache_key = "ci_variables_for:group:#{self&.id}:project:#{project&.id}:ref:#{ref}:environment:#{environment}" ::Gitlab::SafeRequestStore.fetch(cache_key) do uncached_ci_variables_for(ref, project, environment: environment) end end def group_member(user) if group_members.loaded? group_members.find { |gm| gm.user_id == user.id } else group_members.find_by(user_id: user) end end def highest_group_member(user) GroupMember.where(source_id: self_and_ancestors_ids, user_id: user.id).order(:access_level).last end def related_group_ids [id, *ancestors.pluck(:id), *shared_with_group_links.pluck(:shared_with_group_id)] end def hashed_storage?(_feature) false end def refresh_project_authorizations refresh_members_authorized_projects(blocking: false) end # each existing group needs to have a `runners_token`. # we do this on read since migrating all existing groups is not a feasible # solution. def runners_token ensure_runners_token! end def project_creation_level super || ::Gitlab::CurrentSettings.default_project_creation end def subgroup_creation_level super || ::Gitlab::Access::OWNER_SUBGROUP_ACCESS end def access_request_approvers_to_be_notified members.owners.connected_to_user.order_recent_sign_in.limit(Member::ACCESS_REQUEST_APPROVERS_TO_BE_NOTIFIED_LIMIT) end def supports_events? false end def export_file_exists? import_export_upload&.export_file_exists? end def export_file import_export_upload&.export_file end def export_archive_exists? import_export_upload&.export_archive_exists? end def adjourned_deletion? false end def execute_hooks(data, hooks_scope) # NOOP # TODO: group hooks https://gitlab.com/gitlab-org/gitlab/-/issues/216904 end def execute_integrations(data, hooks_scope) # NOOP # TODO: group hooks https://gitlab.com/gitlab-org/gitlab/-/issues/216904 end def preload_shared_group_links preloader = ActiveRecord::Associations::Preloader.new preloader.preload(self, shared_with_group_links: [shared_with_group: :route]) end def update_shared_runners_setting!(state) raise ArgumentError unless SHARED_RUNNERS_SETTINGS.include?(state) case state when 'disabled_and_unoverridable' then disable_shared_runners! # also disallows override when 'disabled_with_override' then disable_shared_runners_and_allow_override! when 'enabled' then enable_shared_runners! # set both to true end end def default_owner owners.first || parent&.default_owner || owner end def default_branch_name namespace_settings&.default_branch_name end def access_level_roles GroupMember.access_level_roles end def access_level_values access_level_roles.values end def parent_allows_two_factor_authentication? return true unless has_parent? ancestor_settings = ancestors.find_by(parent_id: nil).namespace_settings ancestor_settings.allow_mfa_for_subgroups end def has_project_with_service_desk_enabled? Gitlab::ServiceDesk.supported? && all_projects.service_desk_enabled.exists? end def to_ability_name model_name.singular end def activity_path Gitlab::Routing.url_helpers.activity_group_path(self) end # rubocop: disable CodeReuse/ServiceClass def open_issues_count(current_user = nil) Groups::OpenIssuesCountService.new(self, current_user).count end # rubocop: enable CodeReuse/ServiceClass # rubocop: disable CodeReuse/ServiceClass def open_merge_requests_count(current_user = nil) Groups::MergeRequestsCountService.new(self, current_user).count end # rubocop: enable CodeReuse/ServiceClass private def max_member_access(user_ids) max_member_access_for_resource_ids(User, user_ids) do |user_ids| members_with_parents.where(user_id: user_ids).group(:user_id).maximum(:access_level) end end def update_two_factor_requirement return unless saved_change_to_require_two_factor_authentication? || saved_change_to_two_factor_grace_period? direct_and_indirect_members.find_each(&:update_two_factor_requirement) end def path_changed_hook system_hook_service.execute_hooks_for(self, :rename) end def visibility_level_allowed_by_parent return if visibility_level_allowed_by_parent? errors.add(:visibility_level, "#{visibility} is not allowed since the parent group has a #{parent.visibility} visibility.") end def visibility_level_allowed_by_projects return if visibility_level_allowed_by_projects? errors.add(:visibility_level, "#{visibility} is not allowed since this group contains projects with higher visibility.") end def visibility_level_allowed_by_sub_groups return if visibility_level_allowed_by_sub_groups? errors.add(:visibility_level, "#{visibility} is not allowed since there are sub-groups with higher visibility.") end def two_factor_authentication_allowed return unless has_parent? return unless require_two_factor_authentication return if parent_allows_two_factor_authentication? errors.add(:require_two_factor_authentication, _('is forbidden by a top-level group')) end def members_from_self_and_ancestor_group_shares group_group_link_table = GroupGroupLink.arel_table group_member_table = GroupMember.arel_table source_ids = if has_parent? self_and_ancestors.reorder(nil).select(:id) else id end group_group_links_query = GroupGroupLink.where(shared_group_id: source_ids) cte = Gitlab::SQL::CTE.new(:group_group_links_cte, group_group_links_query) cte_alias = cte.table.alias(GroupGroupLink.table_name) # Instead of members.access_level, we need to maximize that access_level at # the respective group_group_links.group_access. member_columns = GroupMember.attribute_names.map do |column_name| if column_name == 'access_level' smallest_value_arel([cte_alias[:group_access], group_member_table[:access_level]], 'access_level') else group_member_table[column_name] end end GroupMember .with(cte.to_arel) .select(*member_columns) .from([group_member_table, cte.alias_to(group_group_link_table)]) .where(group_member_table[:requested_at].eq(nil)) .where(group_member_table[:source_id].eq(group_group_link_table[:shared_with_group_id])) .where(group_member_table[:source_type].eq('Namespace')) .non_minimal_access end def smallest_value_arel(args, column_alias) Arel::Nodes::As.new( Arel::Nodes::NamedFunction.new('LEAST', args), Arel::Nodes::SqlLiteral.new(column_alias)) end def self.groups_including_descendants_by(group_ids) Gitlab::ObjectHierarchy .new(Group.where(id: group_ids)) .base_and_descendants end def disable_shared_runners! update!( shared_runners_enabled: false, allow_descendants_override_disabled_shared_runners: false) group_ids = descendants unless group_ids.empty? Group.by_id(group_ids).update_all( shared_runners_enabled: false, allow_descendants_override_disabled_shared_runners: false) end all_projects.update_all(shared_runners_enabled: false) end def disable_shared_runners_and_allow_override! # enabled -> disabled_with_override if shared_runners_enabled? update!( shared_runners_enabled: false, allow_descendants_override_disabled_shared_runners: true) group_ids = descendants unless group_ids.empty? Group.by_id(group_ids).update_all(shared_runners_enabled: false) end all_projects.update_all(shared_runners_enabled: false) # disabled_and_unoverridable -> disabled_with_override else update!(allow_descendants_override_disabled_shared_runners: true) end end def enable_shared_runners! update!(shared_runners_enabled: true) end def uncached_ci_variables_for(ref, project, environment: nil) list_of_ids = if root_ancestor.use_traversal_ids? [self] + ancestors(hierarchy_order: :asc) else [self] + ancestors end variables = Ci::GroupVariable.where(group: list_of_ids) variables = variables.unprotected unless project.protected_for?(ref) variables = if environment variables.on_environment(environment) else variables.where(environment_scope: '*') end variables = variables.group_by(&:group_id) list_of_ids.reverse.flat_map { |group| variables[group.id] }.compact end end Group.prepend_mod_with('Group')