blob.rb 4,5 КБ
Newer Older
Robert Speicher's avatar
Robert Speicher включено в состав коммита
1
2
# Blob is a Rails-specific wrapper around Gitlab::Git::Blob objects
class Blob < SimpleDelegator
Jacob Vosmaer's avatar
Jacob Vosmaer включено в состав коммита
3
4
5
  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

Douwe Maan's avatar
Douwe Maan включено в состав коммита
6
7
  MAXIMUM_TEXT_HIGHLIGHT_SIZE = 1.megabyte

Douwe Maan's avatar
Douwe Maan включено в состав коммита
8
9
10
11
12
13
14
15
16
17
18
19
20
21
  # 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.
Douwe Maan's avatar
Douwe Maan включено в состав коммита
22
  RICH_VIEWERS = [
Douwe Maan's avatar
Douwe Maan включено в состав коммита
23
24
25
26
    BlobViewer::Markup,
    BlobViewer::Notebook,
    BlobViewer::SVG,

Douwe Maan's avatar
Douwe Maan включено в состав коммита
27
28
    BlobViewer::Image,
    BlobViewer::Sketch,
Douwe Maan's avatar
Douwe Maan включено в состав коммита
29
30
31

    BlobViewer::PDF,

Douwe Maan's avatar
Douwe Maan включено в состав коммита
32
33
    BlobViewer::BinarySTL,
    BlobViewer::TextSTL,
Douwe Maan's avatar
Douwe Maan включено в состав коммита
34
  ].freeze
Yorick Peterse's avatar
Yorick Peterse включено в состав коммита
35

Douwe Maan's avatar
Douwe Maan включено в состав коммита
36
37
38
  BINARY_VIEWERS = RICH_VIEWERS.select(&:binary?).freeze
  TEXT_VIEWERS = RICH_VIEWERS.select(&:text?).freeze

Douwe Maan's avatar
Douwe Maan включено в состав коммита
39
40
  attr_reader :project

Robert Speicher's avatar
Robert Speicher включено в состав коммита
41
42
43
44
45
46
47
48
49
50
  # 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
Douwe Maan's avatar
Douwe Maan включено в состав коммита
51
  def self.decorate(blob, project = nil)
Robert Speicher's avatar
Robert Speicher включено в состав коммита
52
53
    return if blob.nil?

Douwe Maan's avatar
Douwe Maan включено в состав коммита
54
55
56
    new(blob, project)
  end

Douwe Maan's avatar
Douwe Maan включено в состав коммита
57
  def initialize(blob, project = nil)
Douwe Maan's avatar
Douwe Maan включено в состав коммита
58
59
60
    @project = project

    super(blob)
Robert Speicher's avatar
Robert Speicher включено в состав коммита
61
62
  end

Yorick Peterse's avatar
Yorick Peterse включено в состав коммита
63
64
65
66
67
68
69
70
71
72
73
74
  # 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

Zeger-Jan van de Weg's avatar
Zeger-Jan van de Weg включено в состав коммита
75
  def no_highlighting?
Douwe Maan's avatar
Douwe Maan включено в состав коммита
76
    size && size > MAXIMUM_TEXT_HIGHLIGHT_SIZE
Zeger-Jan van de Weg's avatar
Zeger-Jan van de Weg включено в состав коммита
77
78
  end

Douwe Maan's avatar
Douwe Maan включено в состав коммита
79
  def too_large?
Stan Hu's avatar
Stan Hu включено в состав коммита
80
    size && truncated?
Zeger-Jan van de Weg's avatar
Zeger-Jan van de Weg включено в состав коммита
81
82
  end

Douwe Maan's avatar
Douwe Maan включено в состав коммита
83
84
85
  # 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.
Douwe Maan's avatar
Douwe Maan включено в состав коммита
86
87
88
89
90
91
  def raw_size
    if valid_lfs_pointer?
      lfs_size
    else
      size
    end
Douwe Maan's avatar
Douwe Maan включено в состав коммита
92
93
  end

Douwe Maan's avatar
Douwe Maan включено в состав коммита
94
95
96
97
  # 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.
Douwe Maan's avatar
Douwe Maan включено в состав коммита
98
99
  def raw_binary?
    if valid_lfs_pointer?
Douwe Maan's avatar
Douwe Maan включено в состав коммита
100
101
102
103
104
      if rich_viewer
        rich_viewer.binary?
      else
        true
      end
Douwe Maan's avatar
Douwe Maan включено в состав коммита
105
106
107
    else
      binary?
    end
Robert Speicher's avatar
Robert Speicher включено в состав коммита
108
109
  end

Douwe Maan's avatar
Douwe Maan включено в состав коммита
110
111
  def extension
    @extension ||= extname.downcase.delete('.')
Sam Rose's avatar
Sam Rose включено в состав коммита
112
113
  end

Douwe Maan's avatar
Douwe Maan включено в состав коммита
114
115
  def video?
    UploaderHelper::VIDEO_EXT.include?(extension)
Phil Hughes's avatar
Phil Hughes включено в состав коммита
116
117
  end

Douwe Maan's avatar
Douwe Maan включено в состав коммита
118
119
  def readable_text?
    text? && !valid_lfs_pointer? && !too_large?
Jacob Schatz's avatar
Jacob Schatz включено в состав коммита
120
121
  end

Douwe Maan's avatar
Douwe Maan включено в состав коммита
122
  def valid_lfs_pointer?
Douwe Maan's avatar
Douwe Maan включено в состав коммита
123
    lfs_pointer? && project&.lfs_enabled?
Douwe Maan's avatar
Douwe Maan включено в состав коммита
124
125
  end

Douwe Maan's avatar
Douwe Maan включено в состав коммита
126
  def invalid_lfs_pointer?
Douwe Maan's avatar
Douwe Maan включено в состав коммита
127
    lfs_pointer? && !project&.lfs_enabled?
Phil Hughes's avatar
Phil Hughes включено в состав коммита
128
129
  end

Douwe Maan's avatar
Douwe Maan включено в состав коммита
130
131
132
133
134
135
136
  def simple_viewer
    @simple_viewer ||= simple_viewer_class.new(self)
  end

  def rich_viewer
    return @rich_viewer if defined?(@rich_viewer)

Douwe Maan's avatar
Douwe Maan включено в состав коммита
137
    @rich_viewer = rich_viewer_class&.new(self)
Douwe Maan's avatar
Douwe Maan включено в состав коммита
138
139
  end

Douwe Maan's avatar
Douwe Maan включено в состав коммита
140
  def rendered_as_text?(ignore_errors: true)
Douwe Maan's avatar
Douwe Maan включено в состав коммита
141
    simple_viewer.text? && (ignore_errors || simple_viewer.render_error.nil?)
Douwe Maan's avatar
Douwe Maan включено в состав коммита
142
143
144
  end

  def show_viewer_switcher?
Douwe Maan's avatar
Douwe Maan включено в состав коммита
145
146
147
148
149
150
    rendered_as_text? && rich_viewer
  end

  def override_max_size!
    simple_viewer&.override_max_size = true
    rich_viewer&.override_max_size = true
Douwe Maan's avatar
Douwe Maan включено в состав коммита
151
152
153
154
  end

  private

Douwe Maan's avatar
Douwe Maan включено в состав коммита
155
156
157
158
159
160
161
162
163
164
165
166
167
  def simple_viewer_class
    if empty?
      BlobViewer::Empty
    elsif raw_binary?
      BlobViewer::Download
    else # text
      BlobViewer::Text
    end
  end

  def rich_viewer_class
    return if invalid_lfs_pointer? || empty?

Douwe Maan's avatar
Douwe Maan включено в состав коммита
168
169
    classes =
      if valid_lfs_pointer?
Douwe Maan's avatar
Douwe Maan включено в состав коммита
170
        BINARY_VIEWERS + TEXT_VIEWERS
Douwe Maan's avatar
Douwe Maan включено в состав коммита
171
      elsif binary?
Douwe Maan's avatar
Douwe Maan включено в состав коммита
172
        BINARY_VIEWERS
Douwe Maan's avatar
Douwe Maan включено в состав коммита
173
      else # text
Douwe Maan's avatar
Douwe Maan включено в состав коммита
174
        TEXT_VIEWERS
Douwe Maan's avatar
Douwe Maan включено в состав коммита
175
176
177
      end

    classes.find { |viewer_class| viewer_class.can_render?(self) }
Douwe Maan's avatar
Douwe Maan включено в состав коммита
178
  end
Robert Speicher's avatar
Robert Speicher включено в состав коммита
179
end