Class: Projects::ArtifactsController

Inherits:
ApplicationController show all
Includes:
ExtractsPath, RendersBlob, SendFileUpload
Defined in:
app/controllers/projects/artifacts_controller.rb

Constant Summary collapse

MAX_PER_PAGE =
20

Constants included from ExtractsRef

ExtractsRef::InvalidPathError

Constants included from CookiesHelper

CookiesHelper::COOKIE_TYPE_ENCRYPTED, CookiesHelper::COOKIE_TYPE_PERMANENT

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::NoCacheHeaders

Gitlab::NoCacheHeaders::DEFAULT_GITLAB_NO_CACHE_HEADERS

Instance Method Summary collapse

Methods included from SendFileUpload

#content_type_for, #guess_content_type, #send_upload

Methods included from RendersBlob

#blob_json, #conditionally_expand_blob, #conditionally_expand_blobs, #render_blob_json

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, #extract_ref, #tree

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

#set_secure_cookie

Methods inherited from ApplicationController

#not_found, #redirect_back_or_default, #render, #route_not_found

Methods included from Gitlab::Utils::StrongMemoize

#clear_memoization, #strong_memoize, #strong_memoized?

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, #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_card_attributes, #page_card_meta_tags, #page_description, #page_image, #page_title, #search_context, #sidebar

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

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

Methods included from Gitlab::NoCacheHeaders

#no_cache_headers

Methods included from Gitlab::GonHelper

#add_gon_variables, #default_avatar_url, #push_frontend_feature_flag

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

#browseObject


48
49
50
51
52
53
54
# File 'app/controllers/projects/artifacts_controller.rb', line 48

def browse
  @path = params[:path]
  directory = @path ? "#{@path}/" : ''
  @entry = build.(directory)

  render_404 unless @entry.exists?
end

#destroyObject


32
33
34
35
36
37
38
39
40
# File 'app/controllers/projects/artifacts_controller.rb', line 32

def destroy
  notice = if artifact.destroy
             _('Artifact was successfully deleted.')
           else
             _('Artifact could not be deleted.')
           end

  redirect_to project_artifacts_path(@project), status: :see_other, notice: notice
end

#downloadObject


42
43
44
45
46
# File 'app/controllers/projects/artifacts_controller.rb', line 42

def download
  return render_404 unless artifacts_file

  send_upload(artifacts_file, attachment: artifacts_file.filename, proxy: params[:proxy])
end

#fileObject


56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
# File 'app/controllers/projects/artifacts_controller.rb', line 56

def file
  blob = @entry.blob
  conditionally_expand_blob(blob)

  if blob.external_link?(build)
    redirect_to blob.external_url(@project, build)
  else
    respond_to do |format|
      format.html do
        render 'file'
      end

      format.json do
        render_blob_json(blob)
      end
    end
  end
end

#indexObject


18
19
20
21
22
23
24
25
26
27
28
29
30
# File 'app/controllers/projects/artifacts_controller.rb', line 18

def index
  # Loading artifacts is very expensive in projects with a lot of artifacts.
  # This feature flag prevents a DOS attack vector.
  # It should be removed only after resolving the underlying performance
  # issues: https://gitlab.com/gitlab-org/gitlab/issues/32281
  return head :no_content unless Feature.enabled?(:artifacts_management_page, @project)

  finder = Ci::JobArtifactsFinder.new(@project, artifacts_params)
  all_artifacts = finder.execute

  @artifacts = all_artifacts.page(params[:page]).per(MAX_PER_PAGE)
  @total_size = all_artifacts.total_size
end

#keepObject


83
84
85
86
# File 'app/controllers/projects/artifacts_controller.rb', line 83

def keep
  build.keep_artifacts!
  redirect_to project_job_path(project, build)
end

#latest_succeededObject


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

def latest_succeeded
  target_path = artifacts_action_path(@path, project, build)

  if target_path
    redirect_to(target_path)
  else
    render_404
  end
end

#rawObject


75
76
77
78
79
80
81
# File 'app/controllers/projects/artifacts_controller.rb', line 75

def raw
  return render_404 unless zip_artifact?

  path = Gitlab::Ci::Build::Artifacts::Path.new(params[:path])

  send_artifacts_entry(artifacts_file, path)
end