extracts_path.rb 4.15 KB
Newer Older
1 2 3 4
# Module providing methods for dealing with separating a tree-ish string and a
# file path string when combined in a request parameter
module ExtractsPath
  # Raised when given an invalid file path
5 6
  class InvalidPathError < StandardError; end

7 8
  # Given a string containing both a Git tree-ish, such as a branch or tag, and
  # a filesystem path joined by forward slashes, attempts to separate the two.
9
  #
10 11
  # Expects a @project instance variable to contain the active project. This is
  # used to check the input against a list of valid repository refs.
12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
  #
  # Examples
  #
  #   # No @project available
  #   extract_ref('master')
  #   # => ['', '']
  #
  #   extract_ref('master')
  #   # => ['master', '']
  #
  #   extract_ref("f4b14494ef6abf3d144c28e4af0c20143383e062/CHANGELOG")
  #   # => ['f4b14494ef6abf3d144c28e4af0c20143383e062', 'CHANGELOG']
  #
  #   extract_ref("v2.0.0/README.md")
  #   # => ['v2.0.0', 'README.md']
  #
28
  #   extract_ref('master/app/models/project.rb')
29 30
  #   # => ['master', 'app/models/project.rb']
  #
31 32 33 34 35 36 37 38 39
  #   extract_ref('issues/1234/app/models/project.rb')
  #   # => ['issues/1234', 'app/models/project.rb']
  #
  #   # Given an invalid branch, we fall back to just splitting on the first slash
  #   extract_ref('non/existent/branch/README.md')
  #   # => ['non', 'existent/branch/README.md']
  #
  # Returns an Array where the first value is the tree-ish and the second is the
  # path
40
  def extract_ref(id)
41 42 43 44
    pair = ['', '']

    return pair unless @project

45
    if id.match(/^([[:alnum:]]{40})(.+)/)
46 47 48
      # If the ref appears to be a SHA, we're done, just split the string
      pair = $~.captures
    else
49 50 51
      # Otherwise, attempt to detect the ref using a list of the project's
      # branches and tags

52
      # Append a trailing slash if we only get a ref and no file path
53
      id += '/' unless id.ends_with?('/')
54

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
55
      valid_refs = @project.repository.ref_names
56 57
      valid_refs.select! { |v| id.start_with?("#{v}/") }

58
      if valid_refs.length == 0
59
        # No exact ref match, so just try our best
60
        pair = id.match(/([^\/]+)(.*)/).captures
61
      else
62 63 64 65
        # There is a distinct possibility that multiple refs prefix the ID.
        # Use the longest match to maximize the chance that we have the
        # right ref.
        best_match = valid_refs.max_by(&:length)
66
        # Partition the string into the ref and the path, ignoring the empty first value
67
        pair = id.partition(best_match)[1..-1]
68 69 70
      end
    end

71 72
    # Remove ending slashes from path
    pair[1].gsub!(/^\/|\/$/, '')
73

74 75
    pair
  end
76 77 78 79 80 81 82 83

  # Assigns common instance variables for views working with Git tree-ish objects
  #
  # Assignments are:
  #
  # - @id     - A string representing the joined ref and path
  # - @ref    - A string representing the ref (e.g., the branch, tag, or commit SHA)
  # - @path   - A string representing the filesystem path
84
  # - @commit - A Commit representing the commit from the given ref
85
  #
86 87 88 89 90
  # If the :id parameter appears to be requesting a specific response format,
  # that will be handled as well.
  #
  # Automatically renders `not_found!` if a valid tree path could not be
  # resolved (e.g., when a user inserts an invalid path or ref).
91
  def assign_ref_vars
92
    # assign allowed options
Hiroyuki Sato's avatar
Hiroyuki Sato committed
93
    allowed_options = ["filter_ref", "extended_sha1"]
94 95 96
    @options = params.select {|key, value| allowed_options.include?(key) && !value.blank? }
    @options = HashWithIndifferentAccess.new(@options)

97
    @id = Addressable::URI.unescape(get_id)
98
    @ref, @path = extract_ref(@id)
Sato Hiroyuki's avatar
Sato Hiroyuki committed
99
    @repo = @project.repository
Hiroyuki Sato's avatar
Hiroyuki Sato committed
100
    if @options[:extended_sha1].blank?
101 102
      @commit = @repo.commit(@ref)
    else
Hiroyuki Sato's avatar
Hiroyuki Sato committed
103
      @commit = @repo.commit(@options[:extended_sha1])
104
    end
105

106 107
    raise InvalidPathError unless @commit

Sato Hiroyuki's avatar
Sato Hiroyuki committed
108
    @hex_path = Digest::SHA1.hexdigest(@path)
Vinnie Okada's avatar
Vinnie Okada committed
109 110
    @logs_path = logs_file_namespace_project_ref_path(@project.namespace,
                                                      @project, @ref, @path)
111

112
  rescue RuntimeError, NoMethodError, InvalidPathError
113 114
    not_found!
  end
Sato Hiroyuki's avatar
Sato Hiroyuki committed
115

116
  def tree
117
    @tree ||= @repo.tree(@commit.id, @path)
118 119
  end

Sato Hiroyuki's avatar
Sato Hiroyuki committed
120 121 122 123 124 125 126
  private

  def get_id
    id = params[:id] || params[:ref]
    id += "/" + params[:path] unless params[:path].blank?
    id
  end
127
end