# frozen_string_literal: true class Namespace < ApplicationRecord include CacheMarkdownField include Sortable include Gitlab::VisibilityLevel include Routable include AfterCommitQueue include Storage::LegacyNamespace include Gitlab::SQL::Pattern include FeatureGate include FromUnion include Gitlab::Utils::StrongMemoize include Namespaces::Traversal::Recursive include Namespaces::Traversal::Linear include EachBatch include BlocksUnsafeSerialization include Ci::NamespaceSettings # Tells ActiveRecord not to store the full class name, in order to save some space # https://gitlab.com/gitlab-org/gitlab/-/merge_requests/69794 self.store_full_sti_class = false self.store_full_class_name = false # Prevent users from creating unreasonably deep level of nesting. # The number 20 was taken based on maximum nesting level of # Android repo (15) + some extra backup. NUMBER_OF_ANCESTORS_ALLOWED = 20 SR_DISABLED_AND_UNOVERRIDABLE = 'disabled_and_unoverridable' # DISABLED_WITH_OVERRIDE is deprecated in favour of DISABLED_AND_OVERRIDABLE. SR_DISABLED_WITH_OVERRIDE = 'disabled_with_override' SR_DISABLED_AND_OVERRIDABLE = 'disabled_and_overridable' SR_ENABLED = 'enabled' SHARED_RUNNERS_SETTINGS = [SR_DISABLED_AND_UNOVERRIDABLE, SR_DISABLED_WITH_OVERRIDE, SR_DISABLED_AND_OVERRIDABLE, SR_ENABLED].freeze URL_MAX_LENGTH = 255 # This date is just a placeholder until namespace storage enforcement timeline is confirmed at which point # this should be replaced, see https://about.gitlab.com/pricing/faq-efficient-free-tier/#user-limits-on-gitlab-saas-free-tier MIN_STORAGE_ENFORCEMENT_DATE = 3.months.from_now.to_date # https://gitlab.com/gitlab-org/gitlab/-/issues/367531 MIN_STORAGE_ENFORCEMENT_USAGE = 5.gigabytes cache_markdown_field :description, pipeline: :description has_many :projects, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent has_many :project_statistics has_one :namespace_settings, inverse_of: :namespace, class_name: 'NamespaceSetting', autosave: true has_one :ci_cd_settings, inverse_of: :namespace, class_name: 'NamespaceCiCdSetting', autosave: true has_one :namespace_details, inverse_of: :namespace, class_name: 'Namespace::Detail', autosave: true has_one :namespace_statistics has_one :namespace_route, foreign_key: :namespace_id, autosave: false, inverse_of: :namespace, class_name: 'Route' has_many :namespace_members, foreign_key: :member_namespace_id, inverse_of: :member_namespace, class_name: 'Member' has_many :member_roles has_many :runner_namespaces, inverse_of: :namespace, class_name: 'Ci::RunnerNamespace' has_many :runners, through: :runner_namespaces, source: :runner, class_name: 'Ci::Runner' has_many :pending_builds, class_name: 'Ci::PendingBuild' has_one :onboarding_progress, class_name: 'Onboarding::Progress' # This should _not_ be `inverse_of: :namespace`, because that would also set # `user.namespace` when this user creates a group with themselves as `owner`. belongs_to :owner, class_name: 'User' belongs_to :parent, class_name: "Namespace" has_many :children, -> { where(type: Group.sti_name) }, class_name: "Namespace", foreign_key: :parent_id has_many :custom_emoji, inverse_of: :namespace has_one :chat_team, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent has_one :root_storage_statistics, class_name: 'Namespace::RootStorageStatistics' has_one :aggregation_schedule, class_name: 'Namespace::AggregationSchedule' has_one :package_setting_relation, inverse_of: :namespace, class_name: 'PackageSetting' has_one :admin_note, inverse_of: :namespace accepts_nested_attributes_for :admin_note, update_only: true has_one :ci_namespace_mirror, class_name: 'Ci::NamespaceMirror' has_many :sync_events, class_name: 'Namespaces::SyncEvent' has_one :cluster_enabled_grant, inverse_of: :namespace, class_name: 'Clusters::ClusterEnabledGrant' has_many :work_items, inverse_of: :namespace has_many :issues, inverse_of: :namespace has_many :timelog_categories, class_name: 'TimeTracking::TimelogCategory' has_many :achievements, class_name: 'Achievements::Achievement' has_many :namespace_commit_emails, class_name: 'Users::NamespaceCommitEmail' has_many :cycle_analytics_stages, class_name: 'Analytics::CycleAnalytics::Stage', foreign_key: :group_id, inverse_of: :namespace has_many :value_streams, class_name: 'Analytics::CycleAnalytics::ValueStream', foreign_key: :group_id, inverse_of: :namespace validates :owner, presence: true, if: ->(n) { n.owner_required? } validates :name, presence: true, length: { maximum: 255 } validates :name, uniqueness: { scope: [:type, :parent_id] }, if: -> { parent_id.present? } validates :description, length: { maximum: 255 } validates :path, presence: true, length: { maximum: URL_MAX_LENGTH } validates :path, namespace_path: true, if: ->(n) { !n.project_namespace? } # Project path validator is used for project namespaces for now to assure # compatibility with project paths # Issue: https://gitlab.com/gitlab-org/gitlab/-/issues/341764 validates :path, project_path: true, if: ->(n) { n.project_namespace? } # Introduce minimal path length of 2 characters. # Allow change of other attributes without forcing users to # rename their user or group. At the same time prevent changing # the path without complying with new 2 chars requirement. # Issue https://gitlab.com/gitlab-org/gitlab/-/issues/225214 # # For ProjectNamespace we don't check minimal path length to keep # compatibility with existing project restrictions. # Issue: https://gitlab.com/gitlab-org/gitlab/-/issues/341764 validates :path, length: { minimum: 2 }, if: :enforce_minimum_path_length? validates :max_artifacts_size, numericality: { only_integer: true, greater_than: 0, allow_nil: true } validate :validate_parent_type # ProjectNamespaces excluded as they are not meant to appear in the group hierarchy at the moment. validate :nesting_level_allowed, unless: -> { project_namespace? } validate :changing_shared_runners_enabled_is_allowed, unless: -> { project_namespace? } validate :changing_allow_descendants_override_disabled_shared_runners_is_allowed, unless: -> { project_namespace? } delegate :name, to: :owner, allow_nil: true, prefix: true delegate :avatar_url, to: :owner, allow_nil: true delegate :prevent_sharing_groups_outside_hierarchy, :prevent_sharing_groups_outside_hierarchy=, to: :namespace_settings, allow_nil: true delegate :show_diff_preview_in_email, :show_diff_preview_in_email?, :show_diff_preview_in_email=, to: :namespace_settings delegate :runner_registration_enabled, :runner_registration_enabled?, :runner_registration_enabled=, to: :namespace_settings delegate :allow_runner_registration_token, :allow_runner_registration_token?, :allow_runner_registration_token=, to: :namespace_settings delegate :maven_package_requests_forwarding, :pypi_package_requests_forwarding, :npm_package_requests_forwarding, to: :package_settings before_save :update_new_emails_created_column, if: -> { emails_disabled_changed? } before_create :sync_share_with_group_lock_with_parent before_update :sync_share_with_group_lock_with_parent, if: :parent_changed? after_update :force_share_with_group_lock_on_descendants, if: -> { saved_change_to_share_with_group_lock? && share_with_group_lock? } after_update :expire_first_auto_devops_config_cache, if: -> { saved_change_to_auto_devops_enabled? } after_update :move_dir, if: :saved_change_to_path_or_parent?, unless: -> { is_a?(Namespaces::ProjectNamespace) } after_destroy :rm_dir after_save :reload_namespace_details after_commit :refresh_access_of_projects_invited_groups, on: :update, if: -> { previous_changes.key?('share_with_group_lock') } after_sync_traversal_ids :schedule_sync_event_worker # custom callback defined in Namespaces::Traversal::Linear # Legacy Storage specific hooks before_destroy(prepend: true) { prepare_for_destroy } after_commit :expire_child_caches, on: :update, if: -> { Feature.enabled?(:cached_route_lookups, self, type: :ops) && saved_change_to_name? || saved_change_to_path? || saved_change_to_parent_id? } scope :user_namespaces, -> { where(type: Namespaces::UserNamespace.sti_name) } scope :without_project_namespaces, -> { where(Namespace.arel_table[:type].not_eq(Namespaces::ProjectNamespace.sti_name)) } scope :sort_by_type, -> { order(arel_table[:type].asc.nulls_first) } scope :include_route, -> { includes(:route) } scope :by_parent, -> (parent) { where(parent_id: parent) } scope :filter_by_path, -> (query) { where('lower(path) = :query', query: query.downcase) } scope :with_statistics, -> do joins('LEFT JOIN project_statistics ps ON ps.namespace_id = namespaces.id') .group('namespaces.id') .select( 'namespaces.*', 'COALESCE(SUM(ps.storage_size), 0) AS storage_size', 'COALESCE(SUM(ps.repository_size), 0) AS repository_size', 'COALESCE(SUM(ps.wiki_size), 0) AS wiki_size', 'COALESCE(SUM(ps.snippets_size), 0) AS snippets_size', 'COALESCE(SUM(ps.lfs_objects_size), 0) AS lfs_objects_size', 'COALESCE(SUM(ps.build_artifacts_size), 0) AS build_artifacts_size', 'COALESCE(SUM(ps.pipeline_artifacts_size), 0) AS pipeline_artifacts_size', 'COALESCE(SUM(ps.packages_size), 0) AS packages_size', 'COALESCE(SUM(ps.uploads_size), 0) AS uploads_size' ) end scope :sorted_by_similarity_and_parent_id_desc, -> (search) do order_expression = Gitlab::Database::SimilarityScore.build_expression( search: search, rules: [ { column: arel_table["path"], multiplier: 1 }, { column: arel_table["name"], multiplier: 0.7 } ]) reorder(order_expression.desc, Namespace.arel_table['parent_id'].desc.nulls_last, Namespace.arel_table['id'].desc) end scope :with_shared_runners_enabled, -> { where(shared_runners_enabled: true) } # Make sure that the name is same as strong_memoize name in root_ancestor # method attr_writer :root_ancestor, :emails_disabled_memoized class << self def sti_class_for(type_name) case type_name when Group.sti_name Group when Namespaces::ProjectNamespace.sti_name Namespaces::ProjectNamespace when Namespaces::UserNamespace.sti_name Namespaces::UserNamespace else Namespace end end def by_path(path) find_by('lower(path) = :value', value: path.downcase) end # Case insensitive search for namespace by path or name def find_by_path_or_name(path) find_by("lower(path) = :path OR lower(name) = :path", path: path.downcase) end # Searches for namespaces matching the given query. # # This method uses ILIKE on PostgreSQL. # # query - The search query as a String. # # Returns an ActiveRecord::Relation. def search(query, include_parents: false) if include_parents without_project_namespaces.where(id: Route.for_routable_type(Namespace.name).fuzzy_search(query, [Route.arel_table[:path], Route.arel_table[:name]]).select(:source_id)) else without_project_namespaces.fuzzy_search(query, [:path, :name]) end end def clean_path(path, limited_to: Namespace.all) slug = Gitlab::Slug::Path.new(path).generate path = Namespaces::RandomizedSuffixPath.new(slug) Uniquify.new.string(path) { |s| limited_to.find_by_path_or_name(s) } end def clean_name(value) value.scan(Gitlab::Regex.group_name_regex_chars).join(' ') end def find_by_pages_host(host) gitlab_host = "." + Settings.pages.host.downcase host = host.downcase return unless host.ends_with?(gitlab_host) name = host.delete_suffix(gitlab_host) Namespace.top_most.by_path(name) end def top_most by_parent(nil) end end def package_settings package_setting_relation || build_package_setting_relation end def default_branch_protection super || Gitlab::CurrentSettings.default_branch_protection end def visibility_level_field :visibility_level end def to_param full_path end def human_name owner_name end def any_project_has_container_registry_tags? all_projects.includes(:container_repositories).any?(&:has_container_registry_tags?) end def first_project_with_container_registry_tags all_projects.find(&:has_container_registry_tags?) end def send_update_instructions projects.each do |project| project.send_move_instructions("#{full_path_before_last_save}/#{project.path}") end end def kind return 'group' if group_namespace? return 'project' if project_namespace? 'user' # defaults to user end def group_namespace? type == Group.sti_name end def project_namespace? type == Namespaces::ProjectNamespace.sti_name end def user_namespace? # That last bit ensures we're considered a user namespace as a default type.nil? || type == Namespaces::UserNamespace.sti_name || !(group_namespace? || project_namespace?) end def bot_user_namespace? return false unless user_namespace? return false unless owner && owner.bot? true end def owner_required? user_namespace? end def first_owner owner end def find_fork_of(project) return unless project.fork_network if Gitlab::SafeRequestStore.active? forks_in_namespace = Gitlab::SafeRequestStore.fetch("namespaces:#{id}:forked_projects") do Hash.new do |found_forks, project| found_forks[project] = project.fork_network.find_forks_in(projects).first end end forks_in_namespace[project] else project.fork_network.find_forks_in(projects).first end end # any ancestor can disable emails for all descendants def emails_disabled? strong_memoize(:emails_disabled_memoized) do if parent_id self_and_ancestors.where(emails_disabled: true).exists? else !!emails_disabled end end end def emails_enabled? !emails_disabled? end def lfs_enabled? # User namespace will always default to the global setting Gitlab.config.lfs.enabled end def any_project_with_shared_runners_enabled? projects.with_shared_runners_enabled.any? end def user_ids_for_project_authorizations [owner_id] end # Includes projects from this namespace and projects from all subgroups # that belongs to this namespace def all_projects if Feature.enabled?(:recursive_approach_for_all_projects) namespace = user_namespace? ? self : self_and_descendant_ids Project.where(namespace: namespace) else Project.inside_path(full_path) end end def has_parent? parent_id.present? || parent.present? end def subgroup? has_parent? end # Overridden on EE module def multiple_issue_boards_available? false end def all_project_ids_except(ids) all_projects.where.not(id: ids).pluck(:id) end # Deprecated, use #licensed_feature_available? instead. Remove once Namespace#feature_available? isn't used anymore. def feature_available?(feature, _user = nil) licensed_feature_available?(feature) end # Overridden in EE::Namespace def licensed_feature_available?(_feature) false end def full_path_before_last_save if parent_id_before_last_save.nil? path_before_last_save else previous_parent = Group.find_by(id: parent_id_before_last_save) previous_parent.full_path + '/' + path_before_last_save end end def refresh_project_authorizations owner.refresh_authorized_projects end def auto_devops_enabled? first_auto_devops_config[:status] end def first_auto_devops_config return { scope: :group, status: auto_devops_enabled } unless auto_devops_enabled.nil? strong_memoize(:first_auto_devops_config) do if has_parent? Rails.cache.fetch(first_auto_devops_config_cache_key_for(id), expires_in: 1.day) do parent.first_auto_devops_config end else { scope: :instance, status: Gitlab::CurrentSettings.auto_devops_enabled? } end end end def aggregation_scheduled? aggregation_schedule.present? end def container_repositories_size_cache_key "namespaces:#{id}:container_repositories_size" end def container_repositories_size strong_memoize(:container_repositories_size) do next unless Gitlab.com? next unless root? next unless ContainerRegistry::GitlabApiClient.supports_gitlab_api? next 0 if all_container_repositories.empty? next unless all_container_repositories.all_migrated? Rails.cache.fetch(container_repositories_size_cache_key, expires_in: 7.days) do ContainerRegistry::GitlabApiClient.deduplicated_size(full_path) end end end def all_container_repositories ContainerRepository.for_project_id(all_projects) end def pages_virtual_domain cache = if Feature.enabled?(:cache_pages_domain_api, root_ancestor) ::Gitlab::Pages::CacheControl.for_namespace(root_ancestor.id) end Pages::VirtualDomain.new( projects: all_projects_with_pages.includes(:route, :project_feature, pages_metadatum: :pages_deployment), trim_prefix: full_path, cache: cache ) end def any_project_with_pages_deployed? all_projects.with_pages_deployed.any? end def closest_setting(name) self_and_ancestors(hierarchy_order: :asc) .find { |n| !n.read_attribute(name).nil? } .try(name) end def actual_plan Plan.default end def paid? root? && actual_plan.paid? end def prevent_delete? paid? end def actual_limits # We default to PlanLimits.new otherwise a lot of specs would fail # On production each plan should already have associated limits record # https://gitlab.com/gitlab-org/gitlab/issues/36037 actual_plan.actual_limits end def actual_plan_name actual_plan.name end def changing_shared_runners_enabled_is_allowed return unless new_record? || changes.has_key?(:shared_runners_enabled) if shared_runners_enabled && has_parent? && parent.shared_runners_setting == SR_DISABLED_AND_UNOVERRIDABLE errors.add(:shared_runners_enabled, _('cannot be enabled because parent group has shared Runners disabled')) end end def changing_allow_descendants_override_disabled_shared_runners_is_allowed return unless new_record? || changes.has_key?(:allow_descendants_override_disabled_shared_runners) if shared_runners_enabled && !new_record? errors.add(:allow_descendants_override_disabled_shared_runners, _('cannot be changed if shared runners are enabled')) end if allow_descendants_override_disabled_shared_runners && has_parent? && parent.shared_runners_setting == SR_DISABLED_AND_UNOVERRIDABLE errors.add(:allow_descendants_override_disabled_shared_runners, _('cannot be enabled because parent group does not allow it')) end end def shared_runners_setting if shared_runners_enabled SR_ENABLED elsif allow_descendants_override_disabled_shared_runners SR_DISABLED_AND_OVERRIDABLE else SR_DISABLED_AND_UNOVERRIDABLE end end def shared_runners_setting_higher_than?(other_setting) case other_setting when SR_ENABLED false when SR_DISABLED_WITH_OVERRIDE, SR_DISABLED_AND_OVERRIDABLE shared_runners_setting == SR_ENABLED when SR_DISABLED_AND_UNOVERRIDABLE shared_runners_setting == SR_ENABLED || shared_runners_setting == SR_DISABLED_AND_OVERRIDABLE || shared_runners_setting == SR_DISABLED_WITH_OVERRIDE else raise ArgumentError end end def shared_runners @shared_runners ||= shared_runners_enabled ? Ci::Runner.instance_type : Ci::Runner.none end def root? !has_parent? end def recent? created_at >= 90.days.ago end def issue_repositioning_disabled? Feature.enabled?(:block_issue_repositioning, self, type: :ops) end def storage_enforcement_date return Date.current if Feature.enabled?(:namespace_storage_limit_bypass_date_check, self) MIN_STORAGE_ENFORCEMENT_DATE end def certificate_based_clusters_enabled? cluster_enabled_granted? || certificate_based_clusters_enabled_ff? end def enabled_git_access_protocol # If the instance-level setting is enabled, we defer to that return ::Gitlab::CurrentSettings.enabled_git_access_protocol unless ::Gitlab::CurrentSettings.enabled_git_access_protocol.blank? # Otherwise we use the stored setting on the group namespace_settings&.enabled_git_access_protocol end def all_ancestors_have_runner_registration_enabled? namespace_settings&.all_ancestors_have_runner_registration_enabled? end private def update_new_emails_created_column return if namespace_settings.nil? return if namespace_settings.emails_enabled == !emails_disabled if namespace_settings.persisted? namespace_settings.update!(emails_enabled: !emails_disabled) elsif namespace_settings namespace_settings.emails_enabled = !emails_disabled end end def cluster_enabled_granted? (Gitlab.com? || Gitlab.dev_or_test_env?) && root_ancestor.cluster_enabled_grant.present? end def certificate_based_clusters_enabled_ff? Feature.enabled?(:certificate_based_clusters, type: :ops) end def expire_child_caches Namespace.where(id: descendants).each_batch do |namespaces| namespaces.touch_all end all_projects.each_batch do |projects| projects.touch_all end end def all_projects_with_pages all_projects.with_pages_deployed end def parent_changed? parent_id_changed? end def saved_change_to_parent? saved_change_to_parent_id? end def saved_change_to_path_or_parent? saved_change_to_path? || saved_change_to_parent_id? end def refresh_access_of_projects_invited_groups if Feature.enabled?(:specialized_worker_for_group_lock_update_auth_recalculation) Project .where(namespace_id: id) .joins(:project_group_links) .distinct .find_each do |project| AuthorizedProjectUpdate::ProjectRecalculateWorker.perform_async(project.id) end # Until we compare the inconsistency rates of the new specialized worker and # the old approach, we still run AuthorizedProjectsWorker # but with some delay and lower urgency as a safety net. enqueue_jobs_for_groups_requiring_authorizations_refresh(priority: UserProjectAccessChangedService::LOW_PRIORITY) else enqueue_jobs_for_groups_requiring_authorizations_refresh(priority: UserProjectAccessChangedService::HIGH_PRIORITY) end end def enqueue_jobs_for_groups_requiring_authorizations_refresh(priority:) groups_requiring_authorizations_refresh = Group .joins(project_group_links: :project) .where(projects: { namespace_id: id }) .distinct groups_requiring_authorizations_refresh.find_each do |group| group.refresh_members_authorized_projects( priority: priority ) end end def nesting_level_allowed if ancestors.count > Group::NUMBER_OF_ANCESTORS_ALLOWED errors.add(:parent_id, _('has too deep level of nesting')) end end def validate_parent_type unless has_parent? if project_namespace? errors.add(:parent_id, _('must be set for a project namespace')) end return end if parent&.project_namespace? errors.add(:parent_id, _('project namespace cannot be the parent of another namespace')) end if user_namespace? errors.add(:parent_id, _('cannot be used for user namespace')) elsif group_namespace? errors.add(:parent_id, _('user namespace cannot be the parent of another namespace')) if parent.user_namespace? end end def reload_namespace_details return unless !project_namespace? && (previous_changes.keys & %w(description description_html cached_markdown_version)).any? && namespace_details.present? namespace_details.reset end def sync_share_with_group_lock_with_parent if parent&.share_with_group_lock? self.share_with_group_lock = true end end def force_share_with_group_lock_on_descendants # We can't use `descendants.update_all` since Rails will throw away the WITH # RECURSIVE statement. We also can't use WHERE EXISTS since we can't use # different table aliases, hence we're just using WHERE IN. Since we have a # maximum of 20 nested groups this should be fine. Namespace.where(id: descendants.select(:id)) .update_all(share_with_group_lock: true) end def expire_first_auto_devops_config_cache descendants_to_expire = self_and_descendants.as_ids return if descendants_to_expire.load.empty? keys = descendants_to_expire.map { |group| first_auto_devops_config_cache_key_for(group.id) } Rails.cache.delete_multi(keys) end def write_projects_repository_config all_projects.find_each do |project| project.set_full_path project.track_project_repository end end def enforce_minimum_path_length? path_changed? && !project_namespace? end # SyncEvents are created by PG triggers (with the function `insert_namespaces_sync_event`) def schedule_sync_event_worker run_after_commit do Namespaces::SyncEvent.enqueue_worker end end def first_auto_devops_config_cache_key_for(group_id) # Use SHA2 of `traversal_ids` to account for moving a namespace within the same root ancestor hierarchy. "namespaces:{#{traversal_ids.first}}:first_auto_devops_config:#{group_id}:#{Digest::SHA2.hexdigest(traversal_ids.join(' '))}" end end Namespace.prepend_mod_with('Namespace')