extracts_path.rb 5.27 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
  InvalidPathError = Class.new(StandardError)
6

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
    pair = ['', '']

43
    return pair unless @project # rubocop:disable Cop/ModuleWithInstanceVariables
44

Douwe Maan's avatar
Douwe Maan committed
45
    if id =~ /^(\h{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

55
      valid_refs = ref_names.select { |v| id.start_with?("#{v}/") }
56

57
      if valid_refs.length == 0
58
        # No exact ref match, so just try our best
59
        pair = id.match(/([^\/]+)(.*)/).captures
60
      else
61 62 63 64
        # 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)
65
        # Partition the string into the ref and the path, ignoring the empty first value
66
        pair = id.partition(best_match)[1..-1]
67 68 69
      end
    end

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

73 74
    pair
  end
75

76 77 78 79 80 81 82 83 84 85 86 87 88
  # If we have an ID of 'foo.atom', and the controller provides Atom and HTML
  # formats, then we have to check if the request was for the Atom version of
  # the ID without the '.atom' suffix, or the HTML version of the ID including
  # the suffix. We only check this if the version including the suffix doesn't
  # match, so it is possible to create a branch which has an unroutable Atom
  # feed.
  def extract_ref_without_atom(id)
    id_without_atom = id.sub(/\.atom$/, '')
    valid_refs = ref_names.select { |v| "#{id_without_atom}/".start_with?("#{v}/") }

    valid_refs.max_by(&:length)
  end

89 90 91 92 93 94 95
  # 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
96
  # - @commit - A Commit representing the commit from the given ref
97
  #
98 99 100
  # If the :id parameter appears to be requesting a specific response format,
  # that will be handled as well.
  #
101 102 103 104
  # If there is no path and the ref doesn't exist in the repo, try to resolve
  # the ref without an '.atom' suffix. If _that_ ref is found, set the request's
  # format to Atom manually.
  #
105 106
  # Automatically renders `not_found!` if a valid tree path could not be
  # resolved (e.g., when a user inserts an invalid path or ref).
107
  # rubocop:disable Cop/ModuleWithInstanceVariables
108
  def assign_ref_vars
109
    # assign allowed options
110
    allowed_options = ["filter_ref"]
111 112 113
    @options = params.select {|key, value| allowed_options.include?(key) && !value.blank? }
    @options = HashWithIndifferentAccess.new(@options)

winniehell's avatar
winniehell committed
114
    @id = get_id
115
    @ref, @path = extract_ref(@id)
Sato Hiroyuki's avatar
Sato Hiroyuki committed
116
    @repo = @project.repository
117

118
    @commit = @repo.commit(@ref)
119

120 121 122
    if @path.empty? && !@commit && @id.ends_with?('.atom')
      @id = @ref = extract_ref_without_atom(@id)
      @commit = @repo.commit(@ref)
123

124
      request.format = :atom if @commit
125
    end
126

127 128
    raise InvalidPathError unless @commit

Sato Hiroyuki's avatar
Sato Hiroyuki committed
129
    @hex_path = Digest::SHA1.hexdigest(@path)
130
    @logs_path = logs_file_project_ref_path(@project, @ref, @path)
131

132
  rescue RuntimeError, NoMethodError, InvalidPathError
133
    render_404
134
  end
135
  # rubocop:enable Cop/ModuleWithInstanceVariables
Sato Hiroyuki's avatar
Sato Hiroyuki committed
136

137
  def tree
138
    @tree ||= @repo.tree(@commit.id, @path) # rubocop:disable Cop/ModuleWithInstanceVariables
139
  end
winniehell's avatar
winniehell committed
140 141 142 143 144 145 146 147 148

  private

  # overriden in subclasses, do not remove
  def get_id
    id = params[:id] || params[:ref]
    id += "/" + params[:path] unless params[:path].blank?
    id
  end
149 150

  def ref_names
151
    return [] unless @project # rubocop:disable Cop/ModuleWithInstanceVariables
152

153
    @ref_names ||= @project.repository.ref_names # rubocop:disable Cop/ModuleWithInstanceVariables
154
  end
155
end