extracts_path.rb 5.85 KB
Newer Older
1 2
# frozen_string_literal: true

3 4 5 6
# 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
7
  InvalidPathError = Class.new(StandardError)
8

9 10
  # 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.
11
  #
12 13
  # Expects a @project instance variable to contain the active project. This is
  # used to check the input against a list of valid repository refs.
14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
  #
  # 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']
  #
30
  #   extract_ref('master/app/models/project.rb')
31 32
  #   # => ['master', 'app/models/project.rb']
  #
33 34 35 36 37 38 39 40 41
  #   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
42
  def extract_ref(id)
43 44
    pair = ['', '']

45
    return pair unless @project # rubocop:disable Gitlab/ModuleWithInstanceVariables
46

Douwe Maan's avatar
Douwe Maan committed
47
    if id =~ /^(\h{40})(.+)/
48 49 50
      # If the ref appears to be a SHA, we're done, just split the string
      pair = $~.captures
    else
51 52 53
      # Otherwise, attempt to detect the ref using a list of the project's
      # branches and tags

54
      # Append a trailing slash if we only get a ref and no file path
55 56 57
      unless id.ends_with?('/')
        id = [id, '/'].join
      end
58

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

61
      if valid_refs.empty?
62
        # No exact ref match, so just try our best
63
        pair = id.match(%r{([^/]+)(.*)}).captures
64
      else
65 66 67 68
        # 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)
69
        # Partition the string into the ref and the path, ignoring the empty first value
70
        pair = id.partition(best_match)[1..-1]
71 72 73
      end
    end

74
    # Remove ending slashes from path
75
    pair[1].gsub!(%r{^/|/$}, '')
76

77 78
    pair
  end
79

80 81 82 83 84 85 86 87 88 89 90 91 92
  # 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

93 94 95 96 97 98 99
  # 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
100
  # - @commit - A Commit representing the commit from the given ref
101
  #
102 103 104
  # If the :id parameter appears to be requesting a specific response format,
  # that will be handled as well.
  #
105 106 107 108
  # 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.
  #
109 110
  # Automatically renders `not_found!` if a valid tree path could not be
  # resolved (e.g., when a user inserts an invalid path or ref).
111
  # rubocop:disable Gitlab/ModuleWithInstanceVariables
112
  def assign_ref_vars
113
    # assign allowed options
114
    allowed_options = ["filter_ref"]
115 116 117
    @options = params.select {|key, value| allowed_options.include?(key) && !value.blank? }
    @options = HashWithIndifferentAccess.new(@options)

winniehell's avatar
winniehell committed
118
    @id = get_id
119
    @ref, @path = extract_ref(@id)
Sato Hiroyuki's avatar
Sato Hiroyuki committed
120
    @repo = @project.repository
121

122
    @commit = @repo.commit(@ref)
123

124 125 126
    if @path.empty? && !@commit && @id.ends_with?('.atom')
      @id = @ref = extract_ref_without_atom(@id)
      @commit = @repo.commit(@ref)
127

128
      request.format = :atom if @commit
129
    end
130

131 132
    raise InvalidPathError unless @commit

Sato Hiroyuki's avatar
Sato Hiroyuki committed
133
    @hex_path = Digest::SHA1.hexdigest(@path)
134
    @logs_path = logs_file_project_ref_path(@project, @ref, @path)
135
  rescue RuntimeError, NoMethodError, InvalidPathError
136
    render_404
137
  end
138
  # rubocop:enable Gitlab/ModuleWithInstanceVariables
Sato Hiroyuki's avatar
Sato Hiroyuki committed
139

140
  def tree
141
    @tree ||= @repo.tree(@commit.id, @path) # rubocop:disable Gitlab/ModuleWithInstanceVariables
142
  end
winniehell's avatar
winniehell committed
143

144 145
  def lfs_blob_ids
    blob_ids = tree.blobs.map(&:id)
146 147 148 149 150

    # When current endpoint is a Blob then `tree.blobs` will be empty, it means we need to analyze
    # the current Blob in order to determine if it's a LFS object
    blob_ids = Array.wrap(@repo.blob_at(@commit.id, @path)&.id) if blob_ids.empty? # rubocop:disable Gitlab/ModuleWithInstanceVariables

Lin Jen-Shin's avatar
Lin Jen-Shin committed
151
    @lfs_blob_ids = Gitlab::Git::Blob.batch_lfs_pointers(@project.repository, blob_ids).map(&:id) # rubocop:disable Gitlab/ModuleWithInstanceVariables
152 153
  end

winniehell's avatar
winniehell committed
154 155
  private

156
  # overridden in subclasses, do not remove
winniehell's avatar
winniehell committed
157
  def get_id
158 159 160
    id = [params[:id] || params[:ref]]
    id << "/" + params[:path] unless params[:path].blank?
    id.join
winniehell's avatar
winniehell committed
161
  end
162 163

  def ref_names
164
    return [] unless @project # rubocop:disable Gitlab/ModuleWithInstanceVariables
165

166
    @ref_names ||= @project.repository.ref_names # rubocop:disable Gitlab/ModuleWithInstanceVariables
167
  end
168
end