2012-09-20 13:55:14 -04:00
|
|
|
# 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
|
2017-03-01 06:00:37 -05:00
|
|
|
InvalidPathError = Class.new(StandardError)
|
2012-09-17 13:33:04 -04:00
|
|
|
|
2012-09-20 13:55:14 -04:00
|
|
|
# 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.
|
2012-09-17 13:33:04 -04:00
|
|
|
#
|
2012-09-20 13:55:14 -04:00
|
|
|
# Expects a @project instance variable to contain the active project. This is
|
|
|
|
# used to check the input against a list of valid repository refs.
|
2012-09-17 13:33:04 -04:00
|
|
|
#
|
|
|
|
# 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']
|
|
|
|
#
|
2013-03-21 10:41:16 -04:00
|
|
|
# extract_ref('master/app/models/project.rb')
|
2012-12-24 22:14:05 -05:00
|
|
|
# # => ['master', 'app/models/project.rb']
|
|
|
|
#
|
2012-09-17 13:33:04 -04:00
|
|
|
# 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
|
2013-03-21 10:41:16 -04:00
|
|
|
def extract_ref(id)
|
2012-09-17 10:44:36 -04:00
|
|
|
pair = ['', '']
|
|
|
|
|
2017-11-22 02:50:36 -05:00
|
|
|
return pair unless @project # rubocop:disable Gitlab/ModuleWithInstanceVariables
|
2012-09-17 10:44:36 -04:00
|
|
|
|
2017-02-23 10:27:36 -05:00
|
|
|
if id =~ /^(\h{40})(.+)/
|
2012-09-17 10:44:36 -04:00
|
|
|
# If the ref appears to be a SHA, we're done, just split the string
|
|
|
|
pair = $~.captures
|
|
|
|
else
|
2012-09-17 13:33:04 -04:00
|
|
|
# Otherwise, attempt to detect the ref using a list of the project's
|
|
|
|
# branches and tags
|
|
|
|
|
2012-09-17 10:44:36 -04:00
|
|
|
# Append a trailing slash if we only get a ref and no file path
|
2012-10-04 12:31:31 -04:00
|
|
|
id += '/' unless id.ends_with?('/')
|
2012-10-04 14:13:52 -04:00
|
|
|
|
2016-10-07 11:49:48 -04:00
|
|
|
valid_refs = ref_names.select { |v| id.start_with?("#{v}/") }
|
2012-10-04 14:13:52 -04:00
|
|
|
|
2018-09-18 03:36:24 -04:00
|
|
|
if valid_refs.empty?
|
2012-09-17 10:44:36 -04:00
|
|
|
# No exact ref match, so just try our best
|
2018-01-27 00:35:53 -05:00
|
|
|
pair = id.match(%r{([^/]+)(.*)}).captures
|
2012-09-17 10:44:36 -04:00
|
|
|
else
|
2015-06-21 11:26:37 -04:00
|
|
|
# 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)
|
2012-09-17 10:44:36 -04:00
|
|
|
# Partition the string into the ref and the path, ignoring the empty first value
|
2015-06-21 11:26:37 -04:00
|
|
|
pair = id.partition(best_match)[1..-1]
|
2012-09-17 10:44:36 -04:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2012-10-04 12:31:31 -04:00
|
|
|
# Remove ending slashes from path
|
2018-01-27 00:35:53 -05:00
|
|
|
pair[1].gsub!(%r{^/|/$}, '')
|
2012-09-17 13:33:04 -04:00
|
|
|
|
2012-09-17 10:44:36 -04:00
|
|
|
pair
|
|
|
|
end
|
2012-09-17 14:24:31 -04:00
|
|
|
|
2016-10-07 11:49:48 -04:00
|
|
|
# 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
|
|
|
|
|
2012-09-17 14:24:31 -04:00
|
|
|
# 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
|
2013-04-01 09:56:25 -04:00
|
|
|
# - @commit - A Commit representing the commit from the given ref
|
2012-09-17 14:24:31 -04:00
|
|
|
#
|
2012-09-20 13:55:14 -04:00
|
|
|
# If the :id parameter appears to be requesting a specific response format,
|
|
|
|
# that will be handled as well.
|
|
|
|
#
|
2016-10-07 11:49:48 -04:00
|
|
|
# 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.
|
|
|
|
#
|
2012-09-20 13:55:14 -04:00
|
|
|
# Automatically renders `not_found!` if a valid tree path could not be
|
|
|
|
# resolved (e.g., when a user inserts an invalid path or ref).
|
2017-11-22 02:50:36 -05:00
|
|
|
# rubocop:disable Gitlab/ModuleWithInstanceVariables
|
2012-09-17 14:24:31 -04:00
|
|
|
def assign_ref_vars
|
2013-08-21 03:55:18 -04:00
|
|
|
# assign allowed options
|
2016-11-05 23:33:39 -04:00
|
|
|
allowed_options = ["filter_ref"]
|
2013-08-21 03:55:18 -04:00
|
|
|
@options = params.select {|key, value| allowed_options.include?(key) && !value.blank? }
|
|
|
|
@options = HashWithIndifferentAccess.new(@options)
|
|
|
|
|
2016-08-23 20:22:30 -04:00
|
|
|
@id = get_id
|
2013-03-21 10:41:16 -04:00
|
|
|
@ref, @path = extract_ref(@id)
|
2013-04-14 08:08:16 -04:00
|
|
|
@repo = @project.repository
|
2013-10-01 10:00:28 -04:00
|
|
|
|
2016-11-05 23:33:39 -04:00
|
|
|
@commit = @repo.commit(@ref)
|
2016-10-14 18:36:05 -04:00
|
|
|
|
2016-11-05 23:33:39 -04:00
|
|
|
if @path.empty? && !@commit && @id.ends_with?('.atom')
|
|
|
|
@id = @ref = extract_ref_without_atom(@id)
|
|
|
|
@commit = @repo.commit(@ref)
|
2016-10-07 11:49:48 -04:00
|
|
|
|
2016-11-05 23:33:39 -04:00
|
|
|
request.format = :atom if @commit
|
2016-10-28 07:38:14 -04:00
|
|
|
end
|
2013-10-01 11:26:55 -04:00
|
|
|
|
2016-11-05 23:33:39 -04:00
|
|
|
raise InvalidPathError unless @commit
|
|
|
|
|
2013-04-14 08:08:16 -04:00
|
|
|
@hex_path = Digest::SHA1.hexdigest(@path)
|
2017-06-29 13:06:35 -04:00
|
|
|
@logs_path = logs_file_project_ref_path(@project, @ref, @path)
|
2013-03-01 08:59:43 -05:00
|
|
|
rescue RuntimeError, NoMethodError, InvalidPathError
|
2015-10-09 13:07:29 -04:00
|
|
|
render_404
|
2012-09-17 14:24:31 -04:00
|
|
|
end
|
2017-11-22 02:50:36 -05:00
|
|
|
# rubocop:enable Gitlab/ModuleWithInstanceVariables
|
2013-04-14 08:08:16 -04:00
|
|
|
|
2013-10-01 10:00:28 -04:00
|
|
|
def tree
|
2017-11-22 02:50:36 -05:00
|
|
|
@tree ||= @repo.tree(@commit.id, @path) # rubocop:disable Gitlab/ModuleWithInstanceVariables
|
2013-10-01 10:00:28 -04:00
|
|
|
end
|
2016-08-23 20:22:30 -04:00
|
|
|
|
2017-12-14 06:59:01 -05:00
|
|
|
def lfs_blob_ids
|
|
|
|
blob_ids = tree.blobs.map(&:id)
|
2018-07-09 09:29:46 -04:00
|
|
|
|
|
|
|
# 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
|
|
|
|
|
2017-12-15 06:37:57 -05:00
|
|
|
@lfs_blob_ids = Gitlab::Git::Blob.batch_lfs_pointers(@project.repository, blob_ids).map(&:id) # rubocop:disable Gitlab/ModuleWithInstanceVariables
|
2017-12-14 06:59:01 -05:00
|
|
|
end
|
|
|
|
|
2016-08-23 20:22:30 -04:00
|
|
|
private
|
|
|
|
|
|
|
|
# overriden in subclasses, do not remove
|
|
|
|
def get_id
|
|
|
|
id = params[:id] || params[:ref]
|
|
|
|
id += "/" + params[:path] unless params[:path].blank?
|
|
|
|
id
|
|
|
|
end
|
2016-10-07 11:49:48 -04:00
|
|
|
|
|
|
|
def ref_names
|
2017-11-22 02:50:36 -05:00
|
|
|
return [] unless @project # rubocop:disable Gitlab/ModuleWithInstanceVariables
|
2016-10-07 11:49:48 -04:00
|
|
|
|
2017-11-22 02:50:36 -05:00
|
|
|
@ref_names ||= @project.repository.ref_names # rubocop:disable Gitlab/ModuleWithInstanceVariables
|
2016-10-07 11:49:48 -04:00
|
|
|
end
|
2012-09-17 10:44:36 -04:00
|
|
|
end
|