Class: Projects::LabelsController

Inherits:
ApplicationController show all
Includes:
ToggleSubscriptionAction
Defined in:
app/controllers/projects/labels_controller.rb

Constant Summary

Constants included from CookiesHelper

CookiesHelper::COOKIE_TYPE_ENCRYPTED, CookiesHelper::COOKIE_TYPE_PERMANENT

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 ToggleSubscriptionAction

#toggle_subscription

Methods included from SafeFormatHelper

#safe_format, #tag_pair

Methods included from RoutableActions

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

Methods included from CookiesHelper

#set_secure_cookie

Methods included from ChecksCollaboration

#can_collaborate_with_project?, #user_access

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 API::Helpers::RelatedResourcesHelpers

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

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 included from ContentSecurityPolicyPatch

#content_security_policy_with_context

Methods included from CurrentOrganization

#set_current_organization

Dynamic Method Handling

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

Instance Method Details

#create ⇒ Object 



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'app/controllers/projects/labels_controller.rb', line 48

def create
  @label = Labels::CreateService.new(label_params).execute(project: @project)

  if @label.valid?
    respond_to do |format|
      format.html { redirect_to project_labels_path(@project) }
      format.json { render json: @label }
    end
  else
    respond_to do |format|
      format.html { render :new }
      format.json { render json: { message: @label.errors.messages }, status: :bad_request }
    end
  end
end

#destroy ⇒ Object 



89
90
91
92
93
94
95
96
97
 
# File 'app/controllers/projects/labels_controller.rb', line 89

def destroy
  if @label.destroy
    redirect_to project_labels_path(@project), status: :found,
      notice: format(_('%{label_name} was removed'), label_name: @label.name)
  else
    redirect_to project_labels_path(@project), status: :found,
      alert: @label.errors.full_messages.to_sentence
  end
end

#edit ⇒ Object 



64
 
# File 'app/controllers/projects/labels_controller.rb', line 64

def edit; end

#flash_notice_for(label, group) ⇒ Object 



160
161
162
163
 
# File 'app/controllers/projects/labels_controller.rb', line 160

def flash_notice_for(label, group)
  safe_link = view_context.link_to('<u>group label</u>'.html_safe, group_labels_path(group))
  view_context.safe_join([ERB::Util.html_escape(label.title), " promoted to ", safe_link, "."])
end

#generate ⇒ Object 



76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'app/controllers/projects/labels_controller.rb', line 76

def generate
  Gitlab::IssuesLabels.generate(@project)

  case params[:redirect]
  when 'issues'
    redirect_to project_issues_path(@project)
  when 'merge_requests'
    redirect_to project_merge_requests_path(@project)
  else
    redirect_to project_labels_path(@project)
  end
end

#index ⇒ Object 



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'app/controllers/projects/labels_controller.rb', line 24

def index
  respond_to do |format|
    format.html do
      @prioritized_labels = if Feature.enabled?(:labels_archive, :instance) && params[:archived] == 'true'
                              Label.none
                            else
                              @available_labels.prioritized(@project)
                            end

      @labels = @available_labels.unprioritized(@project).page(params[:page])
      # preload group, project, and subscription data
      Preloaders::LabelsPreloader.new(@prioritized_labels, current_user, @project).preload_all
      Preloaders::LabelsPreloader.new(@labels, current_user, @project).preload_all
    end
    format.json do
      render json: LabelSerializer.new.represent_appearance(@available_labels)
    end
  end
end

#new ⇒ Object 



44
45
46
 
# File 'app/controllers/projects/labels_controller.rb', line 44

def new
  @label = @project.labels.new
end

#promote ⇒ Object

rubocop: enable CodeReuse/ActiveRecord



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'app/controllers/projects/labels_controller.rb', line 129

def promote
  promote_service = Labels::PromoteService.new(@project, @current_user)

  begin
    return render_404 unless promote_service.execute(@label)

    flash[:notice] = flash_notice_for(@label, @project.group)
    page = params[:page]
    respond_to do |format|
      format.html do
        redirect_to(project_labels_path(@project, page: page), status: :see_other)
      end
      format.json do
        render json: { url: project_labels_path(@project, page: page) }
      end
    end
  rescue ActiveRecord::RecordInvalid => e
    Gitlab::AppLogger.error "Failed to promote label \"#{@label.title}\" to group label"
    Gitlab::AppLogger.error e

    respond_to do |format|
      format.html do
        redirect_to(
          project_labels_path(@project),
          notice: _('Failed to promote label due to internal error. Please contact administrators.'))
      end
      format.js
    end
  end
end

#remove_priority ⇒ Object 



99
100
101
102
103
104
105
106
107
108
109
 
# File 'app/controllers/projects/labels_controller.rb', line 99

def remove_priority
  respond_to do |format|
    label = @available_labels.find(params[:id])

    if label.unprioritize!(project)
      format.json { render json: label }
    else
      format.json { head :unprocessable_entity }
    end
  end
end

#set_priorities ⇒ Object

rubocop: disable CodeReuse/ActiveRecord



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'app/controllers/projects/labels_controller.rb', line 112

def set_priorities
  Label.transaction do
    available_labels_ids = @available_labels.where(id: params[:label_ids]).pluck(:id)
    label_ids = params[:label_ids].select { |id| available_labels_ids.include?(id.to_i) }

    label_ids.each_with_index do |label_id, index|
      label = @available_labels.find(label_id)
      label.prioritize!(project, index)
    end
  end

  respond_to do |format|
    format.json { render json: { message: 'success' } }
  end
end

#update ⇒ Object 



66
67
68
69
70
71
72
73
74
 
# File 'app/controllers/projects/labels_controller.rb', line 66

def update
  @label = Labels::UpdateService.new(label_params).execute(@label)

  if @label.valid?
    redirect_to project_labels_path(@project)
  else
    render :edit
  end
end