105 lines
2.5 KiB
Ruby
105 lines
2.5 KiB
Ruby
module BlobViewer
|
|
class Base
|
|
PARTIAL_PATH_PREFIX = 'projects/blob/viewers'.freeze
|
|
|
|
class_attribute :partial_name, :loading_partial_name, :type, :extensions, :file_types, :load_async, :binary, :switcher_icon, :switcher_title, :overridable_max_size, :max_size
|
|
|
|
self.loading_partial_name = 'loading'
|
|
|
|
delegate :partial_path, :loading_partial_path, :rich?, :simple?, :text?, :binary?, to: :class
|
|
|
|
attr_reader :blob
|
|
attr_accessor :override_max_size
|
|
|
|
delegate :project, to: :blob
|
|
|
|
def initialize(blob)
|
|
@blob = blob
|
|
end
|
|
|
|
def self.partial_path
|
|
File.join(PARTIAL_PATH_PREFIX, partial_name)
|
|
end
|
|
|
|
def self.loading_partial_path
|
|
File.join(PARTIAL_PATH_PREFIX, loading_partial_name)
|
|
end
|
|
|
|
def self.rich?
|
|
type == :rich
|
|
end
|
|
|
|
def self.simple?
|
|
type == :simple
|
|
end
|
|
|
|
def self.auxiliary?
|
|
type == :auxiliary
|
|
end
|
|
|
|
def self.load_async?
|
|
load_async
|
|
end
|
|
|
|
def self.binary?
|
|
binary
|
|
end
|
|
|
|
def self.text?
|
|
!binary?
|
|
end
|
|
|
|
def self.can_render?(blob, verify_binary: true)
|
|
return false if verify_binary && binary? != blob.binary?
|
|
return true if extensions&.include?(blob.extension)
|
|
return true if file_types&.include?(Gitlab::FileDetector.type_of(blob.path))
|
|
|
|
false
|
|
end
|
|
|
|
def load_async?
|
|
self.class.load_async? && render_error.nil?
|
|
end
|
|
|
|
def exceeds_overridable_max_size?
|
|
overridable_max_size && blob.raw_size > overridable_max_size
|
|
end
|
|
|
|
def exceeds_max_size?
|
|
max_size && blob.raw_size > max_size
|
|
end
|
|
|
|
def can_override_max_size?
|
|
exceeds_overridable_max_size? && !exceeds_max_size?
|
|
end
|
|
|
|
def too_large?
|
|
if override_max_size
|
|
exceeds_max_size?
|
|
else
|
|
exceeds_overridable_max_size?
|
|
end
|
|
end
|
|
|
|
# This method is used on the server side to check whether we can attempt to
|
|
# render the blob at all. Human-readable error messages are found in the
|
|
# `BlobHelper#blob_render_error_reason` helper.
|
|
#
|
|
# This method does not and should not load the entire blob contents into
|
|
# memory, and should not be overridden to do so in order to validate the
|
|
# format of the blob.
|
|
#
|
|
# Prefer to implement a client-side viewer, where the JS component loads the
|
|
# binary from `blob_raw_url` and does its own format validation and error
|
|
# rendering, especially for potentially large binary formats.
|
|
def render_error
|
|
if too_large?
|
|
:too_large
|
|
end
|
|
end
|
|
|
|
def prepare!
|
|
# To be overridden by subclasses
|
|
end
|
|
end
|
|
end
|