Module: BlobHelper

Instance Method Summary collapse

Instance Method Details

#blob_editor_paths(project) ⇒ Object


194
195
196
197
198
199
200
201
202
203
# File 'app/helpers/blob_helper.rb', line 194

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


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

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

#blob_raw_path(**kwargs) ⇒ Object


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

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

#blob_raw_url(**kwargs) ⇒ Object


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

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


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

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


247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
# File 'app/helpers/blob_helper.rb', line 247

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)

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

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

#contribution_options(project) ⇒ Object


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

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


209
210
211
212
213
214
215
# File 'app/helpers/blob_helper.rb', line 209

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

  (: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


205
206
207
# File 'app/helpers/blob_helper.rb', line 205

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

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

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


190
191
192
# File 'app/helpers/blob_helper.rb', line 190

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

#download_blob_button(blob) ⇒ Object


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

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
# 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


307
308
309
310
311
312
313
# File 'app/helpers/blob_helper.rb', line 307

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
7
8
# 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


343
344
345
346
347
348
349
350
351
352
# File 'app/helpers/blob_helper.rb', line 343

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


331
332
333
334
335
336
337
# File 'app/helpers/blob_helper.rb', line 331

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
  (: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


323
324
325
326
327
328
329
# File 'app/helpers/blob_helper.rb', line 323

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

339
340
341
# File 'app/helpers/blob_helper.rb', line 339

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

#edit_modify_file_fork_params(action) ⇒ Object


315
316
317
318
319
320
321
# File 'app/helpers/blob_helper.rb', line 315

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)

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

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


129
130
131
132
133
134
135
# File 'app/helpers/blob_helper.rb', line 129

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


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

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


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

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


178
179
180
# File 'app/helpers/blob_helper.rb', line 178

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

#gitlab_ci_ymls(project) ⇒ Object


182
183
184
# File 'app/helpers/blob_helper.rb', line 182

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

#human_accessObject


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

def human_access
  @project.team.human_max_access(current_user&.id).try(:downcase)
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


44
45
46
# File 'app/helpers/blob_helper.rb', line 44

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
41
42
# 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

  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


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

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

#licenses_for_select(project) ⇒ Object


174
175
176
# File 'app/helpers/blob_helper.rb', line 174

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

#metrics_dashboard_ymls(project) ⇒ Object


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

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

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


77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
# File 'app/helpers/blob_helper.rb', line 77

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 gl-button btn-default btn-#{btn_class}"
  base_button = button_tag(label, class: "#{common_classes} disabled", disabled: true)

  if !on_top_of_branch?(project, ref)
    modify_file_button_tooltip(base_button, _("You can only %{action} files when you are on a branch") % { action: action })
  elsif blob.stored_externally?
    modify_file_button_tooltip(base_button, _("It is not possible to %{action} files that are stored in LFS using the web interface") % { action: action })
  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

#open_raw_blob_button(blob) ⇒ Object


217
218
219
220
221
222
223
224
225
226
227
228
229
230
# File 'app/helpers/blob_helper.rb', line 217

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_pathObject


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

def parent_dir_raw_path
  blob_raw_path.rpartition("/").first + "/"
end

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


299
300
301
302
303
304
305
# File 'app/helpers/blob_helper.rb', line 299

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

  blob if blob&.readable_text?
end

#ref_projectObject


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

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

95
96
97
98
99
100
101
102
103
104
105
106
# File 'app/helpers/blob_helper.rb', line 95

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.


166
167
168
# File 'app/helpers/blob_helper.rb', line 166

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

#show_suggest_pipeline_creation_celebration?Boolean

Returns:

  • (Boolean)

354
355
356
357
358
359
# File 'app/helpers/blob_helper.rb', line 354

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

361
362
363
# File 'app/helpers/blob_helper.rb', line 361

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