debian-mirror-gitlab/app/models/blob.rb

197 lines
4.8 KiB
Ruby
Raw Normal View History

2016-06-02 11:05:42 +05:30
# Blob is a Rails-specific wrapper around Gitlab::Git::Blob objects
class Blob < SimpleDelegator
CACHE_TIME = 60 # Cache raw blobs referred to by a (mutable) ref for 1 minute
CACHE_TIME_IMMUTABLE = 3600 # Cache blobs referred to by an immutable reference for 1 hour
2017-08-17 22:00:37 +05:30
MAXIMUM_TEXT_HIGHLIGHT_SIZE = 1.megabyte
# Finding a viewer for a blob happens based only on extension and whether the
# blob is binary or text, which means 1 blob should only be matched by 1 viewer,
# and the order of these viewers doesn't really matter.
#
# However, when the blob is an LFS pointer, we cannot know for sure whether the
# file being pointed to is binary or text. In this case, we match only on
# extension, preferring binary viewers over text ones if both exist, since the
# large files referred to in "Large File Storage" are much more likely to be
# binary than text.
#
# `.stl` files, for example, exist in both binary and text forms, and are
# handled by different viewers (`BinarySTL` and `TextSTL`) depending on blob
# type. LFS pointers to `.stl` files are assumed to always be the binary kind,
# and use the `BinarySTL` viewer.
RICH_VIEWERS = [
BlobViewer::Markup,
BlobViewer::Notebook,
BlobViewer::SVG,
BlobViewer::Image,
BlobViewer::Sketch,
BlobViewer::Balsamiq,
BlobViewer::Video,
BlobViewer::PDF,
BlobViewer::BinarySTL,
BlobViewer::TextSTL,
].freeze
BINARY_VIEWERS = RICH_VIEWERS.select(&:binary?).freeze
TEXT_VIEWERS = RICH_VIEWERS.select(&:text?).freeze
attr_reader :project
2016-09-13 17:45:13 +05:30
2016-06-02 11:05:42 +05:30
# Wrap a Gitlab::Git::Blob object, or return nil when given nil
#
# This method prevents the decorated object from evaluating to "truthy" when
# given a nil value. For example:
#
# blob = Blob.new(nil)
# puts "truthy" if blob # => "truthy"
#
# blob = Blob.decorate(nil)
# puts "truthy" if blob # No output
2017-08-17 22:00:37 +05:30
def self.decorate(blob, project = nil)
2016-06-02 11:05:42 +05:30
return if blob.nil?
2017-08-17 22:00:37 +05:30
new(blob, project)
end
def initialize(blob, project = nil)
@project = project
super(blob)
2016-06-02 11:05:42 +05:30
end
2016-09-29 09:46:39 +05:30
# Returns the data of the blob.
#
# If the blob is a text based blob the content is converted to UTF-8 and any
# invalid byte sequences are replaced.
def data
if binary?
super
else
@data ||= super.encode(Encoding::UTF_8, invalid: :replace, undef: :replace)
end
end
2016-06-02 11:05:42 +05:30
def no_highlighting?
2017-08-17 22:00:37 +05:30
raw_size && raw_size > MAXIMUM_TEXT_HIGHLIGHT_SIZE
2016-06-02 11:05:42 +05:30
end
2017-08-17 22:00:37 +05:30
def empty?
raw_size == 0
end
def too_large?
size && truncated?
2016-06-02 11:05:42 +05:30
end
2017-08-17 22:00:37 +05:30
def external_storage_error?
if external_storage == :lfs
!project&.lfs_enabled?
else
false
end
2016-06-02 11:05:42 +05:30
end
2017-08-17 22:00:37 +05:30
def stored_externally?
return @stored_externally if defined?(@stored_externally)
@stored_externally = external_storage && !external_storage_error?
2016-09-13 17:45:13 +05:30
end
2017-08-17 22:00:37 +05:30
# Returns the size of the file that this blob represents. If this blob is an
# LFS pointer, this is the size of the file stored in LFS. Otherwise, this is
# the size of the blob itself.
def raw_size
if stored_externally?
external_size
else
size
end
2016-08-24 12:49:21 +05:30
end
2017-08-17 22:00:37 +05:30
# Returns whether the file that this blob represents is binary. If this blob is
# an LFS pointer, we assume the file stored in LFS is binary, unless a
# text-based rich blob viewer matched on the file's extension. Otherwise, this
# depends on the type of the blob itself.
def raw_binary?
if stored_externally?
if rich_viewer
rich_viewer.binary?
elsif Linguist::Language.find_by_filename(name).any?
false
elsif _mime_type
_mime_type.binary?
else
true
end
2016-06-02 11:05:42 +05:30
else
2017-08-17 22:00:37 +05:30
binary?
end
end
def extension
@extension ||= extname.downcase.delete('.')
end
def video?
UploaderHelper::VIDEO_EXT.include?(extension)
end
def readable_text?
text? && !stored_externally? && !too_large?
end
def simple_viewer
@simple_viewer ||= simple_viewer_class.new(self)
end
def rich_viewer
return @rich_viewer if defined?(@rich_viewer)
@rich_viewer = rich_viewer_class&.new(self)
end
def rendered_as_text?(ignore_errors: true)
simple_viewer.text? && (ignore_errors || simple_viewer.render_error.nil?)
end
def show_viewer_switcher?
rendered_as_text? && rich_viewer
end
def override_max_size!
simple_viewer&.override_max_size = true
rich_viewer&.override_max_size = true
end
private
def simple_viewer_class
if empty?
BlobViewer::Empty
elsif raw_binary?
BlobViewer::Download
else # text
BlobViewer::Text
2016-06-02 11:05:42 +05:30
end
end
2017-08-17 22:00:37 +05:30
def rich_viewer_class
return if empty? || external_storage_error?
classes =
if stored_externally?
BINARY_VIEWERS + TEXT_VIEWERS
elsif binary?
BINARY_VIEWERS
else # text
TEXT_VIEWERS
end
classes.find { |viewer_class| viewer_class.can_render?(self) }
end
2016-06-02 11:05:42 +05:30
end