gitlab-org--gitlab-foss/lib/gitlab/git/index.rb

158 lines
4.3 KiB
Ruby
Raw Normal View History

# Gitaly note: JV: When the time comes I think we will want to copy this
# class into Gitaly. None of its methods look like they should be RPC's.
# The RPC's will be at a higher level.
module Gitlab
module Git
class Index
2017-04-19 20:37:44 -04:00
IndexError = Class.new(StandardError)
DEFAULT_MODE = 0o100644
2017-04-19 20:37:44 -04:00
ACTIONS = %w(create create_dir update move delete).freeze
ACTION_OPTIONS = %i(file_path previous_path content encoding).freeze
2017-04-19 20:37:44 -04:00
attr_reader :repository, :raw_index
def initialize(repository)
@repository = repository
@raw_index = repository.rugged.index
end
2017-02-24 10:32:10 -05:00
delegate :read_tree, :get, to: :raw_index
def apply(action, options)
validate_action!(action)
public_send(action, options.slice(*ACTION_OPTIONS)) # rubocop:disable GitlabSecurity/PublicSend
end
def write_tree
raw_index.write_tree(repository.rugged)
end
2017-02-24 10:32:10 -05:00
def dir_exists?(path)
raw_index.find { |entry| entry[:path].start_with?("#{path}/") }
end
def create(options)
2017-02-24 10:32:10 -05:00
options = normalize_options(options)
2017-04-19 20:37:44 -04:00
if get(options[:file_path])
raise IndexError, "A file with this name already exists"
end
add_blob(options)
end
def create_dir(options)
2017-02-24 10:32:10 -05:00
options = normalize_options(options)
2017-04-19 20:37:44 -04:00
if get(options[:file_path])
raise IndexError, "A file with this name already exists"
end
2017-02-24 10:32:10 -05:00
if dir_exists?(options[:file_path])
2017-04-19 20:37:44 -04:00
raise IndexError, "A directory with this name already exists"
2017-02-24 10:32:10 -05:00
end
options = options.dup
options[:file_path] += '/.gitkeep'
options[:content] = ''
add_blob(options)
end
def update(options)
2017-02-24 10:32:10 -05:00
options = normalize_options(options)
2017-02-24 10:32:10 -05:00
file_entry = get(options[:file_path])
unless file_entry
2017-04-19 20:37:44 -04:00
raise IndexError, "A file with this name doesn't exist"
end
add_blob(options, mode: file_entry[:mode])
end
def move(options)
2017-02-24 10:32:10 -05:00
options = normalize_options(options)
2017-02-24 10:32:10 -05:00
file_entry = get(options[:previous_path])
unless file_entry
2017-04-19 20:37:44 -04:00
raise IndexError, "A file with this name doesn't exist"
end
if get(options[:file_path])
raise IndexError, "A file with this name already exists"
end
raw_index.remove(options[:previous_path])
add_blob(options, mode: file_entry[:mode])
end
def delete(options)
2017-02-24 10:32:10 -05:00
options = normalize_options(options)
2017-04-19 20:37:44 -04:00
unless get(options[:file_path])
raise IndexError, "A file with this name doesn't exist"
end
raw_index.remove(options[:file_path])
end
private
2017-02-24 10:32:10 -05:00
def normalize_options(options)
options = options.dup
options[:file_path] = normalize_path(options[:file_path]) if options[:file_path]
options[:previous_path] = normalize_path(options[:previous_path]) if options[:previous_path]
2017-02-24 10:32:10 -05:00
options
end
def normalize_path(path)
2017-04-19 20:37:44 -04:00
unless path
raise IndexError, "You must provide a file path"
end
2017-02-24 10:32:10 -05:00
pathname = Gitlab::Git::PathHelper.normalize_path(path.dup)
2017-04-19 20:37:44 -04:00
pathname.each_filename do |segment|
if segment == '..'
raise IndexError, 'Path cannot include directory traversal'
end
end
pathname.to_s
end
def add_blob(options, mode: nil)
content = options[:content]
2017-04-19 20:37:44 -04:00
unless content
raise IndexError, "You must provide content"
end
content = Base64.decode64(content) if options[:encoding] == 'base64'
detect = CharlockHolmes::EncodingDetector.new.detect(content)
unless detect && detect[:type] == :binary
# When writing to the repo directly as we are doing here,
# the `core.autocrlf` config isn't taken into account.
content.gsub!("\r\n", "\n") if repository.autocrlf
end
oid = repository.rugged.write(content, :blob)
raw_index.add(path: options[:file_path], oid: oid, mode: mode || DEFAULT_MODE)
rescue Rugged::IndexError => e
2017-04-19 20:37:44 -04:00
raise IndexError, e.message
end
def validate_action!(action)
unless ACTIONS.include?(action.to_s)
raise ArgumentError, "Unknown action '#{action}'"
end
end
end
end
end