repository.rb 28.3 KB
Newer Older
1 2
# frozen_string_literal: true

3 4
require 'securerandom'

5
class Repository
L
Lin Jen-Shin 已提交
6 7 8
  REF_MERGE_REQUEST = 'merge-requests'.freeze
  REF_KEEP_AROUND = 'keep-around'.freeze
  REF_ENVIRONMENTS = 'environments'.freeze
9
  MAX_DIVERGING_COUNT = 1000
10 11 12 13

  RESERVED_REFS_NAMES = %W[
    heads
    tags
14
    replace
15 16 17 18 19
    #{REF_ENVIRONMENTS}
    #{REF_KEEP_AROUND}
    #{REF_ENVIRONMENTS}
  ].freeze

20
  include Gitlab::RepositoryCacheAdapter
21

22
  attr_accessor :full_path, :disk_path, :project, :is_wiki
23

24
  delegate :ref_name_for_sha, to: :raw_repository
25
  delegate :bundle_to_disk, to: :raw_repository
26

27
  CreateTreeError = Class.new(StandardError)
M
Matija Čupić 已提交
28
  AmbiguousRefError = Class.new(StandardError)
29

30 31 32 33 34 35
  # 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.
  #
36 37
  # For example, for entry `:commit_count` there's a method called `commit_count` which
  # stores its data in the `commit_count` cache key.
38
  CACHED_METHODS = %i(size commit_count rendered_readme readme_path contribution_guide
39
                      changelog license_blob license_key gitignore
40
                      gitlab_ci_yml branch_names tag_names branch_count
41
                      tag_count avatar exists? root_ref has_visible_content?
42
                      issue_template_names merge_request_template_names xcode_project?).freeze
43 44

  # Methods that use cache_method but only memoize the value
45
  MEMOIZED_CACHED_METHODS = %i(license).freeze
46 47 48 49 50

  # 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 = {
51
    readme: %i(rendered_readme readme_path),
52
    changelog: :changelog,
53
    license: %i(license_blob license_key license),
54 55 56
    contributing: :contribution_guide,
    gitignore: :gitignore,
    gitlab_ci: :gitlab_ci_yml,
S
Sean McGivern 已提交
57 58
    avatar: :avatar,
    issue_template: :issue_template_names,
59 60
    merge_request_template: :merge_request_template_names,
    xcode_config: :xcode_project?
D
Douwe Maan 已提交
61
  }.freeze
62

63
  def initialize(full_path, project, disk_path: nil, is_wiki: false)
64
    @full_path = full_path
65
    @disk_path = disk_path || full_path
66
    @project = project
67
    @commit_cache = {}
68
    @is_wiki = is_wiki
69
  end
70

71
  def ==(other)
72 73 74 75 76 77 78
    other.is_a?(self.class) && @disk_path == other.disk_path
  end

  alias_method :eql?, :==

  def hash
    [self.class, @disk_path].hash
H
http://jneen.net/ 已提交
79 80
  end

81
  def raw_repository
82
    return nil unless full_path
83

84
    @raw_repository ||= initialize_raw_repository
85 86
  end

87 88
  alias_method :raw, :raw_repository

89
  # Don't use this! It's going away. Use Gitaly to read or write from repos.
90
  def path_to_repo
91 92 93 94 95 96 97 98
    @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
99 100
  end

101 102 103 104
  def inspect
    "#<#{self.class.name}:#{@disk_path}>"
  end

105
  def commit(ref = nil)
106
    return nil unless exists?
107
    return ref if ref.is_a?(::Commit)
108

109
    find_commit(ref || root_ref)
110
  end
111

112 113 114 115 116 117
  # 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)
118 119
  end

120 121 122 123 124 125 126 127 128 129 130 131
  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
  end

132
  def commits(ref = nil, path: nil, limit: nil, offset: nil, skip_merges: false, after: nil, before: nil, all: nil)
133
    options = {
134 135 136 137 138
      repo: raw_repository,
      ref: ref,
      path: path,
      limit: limit,
      offset: offset,
139 140
      after: after,
      before: before,
141
      follow: Array(path).length == 1,
142 143
      skip_merges: skip_merges,
      all: all
144 145 146
    }

    commits = Gitlab::Git::Commit.where(options)
147
    commits = Commit.decorate(commits, @project) if commits.present?
148 149

    CommitCollection.new(project, commits, ref)
150 151
  end

152 153
  def commits_between(from, to)
    commits = Gitlab::Git::Commit.between(raw_repository, from, to)
154
    commits = Commit.decorate(commits, @project) if commits.present?
155 156 157
    commits
  end

158 159
  # Returns a list of commits that are not present in any reference
  def new_commits(newrev)
160
    commits = raw.new_commits(newrev)
161

162
    ::Commit.decorate(commits, project)
163 164
  end

J
Jacob Vosmaer 已提交
165
  # Gitaly migration: https://gitlab.com/gitlab-org/gitaly/issues/384
166
  def find_commits_by_message(query, ref = nil, path = nil, limit = 1000, offset = 0)
167 168 169 170
    unless exists? && has_visible_content? && query.present?
      return []
    end

171 172
    commits = raw_repository.find_commits_by_message(query, ref, path, limit, offset).map do |c|
      commit(c)
173
    end
174
    CommitCollection.new(project, commits, ref)
175 176
  end

J
Jacob Vosmaer 已提交
177 178
  def find_branch(name)
    raw_repository.find_branch(name)
179 180 181
  end

  def find_tag(name)
182
    tags.find { |tag| tag.name == name }
183 184
  end

185 186 187
  def ambiguous_ref?(ref)
    tag_exists?(ref) && branch_exists?(ref)
  end
188

189
  def expand_ref(ref)
190
    if tag_exists?(ref)
191
      Gitlab::Git::TAG_REF_PREFIX + ref
192
    elsif branch_exists?(ref)
193 194 195 196
      Gitlab::Git::BRANCH_REF_PREFIX + ref
    end
  end

197
  def add_branch(user, branch_name, ref)
198
    branch = raw_repository.add_branch(branch_name, user: user, target: ref)
199

200
    after_create_branch
201 202 203 204

    branch
  rescue Gitlab::Git::Repository::InvalidRef
    false
205 206
  end

207
  def add_tag(user, tag_name, target, message = nil)
208
    raw_repository.add_tag(tag_name, user: user, target: target, message: message)
209 210
  rescue Gitlab::Git::Repository::InvalidRef
    false
211 212
  end

213
  def rm_branch(user, branch_name)
214
    before_remove_branch
215

216
    raw_repository.rm_branch(branch_name, user: user)
217

218
    after_remove_branch
219
    true
220 221
  end

L
Lin Jen-Shin 已提交
222
  def rm_tag(user, tag_name)
Y
Yorick Peterse 已提交
223
    before_remove_tag
224

225
    raw_repository.rm_tag(tag_name, user: user)
L
Lin Jen-Shin 已提交
226 227 228

    after_remove_tag
    true
229 230
  end

231 232 233 234
  def ref_names
    branch_names + tag_names
  end

235
  def branch_exists?(branch_name)
236 237
    return false unless raw_repository

238
    branch_names.include?(branch_name)
239 240
  end

241 242 243 244 245 246
  def tag_exists?(tag_name)
    return false unless raw_repository

    tag_names.include?(tag_name)
  end

247
  def ref_exists?(ref)
248 249
    !!raw_repository&.ref_exists?(ref)
  rescue ArgumentError
250
    false
251 252
  end

253 254 255 256 257 258
  def languages
    return [] if empty?

    raw_repository.languages(root_ref)
  end

D
Douwe Maan 已提交
259 260 261 262
  # Makes sure a commit is kept around when Git garbage collection runs.
  # Git GC will delete commits from the repository that are no longer in any
  # branches or tags, but we want to keep some of these commits around, for
  # example if they have comments or CI builds.
263 264 265 266 267 268 269
  #
  # For Geo's sake, pass in multiple shas rather than calling it multiple times,
  # to avoid unnecessary syncing.
  def keep_around(*shas)
    shas.each do |sha|
      begin
        next unless sha.present? && commit_by(oid: sha)
270

271
        next if kept_around?(sha)
272

273
        # This will still fail if the file is corrupted (e.g. 0 bytes)
274
        raw_repository.write_ref(keep_around_ref_name(sha), sha)
275 276 277 278
      rescue Gitlab::Git::CommandError => ex
        Rails.logger.error "Unable to create keep-around reference for repository #{disk_path}: #{ex}"
      end
    end
279 280 281
  end

  def kept_around?(sha)
282
    ref_exists?(keep_around_ref_name(sha))
283
  end
284

285
  def diverging_commit_counts(branch)
286
    @root_ref_hash ||= raw_repository.commit(root_ref).id
J
Jeff Stubler 已提交
287
    cache.fetch(:"diverging_commit_counts_#{branch.name}") do
288 289
      # Rugged seems to throw a `ReferenceError` when given branch_names rather
      # than SHA-1 hashes
290 291
      number_commits_behind, number_commits_ahead =
        raw_repository.count_commits_between(
292
          @root_ref_hash,
293 294 295
          branch.dereferenced_target.sha,
          left_right: true,
          max_count: MAX_DIVERGING_COUNT)
296

297 298 299
      { behind: number_commits_behind, ahead: number_commits_ahead }
    end
  end
300

301 302 303 304 305 306 307 308 309 310
  def archive_metadata(ref, storage_path, format = "tar.gz", append_sha:)
    raw_repository.archive_metadata(
      ref,
      storage_path,
      project.path,
      format,
      append_sha: append_sha
    )
  end

311 312 313 314
  def cached_methods
    CACHED_METHODS
  end

315 316 317
  def expire_tags_cache
    expire_method_caches(%i(tag_names tag_count))
    @tags = nil
318
  end
319

320
  def expire_branches_cache
321
    expire_method_caches(%i(branch_names branch_count has_visible_content?))
322
    @local_branches = nil
323
    @branch_exists_memo = nil
324 325
  end

326 327
  def expire_statistics_caches
    expire_method_caches(%i(size commit_count))
328 329
  end

330 331
  def expire_all_method_caches
    expire_method_caches(CACHED_METHODS)
D
Douwe Maan 已提交
332 333
  end

334 335 336 337 338 339 340 341 342
  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)
343 344
    return if types.empty?

345 346 347 348 349 350
    to_refresh = []

    types.each do |type|
      methods = METHOD_CACHES_FOR_FILE_TYPES[type.to_sym]

      to_refresh.concat(Array(methods)) if methods
351
    end
352

353
    expire_method_caches(to_refresh)
354

355
    to_refresh.each { |method| send(method) } # rubocop:disable GitlabSecurity/PublicSend
356
  end
357

358 359 360 361 362 363 364
  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}")
365
        cache.expire(:"commit_count_#{branch.name}")
366 367 368 369 370
      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}")
371
      cache.expire(:"commit_count_#{branch_name}")
372
    end
D
Dmitriy Zaporozhets 已提交
373 374
  end

375
  def expire_root_ref_cache
376
    expire_method_caches(%i(root_ref))
377 378
  end

379 380
  # Expires the cache(s) used to determine if a repository is empty or not.
  def expire_emptiness_caches
381
    return unless empty?
382

383
    expire_method_caches(%i(has_visible_content?))
384
    raw_repository.expire_has_local_branches_cache
Y
Yorick Peterse 已提交
385 386
  end

387 388 389 390
  def lookup_cache
    @lookup_cache ||= {}
  end

391
  def expire_exists_cache
392
    expire_method_caches(%i(exists?))
393 394
  end

395 396 397 398 399 400 401
  # 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
402
    expire_statistics_caches
403 404 405 406 407
  end

  # Runs code after a repository has been created.
  def after_create
    expire_exists_cache
408 409
    expire_root_ref_cache
    expire_emptiness_caches
Y
Yorick Peterse 已提交
410 411

    repository_event(:create_repository)
412 413
  end

414 415
  # Runs code just before a repository is deleted.
  def before_delete
416
    expire_exists_cache
417 418
    expire_all_method_caches
    expire_branch_cache if exists?
419
    expire_content_cache
Y
Yorick Peterse 已提交
420 421

    repository_event(:remove_repository)
422 423 424 425 426 427 428
  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
Y
Yorick Peterse 已提交
429 430

    repository_event(:change_default_branch)
431 432
  end

Y
Yorick Peterse 已提交
433 434
  # Runs code before pushing (= creating or removing) a tag.
  def before_push_tag
435 436
    expire_statistics_caches
    expire_emptiness_caches
437
    expire_tags_cache
Y
Yorick Peterse 已提交
438 439

    repository_event(:push_tag)
Y
Yorick Peterse 已提交
440 441 442 443 444
  end

  # Runs code before removing a tag.
  def before_remove_tag
    expire_tags_cache
445
    expire_statistics_caches
Y
Yorick Peterse 已提交
446 447

    repository_event(:remove_tag)
448 449
  end

L
Lin Jen-Shin 已提交
450 451 452 453 454
  # Runs code after removing a tag.
  def after_remove_tag
    expire_tags_cache
  end

455 456
  # Runs code after the HEAD of a repository is changed.
  def after_change_head
457
    expire_all_method_caches
458 459
  end

460 461
  # Runs code after a repository has been forked/imported.
  def after_import
462
    expire_content_cache
463 464

    DetectRepositoryLanguagesWorker.perform_async(project.id, project.owner.id)
465 466 467
  end

  # Runs code after a new commit has been pushed.
468 469 470
  def after_push_commit(branch_name)
    expire_statistics_caches
    expire_branch_cache(branch_name)
Y
Yorick Peterse 已提交
471 472

    repository_event(:push_commit, branch: branch_name)
473 474 475 476
  end

  # Runs code after a new branch has been created.
  def after_create_branch
477
    expire_branches_cache
Y
Yorick Peterse 已提交
478 479

    repository_event(:push_branch)
480 481
  end

482 483 484
  # Runs code before removing an existing branch.
  def before_remove_branch
    expire_branches_cache
Y
Yorick Peterse 已提交
485 486

    repository_event(:remove_branch)
487 488
  end

489 490
  # Runs code after an existing branch has been removed.
  def after_remove_branch
491
    expire_branches_cache
492 493
  end

494 495 496 497
  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
498
    else
499
      raw_repository.__send__(msg, *args, &block) # rubocop:disable GitlabSecurity/PublicSend
500
    end
501 502
  end

503 504
  def respond_to_missing?(method, include_private = false)
    raw_repository.respond_to?(method, include_private) || super
505
  end
D
Dmitriy Zaporozhets 已提交
506 507

  def blob_at(sha, path)
508 509 510 511 512 513 514 515 516 517 518 519 520 521
    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
D
Douwe Maan 已提交
522 523
  rescue Gitlab::Git::Repository::NoRepository
    nil
D
Dmitriy Zaporozhets 已提交
524
  end
525

526 527 528 529 530
  # items is an Array like: [[oid, path], [oid1, path1]]
  def blobs_at(items)
    raw_repository.batch_blobs(items).map { |blob| Blob.decorate(blob, project) }
  end

531
  def root_ref
532 533
    # When the repo does not exist, or there is no root ref, we raise this error so no data is cached.
    raw_repository&.root_ref or raise Gitlab::Git::Repository::NoRepository # rubocop:disable Style/AndOr
534
  end
535
  cache_method :root_ref
536

537
  # Gitaly migration: https://gitlab.com/gitlab-org/gitaly/issues/314
538
  def exists?
539
    return false unless full_path
540

541
    raw_repository.exists?
542
  end
543
  cache_method_asymmetrically :exists?
544

545 546 547
  # 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.
548 549 550 551 552
  def empty?
    return true unless exists?

    !has_visible_content?
  end
553 554 555 556 557 558 559 560 561 562 563 564

  # 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

565
  def commit_count_for_ref(ref)
566
    return 0 unless exists?
567

568
    cache.fetch(:"commit_count_#{ref}") { raw_repository.commit_count(ref) }
569 570
  end

571
  delegate :branch_names, to: :raw_repository
572 573
  cache_method :branch_names, fallback: []

D
Douwe Maan 已提交
574
  delegate :tag_names, to: :raw_repository
575 576
  cache_method :tag_names, fallback: []

577
  delegate :branch_count, :tag_count, :has_visible_content?, to: :raw_repository
578 579
  cache_method :branch_count, fallback: 0
  cache_method :tag_count, fallback: 0
580
  cache_method :has_visible_content?, fallback: false
581 582

  def avatar
583 584 585 586 587
    # n+1: https://gitlab.com/gitlab-org/gitlab-ce/issues/38327
    Gitlab::GitalyClient.allow_n_plus_1_calls do
      if tree = file_on_head(:avatar)
        tree.path
      end
588 589
    end
  end
590
  cache_method :avatar
591

S
Sean McGivern 已提交
592 593 594 595 596 597 598 599 600 601
  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: []

602
  def readme
603
    head_tree&.readme
604 605
  end

606 607 608 609 610
  def readme_path
    readme&.path
  end
  cache_method :readme_path

611
  def rendered_readme
612 613 614 615 616 617
    return unless readme

    context = { project: project }
    context[:markdown_engine] = :redcarpet unless MarkupHelper.commonmark_for_repositories_enabled?

    MarkupHelper.markup_unsafe(readme.name, readme.data, context)
618 619
  end
  cache_method :rendered_readme
620

621
  def contribution_guide
622
    file_on_head(:contributing)
623
  end
624
  cache_method :contribution_guide
625 626

  def changelog
627
    file_on_head(:changelog)
628
  end
629
  cache_method :changelog
630

631
  def license_blob
632
    file_on_head(:license)
633
  end
634
  cache_method :license_blob
Z
Zeger-Jan van de Weg 已提交
635

636
  def license_key
637
    return unless exists?
638

639
    raw_repository.license_short_name
640
  end
641
  cache_method :license_key
642

D
Douwe Maan 已提交
643 644
  def license
    return unless license_key
645

646
    Licensee::License.new(license_key)
647
  end
648
  memoize_method :license
649 650

  def gitignore
651
    file_on_head(:gitignore)
652
  end
653
  cache_method :gitignore
654

655
  def gitlab_ci_yml
656
    file_on_head(:gitlab_ci)
657
  end
658
  cache_method :gitlab_ci_yml
659

660
  def xcode_project?
661
    file_on_head(:xcode_config, :tree).present?
662 663 664
  end
  cache_method :xcode_project?

665
  def head_commit
666 667 668 669
    @head_commit ||= commit(self.root_ref)
  end

  def head_tree
670 671 672
    if head_commit
      @head_tree ||= Tree.new(self, head_commit.sha, nil)
    end
673 674
  end

675
  def tree(sha = :head, path = nil, recursive: false)
676
    if sha == :head
677 678
      return unless head_commit

679 680 681 682 683
      if path.nil?
        return head_tree
      else
        sha = head_commit.sha
      end
684 685
    end

686
    Tree.new(self, sha, path, recursive: recursive)
687
  end
D
Dmitriy Zaporozhets 已提交
688 689

  def blob_at_branch(branch_name, path)
D
Dmitriy Zaporozhets 已提交
690
    last_commit = commit(branch_name)
D
Dmitriy Zaporozhets 已提交
691

D
Dmitriy Zaporozhets 已提交
692 693 694 695 696
    if last_commit
      blob_at(last_commit.sha, path)
    else
      nil
    end
D
Dmitriy Zaporozhets 已提交
697
  end
D
Dmitriy Zaporozhets 已提交
698

699 700 701 702 703 704 705 706
  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

707
  def last_commit_for_path(sha, path)
708 709
    commit = raw_repository.last_commit_for_path(sha, path)
    ::Commit.new(commit, @project) if commit
710
  end
711

H
Hiroyuki Sato 已提交
712 713
  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)}"
H
Hiroyuki Sato 已提交
714

H
Hiroyuki Sato 已提交
715
    cache.fetch(key) do
716
      last_commit_for_path(sha, path)&.id
H
Hiroyuki Sato 已提交
717 718 719
    end
  end

720
  def next_branch(name, opts = {})
P
P.S.V.R 已提交
721 722
    branch_ids = self.branch_names.map do |n|
      next 1 if n == name
723

P
P.S.V.R 已提交
724
      result = n.match(/\A#{name}-([0-9]+)\z/)
725 726 727
      result[1].to_i if result
    end.compact

P
P.S.V.R 已提交
728
    highest_branch_id = branch_ids.max || 0
729

P
P.S.V.R 已提交
730 731 732
    return name if opts[:mild] && 0 == highest_branch_id

    "#{name}-#{highest_branch_id + 1}"
733 734
  end

735
  def branches_sorted_by(value)
736
    raw_repository.local_branches(sort_by: value)
737
  end
738

739 740
  def tags_sorted_by(value)
    case value
H
haseeb 已提交
741 742 743
    when 'name_asc'
      VersionSorter.sort(tags) { |tag| tag.name }
    when 'name_desc'
744
      VersionSorter.rsort(tags) { |tag| tag.name }
745 746 747 748 749 750 751 752 753
    when 'updated_desc'
      tags_sorted_by_committed_date.reverse
    when 'updated_asc'
      tags_sorted_by_committed_date
    else
      tags
    end
  end

754 755 756 757 758
  # Params:
  #
  # order_by: name|email|commits
  # sort: asc|desc default: 'asc'
  def contributors(order_by: nil, sort: 'asc')
759
    commits = self.commits(nil, limit: 2000, offset: 0, skip_merges: true)
760

761
    commits = commits.group_by(&:author_email).map do |email, commits|
762 763
      contributor = Gitlab::Contributor.new
      contributor.email = email
764

D
Dmitriy Zaporozhets 已提交
765
      commits.each do |commit|
766
        if contributor.name.blank?
D
Dmitriy Zaporozhets 已提交
767
          contributor.name = commit.author_name
768 769
        end

770
        contributor.commits += 1
771 772
      end

773 774
      contributor
    end
775
    Commit.order_by(collection: commits, order_by: order_by, sort: sort)
776
  end
D
Dmitriy Zaporozhets 已提交
777

778
  def branch_names_contains(sha)
779
    raw_repository.branch_names_contains_sha(sha)
780
  end
H
Hannes Rosenögger 已提交
781

782
  def tag_names_contains(sha)
783
    raw_repository.tag_names_contains_sha(sha)
H
Hannes Rosenögger 已提交
784
  end
785

786
  def local_branches
787
    @local_branches ||= raw_repository.local_branches
788 789
  end

790 791
  alias_method :branches, :local_branches

792 793 794 795
  def tags
    @tags ||= raw_repository.tags
  end

D
Douwe Maan 已提交
796 797
  def create_dir(user, path, **options)
    options[:actions] = [{ action: :create_dir, file_path: path }]
798

799
    multi_action(user, **options)
S
Stan Hu 已提交
800 801
  end

D
Douwe Maan 已提交
802 803
  def create_file(user, path, content, **options)
    options[:actions] = [{ action: :create, file_path: path, content: content }]
804

805
    multi_action(user, **options)
S
Stan Hu 已提交
806
  end
807

D
Douwe Maan 已提交
808 809 810
  def update_file(user, path, content, **options)
    previous_path = options.delete(:previous_path)
    action = previous_path && previous_path != path ? :move : :update
811

D
Douwe Maan 已提交
812
    options[:actions] = [{ action: action, file_path: path, previous_path: previous_path, content: content }]
813

814
    multi_action(user, **options)
815 816
  end

D
Douwe Maan 已提交
817 818
  def delete_file(user, path, **options)
    options[:actions] = [{ action: :delete, file_path: path }]
819

820
    multi_action(user, **options)
821 822
  end

823 824
  def with_cache_hooks
    result = yield
825

826
    return unless result
827

828 829
    after_create if result.repo_created?
    after_create_branch if result.branch_created?
830

831 832 833
    result.newrev
  end

834 835
  def multi_action(user, **options)
    start_project = options.delete(:start_project)
M
Marc Siegfriedt 已提交
836

837 838
    if start_project
      options[:start_repository] = start_project.repository.raw_repository
M
Marc Siegfriedt 已提交
839 840
    end

841
    with_cache_hooks { raw.multi_action(user, **options) }
842 843
  end

844 845 846 847 848 849
  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
850
    end
851 852
  end

853
  def ff_merge(user, source, target_branch, merge_request: nil)
854 855
    their_commit_id = commit(source)&.id
    raise 'Invalid merge source' if their_commit_id.nil?
856

857
    merge_request&.update(in_progress_merge_commit_sha: their_commit_id)
858

859
    with_cache_hooks { raw.ff_merge(user, their_commit_id, target_branch) }
860 861
  end

862
  def revert(
863
    user, commit, branch_name, message,
864
    start_branch_name: nil, start_project: project)
865

866 867 868 869 870 871 872 873 874
    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
      )
875
    end
876 877
  end

878
  def cherry_pick(
879
    user, commit, branch_name, message,
880
    start_branch_name: nil, start_project: project)
P
P.S.V.R 已提交
881

882 883 884 885 886 887 888 889 890
    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
      )
P
P.S.V.R 已提交
891 892 893
    end
  end

894
  def merged_to_root_ref?(branch_or_name)
895 896 897
    branch = Gitlab::Git::Branch.find(self, branch_or_name)

    if branch
898 899
      same_head = branch.target == root_ref_sha
      merged = ancestor?(branch.target, root_ref_sha)
900
      !same_head && merged
F
Florent (HP) 已提交
901 902 903 904 905
    else
      nil
    end
  end

906 907 908 909
  def root_ref_sha
    @root_ref_sha ||= commit(root_ref).sha
  end

910
  delegate :merged_branch_names, to: :raw_repository
911

912 913 914 915 916 917
  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)
S
Stan Hu 已提交
918 919
  end

920
  def ancestor?(ancestor_id, descendant_id)
921
    return false if ancestor_id.nil? || descendant_id.nil?
922

923
    raw_repository.ancestor?(ancestor_id, descendant_id)
924 925
  end

926
  def fetch_as_mirror(url, forced: false, refmap: :all_refs, remote_name: nil, prune: true)
927 928 929 930 931
    unless remote_name
      remote_name = "tmp-#{SecureRandom.hex}"
      tmp_remote_name = true
    end

932
    add_remote(remote_name, url, mirror_refmap: refmap)
933
    fetch_remote(remote_name, forced: forced, prune: prune)
934
  ensure
935
    async_remove_remote(remote_name) if tmp_remote_name
936 937
  end

938 939 940 941 942 943 944 945 946 947 948 949 950 951
  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

952 953
  def fetch_source_branch!(source_repository, source_branch, local_ref)
    raw_repository.fetch_source_branch!(source_repository.raw_repository, source_branch, local_ref)
954
  end
955

956 957
  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)
958
  end
959

960
  def create_ref(ref, ref_path)
961
    raw_repository.write_ref(ref_path, ref)
962 963
  end

964 965 966 967 968
  def ls_files(ref)
    actual_ref = ref || root_ref
    raw_repository.ls_files(actual_ref)
  end

969 970 971 972 973 974 975 976 977 978 979 980
  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)
  end

981 982 983 984 985 986 987 988 989 990
  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

991 992 993 994 995 996 997 998 999 1000 1001
  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"
1002
      end
1003 1004 1005

    objects.find do |object|
      Gitlab::FileDetector.type_of(object.path) == type
1006 1007 1008
    end
  end

D
Douwe Maan 已提交
1009 1010 1011 1012
  def route_map_for(sha)
    blob_data_at(sha, '.gitlab/route-map.yml')
  end

1013 1014
  def gitlab_ci_yml_for(sha, path = '.gitlab-ci.yml')
    blob_data_at(sha, path)
D
Douwe Maan 已提交
1015 1016
  end

1017 1018 1019 1020
  def lfsconfig_for(sha)
    blob_data_at(sha, '.lfsconfig')
  end

1021 1022 1023 1024
  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

1025 1026 1027 1028 1029 1030 1031
  def rebase(user, merge_request)
    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)
  end

1032 1033 1034 1035 1036 1037 1038 1039
  def squash(user, merge_request)
    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,
                                       message: merge_request.title)
  end

1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051
  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

1052 1053 1054 1055 1056 1057 1058 1059
  def blob_data_at(sha, path)
    blob = blob_at(sha, path)
    return unless blob

    blob.load_all_data!
    blob.data
  end

1060 1061
  private

1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073
  # TODO Generice finder, later split this on finders by Ref or Oid
  # gitlab-org/gitlab-ce#39239
  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
  end

1074
  def cache
1075
    @cache ||= Gitlab::RepositoryCache.new(self)
1076
  end
1077

1078
  def request_store_cache
1079
    @request_store_cache ||= Gitlab::RepositoryCache.new(self, backend: Gitlab::SafeRequestStore)
1080 1081
  end

1082
  def tags_sorted_by_committed_date
1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094
    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
1095
  end
D
Douwe Maan 已提交
1096 1097

  def keep_around_ref_name(sha)
1098
    "refs/#{REF_KEEP_AROUND}/#{sha}"
D
Douwe Maan 已提交
1099
  end
Y
Yorick Peterse 已提交
1100 1101

  def repository_event(event, tags = {})
1102
    Gitlab::Metrics.add_event(event, tags)
Y
Yorick Peterse 已提交
1103
  end
1104

1105
  def initialize_raw_repository
1106
    Gitlab::Git::Repository.new(project.repository_storage, disk_path + '.git', Gitlab::GlRepository.gl_repository(project, is_wiki))
1107
  end
1108
end