Module: BlobHelper

Included in:
Projects::AvatarsController, Projects::RawController
Defined in:
app/helpers/blob_helper.rb

Instance Method Summary collapse

Instance Method Details

#blob_icon(mode, name) ⇒ Object

Return an image icon depending on the file mode and extension

mode - File unix mode mode - File name


114
115
116
# File 'app/helpers/blob_helper.rb', line 114

def blob_icon(mode, name)
  icon("#{file_type_icon_class('file', mode, name)} fw")
end

#blob_size(blob) ⇒ Object


122
123
124
125
126
127
128
# File 'app/helpers/blob_helper.rb', line 122

def blob_size(blob)
  if blob.lfs_pointer?
    blob.lfs_size
  else
    blob.size
  end
end

#blob_text_viewable?(blob) ⇒ Boolean

Returns:

  • (Boolean)

118
119
120
# File 'app/helpers/blob_helper.rb', line 118

def blob_text_viewable?(blob)
  blob && blob.text? && !blob.lfs_pointer?
end

#cached_blob?Boolean

Returns:

  • (Boolean)

156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
# File 'app/helpers/blob_helper.rb', line 156

def cached_blob?
  stale = stale?(etag: @blob.id) # The #stale? method sets cache headers.

  # Because we are opionated we set the cache headers ourselves.
  response.cache_control[:public] = @project.public?

  if @ref && @commit && @ref == @commit.id
    # This is a link to a commit by its commit SHA. That means that the blob
    # is immutable. The only reason to invalidate the cache is if the commit
    # was deleted or if the user lost access to the repository.
    response.cache_control[:max_age] = Blob::CACHE_TIME_IMMUTABLE
  else
    # A branch or tag points at this blob. That means that the expected blob
    # value may change over time.
    response.cache_control[:max_age] = Blob::CACHE_TIME
  end

  response.etag = @blob.id
  !stale
end

#can_edit_blob?(blob, project = @project, ref = @ref) ⇒ Boolean

Returns:

  • (Boolean)

94
95
96
# File 'app/helpers/blob_helper.rb', line 94

def can_edit_blob?(blob, project = @project, ref = @ref)
  !blob.lfs_pointer? && can_edit_tree?(project, ref)
end

82
83
84
85
86
87
88
89
90
91
92
# File 'app/helpers/blob_helper.rb', line 82

def delete_blob_link(project = @project, ref = @ref, path = @path)
  modify_file_link(
    project,
    ref,
    path,
    label:      "Delete",
    action:     "delete",
    btn_class:  "remove",
    modal_type: "remove"
  )
end

14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
# File 'app/helpers/blob_helper.rb', line 14

def edit_blob_link(project = @project, ref = @ref, path = @path, options = {})
  return unless current_user

  blob = project.repository.blob_at(ref, path) rescue nil

  return unless blob && blob_text_viewable?(blob)

  from_mr = options[:from_merge_request_id]
  link_opts = {}
  link_opts[:from_merge_request_id] = from_mr if from_mr

  edit_path = namespace_project_edit_blob_path(project.namespace, project,
                                   tree_join(ref, path),
                                   link_opts)

  if !on_top_of_branch?(project, ref)
    button_tag "Edit", class: "btn disabled has-tooltip btn-file-option", title: "You can only edit files when you are on a branch", data: { container: 'body' }
  elsif can_edit_blob?(blob, project, ref)
    link_to "Edit", edit_path, class: 'btn btn-file-option'
  elsif can?(current_user, :fork_project, project)
    continue_params = {
      to:     edit_path,
      notice: edit_in_new_fork_notice,
      notice_now: edit_in_new_fork_notice_now
    }
    fork_path = namespace_project_forks_path(project.namespace, project, namespace_key: current_user.namespace.id, continue: continue_params)

    link_to "Edit", fork_path, class: 'btn btn-file-option', method: :post
  end
end

#editing_preview_title(filename) ⇒ Object


102
103
104
105
106
107
108
# File 'app/helpers/blob_helper.rb', line 102

def editing_preview_title(filename)
  if Gitlab::MarkupHelper.previewable?(filename)
    'Preview'
  else
    'Preview Changes'
  end
end

#highlight(blob_name, blob_content, nowrap: false, plain: false) ⇒ Object


6
7
8
# File 'app/helpers/blob_helper.rb', line 6

def highlight(blob_name, blob_content, nowrap: false, plain: false)
  Gitlab::Highlight.highlight(blob_name, blob_content, nowrap: nowrap, plain: plain)
end

#highlighter(blob_name, blob_content, nowrap: false) ⇒ Object


2
3
4
# File 'app/helpers/blob_helper.rb', line 2

def highlighter(blob_name, blob_content, nowrap: false)
  Gitlab::Highlight.new(blob_name, blob_content, nowrap: nowrap)
end

#leave_edit_messageObject


98
99
100
# File 'app/helpers/blob_helper.rb', line 98

def leave_edit_message
  "Leave edit mode?\nAll unsaved changes will be lost."
end

#licenses_for_selectObject


177
178
179
180
181
182
183
184
185
186
# File 'app/helpers/blob_helper.rb', line 177

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

  licenses = Licensee::License.all

  @licenses_for_select = {
    Popular: licenses.select(&:featured).map { |license| [license.name, license.key] },
    Other: licenses.reject(&:featured).map { |license| [license.name, license.key] }
  }
end

45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
# File 'app/helpers/blob_helper.rb', line 45

def modify_file_link(project = @project, ref = @ref, path = @path, label:, action:, btn_class:, modal_type:)
  return unless current_user

  blob = project.repository.blob_at(ref, path) rescue nil

  return unless blob

  if !on_top_of_branch?(project, ref)
    button_tag label, class: "btn btn-#{btn_class} disabled has-tooltip", title: "You can only #{action} files when you are on a branch", data: { container: 'body' }
  elsif blob.lfs_pointer?
    button_tag label, class: "btn btn-#{btn_class} disabled has-tooltip", title: "It is not possible to #{action} files that are stored in LFS using the web interface", data: { container: 'body' }
  elsif can_edit_blob?(blob, project, ref)
    button_tag label, class: "btn btn-#{btn_class}", 'data-target' => "#modal-#{modal_type}-blob", 'data-toggle' => 'modal'
  elsif can?(current_user, :fork_project, project)
    continue_params = {
      to:     request.fullpath,
      notice: edit_in_new_fork_notice + " Try to #{action} this file again.",
      notice_now: edit_in_new_fork_notice_now
    }
    fork_path = namespace_project_forks_path(project.namespace, project, namespace_key: current_user.namespace.id, continue: continue_params)

    link_to label, fork_path, class: "btn btn-#{btn_class}", method: :post
  end
end

#no_highlight_filesObject


10
11
12
# File 'app/helpers/blob_helper.rb', line 10

def no_highlight_files
  %w(credits changelog news copying copyright license authors)
end

70
71
72
73
74
75
76
77
78
79
80
# File 'app/helpers/blob_helper.rb', line 70

def replace_blob_link(project = @project, ref = @ref, path = @path)
  modify_file_link(
    project,
    ref,
    path,
    label:      "Replace",
    action:     "replace",
    btn_class:  "default",
    modal_type: "upload"
  )
end

#safe_content_type(blob) ⇒ Object

If we blindly set the 'real' content type when serving a Git blob we are enabling XSS attacks. An attacker could upload e.g. a Javascript file to a Git repository, trick the browser of a victim into downloading the blob, and then the 'application/javascript' content type would tell the browser to execute the attacker's Javascript. By overriding the content type and setting it to 'text/plain' (in the example of Javascript) we tell the browser of the victim not to execute untrusted data.


146
147
148
149
150
151
152
153
154
# File 'app/helpers/blob_helper.rb', line 146

def safe_content_type(blob)
  if blob.text?
    'text/plain; charset=utf-8'
  elsif blob.image?
    blob.content_type
  else
    'application/octet-stream'
  end
end

#sanitize_svg(blob) ⇒ Object

SVGs can contain malicious JavaScript; only include whitelisted elements and attributes. Note that this whitelist is by no means complete and may omit some elements.


133
134
135
136
# File 'app/helpers/blob_helper.rb', line 133

def sanitize_svg(blob)
  blob.data = Gitlab::Sanitizers::SVG.clean(blob.data)
  blob
end