Class: ProjectsController

Constant Summary

Constants included from CookiesHelper

CookiesHelper::COOKIE_TYPE_ENCRYPTED, CookiesHelper::COOKIE_TYPE_PERMANENT

Constants included from ExtractsRef

ExtractsRef::InvalidPathError

Constants included from Gitlab::EndpointAttributes

Gitlab::EndpointAttributes::DEFAULT_URGENCY

Constants included from Gitlab::Logging::CloudflareHelper

Gitlab::Logging::CloudflareHelper::CLOUDFLARE_CUSTOM_HEADERS

Constants included from Impersonation

Impersonation::SESSION_KEYS_TO_DELETE

Constants included from Gitlab::Experimentation::GroupTypes

Gitlab::Experimentation::GroupTypes::GROUP_CONTROL, Gitlab::Experimentation::GroupTypes::GROUP_EXPERIMENTAL

Constants included from EnforcesTwoFactorAuthentication

EnforcesTwoFactorAuthentication::MFA_HELP_PAGE

Constants included from Gitlab::NoCacheHeaders

Gitlab::NoCacheHeaders::DEFAULT_GITLAB_NO_CACHE_HEADERS

Instance Method Summary collapse

Methods included from PlanningHierarchy

#planning_hierarchy

Methods included from FiltersEvents

#event_filter

Methods included from ImportUrlParams

#import_params_to_full_url, #import_url_params

Methods included from RecordUserLastActivity

#set_user_last_activity

Methods included from CookiesHelper

#set_secure_cookie

Methods included from SendFileUpload

#content_type_for, #guess_content_type, #send_upload

Methods included from PreviewMarkdown

#preview_markdown

Methods included from ExtractsPath

#assign_ref_vars, #extract_ref_without_atom

Methods included from Gitlab::Utils::Override

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

Methods included from ExtractsRef

#assign_ref_vars, #extract_ref_path, #tree

Methods included from Gitlab::Utils::StrongMemoize

#clear_memoization, #strong_memoize, #strong_memoized?

Methods included from SortingPreference

#default_sort_order, #legacy_sort_cookie_name, #set_sort_order, #sorting_field

Methods included from SortingHelper

#admin_groups_sort_options_hash, #admin_users_sort_options, #audit_logs_sort_order_hash, #branches_sort_options_hash, #can_sort_by_issue_weight?, #due_date_option, #forks_reverse_sort_options_hash, #forks_sort_direction_button, #forks_sort_options_hash, #groups_sort_options_hash, #issuable_reverse_sort_order_hash, #issuable_sort_direction_button, #issuable_sort_option_overrides, #issuable_sort_option_title, #issuable_sort_options, #label_priority_option, #label_sort_options_hash, #merged_option, #milestones_sort_options_hash, #packages_reverse_sort_order_hash, #packages_sort_direction_button, #packages_sort_option_title, #packages_sort_options_hash, #popularity_option, #project_sort_direction_button, #projects_reverse_sort_options_hash, #projects_sort_option_titles, #projects_sort_options_hash, #relative_position_option, #runners_sort_options_hash, #sort_direction_button, #sort_direction_icon, #sort_options_hash, #sortable_item, #starrers_sort_options_hash, #subgroups_sort_options_hash, #tags_sort_options_hash, #title_option, #users_sort_options_hash

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_size, #sort_title_stars, #sort_title_start_date_later, #sort_title_start_date_soon, #sort_title_title, #sort_title_upvotes, #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_size, #sort_value_stars_asc, #sort_value_stars_desc, #sort_value_start_date_later, #sort_value_start_date_soon, #sort_value_title, #sort_value_title_desc, #sort_value_upvotes

Methods included from API::Helpers::RelatedResourcesHelpers

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

Methods included from ChecksCollaboration

#can_collaborate_with_project?, #user_access

Methods included from RoutableActions

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

Methods inherited from ApplicationController

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

Methods included from CheckRateLimit

#check_rate_limit!

Methods included from FlocOptOut

#floc_enabled?, #set_floc_opt_out_header

Methods included from Gitlab::Logging::CloudflareHelper

#store_cloudflare_headers!, #valid_cloudflare_header?

Methods included from Impersonation

#current_user

Methods included from InitializesCurrentUserMode

#current_user_mode

Methods included from Gitlab::Experimentation::ControllerConcern

#experiment_enabled?, #experiment_tracking_category_and_group, #frontend_experimentation_tracking_data, #push_frontend_experiment, #record_experiment_conversion_event, #record_experiment_group, #record_experiment_user, #set_experimentation_subject_id_cookie, #track_experiment_event

Methods included from Gitlab::Tracking::Helpers

#dnt_enabled?, #trackable_html_request?

Methods included from SessionsHelper

#ensure_authenticated_session_time, #limit_session_time, #obfuscated_email, #recently_confirmed_com?, #send_rate_limited?, #set_session_time, #unconfirmed_email?

Methods included from SessionlessAuthentication

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

Methods included from Gitlab::SearchContext::ControllerConcern

#search_context

Methods included from EnforcesTwoFactorAuthentication

#check_two_factor_requirement, #current_user_requires_two_factor?, #skip_two_factor?, #two_factor_authentication_reason, #two_factor_authentication_required?, #two_factor_grace_period, #two_factor_grace_period_expired?, #two_factor_skippable?, #two_factor_verifier

Methods included from WorkhorseHelper

#content_disposition_for_blob, #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, #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::PseudonymizationHelper

#masked_page_url

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

#wiki_page_path, #wiki_path

Methods included from Routing::SnippetsHelper

#gitlab_dashboard_snippets_path, #gitlab_raw_snippet_blob_path, #gitlab_raw_snippet_blob_url, #gitlab_raw_snippet_path, #gitlab_raw_snippet_url, #gitlab_snippet_note_path, #gitlab_snippet_note_url, #gitlab_snippet_notes_path, #gitlab_snippet_notes_url, #gitlab_snippet_path, #gitlab_snippet_url, #gitlab_toggle_award_emoji_snippet_note_path, #gitlab_toggle_award_emoji_snippet_note_url, #gitlab_toggle_award_emoji_snippet_path, #gitlab_toggle_award_emoji_snippet_url, #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?, #deprecated_attributes, #enabled_protocol, #enabled_protocol_button, #expanded_by_default?, #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, #http_enabled?, #import_sources_checkboxes, #instance_clusters_enabled?, #integration_expanded?, #key_restriction_options_for_select, #kroki_available_formats, #oauth_providers_checkboxes, #omnibus_protected_paths_throttle?, #pending_user_count, #registration_features_can_be_prompted?, #repository_storages_options_json, #restricted_level_checkboxes, #self_monitoring_project_data, #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

Methods included from ProjectsHelper

#able_to_see_issues?, #able_to_see_merge_requests?, #any_projects?, #author_content_tag, #autodeploy_flash_notice, #can_admin_project_member?, #can_change_visibility_level?, #can_disable_emails?, #clusters_deprecation_alert_message, #delete_confirm_phrase, #directory?, #error_tracking_setting_project_json, #explore_projects_tab?, #external_classification_label_help_message, #fork_button_disabled_tooltip, #grafana_integration_enabled?, #grafana_integration_masked_token, #grafana_integration_url, #import_from_bitbucket_message, #import_from_gitlab_message, #inactive_project_deletion_date, #last_push_event, #link_to_autodeploy_doc, #link_to_member, #link_to_member_avatar, #link_to_project, #load_pipeline_status, #membership_locked?, #metrics_dashboard_timezone, #metrics_external_dashboard_url, #no_password_message, #project_can_be_shared?, #project_classes, #project_incident_management_setting, #project_license_name, #project_list_cache_key, #project_permissions_panel_data, #project_search_tabs?, #project_title, #push_to_create_project_command, #remove_fork_project_confirm_json, #remove_fork_project_description_message, #remove_fork_project_warning_message, #remove_project_message, #show_auto_devops_implicitly_enabled_banner?, #show_clusters_alert?, #show_inactive_project_deletion_banner?, #show_issue_count?, #show_merge_request_count?, #show_no_password_message?, #show_no_ssh_key_message?, #show_projects?, #show_terraform_banner?, #show_xcode_link?, #transfer_project_message, #visible_fork_source, #xcode_uri_to_repo

Methods included from Gitlab::NoCacheHeaders

#no_cache_headers

Methods included from Gitlab::GonHelper

#add_gon_variables, #default_avatar_url, #push_force_frontend_feature_flag, #push_frontend_feature_flag, #push_to_gon_attributes

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

Dynamic Method Handling

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

Instance Method Details

#activityObject


156
157
158
159
160
161
162
163
164
# File 'app/controllers/projects_controller.rb', line 156

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

#archiveObject


212
213
214
215
216
217
218
# File 'app/controllers/projects_controller.rb', line 212

def archive
  ::Projects::UpdateService.new(@project, current_user, archived: true).execute

  respond_to do |format|
    format.html { redirect_to project_path(@project) }
  end
end

#createObject


101
102
103
104
105
106
107
108
109
110
111
112
# File 'app/controllers/projects_controller.rb', line 101

def create
  @project = ::Projects::CreateService.new(current_user, project_params(attributes: project_params_create_attributes)).execute

  if @project.saved?
    redirect_to(
      project_path(@project, custom_import_params),
      notice: _("Project '%{project_name}' was successfully created.") % { project_name: @project.name }
    )
  else
    render 'new'
  end
end

#destroyObject


194
195
196
197
198
199
200
201
202
203
# File 'app/controllers/projects_controller.rb', line 194

def destroy
  return access_denied! unless can?(current_user, :remove_project, @project)

  ::Projects::DestroyService.new(@project, current_user, {}).async_execute
  flash[:notice] = _("Project '%{project_name}' is in the process of being deleted.") % { project_name: @project.full_name }

  redirect_to dashboard_projects_path, status: :found
rescue Projects::DestroyService::DestroyError => ex
  redirect_to edit_project_path(@project), status: :found, alert: ex.message
end

#download_exportObject


256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
# File 'app/controllers/projects_controller.rb', line 256

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

#editObject

rubocop: enable CodeReuse/ActiveRecord


96
97
98
99
# File 'app/controllers/projects_controller.rb', line 96

def edit
  @badge_api_endpoint = expose_path(api_v4_projects_badges_path(id: @project.id))
  render_edit
end

#exportObject


242
243
244
245
246
247
248
249
250
251
252
253
254
# File 'app/controllers/projects_controller.rb', line 242

def export
  @project.add_export_job(current_user: current_user)

  redirect_to(
    edit_project_path(@project, anchor: 'js-export-project'),
    notice: _("Project export started. A download link will be sent by email and made available on this page.")
  )
rescue Project::ExportLimitExceeded => ex
  redirect_to(
    edit_project_path(@project, anchor: 'js-export-project'),
    alert: ex.to_s
  )
end

#generate_new_exportObject


284
285
286
287
288
289
290
291
292
293
# File 'app/controllers/projects_controller.rb', line 284

def generate_new_export
  if @project.remove_exports
    export
  else
    redirect_to(
      edit_project_path(@project, anchor: 'js-export-project'),
      alert: _("Project export could not be deleted.")
    )
  end
end

#housekeepingObject


228
229
230
231
232
233
234
235
236
237
238
239
240
# File 'app/controllers/projects_controller.rb', line 228

def housekeeping
  ::Repositories::HousekeepingService.new(@project, :gc).execute

  redirect_to(
    project_path(@project),
    notice: _("Housekeeping successfully started")
  )
rescue ::Repositories::HousekeepingService::LeaseTaken => ex
  redirect_to(
    edit_project_path(@project, anchor: 'js-project-advanced-settings'),
    alert: ex.to_s
  )
end

#indexObject


76
77
78
# File 'app/controllers/projects_controller.rb', line 76

def index
  redirect_to(current_user ? root_path : explore_root_path)
end

#newObject

rubocop: disable CodeReuse/ActiveRecord


81
82
83
84
85
86
87
88
89
90
91
92
93
# File 'app/controllers/projects_controller.rb', line 81

def new
  @namespace = Namespace.find_by(id: params[:namespace_id]) if params[:namespace_id]
  return access_denied! if @namespace && !can?(current_user, :create_projects, @namespace)

  @current_user_group =
    if current_user.manageable_groups(include_groups_with_developer_maintainer_access: true).count == 1
      current_user.manageable_groups(include_groups_with_developer_maintainer_access: true).first
    else
      nil
    end

  @project = Project.new(namespace_id: @namespace&.id)
end

#new_issuable_addressObject


205
206
207
208
209
210
# File 'app/controllers/projects_controller.rb', line 205

def new_issuable_address
  return render_404 unless Gitlab::IncomingEmail.supports_issue_creation?

  current_user.reset_incoming_email_token!
  render json: { new_address: @project.new_issuable_address(current_user, params[:issuable_type]) }
end

#refsObject

rubocop: disable CodeReuse/ActiveRecord


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

def refs
  find_refs = refs_params['find']

  find_branches = true
  find_tags = true
  find_commits = true

  unless find_refs.nil?
    find_branches = find_refs.include?('branches')
    find_tags = find_refs.include?('tags')
    find_commits = find_refs.include?('commits')
  end

  options = {}

  if find_branches
    branches = BranchesFinder.new(@repository, refs_params).execute.take(100).map(&:name)
    options['Branches'] = branches
  end

  if find_tags && @repository.tag_count.nonzero?
    tags = TagsFinder.new(@repository, refs_params).execute
    options['Tags'] = tags.take(100).map(&:name)
  end

  # If reference is commit id - we should add it to branch/tag selectbox
  ref = Addressable::URI.unescape(refs_params[:ref])
  if find_commits && ref && options.flatten(2).exclude?(ref) && ref =~ /\A[0-9a-zA-Z]{6,52}\z/
    options['Commits'] = [ref]
  end

  render json: options.to_json
rescue Gitlab::Git::CommandError
  render json: { error: _('Unable to load refs') }, status: :service_unavailable
end

#remove_exportObject


274
275
276
277
278
279
280
281
282
# File 'app/controllers/projects_controller.rb', line 274

def remove_export
  if @project.remove_exports
    flash[:notice] = _("Project export has been deleted.")
  else
    flash[:alert] = _("Project export could not be deleted.")
  end

  redirect_to(edit_project_path(@project, anchor: 'js-export-project'))
end

#remove_forkObject

rubocop: enable CodeReuse/ActiveRecord


146
147
148
149
150
151
152
153
154
# File 'app/controllers/projects_controller.rb', line 146

def remove_fork
  return access_denied! unless can?(current_user, :remove_fork_project, @project)

  if ::Projects::UnlinkForkService.new(@project, current_user).execute
    flash[:notice] = _('The fork relationship has been removed.')
  end

  redirect_to edit_project_path(@project)
end

#showObject


166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
# File 'app/controllers/projects_controller.rb', line 166

def show
  @id, @ref, @path = extract_ref_path

  if @project.import_in_progress?
    redirect_to project_import_path(@project, custom_import_params)
    return
  end

  if @project.pending_delete?
    flash.now[:alert] = _("Project '%{project_name}' queued for deletion.") % { project_name: @project.name }
  end

  respond_to do |format|
    format.html do
      @notification_setting = current_user.notification_settings_for(@project) if current_user
      @project = @project.present(current_user: current_user)

      render_landing_page
    end

    format.atom do
      load_events
      @events = @events.select { |event| event.visible_to_user?(current_user) }
      render layout: 'xml'
    end
  end
end

#toggle_starObject


295
296
297
298
299
300
301
302
# File 'app/controllers/projects_controller.rb', line 295

def toggle_star
  current_user.toggle_star(@project)
  @project.reset

  render json: {
    star_count: @project.star_count
  }
end

#transferObject

rubocop: disable CodeReuse/ActiveRecord


131
132
133
134
135
136
137
138
139
140
141
142
143
# File 'app/controllers/projects_controller.rb', line 131

def transfer
  return access_denied! unless can?(current_user, :change_namespace, @project)

  namespace = Namespace.find_by(id: params[:new_namespace_id])
  ::Projects::TransferService.new(project, current_user).execute(namespace)

  if @project.errors[:new_namespace].present?
    flash[:alert] = @project.errors[:new_namespace].first
    return redirect_to edit_project_path(@project)
  end

  redirect_to edit_project_path(@project)
end

#unarchiveObject


220
221
222
223
224
225
226
# File 'app/controllers/projects_controller.rb', line 220

def unarchive
  ::Projects::UpdateService.new(@project, current_user, archived: false).execute

  respond_to do |format|
    format.html { redirect_to project_path(@project) }
  end
end

#unfoldered_environment_namesObject

rubocop: enable CodeReuse/ActiveRecord


342
343
344
345
346
347
348
# File 'app/controllers/projects_controller.rb', line 342

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

#updateObject


114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
# File 'app/controllers/projects_controller.rb', line 114

def update
  result = ::Projects::UpdateService.new(@project, current_user, project_params).execute

  # Refresh the repo in case anything changed
  @repository = @project.repository

  if result[:status] == :success
    flash[:notice] = _("Project '%{project_name}' was successfully updated.") % { project_name: @project.name }
    redirect_to(edit_project_path(@project, anchor: 'js-general-project-settings'))
  else
    flash[:alert] = result[:message]
    @project.reset
    render 'edit'
  end
end