Class: GroupsController

Constant Summary

Constants included from CookiesHelper

CookiesHelper::COOKIE_TYPE_ENCRYPTED, CookiesHelper::COOKIE_TYPE_PERMANENT

Constants included from SortingTitlesValuesHelper

SortingTitlesValuesHelper::SORT_NAME, SortingTitlesValuesHelper::SORT_UPDATED_OLDEST, SortingTitlesValuesHelper::SORT_UPDATED_RECENT

Constants included from Gitlab::HttpRouter::RuleContext

Gitlab::HttpRouter::RuleContext::ALLOWED_ROUTER_RULE_ACTIONS, Gitlab::HttpRouter::RuleContext::ALLOWED_ROUTER_RULE_TYPES, Gitlab::HttpRouter::RuleContext::ROUTER_RULE_ACTIONS_WITHOUT_TYPE

Constants included from StrongPaginationParams

StrongPaginationParams::PAGINATION_PARAMS

Constants included from Gitlab::Logging::JsonMetadataHelper

Gitlab::Logging::JsonMetadataHelper::JSON_METADATA_HEADERS

Constants included from Gitlab::Logging::CloudflareHelper

Gitlab::Logging::CloudflareHelper::CLOUDFLARE_CUSTOM_HEADERS

Constants included from Gitlab::EndpointAttributes

Gitlab::EndpointAttributes::DEFAULT_URGENCY

Constants included from Impersonation

Impersonation::SESSION_KEYS_TO_DELETE

Constants included from PreferredLanguageSwitcherHelper

PreferredLanguageSwitcherHelper::SWITCHER_MINIMUM_TRANSLATION_LEVEL

Constants included from Routing::PseudonymizationHelper

Routing::PseudonymizationHelper::PSEUDONOMIZED_GROUP, Routing::PseudonymizationHelper::PSEUDONOMIZED_ID, Routing::PseudonymizationHelper::PSEUDONOMIZED_NAMESPACE, Routing::PseudonymizationHelper::PSEUDONOMIZED_PROJECT, Routing::PseudonymizationHelper::PSEUDONOMIZED_USERNAME

Constants included from Gitlab::NoCacheHeaders

Gitlab::NoCacheHeaders::DEFAULT_GITLAB_NO_CACHE_HEADERS

Instance Method Summary collapse

Methods included from Gitlab::Utils::Override

extended, extensions, included, method_added, override, prepended, queue_verification, verify!

Methods included from FiltersEvents

#event_filter

Methods included from SendFileUpload

#content_type_for, #send_upload

Methods included from RecordUserLastActivity

#set_member_last_activity, #set_user_last_activity

Methods included from CookiesHelper

#set_secure_cookie

Methods included from PreviewMarkdown

#preview_markdown

Methods included from IssuableCollectionsAction

#issues_calendar

Methods included from IssuesCalendar

#render_issues_calendar

Methods included from SortingPreference

#default_sort_order, #legacy_sort_cookie_name, #set_sort_order, #sorting_field

Methods included from SortingHelper

#admin_users_sort_options, #branches_sort_options_hash, #can_sort_by_issue_weight?, #can_sort_by_merged_date?, #due_date_option, #forks_reverse_sort_options_hash, #forks_sort_direction_button, #issuable_reverse_sort_order_hash, #issuable_sort_direction_button, #issuable_sort_option_overrides, #issuable_sort_options, #label_priority_option, #label_sort_options_hash, #merged_option, #milestones_sort_options_hash, #popularity_option, #projects_sort_options_hash, #relative_position_option, #sort_direction_button, #sort_direction_icon, #sort_options_hash, #starrers_sort_options_hash, #tags_sort_options_hash, #title_option, #users_sort_options_hash

Methods included from ButtonHelper

#clipboard_button, #dropdown_item_with_description, #http_clone_button, #http_dropdown_description, #link_button_to, #ssh_clone_button

Methods included from SortingTitlesValuesHelper

#sort_title_closed_date, #sort_title_closed_earlier, #sort_title_closed_recently, #sort_title_contacted_date, #sort_title_created_date, #sort_title_downvotes, #sort_title_due_date, #sort_title_due_date_later, #sort_title_due_date_soon, #sort_title_expire_date, #sort_title_label_priority, #sort_title_largest_group, #sort_title_largest_repo, #sort_title_latest_activity, #sort_title_merged_date, #sort_title_merged_earlier, #sort_title_merged_recently, #sort_title_milestone, #sort_title_milestone_later, #sort_title_milestone_soon, #sort_title_most_stars, #sort_title_name, #sort_title_name_asc, #sort_title_name_desc, #sort_title_oldest_activity, #sort_title_oldest_created, #sort_title_oldest_last_activity, #sort_title_oldest_signin, #sort_title_oldest_starred, #sort_title_oldest_updated, #sort_title_popularity, #sort_title_priority, #sort_title_recently_created, #sort_title_recently_last_activity, #sort_title_recently_signin, #sort_title_recently_starred, #sort_title_recently_updated, #sort_title_relative_position, #sort_title_relevance, #sort_title_size, #sort_title_stars, #sort_title_start_date_later, #sort_title_start_date_soon, #sort_title_title, #sort_title_upvotes, #sort_title_version_asc, #sort_title_version_desc, #sort_value_closed_date, #sort_value_closed_earlier, #sort_value_closed_recently, #sort_value_contacted_date, #sort_value_created_date, #sort_value_downvotes, #sort_value_due_date, #sort_value_due_date_later, #sort_value_due_date_soon, #sort_value_expire_date, #sort_value_label_priority, #sort_value_largest_group, #sort_value_largest_repo, #sort_value_latest_activity, #sort_value_least_popular, #sort_value_merged_date, #sort_value_merged_earlier, #sort_value_merged_recently, #sort_value_milestone, #sort_value_milestone_later, #sort_value_milestone_soon, #sort_value_most_popular, #sort_value_name, #sort_value_name_desc, #sort_value_oldest_activity, #sort_value_oldest_created, #sort_value_oldest_last_activity, #sort_value_oldest_signin, #sort_value_oldest_updated, #sort_value_popularity, #sort_value_priority, #sort_value_recently_created, #sort_value_recently_last_activity, #sort_value_recently_signin, #sort_value_recently_updated, #sort_value_relative_position, #sort_value_relevance, #sort_value_size, #sort_value_stars_desc, #sort_value_start_date_later, #sort_value_start_date_soon, #sort_value_title, #sort_value_title_desc, #sort_value_upvotes, #sort_value_version_asc, #sort_value_version_desc

Methods included from DefaultBranchProtection

#normalize_default_branch_params!

Methods included from API::Helpers::RelatedResourcesHelpers

#expose_path, #expose_url, #issues_available?, #mrs_available?, #project_feature_string_access_level

Methods included from ControllerWithCrossProjectAccessCheck

#authorize_cross_project_page!, #cross_project_check

Methods included from RoutableActions

#ensure_canonical_path, #find_routable!, #not_found_actions, #perform_not_found_actions, #routable_authorized?

Methods inherited from ApplicationController

#feature_category, #handle_unverified_request, #not_found, #redirect_back_or_default, #render, #route_not_found, #urgency

Methods included from Gitlab::HttpRouter::RuleMetrics

#increment_http_router_metrics

Methods included from StrongPaginationParams

#pagination_params

Methods included from RequestPayloadLogger

#append_info_to_payload

Methods included from Gitlab::Logging::JsonMetadataHelper

#store_json_metadata_headers!

Methods included from Gitlab::Logging::CloudflareHelper

#store_cloudflare_headers!, #valid_cloudflare_header?

Methods included from CheckRateLimit

#check_rate_limit!

Methods included from FlocOptOut

#floc_enabled?, #set_floc_opt_out_header

Methods included from Impersonation

#current_user

Methods included from InitializesCurrentUserMode

#current_user_mode

Methods included from SessionsHelper

#fallback_to_email_otp_permitted?, #obfuscated_email, #remember_me_enabled?, #session_expire_modal_data, #unconfirmed_email?, #verification_data, #verification_data_for_js, #webauthn_authentication_data

Methods included from VerifiesWithEmailHelper

#permitted_to_skip_email_otp_in_grace_period?, #treat_as_locked?, #trusted_ip_address?

Methods included from SessionlessAuthentication

#authenticate_sessionless_user!, #request_authenticator, #sessionless_bypass_admin_mode!, #sessionless_sign_in, #sessionless_user?

Methods included from PreferredLanguageSwitcherHelper

#ordered_selectable_locales

Methods included from Gitlab::SearchContext::ControllerConcern

#search_context

Methods included from EnforcesTwoFactorAuthentication

#check_two_factor_requirement, #current_user_requires_two_factor?, #execute_action_for_2fa_reason, #mfa_help_page_url, #skip_two_factor?, #two_factor_authentication_required?, #two_factor_grace_period, #two_factor_grace_period_expired?, #two_factor_skippable?, #two_factor_verifier

Methods included from WorkhorseHelper

#attachment_content_disposition, #content_disposition_for_blob, #inline_content_disposition, #send_artifacts_entry, #send_dependency, #send_git_archive, #send_git_blob, #send_git_diff, #send_git_patch, #set_workhorse_internal_api_content_type, #workhorse_set_content_type!

Methods included from SafeParamsHelper

#safe_params

Methods included from PageLayoutHelper

#blank_container, #container_class, #favicon, #fluid_layout, #full_content_class, #header_title, #nav, #page_canonical_link, #page_card_attributes, #page_card_meta_tags, #page_description, #page_image, #page_itemtype, #page_title, #search_context, #sidebar, #user_status_properties

Methods included from Routing::PackagesHelper

#package_path

Methods included from Routing::PseudonymizationHelper

#masked_page_url, #masked_query_params, #masked_referrer_url, #referrer_params

Methods included from Routing::GraphqlHelper

#graphql_etag_pipeline_path, #graphql_etag_pipeline_sha_path, #graphql_etag_project_on_demand_scan_counts_path

Methods included from Routing::WikiHelper

#group_wiki_page_url, #project_wiki_page_url, #wiki_page_path, #wiki_path

Methods included from Routing::SnippetsHelper

#gitlab_raw_snippet_blob_url, #gitlab_raw_snippet_url, #gitlab_snippet_note_path, #gitlab_snippet_notes_path, #gitlab_snippet_path, #gitlab_snippet_url, #gitlab_toggle_award_emoji_snippet_note_path, #preview_markdown_path, #toggle_award_emoji_personal_snippet_path, #toggle_award_emoji_project_project_snippet_path, #toggle_award_emoji_project_project_snippet_url

Methods included from Routing::PipelineSchedulesHelper

#edit_pipeline_schedule_path, #pipeline_schedule_path, #pipeline_schedules_path, #play_pipeline_schedule_path, #take_ownership_pipeline_schedule_path

Methods included from Routing::ArtifactsHelper

#artifacts_action_path, #expose_fast_artifacts_path, #fast_browse_project_job_artifacts_path, #fast_download_project_job_artifacts_path, #fast_keep_project_job_artifacts_path

Methods included from Routing::MembersHelper

#source_members_url

Methods included from Routing::Groups::MembersHelper

#approve_access_request_group_member_path, #group_member_path, #group_members_url, #leave_group_members_path, #request_access_group_members_path, #resend_invite_group_member_path

Methods included from Routing::Projects::MembersHelper

#approve_access_request_project_member_path, #leave_project_members_path, #project_member_path, #project_members_url, #request_access_project_members_path, #resend_invite_project_member_path

Methods included from Routing::ProjectsHelper

#commit_url, #commits_url, #edit_milestone_path, #environment_delete_path, #environment_path, #issue_path, #issue_url, #merge_request_path, #merge_request_url, #pipeline_job_url, #pipeline_path, #pipeline_url, #project_commits_path, #project_ref_path, #project_tree_path, #release_url, #toggle_subscription_path, #work_item_url

Methods included from ApplicationSettingsHelper

#all_protocols_enabled?, #allowed_protocols_present?, #anti_spam_service_enabled?, #custom_admin_roles_available?, #deletion_protection_data, #deprecated_attributes, #enabled_protocol, #enabled_protocol_button, #expanded_by_default?, #external_authorization_allow_token_help_text, #external_authorization_client_certificate_help_text, #external_authorization_client_key_help_text, #external_authorization_client_pass_help_text, #external_authorization_client_url_help_text, #external_authorization_description, #external_authorization_service_attributes, #external_authorization_timeout_help_text, #external_authorization_url_help_text, #global_search_settings_checkboxes, #http_enabled?, #import_sources_checkboxes, #instance_clusters_enabled?, #integration_expanded?, #key_restriction_options_for_select, #kroki_available_formats, #oauth_providers_checkboxes, #pending_user_count, #registration_features_can_be_prompted?, #repository_storages_options_json, #restricted_level_checkboxes, #runner_token_expiration_interval_attributes, #sidekiq_job_limiter_mode_help_text, #sidekiq_job_limiter_modes_for_select, #signup_enabled?, #signup_form_data, #ssh_enabled?, #storage_weights, #user_oauth_applications?, #valid_runner_registrars, #visible_attributes, #vscode_extension_marketplace_settings_description, #vscode_extension_marketplace_settings_view

Methods included from ProjectsHelper

#able_to_see_forks_count?, #able_to_see_issues?, #able_to_see_merge_requests?, #any_projects?, #archiving_available?, #author_content_tag, #autodeploy_flash_notice, #badge_count, #branch_rules_path, #can_admin_associated_clusters?, #can_change_visibility_level?, #can_disable_emails?, #can_push_code?, #can_set_diff_preview_in_email?, #can_view_branch_rules?, #clusters_deprecation_alert_message, #dashboard_projects_app_data, #delete_confirm_phrase, #directory?, #error_tracking_setting_project_json, #explore_projects_tab?, #external_classification_label_help_message, #fork_button_data_attributes, #hidden_issue_icon, #home_panel_data_attributes, #http_clone_url_to_repo, #import_from_bitbucket_message, #inactive_project_deletion_date, #issue_css_classes, #issue_manual_ordering_class, #last_pipeline_from_status_cache, #last_push_event, #link_to_autodeploy_doc, #link_to_data_loss_doc, #link_to_member, #link_to_member_avatar, #link_to_namespace_change_doc, #link_to_project, #load_catalog_resources, #load_pipeline_status, #localized_project_human_access, #membership_locked?, #no_password_message, #notification_data_attributes, #project_archive_settings_app_data, #project_can_be_shared?, #project_classes, #project_coverage_chart_data_attributes, #project_incident_management_setting, #project_license_name, #project_pages_domain_choices, #project_permissions_panel_data, #project_unarchive_settings_app_data, #projects_filtered_search_and_sort_app_data, #push_project_breadcrumbs, #push_to_create_project_command, #remote_mirror_setting_enabled?, #remove_fork_project_confirm_json, #remove_fork_project_description_message, #remove_fork_project_warning_message, #remove_project_message, #show_archived_badge?, #show_auto_devops_implicitly_enabled_banner?, #show_clusters_alert?, #show_count?, #show_dashboard_projects_welcome_page?, #show_inactive_project_deletion_banner?, #show_invalid_gpg_key_message?, #show_lfs_misconfiguration_banner?, #show_mobile_devops_project_promo?, #show_no_password_message?, #show_no_ssh_key_message?, #show_terraform_banner?, #show_xcode_link?, #ssh_clone_url_to_repo, #star_count_data_attributes, #transfer_project_confirm_button, #transfer_project_message, #visibility_level_content, #visible_fork_source, #vue_fork_divergence_data, #xcode_uri_to_repo

Methods included from Gitlab::Allowable

#can?, #can_all?, #can_any?

Methods included from CompareHelper

#create_mr_button?, #create_mr_path, #project_compare_selector_data, #target_projects

Methods included from Gitlab::NoCacheHeaders

#no_cache_headers

Methods included from Gitlab::GonHelper

#add_gon_feature_flags, #add_gon_user_specific, #add_gon_variables, #current_organization, #default_avatar_url, #push_force_frontend_feature_flag, #push_frontend_ability, #push_frontend_feature_flag, #push_namespace_setting, #push_to_gon_attributes

Methods included from Organizations::OrganizationHelper

#admin_organizations_index_app_data, #organization_activity_app_data, #organization_groups_and_projects_app_data, #organization_groups_edit_app_data, #organization_groups_new_app_data, #organization_index_app_data, #organization_layout_nav, #organization_new_app_data, #organization_projects_edit_app_data, #organization_settings_general_app_data, #organization_show_app_data, #organization_user_app_data, #ui_for_organizations_enabled?

Methods included from WebpackHelper

#prefetch_link_tag, #webpack_bundle_tag, #webpack_controller_bundle_tags, #webpack_entrypoint_paths, #webpack_preload_asset_tag, #webpack_public_host, #webpack_public_path

Methods included from ViteHelper

#universal_path_to_stylesheet, #universal_stylesheet_link_tag, #vite_enabled?, #vite_page_entrypoint_paths

Methods inherited from BaseActionController

#set_current_organization

Methods included from ContentSecurityPolicyPatch

#content_security_policy_with_context

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Groups::ApplicationController

Instance Method Details

#activityObject



137
138
139
140
141
142
143
144
145
146
# File 'app/controllers/groups_controller.rb', line 137

def activity
  respond_to do |format|
    format.html

    format.json do
      load_events
      pager_json("events/_events", @events.count { |event| event.visible_to_user?(current_user) })
    end
  end
end

#createObject



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
# File 'app/controllers/groups_controller.rb', line 81

def create
  response = Groups::CreateService.new(
    current_user,
    group_params.merge(organization_id: Current.organization.id)
  ).execute
  @group = response[:group]

  if response.success?
    successful_creation_hooks

    notice = if @group.chat_team.present?
               format(
                 _("Group %{group_name} and its Mattermost team were successfully created."),
                 group_name: @group.name
               )
             else
               format(
                 _("Group %{group_name} was successfully created."),
                 group_name: @group.name
               )
             end

    redirect_to @group, notice: notice
  else
    render action: "new"
  end
end

#destroyObject



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
# File 'app/controllers/groups_controller.rb', line 178

def destroy
  if group.self_deletion_scheduled? &&
      ::Gitlab::Utils.to_boolean(params.permit(:permanently_remove)[:permanently_remove])

    # Admin frontend uses this endpoint to force-delete groups
    return destroy_immediately if Gitlab::CurrentSettings.allow_immediate_namespaces_deletion_for_user?(current_user)

    return access_denied!
  end

  result = ::Groups::MarkForDeletionService.new(group, current_user).execute

  if result.success?
    respond_to do |format|
      format.html do
        redirect_to group_path(group), status: :found
      end

      format.json do
        render json: {
          message: format(
            _("'%{group_name}' has been scheduled for deletion and will be deleted on %{date}."),
            group_name: group.name,
            date: helpers.permanent_deletion_date_formatted(group)
          )
        }
      end
    end
  else
    respond_to do |format|
      format.html do
        redirect_to edit_group_path(group), status: :found, alert: result.message
      end

      format.json do
        render json: { message: result.message }, status: :unprocessable_entity
      end
    end
  end
end

#detailsObject



125
126
127
128
129
130
131
132
133
134
135
# File 'app/controllers/groups_controller.rb', line 125

def details
  respond_to do |format|
    format.html do
      redirect_to group_path(group)
    end

    format.atom do
      render_details_view_atom
    end
  end
end

#download_exportObject



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
# File 'app/controllers/groups_controller.rb', line 262

def download_export
  if @group.export_file_exists?(current_user)
    if @group.export_archive_exists?(current_user)
      export_file = @group.export_file(current_user)
      send_upload(export_file, attachment: export_file.filename)
    else
      redirect_to edit_group_path(@group),
        alert: _(
          'The file containing the export is not available yet; it may still be transferring. Please try again later.'
        )
    end
  else
    redirect_to edit_group_path(@group),
      alert: _('Group export link has expired. Please generate a new export from your group settings.')
  end
end

#editObject



148
149
150
# File 'app/controllers/groups_controller.rb', line 148

def edit
  @badge_api_endpoint = expose_path(api_v4_groups_badges_path(id: @group.id))
end

#edit_group_origin_locationObject



170
171
172
173
174
175
176
# File 'app/controllers/groups_controller.rb', line 170

def edit_group_origin_location
  if params.dig(:group, :redirect_target) == 'repository_settings'
    group_settings_repository_path(@group, anchor: 'js-default-branch-name')
  else
    edit_group_path(@group, anchor: params[:update_section])
  end
end

#exportObject

rubocop: enable CodeReuse/ActiveRecord



247
248
249
250
251
252
253
254
255
256
257
258
259
260
# File 'app/controllers/groups_controller.rb', line 247

def export
  export_service = Groups::ImportExport::ExportService.new(
    group: @group,
    user: current_user,
    exported_by_admin: current_user.can_admin_all_resources?
  )

  if export_service.async_execute
    redirect_to edit_group_path(@group),
      notice: _('Group export started. A download link will be sent by email and made available on this page.')
  else
    redirect_to edit_group_path(@group), alert: _('Group export could not be started.')
  end
end

#indexObject



71
72
73
# File 'app/controllers/groups_controller.rb', line 71

def index
  redirect_to(current_user ? dashboard_groups_path : explore_groups_path)
end

#issuesObject



287
288
289
290
291
292
293
294
295
296
297
298
299
# File 'app/controllers/groups_controller.rb', line 287

def issues
  return super unless html_request?

  set_sort_order

  return redirect_issues_to_work_items if group&.work_items_consolidated_list_enabled?(current_user)

  return if redirect_if_epic_params

  respond_to do |format|
    format.html
  end
end

#merge_requestsObject



152
# File 'app/controllers/groups_controller.rb', line 152

def merge_requests; end

#newObject



75
76
77
78
79
# File 'app/controllers/groups_controller.rb', line 75

def new
  @parent_group = Group.find_by_id(params[:parent_id])
  @group = Group.new(params.permit(:parent_id))
  @group.build_namespace_settings
end

#restoreObject



219
220
221
222
223
224
225
226
227
228
229
230
# File 'app/controllers/groups_controller.rb', line 219

def restore
  return render_404 unless group.self_deletion_scheduled?

  result = ::Groups::RestoreService.new(group, current_user).execute

  if result.success?
    redirect_to edit_group_path(group),
      notice: format(_("Group '%{group_name}' has been successfully restored."), group_name: group.full_name)
  else
    redirect_to(edit_group_path(group), alert: result.message)
  end
end

#showObject



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
# File 'app/controllers/groups_controller.rb', line 109

def show
  respond_to do |format|
    format.html do
      if @group.import_state&.in_progress?
        redirect_to group_import_path(@group)
      else
        render_show_html
      end
    end

    format.atom do
      render_details_view_atom
    end
  end
end

#transferObject

rubocop: disable CodeReuse/ActiveRecord



233
234
235
236
237
238
239
240
241
242
243
244
# File 'app/controllers/groups_controller.rb', line 233

def transfer
  parent_group = Group.find_by(id: params[:new_parent_group_id])
  service = ::Groups::TransferService.new(@group, current_user)

  if service.execute(parent_group)
    flash[:notice] = "Group '#{@group.name}' was successfully transferred."
    redirect_to group_path(@group)
  else
    flash[:alert] = service.error.html_safe
    redirect_to edit_group_path(@group)
  end
end

#unfoldered_environment_namesObject



279
280
281
282
283
284
285
# File 'app/controllers/groups_controller.rb', line 279

def unfoldered_environment_names
  respond_to do |format|
    format.json do
      render json: Environments::EnvironmentNamesFinder.new(@group, current_user).execute
    end
  end
end

#updateObject



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
# File 'app/controllers/groups_controller.rb', line 154

def update
  if Groups::UpdateService.new(@group, current_user, group_params).execute

    if @group.namespace_settings.errors.present?
      flash[:alert] = group.namespace_settings.errors.full_messages.to_sentence
    else
      flash[:notice] = "Group '#{@group.name}' was successfully updated."
    end

    redirect_to edit_group_origin_location
  else
    @group.reset
    render action: "edit"
  end
end