Module: BlobHelper

Instance Method Summary collapse

Instance Method Details

#blob_editor_paths(project) ⇒ Object


232
233
234
235
236
237
238
239
240
# File 'app/helpers/blob_helper.rb', line 232

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)
  }
end

#blob_icon(mode, name) ⇒ Object

Return an image icon depending on the file mode and extension

mode - File unix mode mode - File name


171
172
173
# File 'app/helpers/blob_helper.rb', line 171

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

#blob_raw_path(**kwargs) ⇒ Object


185
186
187
# File 'app/helpers/blob_helper.rb', line 185

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

#blob_raw_url(**kwargs) ⇒ Object


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

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


300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
# File 'app/helpers/blob_helper.rb', line 300

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


282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
# File 'app/helpers/blob_helper.rb', line 282

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)

151
152
153
# File 'app/helpers/blob_helper.rb', line 151

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

#contribution_options(project) ⇒ Object


319
320
321
322
323
324
325
326
327
328
329
330
331
332
# File 'app/helpers/blob_helper.rb', line 319

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


246
247
248
249
250
# File 'app/helpers/blob_helper.rb', line 246

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

  clipboard_button(target: ".blob-content[data-blob-id='#{blob.id}']", class: "btn btn-sm js-copy-blob-source-btn", title: _("Copy file contents"))
end

#copy_file_path_button(file_path) ⇒ Object


242
243
244
# File 'app/helpers/blob_helper.rb', line 242

def copy_file_path_button(file_path)
  clipboard_button(text: file_path, gfm: "`#{file_path}`", class: 'btn-clipboard btn-transparent', title: _('Copy file path'))
end

138
139
140
141
142
143
144
145
146
147
148
149
# File 'app/helpers/blob_helper.rb', line 138

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

#dockerfile_names(project) ⇒ Object


228
229
230
# File 'app/helpers/blob_helper.rb', line 228

def dockerfile_names(project)
  @dockerfile_names ||= template_dropdown_names(TemplateFinder.build(:dockerfiles, project).execute)
end

#download_blob_button(blob) ⇒ Object


267
268
269
270
271
272
273
274
275
276
277
278
279
280
# File 'app/helpers/blob_helper.rb', line 267

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 btn-sm 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


68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
# File 'app/helpers/blob_helper.rb', line 68

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

  common_classes = "btn btn-primary js-edit-blob gl-mr-3 #{options[:extra_class]}"
  data = { track_event: 'click_edit', track_label: 'Edit' }

  if Feature.enabled?(:web_ide_primary_edit, project.group)
    common_classes += " btn-inverted"
    data[:track_property] = 'secondary'
  end

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

#edit_blob_fork_params(path) ⇒ Object


341
342
343
344
345
346
347
# File 'app/helpers/blob_helper.rb', line 341

def edit_blob_fork_params(path)
  {
    to: path,
    notice: edit_in_new_fork_notice,
    notice_now: edit_in_new_fork_notice_now
  }
end

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


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

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, data) ⇒ Object


373
374
375
376
377
378
379
380
381
382
# File 'app/helpers/blob_helper.rb', line 373

def edit_button_tag(blob, common_classes, text, edit_path, project, ref, data)
  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, data)
  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


365
366
367
# File 'app/helpers/blob_helper.rb', line 365

def edit_disabled_button_tag(button_text, common_classes)
  button_tag(button_text, class: "#{common_classes} disabled 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


357
358
359
360
361
362
363
# File 'app/helpers/blob_helper.rb', line 357

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

369
370
371
# File 'app/helpers/blob_helper.rb', line 369

def edit_link_tag(link_text, edit_path, common_classes, data)
  link_to link_text, edit_path, class: "#{common_classes} btn-sm", data: data
end

#edit_modify_file_fork_params(action) ⇒ Object


349
350
351
352
353
354
355
# File 'app/helpers/blob_helper.rb', line 349

def edit_modify_file_fork_params(action)
  {
    to: request.fullpath,
    notice: edit_in_new_fork_notice_action(action),
    notice_now: edit_in_new_fork_notice_now
  }
end

#editing_ci_config?Boolean

Returns:

  • (Boolean)

399
400
401
402
# File 'app/helpers/blob_helper.rb', line 399

def editing_ci_config?
  @path.to_s.end_with?(Ci::Pipeline::CONFIG_EXTENSION) ||
    @path.to_s == @project.ci_config_path_or_default
end

#editing_preview_title(filename) ⇒ Object


159
160
161
162
163
164
165
# File 'app/helpers/blob_helper.rb', line 159

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

#encode_ide_path(path) ⇒ Object


64
65
66
# File 'app/helpers/blob_helper.rb', line 64

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


52
53
54
# File 'app/helpers/blob_helper.rb', line 52

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) ⇒ Object


56
57
58
59
60
61
62
# File 'app/helpers/blob_helper.rb', line 56

def fork_path_for_current_user(project, path)
  return unless current_user

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

#gitignore_names(project) ⇒ Object


216
217
218
# File 'app/helpers/blob_helper.rb', line 216

def gitignore_names(project)
  @gitignore_names ||= template_dropdown_names(TemplateFinder.build(:gitignores, project).execute)
end

#gitlab_ci_ymls(project) ⇒ Object


220
221
222
# File 'app/helpers/blob_helper.rb', line 220

def gitlab_ci_ymls(project)
  @gitlab_ci_ymls ||= template_dropdown_names(TemplateFinder.build(:gitlab_ci_ymls, project).execute)
end

#human_accessObject


395
396
397
# File 'app/helpers/blob_helper.rb', line 395

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

#ide_edit_button(project = @project, ref = @ref, path = @path, blob:) ⇒ Object


88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
# File 'app/helpers/blob_helper.rb', line 88

def ide_edit_button(project = @project, ref = @ref, path = @path, blob:)
  return unless blob

  common_classes = 'btn btn-primary ide-edit-button gl-mr-3'
  data = { track_event: 'click_edit_ide', track_label: 'Web IDE' }

  unless Feature.enabled?(:web_ide_primary_edit, project.group)
    common_classes += " btn-inverted"
    data[:track_property] = 'secondary'
  end

  edit_button_tag(blob,
                  common_classes,
                  _('Web IDE'),
                  ide_edit_path(project, ref, path),
                  project,
                  ref,
                  data)
end

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


14
15
16
17
18
19
20
21
22
23
24
25
26
27
# File 'app/helpers/blob_helper.rb', line 14

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, options = {}) ⇒ Object


48
49
50
# File 'app/helpers/blob_helper.rb', line 48

def ide_fork_and_edit_path(project = @project, ref = @ref, path = @path, options = {})
  fork_path_for_current_user(project, ide_edit_path(project, ref, path))
end

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


29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
# File 'app/helpers/blob_helper.rb', line 29

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_messageObject


155
156
157
# File 'app/helpers/blob_helper.rb', line 155

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

#licenses_for_select(project) ⇒ Object


212
213
214
# File 'app/helpers/blob_helper.rb', line 212

def licenses_for_select(project)
  @licenses_for_select ||= template_dropdown_names(TemplateFinder.build(:licenses, project).execute)
end

#metrics_dashboard_ymls(project) ⇒ Object


224
225
226
# File 'app/helpers/blob_helper.rb', line 224

def metrics_dashboard_ymls(project)
  @metrics_dashboard_ymls ||= template_dropdown_names(TemplateFinder.build(:metrics_dashboard_ymls, project).execute)
end

#modify_file_button(project = @project, ref = @ref, path = @path, blob:, label:, action:, btn_class:, modal_type:) ⇒ Object


108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
# File 'app/helpers/blob_helper.rb', line 108

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

  common_classes = "btn btn-#{btn_class}"

  if !on_top_of_branch?(project, ref)
    button_tag label, class: "#{common_classes} disabled has-tooltip", title: "You can only #{action} files when you are on a branch", data: { container: 'body' }
  elsif blob.stored_externally?
    button_tag label, class: "#{common_classes} 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_modify_blob?(blob, project, ref)
    button_tag label, class: "#{common_classes}", 'data-target' => "#modal-#{modal_type}-blob", 'data-toggle' => 'modal'
  elsif can?(current_user, :fork_project, project) && can?(current_user, :create_merge_request_in, project)
    edit_fork_button_tag(common_classes, project, label, edit_modify_file_fork_params(action), action)
  end
end

#no_highlight_filesObject


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

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

#open_raw_blob_button(blob) ⇒ Object


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

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 btn-sm has-tooltip',
    target: '_blank',
    rel: 'noopener noreferrer',
    aria: { label: title },
    title: title,
    data: { container: 'body' }
end

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


334
335
336
337
338
339
# File 'app/helpers/blob_helper.rb', line 334

def readable_blob(options, path, project, ref)
  blob = options.delete(:blob)
  blob ||= project.repository.blob_at(ref, path) rescue nil

  blob if blob&.readable_text?
end

#ref_projectObject


196
197
198
# File 'app/helpers/blob_helper.rb', line 196

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

125
126
127
128
129
130
131
132
133
134
135
136
# File 'app/helpers/blob_helper.rb', line 125

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

#sanitize_svg_data(data) ⇒ 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.


192
193
194
# File 'app/helpers/blob_helper.rb', line 192

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

#show_suggest_pipeline_creation_celebration?Boolean

Returns:

  • (Boolean)

384
385
386
387
388
389
# File 'app/helpers/blob_helper.rb', line 384

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

391
392
393
# File 'app/helpers/blob_helper.rb', line 391

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