# frozen_string_literal: true class ProjectFeature < ApplicationRecord # == Project features permissions # # Grants access level to project tools # # Tools can be enabled only for users, everyone or disabled # Access control is made only for non private projects # # levels: # # Disabled: not enabled for anyone # Private: enabled only for team members # Enabled: enabled for everyone able to access the project # Public: enabled for everyone (only allowed for pages) # # Permission levels DISABLED = 0 PRIVATE = 10 ENABLED = 20 PUBLIC = 30 FEATURES = %i(issues merge_requests wiki snippets builds repository pages).freeze PRIVATE_FEATURES_MIN_ACCESS_LEVEL = { merge_requests: Gitlab::Access::REPORTER }.freeze PRIVATE_FEATURES_MIN_ACCESS_LEVEL_FOR_PRIVATE_PROJECT = { repository: Gitlab::Access::REPORTER }.freeze STRING_OPTIONS = HashWithIndifferentAccess.new({ 'disabled' => DISABLED, 'private' => PRIVATE, 'enabled' => ENABLED, 'public' => PUBLIC }).freeze class << self def access_level_attribute(feature) feature = ensure_feature!(feature) "#{feature}_access_level".to_sym end def quoted_access_level_column(feature) attribute = connection.quote_column_name(access_level_attribute(feature)) table = connection.quote_table_name(table_name) "#{table}.#{attribute}" end def required_minimum_access_level(feature) feature = ensure_feature!(feature) PRIVATE_FEATURES_MIN_ACCESS_LEVEL.fetch(feature, Gitlab::Access::GUEST) end # Guest users can perform certain features on public and internal projects, but not private projects. def required_minimum_access_level_for_private_project(feature) feature = ensure_feature!(feature) PRIVATE_FEATURES_MIN_ACCESS_LEVEL_FOR_PRIVATE_PROJECT.fetch(feature) do required_minimum_access_level(feature) end end def access_level_from_str(level) STRING_OPTIONS.fetch(level) end def str_from_access_level(level) STRING_OPTIONS.key(level) end private def ensure_feature!(feature) feature = feature.model_name.plural if feature.respond_to?(:model_name) feature = feature.to_sym raise ArgumentError, "invalid project feature: #{feature}" unless FEATURES.include?(feature) feature end end # Default scopes force us to unscope here since a service may need to check # permissions for a project in pending_delete # http://stackoverflow.com/questions/1540645/how-to-disable-default-scope-for-a-belongs-to belongs_to :project, -> { unscope(where: :pending_delete) } validates :project, presence: true validate :repository_children_level validate :allowed_access_levels default_value_for :builds_access_level, value: ENABLED, allows_nil: false default_value_for :issues_access_level, value: ENABLED, allows_nil: false default_value_for :merge_requests_access_level, value: ENABLED, allows_nil: false default_value_for :snippets_access_level, value: ENABLED, allows_nil: false default_value_for :wiki_access_level, value: ENABLED, allows_nil: false default_value_for :repository_access_level, value: ENABLED, allows_nil: false default_value_for(:pages_access_level, allows_nil: false) do |feature| if ::Gitlab::Pages.access_control_is_forced? PRIVATE else feature.project&.public? ? ENABLED : PRIVATE end end def feature_available?(feature, user) # This feature might not be behind a feature flag at all, so default to true return false unless ::Feature.enabled?(feature, user, default_enabled: true) get_permission(user, feature) end def access_level(feature) public_send(ProjectFeature.access_level_attribute(feature)) # rubocop:disable GitlabSecurity/PublicSend end def string_access_level(feature) ProjectFeature.str_from_access_level(access_level(feature)) end def builds_enabled? builds_access_level > DISABLED end def wiki_enabled? wiki_access_level > DISABLED end def merge_requests_enabled? merge_requests_access_level > DISABLED end def issues_enabled? issues_access_level > DISABLED end def pages_enabled? pages_access_level > DISABLED end def public_pages? return true unless Gitlab.config.pages.access_control return false if ::Gitlab::Pages.access_control_is_forced? pages_access_level == PUBLIC || pages_access_level == ENABLED && project.public? end def private_pages? !public_pages? end private # Validates builds and merge requests access level # which cannot be higher than repository access level def repository_children_level validator = lambda do |field| level = public_send(field) || ProjectFeature::ENABLED # rubocop:disable GitlabSecurity/PublicSend not_allowed = level > repository_access_level self.errors.add(field, "cannot have higher visibility level than repository access level") if not_allowed end %i(merge_requests_access_level builds_access_level).each(&validator) end # Validates access level for other than pages cannot be PUBLIC def allowed_access_levels validator = lambda do |field| level = public_send(field) || ProjectFeature::ENABLED # rubocop:disable GitlabSecurity/PublicSend not_allowed = level > ProjectFeature::ENABLED self.errors.add(field, "cannot have public visibility level") if not_allowed end (FEATURES - %i(pages)).each {|f| validator.call("#{f}_access_level")} end def get_permission(user, feature) case access_level(feature) when DISABLED false when PRIVATE team_access?(user, feature) when ENABLED true when PUBLIC true else true end end def team_access?(user, feature) return unless user return true if user.can_read_all_resources? project.team.member?(user, ProjectFeature.required_minimum_access_level(feature)) end end ProjectFeature.prepend_if_ee('EE::ProjectFeature')