118 lines
3.1 KiB
Ruby
118 lines
3.1 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
module DiffViewer
|
|
class Base
|
|
PARTIAL_PATH_PREFIX = 'projects/diffs/viewers'
|
|
|
|
class_attribute :partial_name, :type, :extensions, :binary, :switcher_icon, :switcher_title
|
|
|
|
# These limits relate to the sum of the old and new blob sizes.
|
|
# Limits related to the actual size of the diff are enforced in Gitlab::Diff::File.
|
|
class_attribute :collapse_limit, :size_limit
|
|
|
|
delegate :partial_path, :loading_partial_path, :rich?, :simple?, :text?, :binary?, to: :class
|
|
|
|
attr_reader :diff_file
|
|
|
|
delegate :project, to: :diff_file
|
|
|
|
def initialize(diff_file)
|
|
@diff_file = diff_file
|
|
@initially_binary = diff_file.binary_in_repo?
|
|
end
|
|
|
|
def self.partial_path
|
|
File.join(PARTIAL_PATH_PREFIX, partial_name)
|
|
end
|
|
|
|
def self.rich?
|
|
type == :rich
|
|
end
|
|
|
|
def self.simple?
|
|
type == :simple
|
|
end
|
|
|
|
def self.binary?
|
|
binary
|
|
end
|
|
|
|
def self.text?
|
|
!binary?
|
|
end
|
|
|
|
def self.can_render?(diff_file, verify_binary: true)
|
|
can_render_blob?(diff_file.old_blob, verify_binary: verify_binary) &&
|
|
can_render_blob?(diff_file.new_blob, verify_binary: verify_binary)
|
|
end
|
|
|
|
def self.can_render_blob?(blob, verify_binary: true)
|
|
return true if blob.nil?
|
|
return false if verify_binary && binary? != blob.binary_in_repo?
|
|
return true if extensions&.include?(blob.extension)
|
|
|
|
false
|
|
end
|
|
|
|
def collapsed?
|
|
return @collapsed if defined?(@collapsed)
|
|
return @collapsed = true if diff_file.collapsed?
|
|
|
|
@collapsed = !diff_file.expanded? && collapse_limit && diff_file.raw_size > collapse_limit
|
|
end
|
|
|
|
def too_large?
|
|
return @too_large if defined?(@too_large)
|
|
return @too_large = true if diff_file.too_large?
|
|
|
|
@too_large = size_limit && diff_file.raw_size > size_limit
|
|
end
|
|
|
|
def binary_detected_after_load?
|
|
!@initially_binary && diff_file.binary_in_repo?
|
|
end
|
|
|
|
# This method is used on the server side to check whether we can attempt to
|
|
# render the diff_file at all. The human-readable error message can be
|
|
# retrieved by #render_error_message.
|
|
def render_error
|
|
if too_large?
|
|
:too_large
|
|
end
|
|
end
|
|
|
|
def render_error_message
|
|
return unless render_error
|
|
|
|
_("This %{viewer} could not be displayed because %{reason}. You can %{options} instead.") %
|
|
{
|
|
viewer: switcher_title,
|
|
reason: render_error_reason,
|
|
options: Gitlab::Utils.to_exclusive_sentence(render_error_options)
|
|
}
|
|
end
|
|
|
|
def prepare!
|
|
# To be overridden by subclasses
|
|
end
|
|
|
|
private
|
|
|
|
def render_error_options
|
|
options = []
|
|
|
|
blob_url = Gitlab::Routing.url_helpers.project_blob_path(diff_file.repository.project,
|
|
File.join(diff_file.content_sha, diff_file.file_path))
|
|
options << ActionController::Base.helpers.link_to(_('view the blob'), blob_url)
|
|
|
|
options
|
|
end
|
|
|
|
def render_error_reason
|
|
if render_error == :too_large
|
|
_("it is too large")
|
|
end
|
|
end
|
|
end
|
|
end
|