gitlab-org--gitlab-foss/app/helpers/blob_helper.rb

379 lines
12 KiB
Ruby
Raw Normal View History

# frozen_string_literal: true
module BlobHelper
def highlight(file_name, file_content, language: nil, plain: false)
highlighted = Gitlab::Highlight.highlight(file_name, file_content, plain: plain, language: language)
raw %(<pre class="code highlight"><code>#{highlighted}</code></pre>)
end
def no_highlight_files
2014-12-03 06:50:00 -05:00
%w(credits changelog news copying copyright license authors)
end
2015-01-26 18:03:14 -05:00
def edit_blob_path(project = @project, ref = @ref, path = @path, options = {})
project_edit_blob_path(project,
2018-02-09 02:59:03 -05:00
tree_join(ref, path),
options[:link_opts])
2017-04-06 12:36:38 -04:00
end
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)
2018-02-23 10:52:18 -05:00
end
def ide_fork_and_edit_path(project = @project, ref = @ref, path = @path, options = {})
if current_user
project_forks_path(project,
namespace_key: current_user&.namespace&.id,
continue: edit_blob_fork_params(ide_edit_path(project, ref, path)))
end
end
def encode_ide_path(path)
url_encode(path).gsub('%2F', '/')
end
2018-02-22 07:54:19 -05:00
def edit_blob_button(project = @project, ref = @ref, path = @path, options = {})
2018-02-08 08:12:44 -05:00
return unless blob = readable_blob(options, path, project, ref)
common_classes = "btn btn-primary js-edit-blob ml-2 #{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
2018-02-23 03:09:32 -05:00
edit_button_tag(blob,
common_classes,
2018-02-23 10:04:31 -05:00
_('Edit'),
edit_blob_path(project, ref, path, options),
2018-02-23 03:09:32 -05:00
project,
ref,
data)
end
def ide_edit_button(project = @project, ref = @ref, path = @path, blob:)
return unless blob
2018-03-20 13:00:56 -04:00
common_classes = 'btn btn-primary ide-edit-button ml-2'
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
2018-03-20 13:00:56 -04:00
edit_button_tag(blob,
common_classes,
2018-03-20 13:00:56 -04:00
_('Web IDE'),
ide_edit_path(project, ref, path),
2018-03-20 13:00:56 -04:00
project,
ref,
data)
2018-03-20 13:00:56 -04:00
end
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}"
2016-01-21 16:46:49 -05:00
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'
2018-04-06 12:27:12 -04:00
elsif can?(current_user, :fork_project, project) && can?(current_user, :create_merge_request_in, project)
2018-02-15 06:03:37 -05:00
edit_fork_button_tag(common_classes, project, label, edit_modify_file_fork_params(action), action)
end
end
def replace_blob_link(project = @project, ref = @ref, path = @path, blob:)
2018-02-23 10:04:31 -05:00
modify_file_button(
project,
ref,
path,
blob: blob,
label: _("Replace"),
action: "replace",
btn_class: "default",
modal_type: "upload"
)
end
def delete_blob_link(project = @project, ref = @ref, path = @path, blob:)
2018-02-23 10:04:31 -05:00
modify_file_button(
project,
ref,
path,
blob: blob,
label: _("Delete"),
action: "delete",
btn_class: "default",
modal_type: "remove"
)
end
def can_modify_blob?(blob, project = @project, ref = @ref)
!blob.stored_externally? && can_edit_tree?(project, ref)
2015-01-26 18:03:14 -05:00
end
def leave_edit_message
_("Leave edit mode? All unsaved changes will be lost.")
2015-01-26 18:03:14 -05:00
end
def editing_preview_title(filename)
2015-05-12 19:40:11 -04:00
if Gitlab::MarkupHelper.previewable?(filename)
_('Preview')
2015-01-26 18:03:14 -05:00
else
_('Preview changes')
2015-01-26 18:03:14 -05:00
end
end
2014-10-04 06:29:18 -04:00
# Return an image icon depending on the file mode and extension
#
# mode - File unix mode
# mode - File name
def blob_icon(mode, name)
icon("#{file_type_icon_class('file', mode, name)} fw")
end
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)
2017-04-13 12:47:28 -04:00
elsif @blob
project_raw_url(@project, @id, **kwargs)
2017-04-13 12:47:28 -04:00
end
2017-04-13 13:21:07 -04:00
end
def blob_raw_path(**kwargs)
blob_raw_url(**kwargs, only_path: true)
end
# 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.
2017-04-13 13:21:07 -04:00
def sanitize_svg_data(data)
Gitlab::Sanitizers::SVG.clean(data)
end
def ref_project
@ref_project ||= @target_project || @project
end
2018-09-05 09:49:14 -04:00
def template_dropdown_names(items)
grouped = items.group_by(&:category)
categories = grouped.keys
categories.each_with_object({}) do |category, hash|
hash[category] = grouped[category].map do |item|
2018-10-02 19:00:38 -04:00
{ name: item.name, id: item.key }
end
end
end
2018-09-05 09:49:14 -04:00
private :template_dropdown_names
def licenses_for_select(project)
2018-10-02 19:00:38 -04:00
@licenses_for_select ||= template_dropdown_names(TemplateFinder.build(:licenses, project).execute)
end
def gitignore_names(project)
2018-10-02 19:00:38 -04:00
@gitignore_names ||= template_dropdown_names(TemplateFinder.build(:gitignores, project).execute)
end
2016-05-11 20:38:43 -04:00
def gitlab_ci_ymls(project)
2018-10-02 19:00:38 -04:00
@gitlab_ci_ymls ||= template_dropdown_names(TemplateFinder.build(:gitlab_ci_ymls, project).execute)
2016-04-29 10:25:03 -04:00
end
2016-08-19 11:17:14 -04:00
def metrics_dashboard_ymls(project)
@metrics_dashboard_ymls ||= template_dropdown_names(TemplateFinder.build(:metrics_dashboard_ymls, project).execute)
end
def dockerfile_names(project)
2018-10-02 19:00:38 -04:00
@dockerfile_names ||= template_dropdown_names(TemplateFinder.build(:dockerfiles, project).execute)
2016-11-02 11:41:32 -04:00
end
def blob_editor_paths(project)
2016-08-19 11:17:14 -04:00
{
'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)
2016-08-19 11:17:14 -04:00
}
end
2017-03-14 13:58:52 -04:00
def copy_file_path_button(file_path)
clipboard_button(text: file_path, gfm: "`#{file_path}`", class: 'btn-clipboard btn-transparent', title: _('Copy file path'))
2017-03-14 13:58:52 -04:00
end
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"))
2017-03-14 13:58:52 -04:00
end
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' }
2017-03-14 13:58:52 -04:00
end
2017-04-13 13:08:39 -04:00
def download_blob_button(blob)
2018-07-08 21:55:36 -04:00
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' }
2018-07-08 21:55:36 -04:00
end
2017-04-26 16:48:49 -04:00
def blob_render_error_reason(viewer)
case viewer.render_error
when :collapsed
"it is larger than #{number_to_human_size(viewer.collapse_limit)}"
2017-04-13 13:08:39 -04:00
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
2017-04-13 13:08:39 -04:00
end
end
2017-04-21 14:22:04 -04:00
2017-04-26 16:48:49 -04:00
def blob_render_error_options(viewer)
error = viewer.render_error
2017-04-21 14:22:04 -04:00
options = []
if error == :collapsed
options << link_to('load it anyway', url_for(safe_params.merge(viewer: viewer.type, expanded: true, format: nil)))
2017-04-21 14:22:04 -04:00
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' })
2017-04-21 14:22:04 -04:00
end
2017-08-03 08:29:35 -04:00
options << link_to('download it', blob_raw_path, target: '_blank', rel: 'noopener noreferrer')
2017-04-21 14:22:04 -04:00
options
end
2017-05-13 13:06:51 -04:00
def contribution_options(project)
options = []
if can?(current_user, :create_issue, project)
options << link_to("submit an issue", new_project_issue_path(project))
2017-05-13 13:06:51 -04:00
end
2018-04-06 12:27:12 -04:00
merge_project = merge_request_source_project_for_project(@project)
2017-05-13 13:06:51 -04:00
if merge_project
options << link_to("create a merge request", project_new_merge_request_path(project))
2017-05-13 13:06:51 -04:00
end
options
end
2018-02-05 10:25:31 -05:00
2018-02-08 08:12:44 -05:00
def readable_blob(options, path, project, ref)
2018-02-05 10:25:31 -05:00
blob = options.delete(:blob)
blob ||= project.repository.blob_at(ref, path) rescue nil
2018-02-08 08:12:44 -05:00
blob if blob&.readable_text?
2018-02-05 10:25:31 -05:00
end
2018-02-15 03:44:08 -05:00
def edit_blob_fork_params(path)
{
2018-02-22 07:54:19 -05:00
to: path,
notice: edit_in_new_fork_notice,
notice_now: edit_in_new_fork_notice_now
2018-02-05 10:25:31 -05:00
}
2018-02-09 04:32:28 -05:00
end
2018-02-15 03:44:08 -05:00
def edit_modify_file_fork_params(action)
{
2018-02-22 07:54:19 -05:00
to: request.fullpath,
notice: edit_in_new_fork_notice_action(action),
notice_now: edit_in_new_fork_notice_now
2018-02-09 04:32:28 -05:00
}
2018-02-15 03:44:08 -05:00
end
2018-02-15 06:03:37 -05:00
def edit_fork_button_tag(common_classes, project, label, params, action = 'edit')
2018-02-15 03:44:08 -05:00
fork_path = project_forks_path(project, namespace_key: current_user.namespace.id, continue: params)
2018-02-09 04:32:28 -05:00
2018-02-15 06:03:37 -05:00
button_tag label,
2018-02-05 10:25:31 -05:00
class: "#{common_classes} js-edit-blob-link-fork-toggler",
2018-02-15 06:03:37 -05:00
data: { action: action, fork_path: fork_path }
2018-02-05 10:25:31 -05:00
end
2018-02-08 05:58:47 -05:00
2018-02-22 07:54:19 -05:00
def edit_disabled_button_tag(button_text, common_classes)
2018-02-08 05:58:47 -05:00
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
def edit_link_tag(link_text, edit_path, common_classes, data)
link_to link_text, edit_path, class: "#{common_classes} btn-sm", data: data
2018-02-08 05:58:47 -05:00
end
2018-02-23 03:09:32 -05:00
def edit_button_tag(blob, common_classes, text, edit_path, project, ref, data)
2018-02-23 03:09:32 -05:00
if !on_top_of_branch?(project, ref)
edit_disabled_button_tag(text, common_classes)
# This condition only applies to users who are logged in
2018-02-23 10:52:18 -05:00
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)
2018-02-23 07:58:27 -05:00
edit_fork_button_tag(common_classes, project, text, edit_blob_fork_params(edit_path))
2018-02-23 03:09:32 -05:00
end
end
def show_suggest_pipeline_creation_celebration?
experiment_enabled?(:suggest_pipeline) &&
@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
def suggest_pipeline_commit_cookie_name
"suggest_gitlab_ci_yml_commit_#{@project.id}"
end
def human_access
@project.team.human_max_access(current_user&.id).try(:downcase)
end
end