Class: ProjectsController

Constant Summary

Constants included from CookiesHelper

CookiesHelper::COOKIE_TYPE_ENCRYPTED, CookiesHelper::COOKIE_TYPE_PERMANENT

Constants included from ExtractsRef

ExtractsRef::InvalidPathError

Constants inherited from ApplicationController

ApplicationController::DEFAULT_GITLAB_CACHE_CONTROL

Constants included from Gitlab::Logging::CloudflareHelper

Gitlab::Logging::CloudflareHelper::CLOUDFLARE_CUSTOM_HEADERS

Constants included from Gitlab::Experimentation::GroupTypes

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

Constants included from Gitlab::NoCacheHeaders

Gitlab::NoCacheHeaders::DEFAULT_GITLAB_NO_CACHE_HEADERS

Instance Method Summary collapse

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, #lfs_blob_ids

Methods included from Gitlab::Utils::Override

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

Methods included from ExtractsRef

#assign_ref_vars, #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, #audit_logs_sort_order_hash, #branches_sort_options_hash, #groups_sort_options_hash, #issuable_reverse_sort_order_hash, #issuable_sort_direction_button, #issuable_sort_option_overrides, #issuable_sort_option_title, #label_sort_options_hash, #member_sort_options_hash, #milestone_sort_options_hash, #packages_reverse_sort_order_hash, #packages_sort_direction_button, #packages_sort_option_title, #packages_sort_options_hash, #project_sort_direction_button, #projects_reverse_sort_options_hash, #projects_sort_option_titles, #projects_sort_options_hash, #search_reverse_sort_options_hash, #search_sort_direction_button, #search_sort_option_title, #sort_direction_button, #sort_direction_icon, #sort_options_hash, #sort_title_access_level_asc, #sort_title_access_level_desc, #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_last_joined, #sort_title_latest_activity, #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_joined, #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_relevant, #sort_title_size, #sort_title_stars, #sort_title_start_date_later, #sort_title_start_date_soon, #sort_title_upvotes, #sort_value_access_level_asc, #sort_value_access_level_desc, #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_last_joined, #sort_value_latest_activity, #sort_value_least_popular, #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_joined, #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_relevant, #sort_value_size, #sort_value_stars_asc, #sort_value_stars_desc, #sort_value_start_date_later, #sort_value_start_date_soon, #sort_value_upvotes, #sortable_item, #starrers_sort_options_hash, #subgroups_sort_options_hash, #tags_sort_options_hash, #users_sort_options_hash

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

#not_found, #redirect_back_or_default, #render, #route_not_found

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_user, #set_experimentation_subject_id_cookie, #track_experiment_event

Methods included from SessionsHelper

#limit_session_time, #unconfirmed_email?

Methods included from SessionlessAuthentication

#authenticate_sessionless_user!, #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

#send_artifacts_entry, #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 GitlabRoutingHelper

#approve_access_request_group_member_path, #approve_access_request_project_member_path, #artifacts_action_path, #commit_url, #commits_url, #edit_milestone_path, #edit_pipeline_schedule_path, #environment_delete_path, #environment_metrics_path, #environment_path, #expose_fast_artifacts_path, #fast_browse_project_job_artifacts_path, #fast_download_project_job_artifacts_path, #fast_keep_project_job_artifacts_path, #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, #group_member_path, #group_members_url, #issue_path, #issue_url, #leave_group_members_path, #leave_project_members_path, #merge_request_path, #merge_request_url, #pipeline_job_url, #pipeline_path, #pipeline_schedule_path, #pipeline_schedules_path, #pipeline_url, #play_pipeline_schedule_path, #preview_markdown_path, #project_commits_path, #project_member_path, #project_members_url, #project_ref_path, #project_tree_path, #release_url, #request_access_group_members_path, #request_access_project_members_path, #resend_invite_group_member_path, #resend_invite_project_member_path, #take_ownership_pipeline_schedule_path, #toggle_award_emoji_personal_snippet_path, #toggle_award_emoji_project_project_snippet_path, #toggle_award_emoji_project_project_snippet_url, #toggle_subscription_path, #wiki_page_path, #wiki_path

Methods included from Gitlab::NoCacheHeaders

#no_cache_headers

Methods included from Gitlab::GonHelper

#add_gon_variables, #default_avatar_url, #push_frontend_feature_flag, #push_to_gon_features

Methods included from WebpackHelper

#webpack_bundle_tag, #webpack_controller_bundle_tags, #webpack_entrypoint_paths, #webpack_public_host, #webpack_public_path

Methods included from StartupCssHelper

#use_startup_css?

Dynamic Method Handling

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

Instance Method Details

#activityObject


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

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


185
186
187
188
189
190
191
# File 'app/controllers/projects_controller.rb', line 185

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


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

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

  if @project.saved?
    cookies[:issue_board_welcome_hidden] = { path: project_path(@project), value: nil, expires: Time.zone.at(0) }

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

#destroyObject


167
168
169
170
171
172
173
174
175
176
# File 'app/controllers/projects_controller.rb', line 167

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


224
225
226
227
228
229
230
231
232
233
# File 'app/controllers/projects_controller.rb', line 224

def download_export
  if @project.export_file_exists?
    send_upload(@project.export_file, attachment: @project.export_file.filename)
  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


67
68
69
70
# File 'app/controllers/projects_controller.rb', line 67

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

#exportObject


215
216
217
218
219
220
221
222
# File 'app/controllers/projects_controller.rb', line 215

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.")
  )
end

#generate_new_exportObject


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

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


201
202
203
204
205
206
207
208
209
210
211
212
213
# File 'app/controllers/projects_controller.rb', line 201

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

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

#indexObject


54
55
56
# File 'app/controllers/projects_controller.rb', line 54

def index
  redirect_to(current_user ? root_path : explore_root_path)
end

#newObject

rubocop: disable CodeReuse/ActiveRecord


59
60
61
62
63
64
# File 'app/controllers/projects_controller.rb', line 59

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)

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

#new_issuable_addressObject


178
179
180
181
182
183
# File 'app/controllers/projects_controller.rb', line 178

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


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

def refs
  find_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, params).execute.take(100).map(&:name)
    options['Branches'] = branches
  end

  if find_tags && @repository.tag_count.nonzero?
    tags = TagsFinder.new(@repository, params).execute.take(100).map(&:name)

    options['Tags'] = tags
  end

  # If reference is commit id - we should add it to branch/tag selectbox
  ref = Addressable::URI.unescape(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
end

#remove_exportObject


235
236
237
238
239
240
241
242
243
# File 'app/controllers/projects_controller.rb', line 235

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


124
125
126
127
128
129
130
# File 'app/controllers/projects_controller.rb', line 124

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
end

#resolveObject

rubocop: enable CodeReuse/ActiveRecord


302
303
304
305
306
307
308
309
310
# File 'app/controllers/projects_controller.rb', line 302

def resolve
  @project = Project.find(params[:id])

  if can?(current_user, :read_project, @project)
    redirect_to @project
  else
    render_404
  end
end

#showObject


142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
# File 'app/controllers/projects_controller.rb', line 142

def show
  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
      render layout: 'xml.atom'
    end
  end
end

#toggle_starObject


256
257
258
259
260
261
262
263
# File 'app/controllers/projects_controller.rb', line 256

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

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

#transferObject

rubocop: disable CodeReuse/ActiveRecord


112
113
114
115
116
117
118
119
120
121
# File 'app/controllers/projects_controller.rb', line 112

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
  end
end

#unarchiveObject


193
194
195
196
197
198
199
# File 'app/controllers/projects_controller.rb', line 193

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


312
313
314
315
316
317
318
# File 'app/controllers/projects_controller.rb', line 312

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

#updateObject


87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
# File 'app/controllers/projects_controller.rb', line 87

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

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

  respond_to do |format|
    if result[:status] == :success
      flash[:notice] = _("Project '%{project_name}' was successfully updated.") % { project_name: @project.name }

      format.html do
        redirect_to(edit_project_path(@project, anchor: 'js-general-project-settings'))
      end
    else
      flash.now[:alert] = result[:message]
      @project.reset

      format.html { render_edit }
    end

    format.js
  end
end