Class: Projects::BlobController

Inherits:
ApplicationController show all
Extended by:
Gitlab::Utils::Override
Includes:
ActionView::Helpers::SanitizeHelper, CreatesCommit, DiffHelper, ExtractsPath, NotesHelper, RedirectsForMissingPathOnTree, RedisTracking, RendersBlob, SourcegraphDecorator
Defined in:
app/controllers/projects/blob_controller.rb

Overview

Controller for viewing a file's blame

Constant Summary

Constants included from NotesHelper

NotesHelper::MAX_PRERENDERED_NOTES

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 Gitlab::Utils::Override

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

Methods included from DiffHelper

#apply_diff_view_cookie!, #diff_file_blob_raw_path, #diff_file_blob_raw_url, #diff_file_changed_icon, #diff_file_changed_icon_color, #diff_file_html_data, #diff_file_old_blob_raw_path, #diff_file_old_blob_raw_url, #diff_line_content, #diff_match_line, #diff_options, #diff_view, #diffs_expanded?, #editable_diff?, #inline_diff_btn, #mark_inline_diffs, #parallel_diff_btn, #parallel_diff_discussions, #render_overflow_warning?, #submodule_diff_compare_link, #submodule_link

Methods included from RedirectsForMissingPathOnTree

#redirect_to_tree_root_for_missing_path

Methods included from NotesHelper

#add_diff_note_button, #can_create_note?, #diff_view_data, #diff_view_line_data, #discussion_path, #discussion_resolved_intro, #discussions_path, #form_resources, #initial_notes_data, #link_to_reply_discussion, #new_form_url, #note_max_access_for_user, #note_supports_quick_actions?, #note_target_fields, #note_target_title, #note_url, #noteable_json, #noteable_note_url, #notes_data, #notes_url, #rendered_for_merge_request?, #serialize_notes?

Methods included from RendersBlob

#blob_json, #conditionally_expand_blob, #conditionally_expand_blobs, #render_blob_json

Methods included from CreatesCommit

#authorize_edit_tree!, #create_commit

Methods included from Gitlab::Utils::StrongMemoize

#clear_memoization, #strong_memoize, #strong_memoized?

Methods included from ExtractsPath

#assign_ref_vars, #extract_ref_without_atom, #lfs_blob_ids

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

#createObject


46
47
48
49
50
51
# File 'app/controllers/projects/blob_controller.rb', line 46

def create
  create_commit(Files::CreateService, success_notice: _("The file has been successfully created."),
                                      success_path: -> { project_blob_path(@project, File.join(@branch_name, @file_path)) },
                                      failure_view: :new,
                                      failure_path: project_new_blob_path(@project, @ref))
end

#destroyObject


99
100
101
102
103
# File 'app/controllers/projects/blob_controller.rb', line 99

def destroy
  create_commit(Files::DeleteService, success_notice: _("The file has been successfully deleted."),
                                      success_path: -> { after_delete_path },
                                      failure_path: project_blob_path(@project, @id))
end

#diffObject


105
106
107
108
109
110
111
112
113
114
115
116
117
# File 'app/controllers/projects/blob_controller.rb', line 105

def diff
  @form = Blobs::UnfoldPresenter.new(blob, diff_params)

  # keep only json rendering when
  # https://gitlab.com/gitlab-org/gitlab-foss/issues/44988 is done
  if rendered_for_merge_request?
    render json: DiffLineSerializer.new.represent(@form.diff_lines)
  else
    @lines = @form.lines
    @match_line = @form.match_line_text
    render layout: false
  end
end

#editObject


69
70
71
72
73
74
75
# File 'app/controllers/projects/blob_controller.rb', line 69

def edit
  if can_collaborate_with_project?(project, ref: @ref)
    blob.load_all_data!
  else
    redirect_to action: 'show'
  end
end

#newObject


42
43
44
# File 'app/controllers/projects/blob_controller.rb', line 42

def new
  commit unless @repository.empty?
end

#previewObject


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

def preview
  @content = params[:content]
  @blob.load_all_data!
  diffy = Diffy::Diff.new(@blob.data, @content, diff: '-U 3', include_diff_info: true)
  diff_lines = diffy.diff.scan(/.*\n/)[2..-1]
  diff_lines = Gitlab::Diff::Parser.new.parse(diff_lines)
  @diff_lines = Gitlab::Diff::Highlight.new(diff_lines, repository: @repository).highlight

  render layout: false
end

#showObject


53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
# File 'app/controllers/projects/blob_controller.rb', line 53

def show
  conditionally_expand_blob(@blob)

  respond_to do |format|
    format.html do
      show_html
    end

    format.json do
      page_title @blob.path, @ref, @project.full_name

      show_json
    end
  end
end

#updateObject


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

def update
  @path = params[:file_path] if params[:file_path].present?

  create_commit(Files::UpdateService, success_path: -> { after_edit_path },
                                      failure_view: :edit,
                                      failure_path: project_blob_path(@project, @id))
rescue Files::UpdateService::FileChangedError
  @conflict = true
  render :edit
end