Module: BlobHelper

Included in:
BlobPresenter, DiffFileBaseEntity, MergeRequestCurrentUserEntity, ProjectPresenter, TreeHelper
Defined in:
app/helpers/blob_helper.rb

Instance Method Summary collapse

Instance Method Details

#blob_editor_paths(project) ⇒ Object 



148
149
150
151
152
153
154
155
156
157
 
# File 'app/helpers/blob_helper.rb', line 148

def blob_editor_paths(project)
  {
    'relative-url-root' => Rails.application.config.relative_url_root,
    'assets-prefix' => Gitlab::Application.config.assets.prefix,
    'blob-filename' => @blob && @blob.path,
    'project-id' => project.id,
    'is-markdown' => @blob && @blob.path && Gitlab::MarkupHelper.gitlab_markdown?(@blob.path),
    'preview-markdown-path' => preview_markdown_path(project)
  }
end

#blob_icon(mode, name) ⇒ Object

Return an image icon depending on the file mode and extension

mode - File unix mode mode - File name



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

def blob_icon(mode, name)
  sprite_icon(file_type_icon_class('file', mode, name))
end

#blob_raw_path(**kwargs) ⇒ Object 



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

def blob_raw_path(**kwargs)
  blob_raw_url(**kwargs, only_path: true)
end

#blob_raw_url(**kwargs) ⇒ Object 



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

def blob_raw_url(**kwargs)
  if @build && @entry
    raw_project_job_artifacts_url(@project, @build, path: @entry.path, **kwargs)
  elsif @snippet
    gitlab_raw_snippet_url(@snippet)
  elsif @blob
    project_raw_url(@project, @id, **kwargs)
  end
end

#blob_render_error_options(viewer) ⇒ Object 



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'app/helpers/blob_helper.rb', line 219

def blob_render_error_options(viewer)
  error = viewer.render_error
  options = []

  if error == :collapsed
    options << link_to('load it anyway', url_for(safe_params.merge(viewer: viewer.type, expanded: true, format: nil)))
  end

  # If the error is `:server_side_but_stored_externally`, the simple viewer will show the same error,
  # so don't bother switching.
  if viewer.rich? && viewer.blob.rendered_as_text? && error != :server_side_but_stored_externally
    options << link_to('view the source', '#', class: 'js-blob-viewer-switch-btn', data: { viewer: 'simple' })
  end

  options << link_to('download it', blob_raw_path, target: '_blank', rel: 'noopener noreferrer')

  options
end

#blob_render_error_reason(viewer) ⇒ Object 



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'app/helpers/blob_helper.rb', line 201

def blob_render_error_reason(viewer)
  case viewer.render_error
  when :collapsed
    "it is larger than #{number_to_human_size(viewer.collapse_limit)}"
  when :too_large
    "it is larger than #{number_to_human_size(viewer.size_limit)}"
  when :server_side_but_stored_externally
    case viewer.blob.external_storage
    when :lfs
      'it is stored in LFS'
    when :build_artifact
      'it is stored as a job artifact'
    else
      'it is stored externally'
    end
  end
end

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

Returns:

  • (Boolean) 


79
80
81
 
# File 'app/helpers/blob_helper.rb', line 79

def can_modify_blob?(blob, project = @project, ref = @ref)
  !blob.stored_externally? && can_edit_tree?(project, ref)
end

#contribution_options(project) ⇒ Object 



238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'app/helpers/blob_helper.rb', line 238

def contribution_options(project)
  options = []

  if can?(current_user, :create_issue, project)
    options << link_to("submit an issue", new_project_issue_path(project))
  end

  merge_project = merge_request_source_project_for_project(@project)
  if merge_project
    options << link_to("create a merge request", project_new_merge_request_path(project))
  end

  options
end

#copy_blob_source_button(blob) ⇒ Object 



163
164
165
166
167
168
169
 
# File 'app/helpers/blob_helper.rb', line 163

def copy_blob_source_button(blob)
  return unless blob.rendered_as_text?(ignore_errors: false)

  content_tag(:span, class: 'btn-group has-tooltip js-copy-blob-source-btn-tooltip') do
    clipboard_button(target: ".blob-content[data-blob-id='#{blob.id}'] > pre", class: "btn gl-button btn-default btn-icon js-copy-blob-source-btn", hide_tooltip: true)
  end
end

#copy_file_path_button(file_path) ⇒ Object 



159
160
161
 
# File 'app/helpers/blob_helper.rb', line 159

def copy_file_path_button(file_path)
  clipboard_button(text: file_path, gfm: "`#{file_path}`", class: 'gl-button btn btn-default-tertiary btn-icon btn-sm', title: _('Copy file path'))
end

#dockerfile_names(project) ⇒ Object 



144
145
146
 
# File 'app/helpers/blob_helper.rb', line 144

def dockerfile_names(project)
  @dockerfile_names ||= TemplateFinder.all_template_names(project, :dockerfiles)
end

#download_blob_button(blob) ⇒ Object 



186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'app/helpers/blob_helper.rb', line 186

def download_blob_button(blob)
  return if blob.empty?

  title = _('Download')
  link_to sprite_icon('download'),
    external_storage_url_or_path(blob_raw_path(inline: false)),
    download: @path,
    class: 'btn gl-button btn-default btn-icon has-tooltip',
    target: '_blank',
    rel: 'noopener noreferrer',
    aria: { label: title },
    title: title,
    data: { container: 'body' }
end

#edit_blob_button(project = @project, ref = @ref, path = @path, options = {}) ⇒ Object 



64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'app/helpers/blob_helper.rb', line 64

def edit_blob_button(project = @project, ref = @ref, path = @path, options = {})
  return unless blob = readable_blob(options, path, project, ref)

  common_classes = "btn gl-button btn-confirm js-edit-blob gl-ml-3 #{options[:extra_class]}"

  edit_button_tag(
    blob,
    common_classes,
    _('Edit'),
    edit_blob_path(project, ref, path, options),
    project,
    ref
  )
end

#edit_blob_fork_params(path, with_notice: true) ⇒ Object 



263
264
265
266
267
268
269
 
# File 'app/helpers/blob_helper.rb', line 263

def edit_blob_fork_params(path, with_notice: true)
  {
    to: path,
    notice: (edit_in_new_fork_notice if with_notice),
    notice_now: (edit_in_new_fork_notice_now if with_notice)
  }.compact
end

#edit_blob_path(project = @project, ref = @ref, path = @path, options = {}) ⇒ Object 



4
5
6
 
# File 'app/helpers/blob_helper.rb', line 4

def edit_blob_path(project = @project, ref = @ref, path = @path, options = {})
  project_edit_blob_path(project, tree_join(ref, path), options[:link_opts])
end

#edit_button_tag(blob, common_classes, text, edit_path, project, ref) ⇒ Object 



291
292
293
294
295
296
297
298
299
300
 
# File 'app/helpers/blob_helper.rb', line 291

def edit_button_tag(blob, common_classes, text, edit_path, project, ref)
  if !on_top_of_branch?(project, ref)
    edit_disabled_button_tag(text, common_classes)
    # This condition only applies to users who are logged in
  elsif !current_user || (current_user && can_modify_blob?(blob, project, ref))
    edit_link_tag(text, edit_path, common_classes)
  elsif can?(current_user, :fork_project, project) && can?(current_user, :create_merge_request_in, project)
    edit_fork_button_tag(common_classes, project, text, edit_blob_fork_params(edit_path))
  end
end

#edit_disabled_button_tag(button_text, common_classes) ⇒ Object 



279
280
281
282
283
284
285
 
# File 'app/helpers/blob_helper.rb', line 279

def edit_disabled_button_tag(button_text, common_classes)
  button = button_tag(button_text, class: "#{common_classes} disabled", disabled: true)

  # Disabled buttons with tooltips should have the tooltip attached
  # to a wrapper element https://bootstrap-vue.org/docs/components/tooltip#disabled-elements
  content_tag(:span, button, class: 'has-tooltip', title: _('You can only edit files when you are on a branch'), data: { container: 'body' })
end

#edit_fork_button_tag(common_classes, project, label, params, action = 'edit') ⇒ Object 



271
272
273
274
275
276
277
 
# File 'app/helpers/blob_helper.rb', line 271

def edit_fork_button_tag(common_classes, project, label, params, action = 'edit')
  fork_path = project_forks_path(project, namespace_key: current_user.namespace.id, continue: params)

  button_tag label,
    class: "#{common_classes} js-edit-blob-link-fork-toggler",
    data: { action: action, fork_path: fork_path }
end

#edit_link_tag(link_text, edit_path, common_classes) ⇒ Object 



287
288
289
 
# File 'app/helpers/blob_helper.rb', line 287

def edit_link_tag(link_text, edit_path, common_classes)
  link_to link_text, edit_path, class: common_classes
end

#editing_preview_title(filename) ⇒ Object 



87
88
89
90
91
92
93
 
# File 'app/helpers/blob_helper.rb', line 87

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

#encode_ide_path(path) ⇒ Object 



60
61
62
 
# File 'app/helpers/blob_helper.rb', line 60

def encode_ide_path(path)
  ERB::Util.url_encode(path).gsub('%2F', '/')
end

#fork_and_edit_path(project = @project, ref = @ref, path = @path, options = {}) ⇒ Object 



46
47
48
 
# File 'app/helpers/blob_helper.rb', line 46

def fork_and_edit_path(project = @project, ref = @ref, path = @path, options = {})
  fork_path_for_current_user(project, edit_blob_path(project, ref, path, options))
end

#fork_path_for_current_user(project, path, with_notice: true) ⇒ Object 



50
51
52
53
54
55
56
57
58
 
# File 'app/helpers/blob_helper.rb', line 50

def fork_path_for_current_user(project, path, with_notice: true)
  return unless current_user

  project_forks_path(
    project,
    namespace_key: current_user.namespace&.id,
    continue: edit_blob_fork_params(path, with_notice: with_notice)
  )
end

#gitignore_names(project) ⇒ Object 



136
137
138
 
# File 'app/helpers/blob_helper.rb', line 136

def gitignore_names(project)
  @gitignore_names ||= TemplateFinder.all_template_names(project, :gitignores)
end

#gitlab_ci_ymls(project) ⇒ Object 



140
141
142
 
# File 'app/helpers/blob_helper.rb', line 140

def gitlab_ci_ymls(project)
  @gitlab_ci_ymls ||= TemplateFinder.all_template_names(project, :gitlab_ci_ymls)
end

#human_access ⇒ Object 



313
314
315
 
# File 'app/helpers/blob_helper.rb', line 313

def human_access
  @project.team.human_max_access(current_user&.id).try(:downcase)
end

#ide_edit_path(project = @project, ref = @ref, path = @path) ⇒ Object 



8
9
10
11
12
13
14
15
16
17
18
19
20
21
 
# File 'app/helpers/blob_helper.rb', line 8

def ide_edit_path(project = @project, ref = @ref, path = @path)
  project_path =
    if !current_user || can?(current_user, :push_code, project)
      project.full_path
    else
      # We currently always fork to the user's namespace
      # in edit_fork_button_tag
      "#{current_user.namespace.full_path}/#{project.path}"
    end

  segments = [ide_path, 'project', project_path, 'edit', encode_ide_path(ref)]
  segments.concat(['-', encode_ide_path(path)]) if path.present?
  File.join(segments)
end

#ide_fork_and_edit_path(project = @project, ref = @ref, path = @path, with_notice: true) ⇒ Object 



42
43
44
 
# File 'app/helpers/blob_helper.rb', line 42

def ide_fork_and_edit_path(project = @project, ref = @ref, path = @path, with_notice: true)
  fork_path_for_current_user(project, ide_edit_path(project, ref, path), with_notice: with_notice)
end

#ide_merge_request_path(merge_request, path = '') ⇒ Object 



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'app/helpers/blob_helper.rb', line 23

def ide_merge_request_path(merge_request, path = '')
  target_project = merge_request.target_project
  source_project = merge_request.source_project

  if merge_request.merged?
    branch = merge_request.target_branch_exists? ? merge_request.target_branch : target_project.default_branch

    return ide_edit_path(target_project, branch, path)
  end

  if target_project != source_project
    params = { target_project: target_project.full_path }
  end

  result = File.join(ide_path, 'project', source_project.full_path, 'merge_requests', merge_request.to_param)
  result += "?#{params.to_query}" unless params.nil?
  result
end

#leave_edit_message ⇒ Object 



83
84
85
 
# File 'app/helpers/blob_helper.rb', line 83

def leave_edit_message
  _("Leave edit mode? All unsaved changes will be lost.")
end

#licenses_for_select(project) ⇒ Object 



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

def licenses_for_select(project)
  @licenses_for_select ||= TemplateFinder.all_template_names(project, :licenses)
end

#open_raw_blob_button(blob) ⇒ Object 



171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'app/helpers/blob_helper.rb', line 171

def open_raw_blob_button(blob)
  return if blob.empty?
  return if blob.binary? || blob.stored_externally?

  title = _('Open raw')
  link_to sprite_icon('doc-code'),
    external_storage_url_or_path(blob_raw_path),
    class: 'btn gl-button btn-default btn-icon has-tooltip',
    target: '_blank',
    rel: 'noopener noreferrer',
    aria: { label: title },
    title: title,
    data: { container: 'body' }
end

#parent_dir_raw_path ⇒ Object 



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

def parent_dir_raw_path
  "#{blob_raw_path.rpartition('/').first}/"
end

#readable_blob(options, path, project, ref) ⇒ Object 



253
254
255
256
257
258
259
260
261
 
# File 'app/helpers/blob_helper.rb', line 253

def readable_blob(options, path, project, ref)
  blob = options.fetch(:blob) do
    project.repository.blob_at(ref, path)
  rescue StandardError
    nil
  end

  blob if blob&.readable_text?
end

#ref_project ⇒ Object 



128
129
130
 
# File 'app/helpers/blob_helper.rb', line 128

def ref_project
  @ref_project ||= @target_project || @project
end

#sanitize_svg_data(data) ⇒ Object

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



124
125
126
 
# File 'app/helpers/blob_helper.rb', line 124

def sanitize_svg_data(data)
  Gitlab::Sanitizers::SVG.clean(data)
end

#show_suggest_pipeline_creation_celebration? ⇒ Boolean

Returns:

  • (Boolean) 


302
303
304
305
306
307
 
# File 'app/helpers/blob_helper.rb', line 302

def show_suggest_pipeline_creation_celebration?
  @blob.path == Gitlab::FileDetector::PATTERNS[:gitlab_ci] &&
    @blob.auxiliary_viewer&.valid?(project: @project, sha: @commit.sha, user: current_user) &&
    @project.uses_default_ci_config? &&
    cookies[suggest_pipeline_commit_cookie_name].present?
end

#suggest_pipeline_commit_cookie_name ⇒ Object 



309
310
311
 
# File 'app/helpers/blob_helper.rb', line 309

def suggest_pipeline_commit_cookie_name
  "suggest_gitlab_ci_yml_commit_#{@project.id}"
end

#vue_blob_app_data(project, blob, ref) ⇒ Object 



317
318
319
320
321
322
323
324
325
326
 
# File 'app/helpers/blob_helper.rb', line 317

def vue_blob_app_data(project, blob, ref)
  {
    blob_path: blob.path,
    project_path: project.full_path,
    resource_id: project.to_global_id,
    user_id: current_user.present? ? current_user.to_global_id : '',
    target_branch: project.empty_repo? ? ref : @ref,
    original_branch: @ref
  }
end