application_setting.rb 14.3 KB
Newer Older
1
class ApplicationSetting < ActiveRecord::Base
2
  include CacheMarkdownField
3
  include TokenAuthenticatable
4

5
  add_authentication_token_field :runners_registration_token
6
  add_authentication_token_field :health_check_access_token
7

Douwe Maan's avatar
Douwe Maan committed
8
  CACHE_KEY = 'application_setting.last'.freeze
9 10 11 12 13 14
  DOMAIN_LIST_SEPARATOR = %r{\s*[,;]\s*     # comma or semicolon, optionally surrounded by whitespace
                            |               # or
                            \s              # any whitespace character
                            |               # or
                            [\r\n]          # any number of newline characters
                          }x
15

16 17
  # Setting a key restriction to `-1` means that all keys of this type are
  # forbidden.
18
  FORBIDDEN_KEY_VALUE = KeyRestrictionValidator::FORBIDDEN
19 20
  SUPPORTED_KEY_TYPES = %i[rsa dsa ecdsa ed25519].freeze

21 22 23 24 25 26 27
  serialize :restricted_visibility_levels # rubocop:disable Cop/ActiveRecordSerialize
  serialize :import_sources # rubocop:disable Cop/ActiveRecordSerialize
  serialize :disabled_oauth_sign_in_sources, Array # rubocop:disable Cop/ActiveRecordSerialize
  serialize :domain_whitelist, Array # rubocop:disable Cop/ActiveRecordSerialize
  serialize :domain_blacklist, Array # rubocop:disable Cop/ActiveRecordSerialize
  serialize :repository_storages # rubocop:disable Cop/ActiveRecordSerialize
  serialize :sidekiq_throttling_queues, Array # rubocop:disable Cop/ActiveRecordSerialize
28

29 30 31 32 33
  cache_markdown_field :sign_in_text
  cache_markdown_field :help_page_text
  cache_markdown_field :shared_runners_text, pipeline: :plain_markdown
  cache_markdown_field :after_sign_up_text

34
  attr_accessor :domain_whitelist_raw, :domain_blacklist_raw
35

36 37
  default_value_for :id, 1

38 39
  validates :uuid, presence: true

40
  validates :session_expire_delay,
41 42
            presence: true,
            numericality: { only_integer: true, greater_than_or_equal_to: 0 }
43

44
  validates :home_page_url,
45 46
            allow_blank: true,
            url: true,
47 48 49 50 51 52
            if: :home_page_url_column_exists?

  validates :help_page_support_url,
            allow_blank: true,
            url: true,
            if: :help_page_support_url_column_exists?
53

54
  validates :after_sign_out_path,
55 56
            allow_blank: true,
            url: true
57

58
  validates :admin_notification_email,
59
            email: true,
60
            allow_blank: true
61

62
  validates :two_factor_grace_period,
63 64 65 66 67 68 69 70 71
            numericality: { greater_than_or_equal_to: 0 }

  validates :recaptcha_site_key,
            presence: true,
            if: :recaptcha_enabled

  validates :recaptcha_private_key,
            presence: true,
            if: :recaptcha_enabled
72

Jeroen Nijhof's avatar
Jeroen Nijhof committed
73 74 75 76
  validates :sentry_dsn,
            presence: true,
            if: :sentry_enabled

77 78 79 80
  validates :clientside_sentry_dsn,
            presence: true,
            if: :clientside_sentry_enabled

81 82 83 84
  validates :akismet_api_key,
            presence: true,
            if: :akismet_enabled

85 86 87 88 89 90 91 92 93 94
  validates :unique_ips_limit_per_user,
            numericality: { greater_than_or_equal_to: 1 },
            presence: true,
            if: :unique_ips_limit_enabled

  validates :unique_ips_limit_time_window,
            numericality: { greater_than_or_equal_to: 0 },
            presence: true,
            if: :unique_ips_limit_enabled

95 96 97 98
  validates :koding_url,
            presence: true,
            if: :koding_enabled

99 100 101 102
  validates :plantuml_url,
            presence: true,
            if: :plantuml_enabled

103 104 105 106
  validates :max_attachment_size,
            presence: true,
            numericality: { only_integer: true, greater_than: 0 }

107 108 109 110
  validates :max_artifacts_size,
            presence: true,
            numericality: { only_integer: true, greater_than: 0 }

111
  validates :default_artifacts_expire_in, presence: true, duration: true
112

113 114 115 116
  validates :container_registry_token_expire_delay,
            presence: true,
            numericality: { only_integer: true, greater_than: 0 }

117 118
  validates :repository_storages, presence: true
  validate :check_repository_storages
119

120
  validates :enabled_git_access_protocol,
121
            inclusion: { in: %w(ssh http), allow_blank: true, allow_nil: true }
122

123
  validates :domain_blacklist,
124
            presence: { message: 'Domain blacklist cannot be empty if Blacklist is enabled.' },
125 126
            if: :domain_blacklist_enabled?

127 128 129 130 131 132 133 134 135
  validates :sidekiq_throttling_factor,
            numericality: { greater_than: 0, less_than: 1 },
            presence: { message: 'Throttling factor cannot be empty if Sidekiq Throttling is enabled.' },
            if: :sidekiq_throttling_enabled?

  validates :sidekiq_throttling_queues,
            presence: { message: 'Queues to throttle cannot be empty if Sidekiq Throttling is enabled.' },
            if: :sidekiq_throttling_enabled?

136 137 138 139 140 141
  validates :housekeeping_incremental_repack_period,
            presence: true,
            numericality: { only_integer: true, greater_than: 0 }

  validates :housekeeping_full_repack_period,
            presence: true,
142
            numericality: { only_integer: true, greater_than_or_equal_to: :housekeeping_incremental_repack_period }
143 144 145

  validates :housekeeping_gc_period,
            presence: true,
146
            numericality: { only_integer: true, greater_than_or_equal_to: :housekeeping_full_repack_period }
147

148 149 150 151
  validates :terminal_max_session_time,
            presence: true,
            numericality: { only_integer: true, greater_than_or_equal_to: 0 }

152 153 154 155
  validates :polling_interval_multiplier,
            presence: true,
            numericality: { greater_than_or_equal_to: 0 }

156
  SUPPORTED_KEY_TYPES.each do |type|
157
    validates :"#{type}_key_restriction", presence: true, key_restriction: { type: type }
158
  end
159

Nick Thomas's avatar
Nick Thomas committed
160 161
  validates :allowed_key_types, presence: true

162
  validates_each :restricted_visibility_levels do |record, attr, value|
163
    value&.each do |level|
164
      unless Gitlab::VisibilityLevel.options.value?(level)
165
        record.errors.add(attr, "'#{level}' is not a valid visibility level")
166 167 168 169
      end
    end
  end

170
  validates_each :import_sources do |record, attr, value|
171
    value&.each do |source|
172
      unless Gitlab::ImportSources.options.value?(source)
173
        record.errors.add(attr, "'#{source}' is not a import source")
174 175 176 177
      end
    end
  end

178
  validates_each :disabled_oauth_sign_in_sources do |record, attr, value|
179 180 181
    value&.each do |source|
      unless Devise.omniauth_providers.include?(source.to_sym)
        record.errors.add(attr, "'#{source}' is not an OAuth sign-in source")
182 183 184 185
      end
    end
  end

186
  before_validation :ensure_uuid!
187

188
  before_save :ensure_runners_registration_token
189
  before_save :ensure_health_check_access_token
190

191
  after_commit do
192
    Rails.cache.write(CACHE_KEY, self)
193 194
  end

195
  def self.current
196 197
    ensure_cache_setup

198
    Rails.cache.fetch(CACHE_KEY) do
199 200
      ApplicationSetting.last
    end
201 202 203
  rescue
    # Fall back to an uncached value if there are any problems (e.g. redis down)
    ApplicationSetting.last
204
  end
205

206
  def self.expire
207
    Rails.cache.delete(CACHE_KEY)
208 209
  rescue
    # Gracefully handle when Redis is not available. For example,
210
    # omnibus may fail here during gitlab:assets:compile.
211 212
  end

213
  def self.cached
214 215 216
    value = Rails.cache.read(CACHE_KEY)
    ensure_cache_setup if value.present?
    value
217 218
  end

219 220 221 222 223 224
  def self.ensure_cache_setup
    # This is a workaround for a Rails bug that causes attribute methods not
    # to be loaded when read from cache: https://github.com/rails/rails/issues/27348
    ApplicationSetting.define_attribute_methods
  end

225
  def self.defaults
226 227 228 229
    {
      after_sign_up_text: nil,
      akismet_enabled: false,
      container_registry_token_expire_delay: 5,
230
      default_artifacts_expire_in: '30 days',
231 232 233 234
      default_branch_protection: Settings.gitlab['default_branch_protection'],
      default_project_visibility: Settings.gitlab.default_projects_features['visibility_level'],
      default_projects_limit: Settings.gitlab['default_projects_limit'],
      default_snippet_visibility: Settings.gitlab.default_projects_features['visibility_level'],
235
      default_group_visibility: Settings.gitlab.default_projects_features['visibility_level'],
236 237
      disabled_oauth_sign_in_sources: [],
      domain_whitelist: Settings.gitlab['domain_whitelist'],
238 239 240
      dsa_key_restriction: 0,
      ecdsa_key_restriction: 0,
      ed25519_key_restriction: 0,
241 242
      gravatar_enabled: Settings.gravatar['enabled'],
      help_page_text: nil,
243
      help_page_hide_commercial_content: false,
244 245 246
      unique_ips_limit_per_user: 10,
      unique_ips_limit_time_window: 3600,
      unique_ips_limit_enabled: false,
247 248 249 250 251
      housekeeping_bitmaps_enabled: true,
      housekeeping_enabled: true,
      housekeeping_full_repack_period: 50,
      housekeeping_gc_period: 200,
      housekeeping_incremental_repack_period: 10,
252
      import_sources: Settings.gitlab['import_sources'],
253 254 255 256
      koding_enabled: false,
      koding_url: nil,
      max_artifacts_size: Settings.artifacts['max_size'],
      max_attachment_size: Settings.gitlab['max_attachment_size'],
257
      password_authentication_enabled: Settings.gitlab['password_authentication_enabled'],
258
      performance_bar_allowed_group_id: nil,
259
      rsa_key_restriction: 0,
260 261
      plantuml_enabled: false,
      plantuml_url: nil,
262
      project_export_enabled: true,
263 264 265 266 267 268 269 270 271 272 273 274
      recaptcha_enabled: false,
      repository_checks_enabled: true,
      repository_storages: ['default'],
      require_two_factor_authentication: false,
      restricted_visibility_levels: Settings.gitlab['restricted_visibility_levels'],
      session_expire_delay: Settings.gitlab['session_expire_delay'],
      send_user_confirmation_email: false,
      shared_runners_enabled: Settings.gitlab_ci['shared_runners_enabled'],
      shared_runners_text: nil,
      sidekiq_throttling_enabled: false,
      sign_in_text: nil,
      signup_enabled: Settings.gitlab['signup_enabled'],
275
      terminal_max_session_time: 0,
276
      two_factor_grace_period: 48,
277
      user_default_external: false,
278
      polling_interval_multiplier: 1,
279
      usage_ping_enabled: Settings.gitlab['usage_ping_enabled']
280 281 282
    }
  end

283
  def self.create_from_defaults
284
    create(defaults)
285
  end
286

287 288 289 290 291 292 293 294
  def self.human_attribute_name(attr, _options = {})
    if attr == :default_artifacts_expire_in
      'Default artifacts expiration'
    else
      super
    end
  end

295
  def home_page_url_column_exists?
296 297
    ActiveRecord::Base.connection.column_exists?(:application_settings, :home_page_url)
  end
298

299 300 301 302
  def help_page_support_url_column_exists?
    ActiveRecord::Base.connection.column_exists?(:application_settings, :help_page_support_url)
  end

303 304 305 306
  def sidekiq_throttling_column_exists?
    ActiveRecord::Base.connection.column_exists?(:application_settings, :sidekiq_throttling_enabled)
  end

307
  def domain_whitelist_raw
308
    self.domain_whitelist&.join("\n")
309 310
  end

311
  def domain_blacklist_raw
312
    self.domain_blacklist&.join("\n")
313 314
  end

315 316 317 318 319
  def domain_whitelist_raw=(values)
    self.domain_whitelist = []
    self.domain_whitelist = values.split(DOMAIN_LIST_SEPARATOR)
    self.domain_whitelist.reject! { |d| d.empty? }
    self.domain_whitelist
320
  end
321

322 323
  def domain_blacklist_raw=(values)
    self.domain_blacklist = []
324
    self.domain_blacklist = values.split(DOMAIN_LIST_SEPARATOR)
325
    self.domain_blacklist.reject! { |d| d.empty? }
326
    self.domain_blacklist
327 328 329 330 331 332
  end

  def domain_blacklist_file=(file)
    self.domain_blacklist_raw = file.read
  end

333
  def repository_storages
334
    Array(read_attribute(:repository_storages))
335 336
  end

337
  # DEPRECATED
338
  # repository_storage is still required in the API. Remove in 9.0
339
  # Still used in API v3
340 341 342 343 344 345 346 347
  def repository_storage
    repository_storages.first
  end

  def repository_storage=(value)
    self.repository_storages = [value]
  end

348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363
  def default_project_visibility=(level)
    super(Gitlab::VisibilityLevel.level_value(level))
  end

  def default_snippet_visibility=(level)
    super(Gitlab::VisibilityLevel.level_value(level))
  end

  def default_group_visibility=(level)
    super(Gitlab::VisibilityLevel.level_value(level))
  end

  def restricted_visibility_levels=(levels)
    super(levels.map { |level| Gitlab::VisibilityLevel.level_value(level) })
  end

364
  def performance_bar_allowed_group_id=(group_full_path)
365 366 367 368 369 370 371 372 373 374
    group_full_path = nil if group_full_path.blank?

    if group_full_path.nil?
      if group_full_path != performance_bar_allowed_group_id
        super(group_full_path)
        Gitlab::PerformanceBar.expire_allowed_user_ids_cache
      end
      return
    end

375 376
    group = Group.find_by_full_path(group_full_path)

377 378 379 380 381 382 383 384 385
    if group
      if group.id != performance_bar_allowed_group_id
        super(group.id)
        Gitlab::PerformanceBar.expire_allowed_user_ids_cache
      end
    else
      super(nil)
      Gitlab::PerformanceBar.expire_allowed_user_ids_cache
    end
386 387 388 389 390 391
  end

  def performance_bar_allowed_group
    Group.find_by_id(performance_bar_allowed_group_id)
  end

392 393 394
  # Return true if the Performance Bar is enabled for a given group
  def performance_bar_enabled
    performance_bar_allowed_group_id.present?
395 396
  end

397 398 399
  # - If `enable` is true, we early return since the actual attribute that holds
  #   the enabling/disabling is `performance_bar_allowed_group_id`
  # - If `enable` is false, we set `performance_bar_allowed_group_id` to `nil`
400
  def performance_bar_enabled=(enable)
401
    return if enable
402

403
    self.performance_bar_allowed_group_id = nil
404 405
  end

406 407 408 409 410 411
  # Choose one of the available repository storage options. Currently all have
  # equal weighting.
  def pick_repository_storage
    repository_storages.sample
  end

412 413 414
  def runners_registration_token
    ensure_runners_registration_token!
  end
415 416 417 418

  def health_check_access_token
    ensure_health_check_access_token!
  end
419

420 421 422 423 424 425
  def sidekiq_throttling_enabled?
    return false unless sidekiq_throttling_column_exists?

    sidekiq_throttling_enabled
  end

426 427 428 429 430 431 432 433
  def usage_ping_can_be_configured?
    Settings.gitlab.usage_ping_enabled
  end

  def usage_ping_enabled
    usage_ping_can_be_configured? && super
  end

434 435 436 437 438 439 440 441 442
  def allowed_key_types
    SUPPORTED_KEY_TYPES.select do |type|
      key_restriction_for(type) != FORBIDDEN_KEY_VALUE
    end
  end

  def key_restriction_for(type)
    attr_name = "#{type}_key_restriction"

Nick Thomas's avatar
Nick Thomas committed
443
    has_attribute?(attr_name) ? public_send(attr_name) : FORBIDDEN_KEY_VALUE # rubocop:disable GitlabSecurity/PublicSend
444 445
  end

446 447
  private

448 449 450 451 452 453
  def ensure_uuid!
    return if uuid?

    self.uuid = SecureRandom.uuid
  end

454 455 456 457 458
  def check_repository_storages
    invalid = repository_storages - Gitlab.config.repositories.storages.keys
    errors.add(:repository_storages, "can't include: #{invalid.join(", ")}") unless
      invalid.empty?
  end
459
end