Module: BlobHelper

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

Instance Method Summary collapse

Methods included from WebIdeButtonHelper

#can_collaborate?, #can_create_mr_from_fork?, #edit_url, #fork?, #fork_modal_options, #gitpod_url, #needs_to_fork?, #project_fork, #project_to_use, #readable_blob?, #show_edit_button?, #show_gitpod_button?, #show_pipeline_editor_button?, #show_web_ide_button?, #web_ide_button_data, #web_ide_url

Instance Method Details

#blob_editor_paths(project, method) ⇒ Object 



151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'app/helpers/blob_helper.rb', line 151

def blob_editor_paths(project, method)
  {
    '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,
    'project-path': project.full_path,
    'is-markdown' => @blob && @blob.path && Gitlab::MarkupHelper.gitlab_markdown?(@blob.path),
    'preview-markdown-path' => preview_markdown_path(project),
    'form-method' => method
  }
end

#blob_icon(mode, name) ⇒ Object

Return an image icon depending on the file mode and extension

mode - File unix mode mode - File name



102
103
104
 
# File 'app/helpers/blob_helper.rb', line 102

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

#blob_raw_path(**kwargs) ⇒ Object 



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

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

#blob_raw_url(**kwargs) ⇒ Object 



106
107
108
109
110
111
112
113
114
 
# File 'app/helpers/blob_helper.rb', line 106

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 



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'app/helpers/blob_helper.rb', line 209

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 



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'app/helpers/blob_helper.rb', line 191

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

Used for single file Web Editor, Delete and Replace UI actions. can_edit_tree checks if ref is on top of the branch.

Returns:

  • (Boolean) 


81
82
83
 
# File 'app/helpers/blob_helper.rb', line 81

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

#can_modify_blob_with_web_ide?(blob, project = @project) ⇒ Boolean

Used for WebIDE editor where editing is possible even if ref is not on top of the branch.

Returns:

  • (Boolean) 


86
87
88
 
# File 'app/helpers/blob_helper.rb', line 86

def can_modify_blob_with_web_ide?(blob, project = @project)
  !blob.stored_externally? && can_collaborate_with_project?(project)
end

#contribution_options(project) ⇒ Object 



228
229
230
231
232
233
234
235
236
237
 
# File 'app/helpers/blob_helper.rb', line 228

def contribution_options(project)
  options = []

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

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

  options
end

#copy_blob_source_button(blob) ⇒ Object 



168
169
170
171
172
173
174
 
# File 'app/helpers/blob_helper.rb', line 168

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: "js-copy-blob-source-btn", size: :medium)
  end
end

#copy_file_path_button(file_path) ⇒ Object 



164
165
166
 
# File 'app/helpers/blob_helper.rb', line 164

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

#dockerfile_names(project) ⇒ Object 



147
148
149
 
# File 'app/helpers/blob_helper.rb', line 147

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

#download_blob_button(blob) ⇒ Object 



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

def download_blob_button(blob)
  return if blob.empty?

  title = _('Download')
  render Pajamas::ButtonComponent.new(href: external_storage_url_or_path(blob_raw_path(inline: false)), target: '_blank', icon: 'download', button_options: { download: @path, title: title, class: 'has-tooltip', rel: 'noopener noreferrer', data: { container: 'body' } })
end

#edit_blob_app_data(project, id, blob, ref, action) ⇒ Object 



332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'app/helpers/blob_helper.rb', line 332

def edit_blob_app_data(project, id, blob, ref, action)
  is_update = action == 'update'
  is_create = action == 'create'
  can_push_to_branch = project.present(current_user: current_user).can_current_user_push_to_branch?(ref)

  {
    action: action.to_s,
    update_path: edit_blob_update_path(project, id, is_update, is_create),
    cancel_path: edit_blob_cancel_path(project, id, is_update, is_create),
    original_branch: ref,
    target_branch: selected_branch,
    can_push_code: can?(current_user, :push_code, project).to_s,
    can_push_to_branch: can_push_to_branch.to_s,
    empty_repo: project.empty_repo?.to_s,
    blob_name: is_update ? blob.name : nil,
    branch_allows_collaboration: project.branch_allows_collaboration?(current_user, ref).to_s,
    last_commit_sha: @last_commit_sha,
    project_id: project.id,
    project_path: project.full_path,
    new_merge_request_path: project_new_merge_request_path(project),
    target_project_id: edit_blob_target_project_id(project, ref, can_push_to_branch),
    target_project_path: edit_blob_target_project_path(project, can_push_to_branch),
    next_fork_branch_name: edit_blob_fork_project(project)&.repository&.next_branch('patch')
  }
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 = "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 



249
250
251
252
253
254
255
 
# File 'app/helpers/blob_helper.rb', line 249

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 



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

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 



281
282
283
284
285
286
287
288
289
290
 
# File 'app/helpers/blob_helper.rb', line 281

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 



265
266
267
268
269
270
271
272
273
 
# File 'app/helpers/blob_helper.rb', line 265

def edit_disabled_button_tag(button_text, common_classes)
  button = render Pajamas::ButtonComponent.new(disabled: true, variant: :confirm, button_options: { class: common_classes }) do
    button_text
  end

  # 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 



257
258
259
260
261
262
263
 
# File 'app/helpers/blob_helper.rb', line 257

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)

  render Pajamas::ButtonComponent.new(variant: :confirm, button_options: { class: "#{common_classes} js-edit-blob-link-fork-toggler", data: { action: action, fork_path: fork_path } }) do
    label
  end
end

#edit_link_tag(link_text, edit_path, common_classes) ⇒ Object 



275
276
277
278
279
 
# File 'app/helpers/blob_helper.rb', line 275

def edit_link_tag(link_text, edit_path, common_classes)
  render Pajamas::ButtonComponent.new(variant: :confirm, href: edit_path, button_options: { class: common_classes }) do
    link_text
  end
end

#editing_preview_title(filename) ⇒ Object 



90
91
92
93
94
95
96
 
# File 'app/helpers/blob_helper.rb', line 90

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 



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

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

#gitlab_ci_ymls(project) ⇒ Object 



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

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

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



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

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 



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

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

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

  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

#licenses_for_select(project) ⇒ Object 



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

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

#open_raw_blob_button(blob) ⇒ Object 



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

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

  title = _('Open raw')
  render Pajamas::ButtonComponent.new(href: external_storage_url_or_path(blob_raw_path), target: '_blank', icon: 'doc-code', button_options: { title: title, class: 'has-tooltip', rel: 'noopener noreferrer', data: { container: 'body' } })
end

#parent_dir_raw_path ⇒ Object 



120
121
122
 
# File 'app/helpers/blob_helper.rb', line 120

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

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



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

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 



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

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.



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

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

#vue_blob_app_data(project, blob, ref) ⇒ Object 



292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'app/helpers/blob_helper.rb', line 292

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: selected_branch,
    original_branch: ref,
    escaped_ref: ActionDispatch::Journey::Router::Utils.escape_path(ref),
    can_download_code: can?(current_user, :download_code, project).to_s,
    full_name: project.name_with_namespace,
    has_revs_file: (!project.repository.ignore_revs_file_blob.nil?).to_s
  }
end

#vue_blob_header_app_data(project, blob, ref) ⇒ Object 



307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'app/helpers/blob_helper.rb', line 307

def vue_blob_header_app_data(project, blob, ref)
  archive_prefix = ref ? "#{project.path}-#{ref.tr('/', '-')}" : ''

  {
    blob_path: blob.path,
    is_binary: blob.binary?,
    breadcrumbs: breadcrumb_data_attributes,
    escaped_ref: ActionDispatch::Journey::Router::Utils.escape_path(ref),
    history_link: project_commits_path(project, ref),
    project_id: project.id,
    project_root_path: project_path(project),
    project_path: project.full_path,
    project_short_path: project.path,
    ref_type: @ref_type.to_s,
    ref: ref,
    root_ref: project.repository.root_ref,
    ssh_url: ssh_enabled? ? ssh_clone_url_to_repo(project) : '',
    http_url: http_enabled? ? http_clone_url_to_repo(project) : '',
    xcode_url: show_xcode_link?(project) ? xcode_uri_to_repo(project) : '',
    download_links: archive_download_links(project, ref, archive_prefix).to_json,
    web_ide_button_options: web_ide_button_data({ blob: blob }).merge(fork_modal_options(project, blob)).to_json,
    web_ide_button_default_branch: project.default_branch_or_main
  }
end