Module: ApplicationSettingsHelper

Extended by:
ApplicationSettingsHelper
Included in:
ApplicationSettingsHelper, GitlabRoutingHelper, MergeRequestWidgetEntity
Defined in:
app/helpers/application_settings_helper.rb

Instance Method Summary collapse

Instance Method Details

#all_protocols_enabled?Boolean

Returns:

  • (Boolean)

51
52
53
# File 'app/helpers/application_settings_helper.rb', line 51

def all_protocols_enabled?
  Gitlab::CurrentSettings.enabled_git_access_protocol.blank?
end

#allowed_protocols_present?Boolean

Returns:

  • (Boolean)

16
17
18
# File 'app/helpers/application_settings_helper.rb', line 16

def allowed_protocols_present?
  Gitlab::CurrentSettings.enabled_git_access_protocol.present?
end

#deprecated_attributesObject

ok to remove in REST API v5


447
448
449
450
451
452
# File 'app/helpers/application_settings_helper.rb', line 447

def deprecated_attributes
  [
    :admin_notification_email,
    :asset_proxy_whitelist
  ]
end

#enabled_protocolObject


20
21
22
23
24
25
26
27
# File 'app/helpers/application_settings_helper.rb', line 20

def enabled_protocol
  case Gitlab::CurrentSettings.enabled_git_access_protocol
  when 'http'
    Gitlab.config.gitlab.protocol
  when 'ssh'
    'ssh'
  end
end

#enabled_protocol_button(container, protocol) ⇒ Object


63
64
65
66
67
68
69
70
# File 'app/helpers/application_settings_helper.rb', line 63

def enabled_protocol_button(container, protocol)
  case protocol
  when 'ssh'
    ssh_clone_button(container, append_link: false)
  else
    http_clone_button(container, append_link: false)
  end
end

#expanded_by_default?Boolean

Returns:

  • (Boolean)

454
455
456
# File 'app/helpers/application_settings_helper.rb', line 454

def expanded_by_default?
  Rails.env.test?
end

#external_authorization_client_certificate_help_textObject


154
155
156
157
# File 'app/helpers/application_settings_helper.rb', line 154

def external_authorization_client_certificate_help_text
  s_("ExternalAuthorization|Certificate used to authenticate with the external authorization service. "\
      "If blank, the server certificate is validated when accessing over HTTPS.")
end

#external_authorization_client_key_help_textObject


159
160
161
162
# File 'app/helpers/application_settings_helper.rb', line 159

def external_authorization_client_key_help_text
  s_("ExternalAuthorization|Private key of client authentication certificate. "\
      "Encrypted when stored.")
end

#external_authorization_client_pass_help_textObject


164
165
166
167
# File 'app/helpers/application_settings_helper.rb', line 164

def external_authorization_client_pass_help_text
  s_("ExternalAuthorization|Passphrase required to decrypt the private key. "\
      "Encrypted when stored.")
end

#external_authorization_client_url_help_textObject


169
170
171
172
# File 'app/helpers/application_settings_helper.rb', line 169

def external_authorization_client_url_help_text
  s_("ExternalAuthorization|Classification label to use when requesting authorization if no specific "\
    " label is defined on the project.")
end

#external_authorization_descriptionObject


138
139
140
141
# File 'app/helpers/application_settings_helper.rb', line 138

def external_authorization_description
  s_("ExternalAuthorization|Access to projects is validated on an external service"\
      " using their classification label.")
end

#external_authorization_service_attributesObject


434
435
436
437
438
439
440
441
442
443
444
# File 'app/helpers/application_settings_helper.rb', line 434

def external_authorization_service_attributes
  [
    :external_auth_client_cert,
    :external_auth_client_key,
    :external_auth_client_key_pass,
    :external_authorization_service_default_label,
    :external_authorization_service_enabled,
    :external_authorization_service_timeout,
    :external_authorization_service_url
  ]
end

#external_authorization_timeout_help_textObject


143
144
145
146
# File 'app/helpers/application_settings_helper.rb', line 143

def external_authorization_timeout_help_text
  s_("ExternalAuthorization|Period GitLab waits for a response from the external "\
      "service. If there is no response, access is denied. Default: 0.5 seconds.")
end

#external_authorization_url_help_textObject


148
149
150
151
152
# File 'app/helpers/application_settings_helper.rb', line 148

def external_authorization_url_help_text
  s_("ExternalAuthorization|URL to which the projects make authorization requests. If the URL is blank, cross-project "\
    "features are available and can still specify classification "\
    "labels for projects.")
end

#http_enabled?Boolean

Returns:

  • (Boolean)

59
60
61
# File 'app/helpers/application_settings_helper.rb', line 59

def http_enabled?
  all_protocols_enabled? || Gitlab::CurrentSettings.enabled_git_access_protocol == 'http'
end

#import_sources_checkboxes(form) ⇒ Object


86
87
88
89
90
91
92
93
94
95
96
97
98
# File 'app/helpers/application_settings_helper.rb', line 86

def import_sources_checkboxes(form)
  Gitlab::ImportSources.options.map do |name, source|
    checked = @application_setting.import_sources.include?(source)

    form.gitlab_ui_checkbox_component(
      :import_sources,
      name,
      checkbox_options: { checked: checked, multiple: true, autocomplete: 'off' },
      checked_value: source,
      unchecked_value: nil
    )
  end
end

#instance_clusters_enabled?Boolean

Returns:

  • (Boolean)

462
463
464
465
466
467
# File 'app/helpers/application_settings_helper.rb', line 462

def instance_clusters_enabled?
  clusterable = Clusters::Instance.new

  clusterable.certificate_based_clusters_enabled? &&
    can?(current_user, :read_cluster, clusterable)
end

#integration_expanded?(substring) ⇒ Boolean

Returns:

  • (Boolean)

458
459
460
# File 'app/helpers/application_settings_helper.rb', line 458

def integration_expanded?(substring)
  @application_setting.errors.messages.any? { |k, _| k.to_s.start_with?(substring) }
end

#key_restriction_options_for_select(type) ⇒ Object


115
116
117
118
119
120
121
122
123
124
125
# File 'app/helpers/application_settings_helper.rb', line 115

def key_restriction_options_for_select(type)
  bit_size_options = Gitlab::SSHPublicKey.supported_sizes(type).map do |bits|
    ["Must be at least #{bits} bits", bits]
  end

  [
    ['Are allowed', 0],
    *bit_size_options,
    ['Are forbidden', ApplicationSetting::FORBIDDEN_KEY_VALUE]
  ]
end

#kroki_available_formatsObject


29
30
31
32
33
34
35
36
37
# File 'app/helpers/application_settings_helper.rb', line 29

def kroki_available_formats
  ApplicationSetting.kroki_formats_attributes.map do |key, value|
    {
      name: "kroki_formats_#{key}",
      label: value[:label],
      value: @application_setting.kroki_formats[key] || false
    }
  end
end

#oauth_providers_checkboxes(form) ⇒ Object


100
101
102
103
104
105
106
107
108
109
110
111
112
113
# File 'app/helpers/application_settings_helper.rb', line 100

def oauth_providers_checkboxes(form)
  button_based_providers.map do |source|
    checked = !@application_setting..include?(source.to_s)
    name = Gitlab::Auth::OAuth::Provider.label_for(source)

    form.gitlab_ui_checkbox_component(
      :enabled_oauth_sign_in_sources,
      name,
      checkbox_options: { checked: checked, multiple: true, autocomplete: 'off' },
      checked_value: source,
      unchecked_value: nil
    )
  end
end

#omnibus_protected_paths_throttle?Boolean

Returns:

  • (Boolean)

469
470
471
# File 'app/helpers/application_settings_helper.rb', line 469

def omnibus_protected_paths_throttle?
  Rack::Attack.throttles.key?('protected paths')
end

#pending_user_countObject


503
504
505
# File 'app/helpers/application_settings_helper.rb', line 503

def pending_user_count
  User.blocked_pending_approval.count
end

#registration_features_can_be_prompted?Boolean

Returns:

  • (Boolean)

507
508
509
# File 'app/helpers/application_settings_helper.rb', line 507

def registration_features_can_be_prompted?
  !Gitlab::CurrentSettings.usage_ping_enabled?
end

#repository_storages_options_jsonObject


127
128
129
130
131
132
133
134
135
136
# File 'app/helpers/application_settings_helper.rb', line 127

def repository_storages_options_json
  options = Gitlab.config.repositories.storages.map do |name, storage|
    {
      label: "#{name} - #{storage['gitaly_address']}",
      value: name
    }
  end

  options.to_json
end

#restricted_level_checkboxes(form) ⇒ Object


72
73
74
75
76
77
78
79
80
81
82
83
84
# File 'app/helpers/application_settings_helper.rb', line 72

def restricted_level_checkboxes(form)
  Gitlab::VisibilityLevel.values.map do |level|
    checked = restricted_visibility_levels(true).include?(level)

    form.gitlab_ui_checkbox_component(
      :restricted_visibility_levels,
      "#{visibility_level_icon(level)} #{visibility_level_label(level)}".html_safe,
      checkbox_options: { checked: checked, multiple: true, autocomplete: 'off' },
      checked_value: level,
      unchecked_value: nil
    )
  end
end

#self_monitoring_project_dataObject


473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
# File 'app/helpers/application_settings_helper.rb', line 473

def self_monitoring_project_data
  {
    'create_self_monitoring_project_path' =>
      create_self_monitoring_project_admin_application_settings_path,

    'status_create_self_monitoring_project_path' =>
      status_create_self_monitoring_project_admin_application_settings_path,

    'delete_self_monitoring_project_path' =>
      delete_self_monitoring_project_admin_application_settings_path,

    'status_delete_self_monitoring_project_path' =>
      status_delete_self_monitoring_project_admin_application_settings_path,

    'self_monitoring_project_exists' =>
      Gitlab::CurrentSettings.self_monitoring_project.present?.to_s,

    'self_monitoring_project_full_path' =>
      Gitlab::CurrentSettings.self_monitoring_project&.full_path
  }
end

#sidekiq_job_limiter_mode_help_textObject


174
175
176
177
178
# File 'app/helpers/application_settings_helper.rb', line 174

def sidekiq_job_limiter_mode_help_text
  _("How the job limiter handles jobs exceeding the thresholds specified below. "\
    "The 'track' mode only logs the jobs. The 'compress' mode compresses the jobs and "\
    "raises an exception if the compressed size exceeds the limit.")
end

#sidekiq_job_limiter_modes_for_selectObject


180
181
182
# File 'app/helpers/application_settings_helper.rb', line 180

def sidekiq_job_limiter_modes_for_select
  ApplicationSetting.sidekiq_job_limiter_modes.keys.map { |mode| [mode.humanize, mode] }
end

#signup_enabled?Boolean

Returns:

  • (Boolean)

499
500
501
# File 'app/helpers/application_settings_helper.rb', line 499

def 
  !!Gitlab::CurrentSettings.
end

#ssh_enabled?Boolean

Returns:

  • (Boolean)

55
56
57
# File 'app/helpers/application_settings_helper.rb', line 55

def ssh_enabled?
  all_protocols_enabled? || enabled_protocol == 'ssh'
end

#storage_weightsObject


39
40
41
42
43
44
45
46
47
48
49
# File 'app/helpers/application_settings_helper.rb', line 39

def storage_weights
  # Instead of using a `Struct` we could wrap this into an object.
  # See https://gitlab.com/gitlab-org/gitlab/-/issues/358419
  weights = Struct.new(*Gitlab.config.repositories.storages.keys.map(&:to_sym))

  values = Gitlab.config.repositories.storages.keys.map do |storage|
    @application_setting.repository_storages_weighted[storage] || 0
  end

  weights.new(*values)
end

#user_oauth_applications?Boolean

Returns:

  • (Boolean)

12
13
14
# File 'app/helpers/application_settings_helper.rb', line 12

def user_oauth_applications?
  Gitlab::CurrentSettings.user_oauth_applications
end

#valid_runner_registrarsObject


495
496
497
# File 'app/helpers/application_settings_helper.rb', line 495

def valid_runner_registrars
  Gitlab::CurrentSettings.valid_runner_registrars
end

#visible_attributesObject


184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
# File 'app/helpers/application_settings_helper.rb', line 184

def visible_attributes
  [
    :abuse_notification_email,
    :admin_mode,
    :after_sign_out_path,
    :after_sign_up_text,
    :akismet_api_key,
    :akismet_enabled,
    :allow_local_requests_from_hooks_and_services,
    :allow_local_requests_from_web_hooks_and_services,
    :allow_local_requests_from_system_hooks,
    :dns_rebinding_protection_enabled,
    :archive_builds_in_human_readable,
    :asset_proxy_enabled,
    :asset_proxy_secret_key,
    :asset_proxy_url,
    :asset_proxy_allowlist,
    :static_objects_external_storage_auth_token,
    :static_objects_external_storage_url,
    :authorized_keys_enabled,
    :auto_devops_enabled,
    :auto_devops_domain,
    :container_expiration_policies_enable_historic_entries,
    :container_registry_expiration_policies_caching,
    :container_registry_token_expire_delay,
    :default_artifacts_expire_in,
    :default_branch_name,
    :default_branch_protection,
    :default_ci_config_path,
    :default_group_visibility,
    :default_project_creation,
    :default_project_visibility,
    :default_projects_limit,
    :default_snippet_visibility,
    :delete_inactive_projects,
    :disable_feed_token,
    :disabled_oauth_sign_in_sources,
    :domain_denylist,
    :domain_denylist_enabled,
    # TODO Remove domain_denylist_raw in APIv5 (See https://gitlab.com/gitlab-org/gitlab-foss/issues/67204)
    :domain_denylist_raw,
    :domain_allowlist,
    # TODO Remove domain_allowlist_raw in APIv5 (See https://gitlab.com/gitlab-org/gitlab-foss/issues/67204)
    :domain_allowlist_raw,
    :outbound_local_requests_allowlist_raw,
    :dsa_key_restriction,
    :ecdsa_key_restriction,
    :ecdsa_sk_key_restriction,
    :ed25519_key_restriction,
    :ed25519_sk_key_restriction,
    :eks_integration_enabled,
    :eks_account_id,
    :eks_access_key_id,
    :eks_secret_access_key,
    :email_author_in_body,
    :enabled_git_access_protocol,
    :enforce_terms,
    :external_pipeline_validation_service_timeout,
    :external_pipeline_validation_service_token,
    :external_pipeline_validation_service_url,
    :first_day_of_week,
    :floc_enabled,
    :force_pages_access_control,
    :gitaly_timeout_default,
    :gitaly_timeout_medium,
    :gitaly_timeout_fast,
    :gitpod_enabled,
    :gitpod_url,
    :grafana_enabled,
    :grafana_url,
    :gravatar_enabled,
    :hashed_storage_enabled,
    :help_page_hide_commercial_content,
    :help_page_support_url,
    :help_page_documentation_base_url,
    :help_page_text,
    :hide_third_party_offers,
    :home_page_url,
    :housekeeping_enabled,
    :housekeeping_full_repack_period,
    :housekeeping_gc_period,
    :housekeeping_incremental_repack_period,
    :html_emails_enabled,
    :import_sources,
    :in_product_marketing_emails_enabled,
    :inactive_projects_delete_after_months,
    :inactive_projects_min_size_mb,
    :inactive_projects_send_warning_email_after_months,
    :invisible_captcha_enabled,
    :max_artifacts_size,
    :max_attachment_size,
    :max_import_size,
    :max_pages_size,
    :max_yaml_size_bytes,
    :max_yaml_depth,
    :metrics_method_call_threshold,
    :minimum_password_length,
    :mirror_available,
    :notify_on_unknown_sign_in,
    :pages_domain_verification_enabled,
    :password_authentication_enabled_for_web,
    :password_authentication_enabled_for_git,
    :performance_bar_allowed_group_path,
    :performance_bar_enabled,
    :personal_access_token_prefix,
    :kroki_enabled,
    :kroki_url,
    :kroki_formats,
    :plantuml_enabled,
    :plantuml_url,
    :polling_interval_multiplier,
    :project_export_enabled,
    :prometheus_metrics_enabled,
    :recaptcha_enabled,
    :recaptcha_private_key,
    :recaptcha_site_key,
    :login_recaptcha_protection_enabled,
    :receive_max_input_size,
    :repository_checks_enabled,
    :repository_storages_weighted,
    :require_admin_approval_after_user_signup,
    :require_two_factor_authentication,
    :restricted_visibility_levels,
    :rsa_key_restriction,
    :send_user_confirmation_email,
    :session_expire_delay,
    :shared_runners_enabled,
    :shared_runners_text,
    :sign_in_text,
    :signup_enabled,
    :sourcegraph_enabled,
    :sourcegraph_url,
    :sourcegraph_public_only,
    :spam_check_endpoint_enabled,
    :spam_check_endpoint_url,
    :spam_check_api_key,
    :terminal_max_session_time,
    :terms,
    :throttle_authenticated_api_enabled,
    :throttle_authenticated_api_period_in_seconds,
    :throttle_authenticated_api_requests_per_period,
    :throttle_authenticated_git_lfs_enabled,
    :throttle_authenticated_git_lfs_period_in_seconds,
    :throttle_authenticated_git_lfs_requests_per_period,
    :throttle_authenticated_web_enabled,
    :throttle_authenticated_web_period_in_seconds,
    :throttle_authenticated_web_requests_per_period,
    :throttle_authenticated_packages_api_enabled,
    :throttle_authenticated_packages_api_period_in_seconds,
    :throttle_authenticated_packages_api_requests_per_period,
    :throttle_authenticated_files_api_enabled,
    :throttle_authenticated_files_api_period_in_seconds,
    :throttle_authenticated_files_api_requests_per_period,
    :throttle_authenticated_deprecated_api_enabled,
    :throttle_authenticated_deprecated_api_period_in_seconds,
    :throttle_authenticated_deprecated_api_requests_per_period,
    :throttle_unauthenticated_api_enabled,
    :throttle_unauthenticated_api_period_in_seconds,
    :throttle_unauthenticated_api_requests_per_period,
    :throttle_unauthenticated_enabled,
    :throttle_unauthenticated_period_in_seconds,
    :throttle_unauthenticated_requests_per_period,
    :throttle_unauthenticated_packages_api_enabled,
    :throttle_unauthenticated_packages_api_period_in_seconds,
    :throttle_unauthenticated_packages_api_requests_per_period,
    :throttle_unauthenticated_files_api_enabled,
    :throttle_unauthenticated_files_api_period_in_seconds,
    :throttle_unauthenticated_files_api_requests_per_period,
    :throttle_unauthenticated_deprecated_api_enabled,
    :throttle_unauthenticated_deprecated_api_period_in_seconds,
    :throttle_unauthenticated_deprecated_api_requests_per_period,
    :throttle_protected_paths_enabled,
    :throttle_protected_paths_period_in_seconds,
    :throttle_protected_paths_requests_per_period,
    :protected_paths_raw,
    :time_tracking_limit_to_hours,
    :two_factor_grace_period,
    :unique_ips_limit_enabled,
    :unique_ips_limit_per_user,
    :unique_ips_limit_time_window,
    :usage_ping_enabled,
    :usage_ping_features_enabled,
    :user_default_external,
    :user_show_add_ssh_key_message,
    :user_default_internal_regex,
    :user_oauth_applications,
    :version_check_enabled,
    :web_ide_clientside_preview_enabled,
    :diff_max_patch_bytes,
    :diff_max_files,
    :diff_max_lines,
    :commit_email_hostname,
    :protected_ci_variables,
    :local_markdown_version,
    :mailgun_signing_key,
    :mailgun_events_enabled,
    :snowplow_collector_hostname,
    :snowplow_cookie_domain,
    :snowplow_enabled,
    :snowplow_app_id,
    :push_event_hooks_limit,
    :push_event_activities_limit,
    :custom_http_clone_url_root,
    :snippet_size_limit,
    :email_restrictions_enabled,
    :email_restrictions,
    :issues_create_limit,
    :notes_create_limit,
    :notes_create_limit_allowlist_raw,
    :raw_blob_request_limit,
    :project_import_limit,
    :project_export_limit,
    :project_download_export_limit,
    :group_import_limit,
    :group_export_limit,
    :group_download_export_limit,
    :wiki_page_max_content_bytes,
    :container_registry_delete_tags_service_timeout,
    :rate_limiting_response_text,
    :container_registry_expiration_policies_worker_capacity,
    :container_registry_cleanup_tags_service_max_list_size,
    :container_registry_import_max_tags_count,
    :container_registry_import_max_retries,
    :container_registry_import_start_max_retries,
    :container_registry_import_max_step_duration,
    :container_registry_import_target_plan,
    :container_registry_import_created_before,
    :keep_latest_artifact,
    :whats_new_variant,
    :user_deactivation_emails_enabled,
    :sentry_enabled,
    :sentry_dsn,
    :sentry_clientside_dsn,
    :sentry_environment,
    :sidekiq_job_limiter_mode,
    :sidekiq_job_limiter_compression_threshold_bytes,
    :sidekiq_job_limiter_limit_bytes,
    :suggest_pipeline_enabled,
    :search_rate_limit,
    :search_rate_limit_unauthenticated,
    :users_get_by_id_limit,
    :users_get_by_id_limit_allowlist_raw,
    :runner_token_expiration_interval,
    :group_runner_token_expiration_interval,
    :project_runner_token_expiration_interval
  ].tap do |settings|
    settings << :deactivate_dormant_users unless Gitlab.com?
  end
end