projects_controller.rb 15.5 KB
Newer Older
1 2
# frozen_string_literal: true

3
class ProjectsController < Projects::ApplicationController
4
  include API::Helpers::RelatedResourcesHelpers
5
  include IssuableCollections
6
  include ExtractsPath
7
  include PreviewMarkdown
8
  include SendFileUpload
9
  include RecordUserLastActivity
10
  include ImportUrlParams
11
  include FiltersEvents
12 13 14

  prepend_before_action(only: [:show]) { authenticate_sessionless_user!(:rss) }

15 16
  around_action :allow_gitaly_ref_name_caching, only: [:index, :show]

17
  before_action :whitelist_query_limiting, only: [:show, :create]
18
  before_action :authenticate_user!, except: [:index, :show, :activity, :refs, :resolve, :unfoldered_environment_names]
19
  before_action :redirect_git_extension, only: [:show]
20 21
  before_action :project, except: [:index, :new, :create, :resolve]
  before_action :repository, except: [:index, :new, :create, :resolve]
22
  before_action :project_export_enabled, only: [:export, :download_export, :remove_export, :generate_new_export]
23
  before_action :present_project, only: [:edit]
24
  before_action :authorize_download_code!, only: [:refs]
gitlabhq's avatar
gitlabhq committed
25 26

  # Authorize
27
  before_action :authorize_admin_project!, only: [:edit, :update, :housekeeping, :download_export, :export, :remove_export, :generate_new_export]
28
  before_action :authorize_archive_project!, only: [:archive, :unarchive]
29
  before_action :event_filter, only: [:show, :activity]
gitlabhq's avatar
gitlabhq committed
30

31 32 33
  # Project Export Rate Limit
  before_action :export_rate_limit, only: [:export, :download_export, :generate_new_export]

wortschi's avatar
wortschi committed
34 35 36 37
  before_action do
    push_frontend_feature_flag(:vue_notification_dropdown, @project, default_enabled: :yaml)
  end

38
  before_action only: [:edit] do
39
    push_frontend_feature_flag(:approval_suggestions, @project, default_enabled: true)
40
    push_frontend_feature_flag(:allow_editing_commit_messages, @project)
41 42
  end

43
  layout :determine_layout
Cyril's avatar
Cyril committed
44

45 46 47 48 49 50 51 52 53
  feature_category :projects, [
                     :index, :show, :new, :create, :edit, :update, :transfer,
                     :destroy, :resolve, :archive, :unarchive, :toggle_star
                   ]

  feature_category :source_code_management, [:remove_fork, :housekeeping, :refs]
  feature_category :issue_tracking, [:preview_markdown, :new_issuable_address]
  feature_category :importers, [:export, :remove_export, :generate_new_export, :download_export]
  feature_category :audit_events, [:activity]
54
  feature_category :code_review, [:unfoldered_environment_names]
55

56
  def index
57
    redirect_to(current_user ? root_path : explore_root_path)
58 59
  end

60
  # rubocop: disable CodeReuse/ActiveRecord
gitlabhq's avatar
gitlabhq committed
61
  def new
62 63
    @namespace = Namespace.find_by(id: params[:namespace_id]) if params[:namespace_id]
    return access_denied! if @namespace && !can?(current_user, :create_projects, @namespace)
64

65
    @project = Project.new(namespace_id: @namespace&.id)
gitlabhq's avatar
gitlabhq committed
66
  end
67
  # rubocop: enable CodeReuse/ActiveRecord
gitlabhq's avatar
gitlabhq committed
68 69

  def edit
70
    @badge_api_endpoint = expose_path(api_v4_projects_badges_path(id: @project.id))
71
    render_edit
gitlabhq's avatar
gitlabhq committed
72 73 74
  end

  def create
75
    @project = ::Projects::CreateService.new(current_user, project_params(attributes: project_params_create_attributes)).execute
gitlabhq's avatar
gitlabhq committed
76

77
    if @project.saved?
78
      experiment(:new_project_readme, actor: current_user).track(:created, property: active_new_project_tab)
Vinnie Okada's avatar
Vinnie Okada committed
79
      redirect_to(
80
        project_path(@project, custom_import_params),
81
        notice: _("Project '%{project_name}' was successfully created.") % { project_name: @project.name }
Vinnie Okada's avatar
Vinnie Okada committed
82
      )
83
    else
Eric Eastwood's avatar
Eric Eastwood committed
84
      render 'new', locals: { active_tab: active_new_project_tab }
gitlabhq's avatar
gitlabhq committed
85 86
    end
  end
gitlabhq's avatar
gitlabhq committed
87

gitlabhq's avatar
gitlabhq committed
88
  def update
89
    result = ::Projects::UpdateService.new(@project, current_user, project_params).execute
90

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

gitlabhq's avatar
gitlabhq committed
94
    respond_to do |format|
95
      if result[:status] == :success
96
        flash[:notice] = _("Project '%{project_name}' was successfully updated.") % { project_name: @project.name }
97

Vinnie Okada's avatar
Vinnie Okada committed
98
        format.html do
99
          redirect_to(edit_project_path(@project, anchor: 'js-general-project-settings'))
Vinnie Okada's avatar
Vinnie Okada committed
100
        end
gitlabhq's avatar
gitlabhq committed
101
      else
102
        flash[:alert] = result[:message]
103
        @project.reset
104

105
        format.html { render_edit }
gitlabhq's avatar
gitlabhq committed
106
      end
107 108

      format.js
gitlabhq's avatar
gitlabhq committed
109
    end
110
  end
111

112
  # rubocop: disable CodeReuse/ActiveRecord
113
  def transfer
114 115
    return access_denied! unless can?(current_user, :change_namespace, @project)

116 117 118 119 120
    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
skv-headless's avatar
skv-headless committed
121
    end
gitlabhq's avatar
gitlabhq committed
122
  end
123
  # rubocop: enable CodeReuse/ActiveRecord
gitlabhq's avatar
gitlabhq committed
124

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

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

133 134 135 136 137
  def activity
    respond_to do |format|
      format.html
      format.json do
        load_events
138
        pager_json('events/_events', @events.count { |event| event.visible_to_user?(current_user) })
139
      end
skv-headless's avatar
skv-headless committed
140
    end
gitlabhq's avatar
gitlabhq committed
141 142 143
  end

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

146
    if @project.import_in_progress?
147
      redirect_to project_import_path(@project, custom_import_params)
148 149 150
      return
    end

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

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
155
    respond_to do |format|
Nihad Abbasov's avatar
Nihad Abbasov committed
156
      format.html do
157
        @notification_setting = current_user.notification_settings_for(@project) if current_user
158 159
        @project = @project.present(current_user: current_user)

160
        render_landing_page
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
161
      end
162

163 164
      format.atom do
        load_events
165
        render layout: 'xml.atom'
166
      end
167 168 169
    end
  end

gitlabhq's avatar
gitlabhq committed
170
  def destroy
171
    return access_denied! unless can?(current_user, :remove_project, @project)
172

Stan Hu's avatar
Stan Hu committed
173
    ::Projects::DestroyService.new(@project, current_user, {}).async_execute
174
    flash[:notice] = _("Project '%{project_name}' is in the process of being deleted.") % { project_name: @project.full_name }
gitlabhq's avatar
gitlabhq committed
175

176
    redirect_to dashboard_projects_path, status: :found
177
  rescue Projects::DestroyService::DestroyError => ex
178
    redirect_to edit_project_path(@project), status: :found, alert: ex.message
gitlabhq's avatar
gitlabhq committed
179
  end
180

181
  def new_issuable_address
182 183 184
    return render_404 unless Gitlab::IncomingEmail.supports_issue_creation?

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

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

    respond_to do |format|
192
      format.html { redirect_to project_path(@project) }
193 194 195 196
    end
  end

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

    respond_to do |format|
200
      format.html { redirect_to project_path(@project) }
201 202 203
    end
  end

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

207 208
    redirect_to(
      project_path(@project),
209
      notice: _("Housekeeping successfully started")
210
    )
211
  rescue ::Repositories::HousekeepingService::LeaseTaken => ex
212
    redirect_to(
213
      edit_project_path(@project, anchor: 'js-project-advanced-settings'),
214 215
      alert: ex.to_s
    )
216
  end
217

218
  def export
219
    @project.add_export_job(current_user: current_user)
220 221

    redirect_to(
222
      edit_project_path(@project, anchor: 'js-export-project'),
223
      notice: _("Project export started. A download link will be sent by email and made available on this page.")
224 225 226
    )
  end

James Lopez's avatar
James Lopez committed
227
  def download_export
228
    if @project.export_file_exists?
229
      send_upload(@project.export_file, attachment: @project.export_file.filename)
James Lopez's avatar
James Lopez committed
230
    else
231
      redirect_to(
232
        edit_project_path(@project, anchor: 'js-export-project'),
233
        alert: _("Project export link has expired. Please generate a new export from your project settings.")
234 235 236 237 238 239
      )
    end
  end

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

245
    redirect_to(edit_project_path(@project, anchor: 'js-export-project'))
246 247 248 249 250
  end

  def generate_new_export
    if @project.remove_exports
      export
251 252
    else
      redirect_to(
253
        edit_project_path(@project, anchor: 'js-export-project'),
254
        alert: _("Project export could not be deleted.")
255
      )
James Lopez's avatar
James Lopez committed
256
    end
James Lopez's avatar
James Lopez committed
257 258
  end

Ciro Santilli's avatar
Ciro Santilli committed
259 260
  def toggle_star
    current_user.toggle_star(@project)
261
    @project.reset
262 263

    render json: {
264
      star_count: @project.star_count
265
    }
Ciro Santilli's avatar
Ciro Santilli committed
266 267
  end

268
  # rubocop: disable CodeReuse/ActiveRecord
269
  def refs
270
    find_refs = params['find']
271

272 273 274
    find_branches = true
    find_tags = true
    find_commits = true
Luke "Jared" Bennett's avatar
Luke "Jared" Bennett committed
275 276

    unless find_refs.nil?
Douwe Maan's avatar
Douwe Maan committed
277 278 279
      find_branches = find_refs.include?('branches')
      find_tags = find_refs.include?('tags')
      find_commits = find_refs.include?('commits')
280
    end
281

282 283 284
    options = {}

    if find_branches
Douwe Maan's avatar
Douwe Maan committed
285
      branches = BranchesFinder.new(@repository, params).execute.take(100).map(&:name)
286
      options['Branches'] = branches
287
    end
288

Douwe Maan's avatar
Douwe Maan committed
289 290
    if find_tags && @repository.tag_count.nonzero?
      tags = TagsFinder.new(@repository, params).execute.take(100).map(&:name)
291

292
      options['Tags'] = tags
Phil Hughes's avatar
Phil Hughes committed
293 294
    end

295
    # If reference is commit id - we should add it to branch/tag selectbox
296
    ref = Addressable::URI.unescape(params[:ref])
Douwe Maan's avatar
Douwe Maan committed
297
    if find_commits && ref && options.flatten(2).exclude?(ref) && ref =~ /\A[0-9a-zA-Z]{6,52}\z/
298
      options['Commits'] = [ref]
299 300 301 302
    end

    render json: options.to_json
  end
303
  # rubocop: enable CodeReuse/ActiveRecord
304

305 306 307 308 309 310 311 312 313 314
  def resolve
    @project = Project.find(params[:id])

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

315 316 317 318 319 320 321 322
  def unfoldered_environment_names
    respond_to do |format|
      format.json do
        render json: EnvironmentNamesFinder.new(@project, current_user).execute
      end
    end
  end

323 324
  private

325
  # Render project landing depending of which features are available
326
  # So if page is not available in the list it renders the next page
327 328 329
  #
  # pages list order: repository readme, wiki home, issues list, customize workflow
  def render_landing_page
330
    if can?(current_user, :download_code, @project)
331
      return render 'projects/no_repo' unless @project.repository_exists?
332

333 334 335 336 337
      if @project.empty_repo?
        record_experiment_user(:invite_members_empty_project_version_a)

        render 'projects/empty'
      end
338
    else
339
      if can?(current_user, :read_wiki, @project)
340 341
        @wiki = @project.wiki
        @wiki_home = @wiki.find_page('home', params[:version_id])
342
      elsif @project.feature_available?(:issues, current_user)
343
        @issues = issuables_collection.page(params[:page])
Felipe Artur's avatar
Felipe Artur committed
344
        @issuable_meta_data = Gitlab::IssuableMetadata.new(current_user, @issues).data
345 346 347 348 349 350
      end

      render :show
    end
  end

351 352 353 354
  def finder_type
    IssuesFinder
  end

355 356 357 358 359 360 361 362
  def determine_layout
    if [:new, :create].include?(action_name.to_sym)
      'application'
    elsif [:edit, :update].include?(action_name.to_sym)
      'project_settings'
    else
      'project'
    end
363
  end
364

365
  # rubocop: disable CodeReuse/ActiveRecord
366
  def load_events
367 368 369 370 371
    projects = Project.where(id: @project.id)

    @events = EventCollection
      .new(projects, offset: params[:offset].to_i, filter: event_filter)
      .to_a
372
      .map(&:present)
373 374

    Events::RenderService.new(current_user).execute(@events, atom_request: request.format.atom?)
375
  end
376
  # rubocop: enable CodeReuse/ActiveRecord
377

Małgorzata Ksionek's avatar
Małgorzata Ksionek committed
378
  def project_params(attributes: [])
379
    params.require(:project)
Małgorzata Ksionek's avatar
Małgorzata Ksionek committed
380
      .permit(project_params_attributes + attributes)
381
      .merge(import_url_params)
382
  end
383

384 385 386 387 388 389 390 391 392 393 394
  def project_feature_attributes
    %i[
      builds_access_level
      issues_access_level
      forking_access_level
      merge_requests_access_level
      repository_access_level
      snippets_access_level
      wiki_access_level
      pages_access_level
      metrics_dashboard_access_level
395
      analytics_access_level
396
      operations_access_level
397 398 399
    ]
  end

400
  def project_params_attributes
401
    [
402
      :allow_merge_on_skipped_pipeline,
403 404 405
      :avatar,
      :build_allow_git_fetch,
      :build_coverage_regex,
406
      :build_timeout_human_readable,
407
      :resolve_outdated_diff_discussions,
408
      :container_registry_enabled,
409 410
      :default_branch,
      :description,
411
      :emails_disabled,
412
      :external_authorization_classification_label,
413 414 415 416 417 418
      :import_url,
      :issues_tracker,
      :issues_tracker_id,
      :last_activity_at,
      :lfs_enabled,
      :name,
419
      :only_allow_merge_if_all_discussions_are_resolved,
420
      :only_allow_merge_if_pipeline_succeeds,
421
      :path,
422
      :printing_merge_request_link_enabled,
423
      :public_builds,
424
      :remove_source_branch_after_merge,
425 426 427 428
      :request_access_enabled,
      :runners_token,
      :tag_list,
      :visibility_level,
429
      :template_name,
430
      :template_project_id,
431
      :merge_method,
432
      :initialize_with_readme,
433
      :autoclose_referenced_issues,
434
      :suggestion_commit_message,
435
      :packages_enabled,
436
      :service_desk_enabled,
437 438
      project_setting_attributes: %i[
        show_default_award_emojis
439
        squash_option
440
        allow_editing_commit_messages
441
      ]
442
    ] + [project_feature_attributes: project_feature_attributes]
443 444
  end

445
  def project_params_create_attributes
Małgorzata Ksionek's avatar
Małgorzata Ksionek committed
446
    [:namespace_id]
447 448
  end

449 450 451 452
  def custom_import_params
    {}
  end

Eric Eastwood's avatar
Eric Eastwood committed
453 454 455 456
  def active_new_project_tab
    project_params[:import_url].present? ? 'import' : 'blank'
  end

457
  def repo_exists?
458
    project.repository_exists? && !project.empty_repo?
459 460 461 462 463

  rescue Gitlab::Git::Repository::NoRepository
    project.repository.expire_exists_cache

    false
464 465
  end

466
  def project_view_files?
467 468 469 470 471
    if current_user
      current_user.project_view == 'files'
    else
      project_view_files_allowed?
    end
472 473
  end

474
  # Override extract_ref from ExtractsPath, which returns the branch and file path
Douwe Maan's avatar
Douwe Maan committed
475
  # for the blob/tree, which in this case is just the root of the default branch.
476 477 478 479 480 481
  # This way we avoid to access the repository.ref_names.
  def extract_ref(_id)
    [get_id, '']
  end

  # Override get_id from ExtractsPath in this case is just the root of the default branch.
482 483 484
  def get_id
    project.repository.root_ref
  end
485

486 487
  def project_view_files_allowed?
    !project.empty_repo? && can?(current_user, :download_code, project)
488
  end
489 490 491 492 493

  def build_canonical_path(project)
    params[:namespace_id] = project.namespace.to_param
    params[:id] = project.to_param

494
    url_for(safe_params)
495
  end
496 497

  def project_export_enabled
498
    render_404 unless Gitlab::CurrentSettings.project_export_enabled?
499
  end
500 501 502 503 504 505 506

  def redirect_git_extension
    # Redirect from
    #   localhost/group/project.git
    # to
    #   localhost/group/project
    #
507
    redirect_to request.original_url.sub(%r{\.git/?\Z}, '') if params[:format] == 'git'
508
  end
509 510

  def whitelist_query_limiting
511
    Gitlab::QueryLimiting.whitelist('https://gitlab.com/gitlab-org/gitlab/-/issues/20826')
512
  end
513 514 515 516

  def present_project
    @project = @project.present(current_user: current_user)
  end
517 518 519 520

  def export_rate_limit
    prefixed_action = "project_#{params[:action]}".to_sym

521 522
    project_scope = params[:action] == :download_export ? @project : nil

523
    if rate_limiter.throttled?(prefixed_action, scope: [current_user, project_scope].compact)
524 525
      rate_limiter.log_request(request, "#{prefixed_action}_request_limit".to_sym, current_user)

526
      render plain: _('This endpoint has been requested too many times. Try again later.'), status: :too_many_requests
527 528 529 530 531 532
    end
  end

  def rate_limiter
    ::Gitlab::ApplicationRateLimiter
  end
533 534 535 536

  def render_edit
    render 'edit'
  end
gitlabhq's avatar
gitlabhq committed
537
end
538

539
ProjectsController.prepend_if_ee('EE::ProjectsController')