debian-mirror-gitlab/app/models/repository.rb

1182 lines
30 KiB
Ruby
Raw Normal View History

2018-11-18 11:00:15 +05:30
# frozen_string_literal: true
2015-09-25 12:07:36 +05:30
require 'securerandom'
2014-09-02 18:07:02 +05:30
class Repository
2019-12-04 20:38:33 +05:30
REF_MERGE_REQUEST = 'merge-requests'
REF_KEEP_AROUND = 'keep-around'
REF_ENVIRONMENTS = 'environments'
2019-12-21 20:55:43 +05:30
REF_PIPELINES = 'pipelines'
2018-03-17 18:26:18 +05:30
2019-10-12 21:52:04 +05:30
ARCHIVE_CACHE_TIME = 60 # Cache archives referred to by a (mutable) ref for 1 minute
ARCHIVE_CACHE_TIME_IMMUTABLE = 3600 # Cache archives referred to by an immutable reference for 1 hour
2018-03-17 18:26:18 +05:30
RESERVED_REFS_NAMES = %W[
heads
tags
replace
#{REF_ENVIRONMENTS}
#{REF_KEEP_AROUND}
2019-12-21 20:55:43 +05:30
#{REF_PIPELINES}
2018-03-17 18:26:18 +05:30
].freeze
2018-03-27 19:54:05 +05:30
include Gitlab::RepositoryCacheAdapter
2014-09-02 18:07:02 +05:30
2019-07-07 11:18:12 +05:30
attr_accessor :full_path, :disk_path, :project, :repo_type
2014-09-02 18:07:02 +05:30
2017-08-17 22:00:37 +05:30
delegate :ref_name_for_sha, to: :raw_repository
2018-11-08 19:23:39 +05:30
delegate :bundle_to_disk, to: :raw_repository
2017-08-17 22:00:37 +05:30
CreateTreeError = Class.new(StandardError)
2019-01-03 12:48:30 +05:30
AmbiguousRefError = Class.new(StandardError)
2017-08-17 22:00:37 +05:30
# Methods that cache data from the Git repository.
#
# Each entry in this Array should have a corresponding method with the exact
# same name. The cache key used by those methods must also match method's
# name.
#
# For example, for entry `:commit_count` there's a method called `commit_count` which
# stores its data in the `commit_count` cache key.
2019-02-15 15:39:39 +05:30
CACHED_METHODS = %i(size commit_count rendered_readme readme_path contribution_guide
2018-12-13 13:39:08 +05:30
changelog license_blob license_key gitignore
2017-08-17 22:00:37 +05:30
gitlab_ci_yml branch_names tag_names branch_count
2018-03-17 18:26:18 +05:30
tag_count avatar exists? root_ref has_visible_content?
2019-07-31 22:56:46 +05:30
issue_template_names merge_request_template_names
metrics_dashboard_paths xcode_project?).freeze
2018-03-17 18:26:18 +05:30
# Methods that use cache_method but only memoize the value
MEMOIZED_CACHED_METHODS = %i(license).freeze
2017-08-17 22:00:37 +05:30
# Certain method caches should be refreshed when certain types of files are
# changed. This Hash maps file types (as returned by Gitlab::FileDetector) to
# the corresponding methods to call for refreshing caches.
METHOD_CACHES_FOR_FILE_TYPES = {
2019-02-15 15:39:39 +05:30
readme: %i(rendered_readme readme_path),
2017-08-17 22:00:37 +05:30
changelog: :changelog,
2017-09-10 17:25:29 +05:30
license: %i(license_blob license_key license),
2017-08-17 22:00:37 +05:30
contributing: :contribution_guide,
gitignore: :gitignore,
gitlab_ci: :gitlab_ci_yml,
2018-03-17 18:26:18 +05:30
avatar: :avatar,
issue_template: :issue_template_names,
2018-11-08 19:23:39 +05:30
merge_request_template: :merge_request_template_names,
2019-07-31 22:56:46 +05:30
metrics_dashboard: :metrics_dashboard_paths,
2018-11-08 19:23:39 +05:30
xcode_config: :xcode_project?
2017-08-17 22:00:37 +05:30
}.freeze
2019-07-07 11:18:12 +05:30
def initialize(full_path, project, disk_path: nil, repo_type: Gitlab::GlRepository::PROJECT)
2017-09-10 17:25:29 +05:30
@full_path = full_path
@disk_path = disk_path || full_path
2015-09-11 14:41:01 +05:30
@project = project
2018-03-17 18:26:18 +05:30
@commit_cache = {}
2019-07-07 11:18:12 +05:30
@repo_type = repo_type
2018-03-17 18:26:18 +05:30
end
def ==(other)
2019-02-15 15:39:39 +05:30
other.is_a?(self.class) && @disk_path == other.disk_path
end
alias_method :eql?, :==
def hash
[self.class, @disk_path].hash
2015-11-26 14:37:03 +05:30
end
2015-09-11 14:41:01 +05:30
2015-11-26 14:37:03 +05:30
def raw_repository
2019-07-07 11:18:12 +05:30
return unless full_path
2015-09-11 14:41:01 +05:30
2017-08-17 22:00:37 +05:30
@raw_repository ||= initialize_raw_repository
2014-09-02 18:07:02 +05:30
end
2017-09-10 17:25:29 +05:30
alias_method :raw, :raw_repository
2018-11-08 19:23:39 +05:30
# Don't use this! It's going away. Use Gitaly to read or write from repos.
2014-09-02 18:07:02 +05:30
def path_to_repo
2018-10-15 14:42:47 +05:30
@path_to_repo ||=
begin
storage = Gitlab.config.repositories.storages[@project.repository_storage]
File.expand_path(
File.join(storage.legacy_disk_path, disk_path + '.git')
)
end
2014-09-02 18:07:02 +05:30
end
2018-03-17 18:26:18 +05:30
def inspect
"#<#{self.class.name}:#{@disk_path}>"
end
2018-11-08 19:23:39 +05:30
def commit(ref = nil)
2019-07-07 11:18:12 +05:30
return unless exists?
2018-03-17 18:26:18 +05:30
return ref if ref.is_a?(::Commit)
2017-08-17 22:00:37 +05:30
2018-11-08 19:23:39 +05:30
find_commit(ref || root_ref)
2018-03-17 18:26:18 +05:30
end
2017-08-17 22:00:37 +05:30
2018-03-17 18:26:18 +05:30
# Finding a commit by the passed SHA
# Also takes care of caching, based on the SHA
def commit_by(oid:)
return @commit_cache[oid] if @commit_cache.key?(oid)
@commit_cache[oid] = find_commit(oid)
end
def commits_by(oids:)
return [] unless oids.present?
commits = Gitlab::Git::Commit.batch_by_oid(raw_repository, oids)
if commits.present?
Commit.decorate(commits, @project)
else
[]
end
2014-09-02 18:07:02 +05:30
end
2019-12-21 20:55:43 +05:30
# the opts are:
# - :path
# - :limit
# - :offset
# - :skip_merges
# - :after
# - :before
# - :all
# - :first_parent
def commits(ref = nil, opts = {})
2015-11-26 14:37:03 +05:30
options = {
2014-09-02 18:07:02 +05:30
repo: raw_repository,
ref: ref,
2019-12-21 20:55:43 +05:30
path: opts[:path],
follow: Array(opts[:path]).length == 1,
limit: opts[:limit],
offset: opts[:offset],
skip_merges: !!opts[:skip_merges],
after: opts[:after],
before: opts[:before],
all: !!opts[:all],
first_parent: !!opts[:first_parent]
2015-11-26 14:37:03 +05:30
}
commits = Gitlab::Git::Commit.where(options)
2015-09-11 14:41:01 +05:30
commits = Commit.decorate(commits, @project) if commits.present?
2018-03-17 18:26:18 +05:30
CommitCollection.new(project, commits, ref)
2014-09-02 18:07:02 +05:30
end
def commits_between(from, to)
commits = Gitlab::Git::Commit.between(raw_repository, from, to)
2015-09-11 14:41:01 +05:30
commits = Commit.decorate(commits, @project) if commits.present?
2014-09-02 18:07:02 +05:30
commits
end
2018-03-17 18:26:18 +05:30
# Returns a list of commits that are not present in any reference
def new_commits(newrev)
2018-11-18 11:00:15 +05:30
commits = raw.new_commits(newrev)
2018-03-17 18:26:18 +05:30
2018-11-18 11:00:15 +05:30
::Commit.decorate(commits, project)
2018-03-17 18:26:18 +05:30
end
2017-09-10 17:25:29 +05:30
# Gitaly migration: https://gitlab.com/gitlab-org/gitaly/issues/384
def find_commits_by_message(query, ref = nil, path = nil, limit = 1000, offset = 0)
2017-08-17 22:00:37 +05:30
unless exists? && has_visible_content? && query.present?
return []
end
2018-03-17 18:26:18 +05:30
commits = raw_repository.find_commits_by_message(query, ref, path, limit, offset).map do |c|
commit(c)
2017-09-10 17:25:29 +05:30
end
2018-03-17 18:26:18 +05:30
CommitCollection.new(project, commits, ref)
2015-11-26 14:37:03 +05:30
end
2018-11-18 11:00:15 +05:30
def find_branch(name)
raw_repository.find_branch(name)
2014-09-02 18:07:02 +05:30
end
def find_tag(name)
2016-08-24 12:49:21 +05:30
tags.find { |tag| tag.name == name }
2014-09-02 18:07:02 +05:30
end
2019-01-03 12:48:30 +05:30
def ambiguous_ref?(ref)
tag_exists?(ref) && branch_exists?(ref)
end
def expand_ref(ref)
if tag_exists?(ref)
Gitlab::Git::TAG_REF_PREFIX + ref
elsif branch_exists?(ref)
Gitlab::Git::BRANCH_REF_PREFIX + ref
end
end
2017-08-17 22:00:37 +05:30
def add_branch(user, branch_name, ref)
2018-03-17 18:26:18 +05:30
branch = raw_repository.add_branch(branch_name, user: user, target: ref)
2014-09-02 18:07:02 +05:30
2016-06-02 11:05:42 +05:30
after_create_branch
2018-03-17 18:26:18 +05:30
branch
rescue Gitlab::Git::Repository::InvalidRef
false
2014-09-02 18:07:02 +05:30
end
2016-06-02 11:05:42 +05:30
def add_tag(user, tag_name, target, message = nil)
2018-03-17 18:26:18 +05:30
raw_repository.add_tag(tag_name, user: user, target: target, message: message)
rescue Gitlab::Git::Repository::InvalidRef
false
2014-09-02 18:07:02 +05:30
end
2015-12-23 02:04:40 +05:30
def rm_branch(user, branch_name)
2016-06-02 11:05:42 +05:30
before_remove_branch
2015-12-23 02:04:40 +05:30
2018-03-17 18:26:18 +05:30
raw_repository.rm_branch(branch_name, user: user)
2015-12-23 02:04:40 +05:30
2016-06-02 11:05:42 +05:30
after_remove_branch
2015-12-23 02:04:40 +05:30
true
2014-09-02 18:07:02 +05:30
end
2017-08-17 22:00:37 +05:30
def rm_tag(user, tag_name)
2016-06-02 11:05:42 +05:30
before_remove_tag
2014-09-02 18:07:02 +05:30
2018-03-17 18:26:18 +05:30
raw_repository.rm_tag(tag_name, user: user)
2017-08-17 22:00:37 +05:30
after_remove_tag
true
2014-09-02 18:07:02 +05:30
end
2016-06-22 15:30:34 +05:30
def ref_names
branch_names + tag_names
end
2016-06-02 11:05:42 +05:30
def branch_exists?(branch_name)
2018-03-17 18:26:18 +05:30
return false unless raw_repository
2019-12-21 20:55:43 +05:30
branch_names_include?(branch_name)
2014-09-02 18:07:02 +05:30
end
2018-03-17 18:26:18 +05:30
def tag_exists?(tag_name)
return false unless raw_repository
2019-12-21 20:55:43 +05:30
tag_names_include?(tag_name)
2018-03-17 18:26:18 +05:30
end
2016-08-24 12:49:21 +05:30
def ref_exists?(ref)
2018-03-17 18:26:18 +05:30
!!raw_repository&.ref_exists?(ref)
rescue ArgumentError
2017-08-17 22:00:37 +05:30
false
2016-09-29 09:46:39 +05:30
end
2018-11-18 11:00:15 +05:30
def languages
return [] if empty?
raw_repository.languages(root_ref)
end
2018-11-20 20:47:30 +05:30
def keep_around(*shas)
2019-12-04 20:38:33 +05:30
Gitlab::Git::KeepAround.execute(self, shas)
2014-09-02 18:07:02 +05:30
end
2019-07-31 22:56:46 +05:30
def archive_metadata(ref, storage_path, format = "tar.gz", append_sha:, path: nil)
2018-11-08 19:23:39 +05:30
raw_repository.archive_metadata(
ref,
storage_path,
project.path,
format,
2019-07-31 22:56:46 +05:30
append_sha: append_sha,
path: path
2018-11-08 19:23:39 +05:30
)
end
def cached_methods
CACHED_METHODS
end
2017-08-17 22:00:37 +05:30
def expire_tags_cache
expire_method_caches(%i(tag_names tag_count))
@tags = nil
2015-09-11 14:41:01 +05:30
end
2017-08-17 22:00:37 +05:30
def expire_branches_cache
2018-03-17 18:26:18 +05:30
expire_method_caches(%i(branch_names branch_count has_visible_content?))
2017-08-17 22:00:37 +05:30
@local_branches = nil
2018-03-17 18:26:18 +05:30
@branch_exists_memo = nil
2016-08-24 12:49:21 +05:30
end
2017-08-17 22:00:37 +05:30
def expire_statistics_caches
expire_method_caches(%i(size commit_count))
2016-06-02 11:05:42 +05:30
end
2017-08-17 22:00:37 +05:30
def expire_all_method_caches
expire_method_caches(CACHED_METHODS)
2015-11-26 14:37:03 +05:30
end
2017-08-17 22:00:37 +05:30
def expire_avatar_cache
expire_method_caches(%i(avatar))
end
# Refreshes the method caches of this repository.
#
# types - An Array of file types (e.g. `:readme`) used to refresh extra
# caches.
def refresh_method_caches(types)
2018-11-18 11:00:15 +05:30
return if types.empty?
2017-08-17 22:00:37 +05:30
to_refresh = []
types.each do |type|
methods = METHOD_CACHES_FOR_FILE_TYPES[type.to_sym]
to_refresh.concat(Array(methods)) if methods
2015-04-26 12:48:37 +05:30
end
2017-08-17 22:00:37 +05:30
expire_method_caches(to_refresh)
2016-04-02 18:10:28 +05:30
2018-03-17 18:26:18 +05:30
to_refresh.each { |method| send(method) } # rubocop:disable GitlabSecurity/PublicSend
2016-04-02 18:10:28 +05:30
end
def expire_branch_cache(branch_name = nil)
# When we push to the root branch we have to flush the cache for all other
# branches as their statistics are based on the commits relative to the
# root branch.
if !branch_name || branch_name == root_ref
branches.each do |branch|
cache.expire(:"diverging_commit_counts_#{branch.name}")
2017-08-17 22:00:37 +05:30
cache.expire(:"commit_count_#{branch.name}")
2016-04-02 18:10:28 +05:30
end
# In case a commit is pushed to a non-root branch we only have to flush the
# cache for said branch.
else
cache.expire(:"diverging_commit_counts_#{branch_name}")
2017-08-17 22:00:37 +05:30
cache.expire(:"commit_count_#{branch_name}")
end
2014-09-02 18:07:02 +05:30
end
2016-04-02 18:10:28 +05:30
def expire_root_ref_cache
2017-08-17 22:00:37 +05:30
expire_method_caches(%i(root_ref))
2016-04-02 18:10:28 +05:30
end
# Expires the cache(s) used to determine if a repository is empty or not.
def expire_emptiness_caches
2017-08-17 22:00:37 +05:30
return unless empty?
2018-03-17 18:26:18 +05:30
expire_method_caches(%i(has_visible_content?))
2018-05-09 12:01:36 +05:30
raw_repository.expire_has_local_branches_cache
2014-09-02 18:07:02 +05:30
end
2015-04-26 12:48:37 +05:30
def lookup_cache
@lookup_cache ||= {}
2014-09-02 18:07:02 +05:30
end
2016-06-02 11:05:42 +05:30
def expire_exists_cache
2017-08-17 22:00:37 +05:30
expire_method_caches(%i(exists?))
2016-06-02 11:05:42 +05:30
end
2016-11-03 12:29:30 +05:30
# expire cache that doesn't depend on repository data (when expiring)
def expire_content_cache
expire_tags_cache
expire_branches_cache
expire_root_ref_cache
expire_emptiness_caches
expire_exists_cache
2017-08-17 22:00:37 +05:30
expire_statistics_caches
2016-11-03 12:29:30 +05:30
end
2019-10-12 21:52:04 +05:30
def expire_status_cache
2016-06-02 11:05:42 +05:30
expire_exists_cache
expire_root_ref_cache
expire_emptiness_caches
2019-10-12 21:52:04 +05:30
end
# Runs code after a repository has been created.
def after_create
expire_status_cache
2016-09-13 17:45:13 +05:30
repository_event(:create_repository)
2016-06-02 11:05:42 +05:30
end
# Runs code just before a repository is deleted.
def before_delete
expire_exists_cache
2017-08-17 22:00:37 +05:30
expire_all_method_caches
expire_branch_cache if exists?
2016-11-03 12:29:30 +05:30
expire_content_cache
2016-09-13 17:45:13 +05:30
repository_event(:remove_repository)
2016-06-02 11:05:42 +05:30
end
# Runs code just before the HEAD of a repository is changed.
def before_change_head
# Cached divergent commit counts are based on repository head
expire_branch_cache
expire_root_ref_cache
2016-09-13 17:45:13 +05:30
repository_event(:change_default_branch)
2016-06-02 11:05:42 +05:30
end
# Runs code before pushing (= creating or removing) a tag.
2019-10-12 21:52:04 +05:30
#
# Note that this doesn't expire the tags. You may need to call
# expire_caches_for_tags or expire_tags_cache.
2016-06-02 11:05:42 +05:30
def before_push_tag
2019-10-12 21:52:04 +05:30
repository_event(:push_tag)
end
def expire_caches_for_tags
2017-08-17 22:00:37 +05:30
expire_statistics_caches
expire_emptiness_caches
2016-06-02 11:05:42 +05:30
expire_tags_cache
end
# Runs code before removing a tag.
def before_remove_tag
2019-10-12 21:52:04 +05:30
expire_caches_for_tags
2016-09-13 17:45:13 +05:30
repository_event(:remove_tag)
2016-06-02 11:05:42 +05:30
end
2017-08-17 22:00:37 +05:30
# Runs code after removing a tag.
def after_remove_tag
2019-10-12 21:52:04 +05:30
expire_caches_for_tags
2017-08-17 22:00:37 +05:30
end
# Runs code after the HEAD of a repository is changed.
def after_change_head
2018-11-08 19:23:39 +05:30
expire_all_method_caches
2016-06-02 11:05:42 +05:30
end
# Runs code after a repository has been forked/imported.
def after_import
2016-11-03 12:29:30 +05:30
expire_content_cache
2018-11-18 11:00:15 +05:30
2019-12-04 20:38:33 +05:30
# This call is stubbed in tests due to being an expensive operation
# It can be reenabled for specific tests via:
#
# allow(DetectRepositoryLanguagesWorker).to receive(:perform_async).and_call_original
2019-09-04 21:01:54 +05:30
DetectRepositoryLanguagesWorker.perform_async(project.id)
2016-06-02 11:05:42 +05:30
end
# Runs code after a new commit has been pushed.
2017-08-17 22:00:37 +05:30
def after_push_commit(branch_name)
expire_statistics_caches
expire_branch_cache(branch_name)
2016-09-13 17:45:13 +05:30
repository_event(:push_commit, branch: branch_name)
2016-06-02 11:05:42 +05:30
end
# Runs code after a new branch has been created.
2019-10-12 21:52:04 +05:30
def after_create_branch(expire_cache: true)
expire_branches_cache if expire_cache
2016-09-13 17:45:13 +05:30
repository_event(:push_branch)
2016-06-02 11:05:42 +05:30
end
# Runs code before removing an existing branch.
def before_remove_branch
expire_branches_cache
2016-09-13 17:45:13 +05:30
repository_event(:remove_branch)
2016-06-02 11:05:42 +05:30
end
# Runs code after an existing branch has been removed.
2019-10-12 21:52:04 +05:30
def after_remove_branch(expire_cache: true)
expire_branches_cache if expire_cache
2016-06-02 11:05:42 +05:30
end
2018-11-18 11:00:15 +05:30
def method_missing(msg, *args, &block)
if msg == :lookup && !block_given?
lookup_cache[msg] ||= {}
lookup_cache[msg][args.join(":")] ||= raw_repository.__send__(msg, *args, &block) # rubocop:disable GitlabSecurity/PublicSend
2015-04-26 12:48:37 +05:30
else
2018-11-18 11:00:15 +05:30
raw_repository.__send__(msg, *args, &block) # rubocop:disable GitlabSecurity/PublicSend
2015-04-26 12:48:37 +05:30
end
2014-09-02 18:07:02 +05:30
end
2015-09-11 14:41:01 +05:30
def respond_to_missing?(method, include_private = false)
raw_repository.respond_to?(method, include_private) || super
2014-09-02 18:07:02 +05:30
end
def blob_at(sha, path)
2018-12-13 13:39:08 +05:30
blob = Blob.decorate(raw_repository.blob_at(sha, path), project)
# Don't attempt to return a special result if there is no blob at all
return unless blob
# Don't attempt to return a special result unless we're looking at HEAD
return blob unless head_commit&.sha == sha
case path
when head_tree&.readme_path
ReadmeBlob.new(blob, self)
else
blob
end
2017-08-17 22:00:37 +05:30
rescue Gitlab::Git::Repository::NoRepository
nil
2014-09-02 18:07:02 +05:30
end
2018-03-17 18:26:18 +05:30
# items is an Array like: [[oid, path], [oid1, path1]]
def blobs_at(items)
2019-02-15 15:39:39 +05:30
return [] unless exists?
2018-03-17 18:26:18 +05:30
raw_repository.batch_blobs(items).map { |blob| Blob.decorate(blob, project) }
end
2017-08-17 22:00:37 +05:30
def root_ref
2019-07-07 11:18:12 +05:30
raw_repository&.root_ref
2014-09-02 18:07:02 +05:30
end
2019-07-07 11:18:12 +05:30
cache_method_asymmetrically :root_ref
2014-09-02 18:07:02 +05:30
2017-09-10 17:25:29 +05:30
# Gitaly migration: https://gitlab.com/gitlab-org/gitaly/issues/314
2017-08-17 22:00:37 +05:30
def exists?
2017-09-10 17:25:29 +05:30
return false unless full_path
2018-03-17 18:26:18 +05:30
raw_repository.exists?
2017-08-17 22:00:37 +05:30
end
2018-12-05 23:21:45 +05:30
cache_method_asymmetrically :exists?
2017-08-17 22:00:37 +05:30
2018-03-17 18:26:18 +05:30
# We don't need to cache the output of this method because both exists? and
# has_visible_content? are already memoized and cached. There's no guarantee
# that the values are expired and loaded atomically.
def empty?
return true unless exists?
!has_visible_content?
end
2017-08-17 22:00:37 +05:30
# The size of this repository in megabytes.
def size
exists? ? raw_repository.size : 0.0
end
cache_method :size, fallback: 0.0
def commit_count
root_ref ? raw_repository.commit_count(root_ref) : 0
end
cache_method :commit_count, fallback: 0
def commit_count_for_ref(ref)
return 0 unless exists?
2018-03-17 18:26:18 +05:30
cache.fetch(:"commit_count_#{ref}") { raw_repository.commit_count(ref) }
2014-09-02 18:07:02 +05:30
end
2017-08-17 22:00:37 +05:30
delegate :branch_names, to: :raw_repository
2019-12-21 20:55:43 +05:30
cache_method_as_redis_set :branch_names, fallback: []
2017-08-17 22:00:37 +05:30
delegate :tag_names, to: :raw_repository
2019-12-21 20:55:43 +05:30
cache_method_as_redis_set :tag_names, fallback: []
2017-08-17 22:00:37 +05:30
2018-03-17 18:26:18 +05:30
delegate :branch_count, :tag_count, :has_visible_content?, to: :raw_repository
2017-08-17 22:00:37 +05:30
cache_method :branch_count, fallback: 0
cache_method :tag_count, fallback: 0
2019-12-21 20:55:43 +05:30
cache_method_asymmetrically :has_visible_content?
2017-08-17 22:00:37 +05:30
def avatar
2019-12-04 20:38:33 +05:30
# n+1: https://gitlab.com/gitlab-org/gitlab-foss/issues/38327
2018-03-17 18:26:18 +05:30
Gitlab::GitalyClient.allow_n_plus_1_calls do
if tree = file_on_head(:avatar)
tree.path
end
2015-04-26 12:48:37 +05:30
end
end
2017-08-17 22:00:37 +05:30
cache_method :avatar
2015-04-26 12:48:37 +05:30
2018-03-17 18:26:18 +05:30
def issue_template_names
Gitlab::Template::IssueTemplate.dropdown_names(project)
end
cache_method :issue_template_names, fallback: []
def merge_request_template_names
Gitlab::Template::MergeRequestTemplate.dropdown_names(project)
end
cache_method :merge_request_template_names, fallback: []
2019-07-31 22:56:46 +05:30
def metrics_dashboard_paths
Gitlab::Metrics::Dashboard::Finder.find_all_paths_from_source(project)
end
cache_method :metrics_dashboard_paths
2017-08-17 22:00:37 +05:30
def readme
2018-12-13 13:39:08 +05:30
head_tree&.readme
2015-04-26 12:48:37 +05:30
end
2019-02-15 15:39:39 +05:30
def readme_path
readme&.path
end
cache_method :readme_path
2017-08-17 22:00:37 +05:30
def rendered_readme
2018-11-20 20:47:30 +05:30
return unless readme
context = { project: project }
MarkupHelper.markup_unsafe(readme.name, readme.data, context)
2017-08-17 22:00:37 +05:30
end
cache_method :rendered_readme
2015-12-23 02:04:40 +05:30
2017-08-17 22:00:37 +05:30
def contribution_guide
file_on_head(:contributing)
end
cache_method :contribution_guide
def changelog
file_on_head(:changelog)
end
cache_method :changelog
def license_blob
file_on_head(:license)
2016-06-02 11:05:42 +05:30
end
2017-08-17 22:00:37 +05:30
cache_method :license_blob
2015-12-23 02:04:40 +05:30
2016-06-02 11:05:42 +05:30
def license_key
2017-08-17 22:00:37 +05:30
return unless exists?
2015-12-23 02:04:40 +05:30
2018-03-27 19:54:05 +05:30
raw_repository.license_short_name
2014-09-02 18:07:02 +05:30
end
2017-08-17 22:00:37 +05:30
cache_method :license_key
2014-09-02 18:07:02 +05:30
2017-09-10 17:25:29 +05:30
def license
return unless license_key
Licensee::License.new(license_key)
end
2018-12-05 23:21:45 +05:30
memoize_method :license
2017-09-10 17:25:29 +05:30
2016-06-02 11:05:42 +05:30
def gitignore
2017-08-17 22:00:37 +05:30
file_on_head(:gitignore)
2016-06-02 11:05:42 +05:30
end
2017-08-17 22:00:37 +05:30
cache_method :gitignore
2016-06-02 11:05:42 +05:30
def gitlab_ci_yml
2017-08-17 22:00:37 +05:30
file_on_head(:gitlab_ci)
2016-06-02 11:05:42 +05:30
end
2017-08-17 22:00:37 +05:30
cache_method :gitlab_ci_yml
2016-06-02 11:05:42 +05:30
2018-11-08 19:23:39 +05:30
def xcode_project?
file_on_head(:xcode_config, :tree).present?
end
cache_method :xcode_project?
2014-09-02 18:07:02 +05:30
def head_commit
2015-04-26 12:48:37 +05:30
@head_commit ||= commit(self.root_ref)
end
def head_tree
2017-08-17 22:00:37 +05:30
if head_commit
@head_tree ||= Tree.new(self, head_commit.sha, nil)
end
2014-09-02 18:07:02 +05:30
end
2017-08-17 22:00:37 +05:30
def tree(sha = :head, path = nil, recursive: false)
2014-09-02 18:07:02 +05:30
if sha == :head
2017-08-17 22:00:37 +05:30
return unless head_commit
2015-04-26 12:48:37 +05:30
if path.nil?
return head_tree
else
sha = head_commit.sha
end
2014-09-02 18:07:02 +05:30
end
2017-08-17 22:00:37 +05:30
Tree.new(self, sha, path, recursive: recursive)
2014-09-02 18:07:02 +05:30
end
def blob_at_branch(branch_name, path)
last_commit = commit(branch_name)
if last_commit
blob_at(last_commit.sha, path)
else
nil
end
end
2018-12-05 23:21:45 +05:30
def list_last_commits_for_tree(sha, path, offset: 0, limit: 25)
commits = raw_repository.list_last_commits_for_tree(sha, path, offset: offset, limit: limit)
commits.each do |path, commit|
commits[path] = ::Commit.new(commit, @project)
end
end
2017-09-10 17:25:29 +05:30
def last_commit_for_path(sha, path)
2018-03-27 19:54:05 +05:30
commit = raw_repository.last_commit_for_path(sha, path)
::Commit.new(commit, @project) if commit
2014-09-02 18:07:02 +05:30
end
2017-08-17 22:00:37 +05:30
def last_commit_id_for_path(sha, path)
key = path.blank? ? "last_commit_id_for_path:#{sha}" : "last_commit_id_for_path:#{sha}:#{Digest::SHA1.hexdigest(path)}"
cache.fetch(key) do
2018-03-27 19:54:05 +05:30
last_commit_for_path(sha, path)&.id
2017-08-17 22:00:37 +05:30
end
end
2016-09-13 17:45:13 +05:30
def next_branch(name, opts = {})
2016-06-02 11:05:42 +05:30
branch_ids = self.branch_names.map do |n|
next 1 if n == name
2018-03-17 18:26:18 +05:30
2016-06-02 11:05:42 +05:30
result = n.match(/\A#{name}-([0-9]+)\z/)
2015-12-23 02:04:40 +05:30
result[1].to_i if result
end.compact
2016-06-02 11:05:42 +05:30
highest_branch_id = branch_ids.max || 0
2015-12-23 02:04:40 +05:30
2016-06-02 11:05:42 +05:30
return name if opts[:mild] && 0 == highest_branch_id
"#{name}-#{highest_branch_id + 1}"
2015-12-23 02:04:40 +05:30
end
2014-09-02 18:07:02 +05:30
def branches_sorted_by(value)
2017-09-10 17:25:29 +05:30
raw_repository.local_branches(sort_by: value)
2014-09-02 18:07:02 +05:30
end
2016-06-22 15:30:34 +05:30
def tags_sorted_by(value)
case value
2018-03-17 18:26:18 +05:30
when 'name_asc'
VersionSorter.sort(tags) { |tag| tag.name }
when 'name_desc'
2016-09-13 17:45:13 +05:30
VersionSorter.rsort(tags) { |tag| tag.name }
2016-06-22 15:30:34 +05:30
when 'updated_desc'
tags_sorted_by_committed_date.reverse
when 'updated_asc'
tags_sorted_by_committed_date
else
tags
end
end
2018-03-17 18:26:18 +05:30
# Params:
#
# order_by: name|email|commits
# sort: asc|desc default: 'asc'
def contributors(order_by: nil, sort: 'asc')
2016-06-02 11:05:42 +05:30
commits = self.commits(nil, limit: 2000, offset: 0, skip_merges: true)
2014-09-02 18:07:02 +05:30
2018-03-17 18:26:18 +05:30
commits = commits.group_by(&:author_email).map do |email, commits|
2014-09-02 18:07:02 +05:30
contributor = Gitlab::Contributor.new
contributor.email = email
2015-04-26 12:48:37 +05:30
commits.each do |commit|
2014-09-02 18:07:02 +05:30
if contributor.name.blank?
2015-04-26 12:48:37 +05:30
contributor.name = commit.author_name
2014-09-02 18:07:02 +05:30
end
contributor.commits += 1
end
contributor
end
2018-03-17 18:26:18 +05:30
Commit.order_by(collection: commits, order_by: order_by, sort: sort)
2015-04-26 12:48:37 +05:30
end
2015-11-26 14:37:03 +05:30
def branch_names_contains(sha)
2018-03-17 18:26:18 +05:30
raw_repository.branch_names_contains_sha(sha)
2015-11-26 14:37:03 +05:30
end
2015-04-26 12:48:37 +05:30
2015-11-26 14:37:03 +05:30
def tag_names_contains(sha)
2018-03-17 18:26:18 +05:30
raw_repository.tag_names_contains_sha(sha)
2015-04-26 12:48:37 +05:30
end
2016-06-02 11:05:42 +05:30
def local_branches
2016-09-13 17:45:13 +05:30
@local_branches ||= raw_repository.local_branches
2015-04-26 12:48:37 +05:30
end
2016-06-02 11:05:42 +05:30
alias_method :branches, :local_branches
2015-04-26 12:48:37 +05:30
def tags
@tags ||= raw_repository.tags
end
2017-08-17 22:00:37 +05:30
def create_dir(user, path, **options)
options[:actions] = [{ action: :create_dir, file_path: path }]
2015-04-26 12:48:37 +05:30
2018-03-17 18:26:18 +05:30
multi_action(user, **options)
2017-08-17 22:00:37 +05:30
end
2015-09-25 12:07:36 +05:30
2017-08-17 22:00:37 +05:30
def create_file(user, path, content, **options)
options[:actions] = [{ action: :create, file_path: path, content: content }]
2016-09-29 09:46:39 +05:30
2018-03-17 18:26:18 +05:30
multi_action(user, **options)
2015-10-24 18:46:33 +05:30
end
2017-08-17 22:00:37 +05:30
def update_file(user, path, content, **options)
previous_path = options.delete(:previous_path)
action = previous_path && previous_path != path ? :move : :update
2015-09-25 12:07:36 +05:30
2017-08-17 22:00:37 +05:30
options[:actions] = [{ action: action, file_path: path, previous_path: previous_path, content: content }]
2015-09-25 12:07:36 +05:30
2018-03-17 18:26:18 +05:30
multi_action(user, **options)
2015-09-25 12:07:36 +05:30
end
2017-08-17 22:00:37 +05:30
def delete_file(user, path, **options)
options[:actions] = [{ action: :delete, file_path: path }]
2016-08-24 12:49:21 +05:30
2018-03-17 18:26:18 +05:30
multi_action(user, **options)
2016-08-24 12:49:21 +05:30
end
2018-03-17 18:26:18 +05:30
def with_cache_hooks
result = yield
2016-11-03 12:29:30 +05:30
2018-03-17 18:26:18 +05:30
return unless result
2016-11-03 12:29:30 +05:30
2018-03-17 18:26:18 +05:30
after_create if result.repo_created?
after_create_branch if result.branch_created?
2016-11-03 12:29:30 +05:30
2018-03-17 18:26:18 +05:30
result.newrev
2016-11-03 12:29:30 +05:30
end
2018-03-17 18:26:18 +05:30
def multi_action(user, **options)
start_project = options.delete(:start_project)
2016-09-29 09:46:39 +05:30
2018-03-17 18:26:18 +05:30
if start_project
options[:start_repository] = start_project.repository.raw_repository
end
2015-09-25 12:07:36 +05:30
2018-03-17 18:26:18 +05:30
with_cache_hooks { raw.multi_action(user, **options) }
2016-09-29 09:46:39 +05:30
end
2018-03-17 18:26:18 +05:30
def merge(user, source_sha, merge_request, message)
with_cache_hooks do
raw_repository.merge(user, source_sha, merge_request.target_branch, message) do |commit_id|
merge_request.update(in_progress_merge_commit_sha: commit_id)
nil # Return value does not matter.
end
2015-09-25 12:07:36 +05:30
end
end
2019-09-30 21:07:59 +05:30
def merge_to_ref(user, source_sha, merge_request, target_ref, message, first_parent_ref)
2019-07-07 11:18:12 +05:30
branch = merge_request.target_branch
2019-09-30 21:07:59 +05:30
raw.merge_to_ref(user, source_sha, branch, target_ref, message, first_parent_ref)
end
def delete_refs(*ref_names)
raw.delete_refs(*ref_names)
2019-07-07 11:18:12 +05:30
end
2018-03-17 18:26:18 +05:30
def ff_merge(user, source, target_branch, merge_request: nil)
their_commit_id = commit(source)&.id
raise 'Invalid merge source' if their_commit_id.nil?
2015-09-25 12:07:36 +05:30
2018-03-17 18:26:18 +05:30
merge_request&.update(in_progress_merge_commit_sha: their_commit_id)
2015-09-25 12:07:36 +05:30
2018-03-17 18:26:18 +05:30
with_cache_hooks { raw.ff_merge(user, their_commit_id, target_branch) }
2015-09-25 12:07:36 +05:30
end
2017-08-17 22:00:37 +05:30
def revert(
2018-03-17 18:26:18 +05:30
user, commit, branch_name, message,
2017-08-17 22:00:37 +05:30
start_branch_name: nil, start_project: project)
2016-04-02 18:10:28 +05:30
2018-03-17 18:26:18 +05:30
with_cache_hooks do
raw_repository.revert(
user: user,
commit: commit.raw,
branch_name: branch_name,
message: message,
start_branch_name: start_branch_name,
start_repository: start_project.repository.raw_repository
)
2016-04-02 18:10:28 +05:30
end
end
2017-08-17 22:00:37 +05:30
def cherry_pick(
2018-03-17 18:26:18 +05:30
user, commit, branch_name, message,
2017-08-17 22:00:37 +05:30
start_branch_name: nil, start_project: project)
2016-06-02 11:05:42 +05:30
2018-03-17 18:26:18 +05:30
with_cache_hooks do
raw_repository.cherry_pick(
user: user,
commit: commit.raw,
branch_name: branch_name,
message: message,
start_branch_name: start_branch_name,
start_repository: start_project.repository.raw_repository
)
2016-09-13 17:45:13 +05:30
end
end
2018-03-17 18:26:18 +05:30
def merged_to_root_ref?(branch_or_name)
branch = Gitlab::Git::Branch.find(self, branch_or_name)
2016-09-13 17:45:13 +05:30
2018-03-17 18:26:18 +05:30
if branch
same_head = branch.target == root_ref_sha
merged = ancestor?(branch.target, root_ref_sha)
!same_head && merged
else
nil
2016-06-02 11:05:42 +05:30
end
end
2018-03-17 18:26:18 +05:30
def root_ref_sha
@root_ref_sha ||= commit(root_ref).sha
2016-04-02 18:10:28 +05:30
end
2018-11-08 19:23:39 +05:30
delegate :merged_branch_names, to: :raw_repository
2015-09-11 14:41:01 +05:30
2018-12-13 13:39:08 +05:30
def merge_base(*commits_or_ids)
commit_ids = commits_or_ids.map do |commit_or_id|
commit_or_id.is_a?(::Commit) ? commit_or_id.id : commit_or_id
end
raw_repository.merge_base(*commit_ids)
2015-10-24 18:46:33 +05:30
end
2018-03-17 18:26:18 +05:30
def ancestor?(ancestor_id, descendant_id)
2017-08-17 22:00:37 +05:30
return false if ancestor_id.nil? || descendant_id.nil?
2017-09-10 17:25:29 +05:30
2020-01-01 13:55:28 +05:30
counter = Gitlab::Metrics.counter(
:repository_ancestor_calls_total,
'The number of times we call Repository#ancestor with valid arguments')
cache_hit = true
cache_key = "ancestor:#{ancestor_id}:#{descendant_id}"
result = request_store_cache.fetch(cache_key) do
cache.fetch(cache_key) do
cache_hit = false
raw_repository.ancestor?(ancestor_id, descendant_id)
end
end
counter.increment(cache_hit: cache_hit.to_s)
result
2016-11-03 12:29:30 +05:30
end
2018-03-27 19:54:05 +05:30
def fetch_as_mirror(url, forced: false, refmap: :all_refs, remote_name: nil, prune: true)
2018-03-17 18:26:18 +05:30
unless remote_name
remote_name = "tmp-#{SecureRandom.hex}"
tmp_remote_name = true
end
2016-09-29 09:46:39 +05:30
2018-03-17 18:26:18 +05:30
add_remote(remote_name, url, mirror_refmap: refmap)
2018-03-27 19:54:05 +05:30
fetch_remote(remote_name, forced: forced, prune: prune)
2017-08-17 22:00:37 +05:30
ensure
2018-10-15 14:42:47 +05:30
async_remove_remote(remote_name) if tmp_remote_name
2017-08-17 22:00:37 +05:30
end
2016-09-13 17:45:13 +05:30
2019-09-30 21:07:59 +05:30
# rubocop:disable Gitlab/RailsLogger
2018-10-15 14:42:47 +05:30
def async_remove_remote(remote_name)
return unless remote_name
job_id = RepositoryRemoveRemoteWorker.perform_async(project.id, remote_name)
if job_id
Rails.logger.info("Remove remote job scheduled for #{project.id} with remote name: #{remote_name} job ID #{job_id}.")
else
Rails.logger.info("Remove remote job failed to create for #{project.id} with remote name #{remote_name}.")
end
job_id
end
2019-09-30 21:07:59 +05:30
# rubocop:enable Gitlab/RailsLogger
2018-10-15 14:42:47 +05:30
2018-03-17 18:26:18 +05:30
def fetch_source_branch!(source_repository, source_branch, local_ref)
raw_repository.fetch_source_branch!(source_repository.raw_repository, source_branch, local_ref)
2017-08-17 22:00:37 +05:30
end
2018-03-17 18:26:18 +05:30
def compare_source_branch(target_branch_name, source_repository, source_branch_name, straight:)
raw_repository.compare_source_branch(target_branch_name, source_repository.raw_repository, source_branch_name, straight: straight)
2017-08-17 22:00:37 +05:30
end
2016-09-13 17:45:13 +05:30
2017-08-17 22:00:37 +05:30
def create_ref(ref, ref_path)
2018-03-17 18:26:18 +05:30
raw_repository.write_ref(ref_path, ref)
end
def ls_files(ref)
actual_ref = ref || root_ref
raw_repository.ls_files(actual_ref)
2015-09-25 12:07:36 +05:30
end
2018-03-17 18:26:18 +05:30
def search_files_by_content(query, ref)
return [] if empty? || query.blank?
raw_repository.search_files_by_content(query, ref)
end
def search_files_by_name(query, ref)
return [] if empty?
raw_repository.search_files_by_name(query, ref)
2016-08-24 12:49:21 +05:30
end
2016-06-02 11:05:42 +05:30
def copy_gitattributes(ref)
actual_ref = ref || root_ref
begin
raw_repository.copy_gitattributes(actual_ref)
true
rescue Gitlab::Git::Repository::InvalidRef
false
end
end
2018-11-08 19:23:39 +05:30
def file_on_head(type, object_type = :blob)
return unless head = tree(:head)
objects =
case object_type
when :blob
head.blobs
when :tree
head.trees
else
raise ArgumentError, "Object type #{object_type} is not supported"
2017-08-17 22:00:37 +05:30
end
2018-11-08 19:23:39 +05:30
objects.find do |object|
Gitlab::FileDetector.type_of(object.path) == type
2017-08-17 22:00:37 +05:30
end
end
def route_map_for(sha)
blob_data_at(sha, '.gitlab/route-map.yml')
end
2017-09-10 17:25:29 +05:30
def gitlab_ci_yml_for(sha, path = '.gitlab-ci.yml')
blob_data_at(sha, path)
2017-08-17 22:00:37 +05:30
end
2018-11-08 19:23:39 +05:30
def lfsconfig_for(sha)
blob_data_at(sha, '.lfsconfig')
end
2018-03-17 18:26:18 +05:30
def fetch_ref(source_repository, source_ref:, target_ref:)
raw_repository.fetch_ref(source_repository.raw_repository, source_ref: source_ref, target_ref: target_ref)
end
2019-07-31 22:56:46 +05:30
# DEPRECATED: https://gitlab.com/gitlab-org/gitaly/issues/1628
def rebase_deprecated(user, merge_request)
rebase_sha = raw.rebase_deprecated(
user,
merge_request.id,
branch: merge_request.source_branch,
branch_sha: merge_request.source_branch_sha,
remote_repository: merge_request.target_project.repository.raw,
remote_branch: merge_request.target_branch
)
# To support the full deprecated behaviour, set the
# `rebase_commit_sha` for the merge_request here and return the value
2019-09-04 21:01:54 +05:30
merge_request.update(rebase_commit_sha: rebase_sha, merge_error: nil)
2019-07-31 22:56:46 +05:30
rebase_sha
end
2018-03-17 18:26:18 +05:30
def rebase(user, merge_request)
2019-07-31 22:56:46 +05:30
if Feature.disabled?(:two_step_rebase, default_enabled: true)
return rebase_deprecated(user, merge_request)
end
2020-01-01 13:55:28 +05:30
raw.rebase(
user,
merge_request.id,
branch: merge_request.source_branch,
branch_sha: merge_request.source_branch_sha,
remote_repository: merge_request.target_project.repository.raw,
remote_branch: merge_request.target_branch
) do |commit_id|
merge_request.update!(rebase_commit_sha: commit_id, merge_error: nil)
2019-07-31 22:56:46 +05:30
end
2020-01-01 13:55:28 +05:30
rescue StandardError => error
merge_request.update!(rebase_commit_sha: nil)
raise error
2018-03-17 18:26:18 +05:30
end
2019-03-02 22:35:43 +05:30
def squash(user, merge_request, message)
2018-11-08 19:23:39 +05:30
raw.squash(user, merge_request.id, branch: merge_request.target_branch,
start_sha: merge_request.diff_start_sha,
end_sha: merge_request.diff_head_sha,
author: merge_request.author,
2019-03-02 22:35:43 +05:30
message: message)
2018-11-08 19:23:39 +05:30
end
2018-12-13 13:39:08 +05:30
def update_submodule(user, submodule, commit_sha, message:, branch:)
with_cache_hooks do
raw.update_submodule(
user: user,
submodule: submodule,
commit_sha: commit_sha,
branch: branch,
message: message
)
end
end
2018-12-05 23:21:45 +05:30
def blob_data_at(sha, path)
blob = blob_at(sha, path)
return unless blob
blob.load_all_data!
blob.data
end
2019-07-31 22:56:46 +05:30
def create_if_not_exists
return if exists?
raw.create_repository
after_create
2019-12-21 20:55:43 +05:30
true
2019-07-31 22:56:46 +05:30
end
def blobs_metadata(paths, ref = 'HEAD')
references = Array.wrap(paths).map { |path| [ref, path] }
Gitlab::Git::Blob.batch_metadata(raw, references).map { |raw_blob| Blob.decorate(raw_blob) }
end
2015-04-26 12:48:37 +05:30
private
2018-03-17 18:26:18 +05:30
# TODO Generice finder, later split this on finders by Ref or Oid
2019-12-04 20:38:33 +05:30
# https://gitlab.com/gitlab-org/gitlab-foss/issues/39239
2018-03-17 18:26:18 +05:30
def find_commit(oid_or_ref)
commit = if oid_or_ref.is_a?(Gitlab::Git::Commit)
oid_or_ref
else
Gitlab::Git::Commit.find(raw_repository, oid_or_ref)
end
::Commit.new(commit, @project) if commit
2017-09-10 17:25:29 +05:30
end
2017-08-17 22:00:37 +05:30
def cache
2018-03-27 19:54:05 +05:30
@cache ||= Gitlab::RepositoryCache.new(self)
2016-06-02 11:05:42 +05:30
end
2016-06-22 15:30:34 +05:30
2019-12-04 20:38:33 +05:30
def redis_set_cache
@redis_set_cache ||= Gitlab::RepositorySetCache.new(self)
end
2018-12-05 23:21:45 +05:30
def request_store_cache
@request_store_cache ||= Gitlab::RepositoryCache.new(self, backend: Gitlab::SafeRequestStore)
end
2016-06-22 15:30:34 +05:30
def tags_sorted_by_committed_date
2017-08-17 22:00:37 +05:30
tags.sort_by do |tag|
# Annotated tags can point to any object (e.g. a blob), but generally
# tags point to a commit. If we don't have a commit, then just default
# to putting the tag at the end of the list.
target = tag.dereferenced_target
if target
target.committed_date
else
Time.now
end
end
2016-06-22 15:30:34 +05:30
end
2016-08-24 12:49:21 +05:30
2016-09-13 17:45:13 +05:30
def repository_event(event, tags = {})
2018-10-15 14:42:47 +05:30
Gitlab::Metrics.add_event(event, tags)
2016-09-13 17:45:13 +05:30
end
2017-08-17 22:00:37 +05:30
def initialize_raw_repository
2019-03-02 22:35:43 +05:30
Gitlab::Git::Repository.new(project.repository_storage,
disk_path + '.git',
2019-07-07 11:18:12 +05:30
repo_type.identifier_for_subject(project),
2019-03-02 22:35:43 +05:30
project.full_path)
2017-08-17 22:00:37 +05:30
end
2014-09-02 18:07:02 +05:30
end
2019-12-04 20:38:33 +05:30
Repository.prepend_if_ee('EE::Repository')