Module: ApplicationSettingsHelper

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

Instance Method Summary collapse

Instance Method Details

#all_protocols_enabled?Boolean

Returns:

  • (Boolean)

40
41
42
# File 'app/helpers/application_settings_helper.rb', line 40

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

#enabled_project_button(project, protocol) ⇒ Object


52
53
54
55
56
57
58
59
# File 'app/helpers/application_settings_helper.rb', line 52

def enabled_project_button(project, protocol)
  case protocol
  when 'ssh'
    ssh_clone_button(project, append_link: false)
  else
    http_clone_button(project, append_link: false)
  end
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

#expanded_by_default?Boolean

Returns:

  • (Boolean)

346
347
348
# File 'app/helpers/application_settings_helper.rb', line 346

def expanded_by_default?
  Rails.env.test?
end

#external_authorization_client_certificate_help_textObject


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

def external_authorization_client_certificate_help_text
  _("The X509 Certificate to use when mutual TLS is required to communicate "\
      "with the external authorization service. If left blank, the server "\
      "certificate is still 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
  _("The private key to use when a client certificate is provided. This value "\
      "is encrypted at rest.")
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
  _("The passphrase required to decrypt the private key. This is optional "\
      "and the value is encrypted at rest.")
end

#external_authorization_descriptionObject


136
137
138
139
# File 'app/helpers/application_settings_helper.rb', line 136

def external_authorization_description
  _("If enabled, access to projects will be validated on an external service"\
      " using their classification label.")
end

#external_authorization_service_attributesObject


334
335
336
337
338
339
340
341
342
343
344
# File 'app/helpers/application_settings_helper.rb', line 334

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


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

def external_authorization_timeout_help_text
  _("Time in seconds GitLab will wait for a response from the external "\
      "service. When the service does not respond in time, access will be "\
      "denied.")
end

#external_authorization_url_help_textObject


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

def external_authorization_url_help_text
  _("When leaving the URL blank, classification labels can still be "\
      "specified without disabling cross project features or performing "\
      "external authorization checks.")
end

#http_enabled?Boolean

Returns:

  • (Boolean)

48
49
50
# File 'app/helpers/application_settings_helper.rb', line 48

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

#import_sources_checkboxes(help_block_id, options = {}) ⇒ Object

Return a group of checkboxes that use Bootstrap's button plugin for a toggle button effect.


81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
# File 'app/helpers/application_settings_helper.rb', line 81

def import_sources_checkboxes(help_block_id, options = {})
  Gitlab::ImportSources.options.map do |name, source|
    checked = @application_setting.import_sources.include?(source)
    css_class = checked ? 'active' : ''
    checkbox_name = 'application_setting[import_sources][]'

    label_tag(name, class: css_class) do
      check_box_tag(checkbox_name, source, checked,
                    autocomplete: 'off',
                    'aria-describedby' => help_block_id,
                    'class' => options[:class],
                    id: name.tr(' ', '_')) + name
    end
  end
end

#instance_clusters_enabled?Boolean

Returns:

  • (Boolean)

354
355
356
# File 'app/helpers/application_settings_helper.rb', line 354

def instance_clusters_enabled?
  can?(current_user, :read_cluster, Clusters::Instance.new)
end

#integration_expanded?(substring) ⇒ Boolean

Returns:

  • (Boolean)

350
351
352
# File 'app/helpers/application_settings_helper.rb', line 350

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

#key_restriction_options_for_select(type) ⇒ Object


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

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

#oauth_providers_checkboxesObject


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

def oauth_providers_checkboxes
  button_based_providers.map do |source|
    disabled = @application_setting..include?(source.to_s)
    css_class = ['btn']
    css_class << 'active' unless disabled
    checkbox_name = 'application_setting[enabled_oauth_sign_in_sources][]'
    name = Gitlab::Auth::OAuth::Provider.label_for(source)

    label_tag(checkbox_name, class: css_class.join(' ')) do
      check_box_tag(checkbox_name, source, !disabled,
                    autocomplete: 'off',
                    id: name.tr(' ', '_')) + name
    end
  end
end

#omnibus_protected_paths_throttle?Boolean

Returns:

  • (Boolean)

358
359
360
# File 'app/helpers/application_settings_helper.rb', line 358

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

#repository_storages_options_jsonObject


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

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(help_block_id, checkbox_name, options = {}) ⇒ Object

Return a group of checkboxes that use Bootstrap's button plugin for a toggle button effect.


63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
# File 'app/helpers/application_settings_helper.rb', line 63

def restricted_level_checkboxes(help_block_id, checkbox_name, options = {})
  Gitlab::VisibilityLevel.values.map do |level|
    checked = restricted_visibility_levels(true).include?(level)
    css_class = checked ? 'active' : ''
    tag_name = "application_setting_visibility_level_#{level}"

    label_tag(tag_name, class: css_class) do
      check_box_tag(checkbox_name, level, checked,
                    autocomplete: 'off',
                    'aria-describedby' => help_block_id,
                    'class' => options[:class],
                    id: tag_name) + visibility_level_icon(level) + visibility_level_label(level)
    end
  end
end

#self_monitoring_project_dataObject


362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
# File 'app/helpers/application_settings_helper.rb', line 362

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

#ssh_enabled?Boolean

Returns:

  • (Boolean)

44
45
46
# File 'app/helpers/application_settings_helper.rb', line 44

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

#storage_weightsObject


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

def storage_weights
  ApplicationSetting.repository_storages_weighted_attributes.map do |attribute|
    storage = attribute.to_s.delete_prefix('repository_storages_weighted_')
    {
      name: attribute,
      label: storage,
      value: @application_setting.repository_storages_weighted[storage] || 0
    }
  end
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

#visible_attributesObject


169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
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
# File 'app/helpers/application_settings_helper.rb', line 169

def visible_attributes
  [
    :admin_notification_email,
    :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_whitelist,
    :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_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,
    :disabled_oauth_sign_in_sources,
    :domain_blacklist,
    :domain_blacklist_enabled,
    # TODO Remove domain_blacklist_raw in APIv5 (See https://gitlab.com/gitlab-org/gitlab-foss/issues/67204)
    :domain_blacklist_raw,
    :domain_whitelist,
    # TODO Remove domain_whitelist_raw in APIv5 (See https://gitlab.com/gitlab-org/gitlab-foss/issues/67204)
    :domain_whitelist_raw,
    :outbound_local_requests_whitelist_raw,
    :dsa_key_restriction,
    :ecdsa_key_restriction,
    :ed25519_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,
    :first_day_of_week,
    :force_pages_access_control,
    :gitaly_timeout_default,
    :gitaly_timeout_medium,
    :gitaly_timeout_fast,
    :grafana_enabled,
    :grafana_url,
    :gravatar_enabled,
    :hashed_storage_enabled,
    :help_page_hide_commercial_content,
    :help_page_support_url,
    :help_page_text,
    :hide_third_party_offers,
    :home_page_url,
    :housekeeping_bitmaps_enabled,
    :housekeeping_enabled,
    :housekeeping_full_repack_period,
    :housekeeping_gc_period,
    :housekeeping_incremental_repack_period,
    :html_emails_enabled,
    :import_sources,
    :max_artifacts_size,
    :max_attachment_size,
    :max_import_size,
    :max_pages_size,
    :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,
    :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_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,
    :terminal_max_session_time,
    :terms,
    :throttle_authenticated_api_enabled,
    :throttle_authenticated_api_period_in_seconds,
    :throttle_authenticated_api_requests_per_period,
    :throttle_authenticated_web_enabled,
    :throttle_authenticated_web_period_in_seconds,
    :throttle_authenticated_web_requests_per_period,
    :throttle_unauthenticated_enabled,
    :throttle_unauthenticated_period_in_seconds,
    :throttle_unauthenticated_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,
    :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,
    :commit_email_hostname,
    :protected_ci_variables,
    :local_markdown_version,
    :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,
    :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
  ]
end