GitLab steht wegen Wartungsarbeiten am Montag, den 10. Mai, zwischen 17:00 und 19:00 Uhr nicht zur Verfügung.

commits_helper.rb 7.54 KB
Newer Older
1 2
# frozen_string_literal: true

gitlabhq's avatar
gitlabhq committed
3
module CommitsHelper
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
  # Returns a link to the commit author. If the author has a matching user and
  # is a member of the current @project it will link to the team member page.
  # Otherwise it will link to the author email as specified in the commit.
  #
  # options:
  #  avatar: true will prepend the avatar image
  #  size:   size of the avatar image in px
  def commit_author_link(commit, options = {})
    commit_person_link(commit, options.merge(source: :author))
  end

  # Just like #author_link but for the committer.
  def commit_committer_link(commit, options = {})
    commit_person_link(commit, options.merge(source: :committer))
  end

20 21 22 23 24
  def commit_to_html(commit, ref, project)
    render 'projects/commits/commit',
      commit: commit,
      ref: ref,
      project: project
25
  end
26

27 28 29 30 31
  # Breadcrumb links for a Project and, if applicable, a tree path
  def commits_breadcrumbs
    return unless @project && @ref

    # Add the root project link and the arrow icon
32
    crumbs = content_tag(:li, class: 'breadcrumb-item') do
Vinnie Okada's avatar
Vinnie Okada committed
33 34
      link_to(
        @project.path,
35
        project_commits_path(@project, @ref)
Vinnie Okada's avatar
Vinnie Okada committed
36
      )
37 38 39 40 41 42
    end

    if @path
      parts = @path.split('/')

      parts.each_with_index do |part, i|
43
        crumbs << content_tag(:li, class: 'breadcrumb-item') do
44
          # The text is just the individual part, but the link needs all the parts before it
Vinnie Okada's avatar
Vinnie Okada committed
45 46
          link_to(
            part,
47
            project_commits_path(
Vinnie Okada's avatar
Vinnie Okada committed
48 49 50 51
              @project,
              tree_join(@ref, parts[0..i].join('/'))
            )
          )
52 53 54 55 56 57 58
        end
      end
    end

    crumbs.html_safe
  end

59 60 61 62 63 64
  # Return Project default branch, if it present in array
  # Else - first branch in array (mb last actual branch)
  def commit_default_branch(project, branches)
    branches.include?(project.default_branch) ? branches.delete(project.default_branch) : branches.pop
  end

Mayra Cabrera's avatar
Mayra Cabrera committed
65
  # Returns a link formatted as a commit branch link
66
  def commit_branch_link(url, text)
67
    link_to(url, class: 'badge badge-gray ref-name branch-link') do
68
      sprite_icon('branch', size: 12, css_class: 'fork-svg') + "#{text}"
69 70 71
    end
  end

72 73
  # Returns the sorted alphabetically links to branches, separated by a comma
  def commit_branches_links(project, branches)
74
    branches.sort.map do |branch|
75 76 77 78
      commit_branch_link(project_ref_path(project, branch), branch)
    end.join(' ').html_safe
  end

Mayra Cabrera's avatar
Mayra Cabrera committed
79
  # Returns a link formatted as a commit tag link
80
  def commit_tag_link(url, text)
81
    link_to(url, class: 'badge badge-gray ref-name') do
82
      sprite_icon('tag', size: 12, css_class: 'append-right-5 vertical-align-middle') + "#{text}"
83
    end
84 85
  end

Hannes Rosenögger's avatar
Hannes Rosenögger committed
86 87 88
  # Returns the sorted links to tags, separated by a comma
  def commit_tags_links(project, tags)
    sorted = VersionSorter.rsort(tags)
89
    sorted.map do |tag|
90 91
      commit_tag_link(project_ref_path(project, tag), tag)
    end.join(' ').html_safe
Hannes Rosenögger's avatar
Hannes Rosenögger committed
92 93
  end

94
  def link_to_browse_code(project, commit)
95
    return unless current_controller?(:commits)
96

97
    if @path.blank?
98 99
      url = project_tree_path(project, commit)
      tooltip = _("Browse Files")
100
    elsif @repo.blob_at(commit.id, @path)
101 102
      url = project_blob_path(project, tree_join(commit.id, @path))
      tooltip = _("Browse File")
103
    elsif @path.present?
104 105 106 107 108 109
      url = project_tree_path(project, tree_join(commit.id, @path))
      tooltip = _("Browse Directory")
    end

    link_to url, class: "btn btn-default has-tooltip", title: tooltip, data: { container: "body" } do
      sprite_icon('folder-open')
110 111 112
    end
  end

113
  def revert_commit_link(commit, continue_to_path, btn_class: nil, has_tooltip: true)
114
    commit_action_link('revert', commit, continue_to_path, btn_class: btn_class, has_tooltip: has_tooltip)
115 116
  end

117
  def cherry_pick_commit_link(commit, continue_to_path, btn_class: nil, has_tooltip: true)
118
    commit_action_link('cherry-pick', commit, continue_to_path, btn_class: btn_class, has_tooltip: has_tooltip)
119 120
  end

121
  def commit_signature_badge_classes(additional_classes)
122
    %w(btn gpg-status-box) + Array(additional_classes)
123 124
  end

125 126 127 128 129 130 131 132 133 134 135
  protected

  # Private: Returns a link to a person. If the person has a matching user and
  # is a member of the current @project it will link to the team member page.
  # Otherwise it will link to the person email as specified in the commit.
  #
  # options:
  #  source: one of :author or :committer
  #  avatar: true will prepend the avatar image
  #  size:   size of the avatar image in px
  def commit_person_link(commit, options = {})
136
    user = commit.public_send(options[:source]) # rubocop:disable GitlabSecurity/PublicSend
137

138 139
    source_name  = clean(commit.public_send(:"#{options[:source]}_name"))  # rubocop:disable GitlabSecurity/PublicSend
    source_email = clean(commit.public_send(:"#{options[:source]}_email")) # rubocop:disable GitlabSecurity/PublicSend
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
140

Douwe Maan's avatar
Douwe Maan committed
141
    person_name = user.try(:name) || source_name
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
142

143 144
    text =
      if options[:avatar]
145
        content_tag(:span, person_name, class: "commit-#{options[:source]}-name")
146 147 148
      else
        person_name
      end
149

150
    link_options = {
Luke Bennett's avatar
Luke Bennett committed
151
      class: "commit-#{options[:source]}-link"
152
    }
Luke Bennett's avatar
Luke Bennett committed
153

154
    if user.nil?
155
      mail_to(source_email, text, link_options)
156
    else
157
      link_to(text, user_path(user), link_options)
158 159
    end
  end
160

161 162 163 164 165 166
  def commit_action_link(action, commit, continue_to_path, btn_class: nil, has_tooltip: true)
    return unless current_user

    tooltip = "#{action.capitalize} this #{commit.change_type_title(current_user)} in a new merge request" if has_tooltip
    btn_class = "btn btn-#{btn_class}" unless btn_class.nil?

167
    if can_collaborate_with_project?(@project)
168 169 170 171 172 173 174
      link_to action.capitalize, "#modal-#{action}-commit", 'data-toggle' => 'modal', 'data-container' => 'body', title: (tooltip if has_tooltip), class: "#{btn_class} #{'has-tooltip' if has_tooltip}"
    elsif can?(current_user, :fork_project, @project)
      continue_params = {
        to: continue_to_path,
        notice: "#{edit_in_new_fork_notice} Try to #{action} this commit again.",
        notice_now: edit_in_new_fork_notice_now
      }
175
      fork_path = project_forks_path(@project,
176 177 178 179 180 181 182
        namespace_key: current_user.namespace.id,
        continue: continue_params)

      link_to action.capitalize, fork_path, class: btn_class, method: :post, 'data-toggle' => 'tooltip', 'data-container' => 'body', title: (tooltip if has_tooltip)
    end
  end

183 184 185
  def view_file_button(commit_sha, diff_new_path, project, replaced: false)
    title = replaced ? _('View replaced file @ ') : _('View file @ ')

Vinnie Okada's avatar
Vinnie Okada committed
186
    link_to(
187
      project_blob_path(project,
188
                                  tree_join(commit_sha, diff_new_path)),
Nur Rony's avatar
Nur Rony committed
189
      class: 'btn view-file js-view-file'
Vinnie Okada's avatar
Vinnie Okada committed
190
    ) do
191
      raw(title) + content_tag(:span, Commit.truncate_sha(commit_sha),
192
                                       class: 'commit-sha')
skv's avatar
skv committed
193 194
    end
  end
195

Douwe Maan's avatar
Douwe Maan committed
196
  def view_on_environment_button(commit_sha, diff_new_path, environment)
197 198 199 200 201
    return unless environment && commit_sha

    external_url = environment.external_url_for(diff_new_path, commit_sha)
    return unless external_url

202
    link_to(external_url, class: 'btn btn-file-option has-tooltip', target: '_blank', rel: 'noopener noreferrer', title: "View on #{environment.formatted_external_url}", data: { container: 'body' }) do
203 204 205 206
      icon('external-link')
    end
  end

207 208 209
  def truncate_sha(sha)
    Commit.truncate_sha(sha)
  end
210 211 212 213

  def clean(string)
    Sanitize.clean(string, remove_contents: true)
  end
214

215 216
  def commit_path(project, commit, merge_request: nil)
    if merge_request&.persisted?
micael.bergeron's avatar
micael.bergeron committed
217
      diffs_project_merge_request_path(project, merge_request, commit_id: commit.id)
218
    else
micael.bergeron's avatar
micael.bergeron committed
219
      project_commit_path(project, commit)
220 221
    end
  end
gitlabhq's avatar
gitlabhq committed
222
end