BigW Consortium Gitlab

blob_helper.rb 4.55 KB
Newer Older
1
module BlobHelper
2
  def highlight(blob_name, blob_content, nowrap: false, continue: false)
3
    @formatter ||= Rouge::Formatters::HTMLGitlab.new(
4 5 6 7 8 9 10
      nowrap: nowrap,
      cssclass: 'code highlight',
      lineanchors: true,
      lineanchorsid: 'LC'
    )

    begin
11
      @lexer ||= Rouge::Lexer.guess(filename: blob_name, source: blob_content).new
12
      result = @formatter.format(@lexer.lex(blob_content, continue: continue)).html_safe
13
    rescue
14 15
      @lexer = Rouge::Lexers::PlainText
      result = @formatter.format(@lexer.lex(blob_content)).html_safe
16
    end
17

18
    result
19 20 21
  end

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

25 26 27 28 29
  def edit_blob_link(project = @project, ref = @ref, path = @path, options = {})
    return unless current_user

    blob = project.repository.blob_at(ref, path) rescue nil

30
    return unless blob && blob_text_viewable?(blob)
31

32 33 34
    from_mr = options[:from_merge_request_id]
    link_opts = {}
    link_opts[:from_merge_request_id] = from_mr if from_mr
35 36 37 38 39 40

    edit_path = namespace_project_edit_blob_path(project.namespace, project,
                                     tree_join(ref, path),
                                     link_opts)

    if !on_top_of_branch?
Douwe Maan committed
41
      button_tag "Edit", class: "btn btn-default disabled has_tooltip", title: "You can only edit files when you are on a branch", data: { container: 'body' }
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64
    elsif can_edit_blob?(blob)
      link_to "Edit", edit_path, class: 'btn btn-small'
    elsif can?(current_user, :fork_project, project)
      continue_params = {
        to:     edit_path,
        notice: edit_in_new_fork_notice,
        notice_now: edit_in_new_fork_notice_now
      }
      fork_path = namespace_project_fork_path(project.namespace, project, namespace_key:  current_user.namespace.id,
                                                                          continue:       continue_params)

      link_to "Edit", fork_path, class: 'btn btn-small', method: :post
    end
  end

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

    blob = project.repository.blob_at(ref, path) rescue nil

    return unless blob

    if !on_top_of_branch?
Douwe Maan committed
65
      button_tag label, class: "btn btn-#{btn_class} disabled has_tooltip", title: "You can only #{action} files when you are on a branch", data: { container: 'body' }
66 67
    elsif blob.lfs_pointer?
      button_tag label, class: "btn btn-#{btn_class} disabled has_tooltip", title: "It is not possible to #{action} files that are stored in LFS using the web interface", data: { container: 'body' }
68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108
    elsif can_edit_blob?(blob)
      button_tag label, class: "btn btn-#{btn_class}", 'data-target' => "#modal-#{modal_type}-blob", 'data-toggle' => 'modal'
    elsif can?(current_user, :fork_project, project)
      continue_params = {
        to:     request.fullpath,
        notice: edit_in_new_fork_notice + " Try to #{action} this file again.",
        notice_now: edit_in_new_fork_notice_now
      }
      fork_path = namespace_project_fork_path(project.namespace, project, namespace_key:  current_user.namespace.id,
                                                                          continue:       continue_params)

      link_to label, fork_path, class: "btn btn-#{btn_class}", method: :post
    end
  end

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

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

  def can_edit_blob?(blob, project = @project, ref = @ref)
    !blob.lfs_pointer? && can_edit_tree?(project, ref)
109 110 111 112 113 114 115
  end

  def leave_edit_message
    "Leave edit mode?\nAll unsaved changes will be lost."
  end

  def editing_preview_title(filename)
116
    if Gitlab::MarkupHelper.previewable?(filename)
117 118
      'Preview'
    else
Douwe Maan committed
119
      'Preview Changes'
120 121
    end
  end
122 123 124 125 126 127 128 129

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

131
  def blob_text_viewable?(blob)
132
    blob && blob.text? && !blob.lfs_pointer?
133 134 135 136 137 138 139 140 141
  end

  def blob_size(blob)
    if blob.lfs_pointer?
      blob.lfs_size
    else
      blob.size
    end
  end
142
end