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

3 4
require 'securerandom'

5
class Repository
6 7 8
  REF_MERGE_REQUEST = 'merge-requests'
  REF_KEEP_AROUND = 'keep-around'
  REF_ENVIRONMENTS = 'environments'
9

10 11 12
  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

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

22
  include Gitlab::RepositoryCacheAdapter
23

24
  attr_accessor :full_path, :disk_path, :project, :repo_type
25

26
  delegate :ref_name_for_sha, to: :raw_repository
27
  delegate :bundle_to_disk, to: :raw_repository
28

29
  CreateTreeError = Class.new(StandardError)
30
  AmbiguousRefError = Class.new(StandardError)
31

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

  # Methods that use cache_method but only memoize the value
48
  MEMOIZED_CACHED_METHODS = %i(license).freeze
49 50 51 52 53

  # 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 = {
54
    readme: %i(rendered_readme readme_path),
55
    changelog: :changelog,
56
    license: %i(license_blob license_key license),
57 58 59
    contributing: :contribution_guide,
    gitignore: :gitignore,
    gitlab_ci: :gitlab_ci_yml,
60 61
    avatar: :avatar,
    issue_template: :issue_template_names,
62
    merge_request_template: :merge_request_template_names,
63
    metrics_dashboard: :metrics_dashboard_paths,
Rémy Coutable's avatar
Rémy Coutable committed
64
    xcode_config: :xcode_project?
Douwe Maan's avatar
Douwe Maan committed
65
  }.freeze
66

67
  def initialize(full_path, project, disk_path: nil, repo_type: Gitlab::GlRepository::PROJECT)
68
    @full_path = full_path
69
    @disk_path = disk_path || full_path
70
    @project = project
71
    @commit_cache = {}
72
    @repo_type = repo_type
73
  end
74

75
  def ==(other)
76 77 78 79 80 81 82
    other.is_a?(self.class) && @disk_path == other.disk_path
  end

  alias_method :eql?, :==

  def hash
    [self.class, @disk_path].hash
83 84
  end

85
  def raw_repository
86
    return unless full_path
87

88
    @raw_repository ||= initialize_raw_repository
89 90
  end

91 92
  alias_method :raw, :raw_repository

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

105 106 107 108
  def inspect
    "#<#{self.class.name}:#{@disk_path}>"
  end

109
  def commit(ref = nil)
110
    return unless exists?
111
    return ref if ref.is_a?(::Commit)
112

113
    find_commit(ref || root_ref)
114
  end
115

116 117 118 119 120 121
  # 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)
122 123
  end

124 125 126 127 128 129 130 131 132 133 134 135
  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

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

    commits = Gitlab::Git::Commit.where(options)
151
    commits = Commit.decorate(commits, @project) if commits.present?
152 153

    CommitCollection.new(project, commits, ref)
154 155
  end

156 157
  def commits_between(from, to)
    commits = Gitlab::Git::Commit.between(raw_repository, from, to)
158
    commits = Commit.decorate(commits, @project) if commits.present?
159 160 161
    commits
  end

162 163
  # Returns a list of commits that are not present in any reference
  def new_commits(newrev)
164
    commits = raw.new_commits(newrev)
165

166
    ::Commit.decorate(commits, project)
167 168
  end

Jacob Vosmaer's avatar
Jacob Vosmaer committed
169
  # Gitaly migration: https://gitlab.com/gitlab-org/gitaly/issues/384
170
  def find_commits_by_message(query, ref = nil, path = nil, limit = 1000, offset = 0)
171 172 173 174
    unless exists? && has_visible_content? && query.present?
      return []
    end

175 176
    commits = raw_repository.find_commits_by_message(query, ref, path, limit, offset).map do |c|
      commit(c)
177
    end
178
    CommitCollection.new(project, commits, ref)
179 180
  end

Jacob Vosmaer's avatar
Jacob Vosmaer committed
181 182
  def find_branch(name)
    raw_repository.find_branch(name)
183 184 185
  end

  def find_tag(name)
186
    tags.find { |tag| tag.name == name }
187 188
  end

189 190 191
  def ambiguous_ref?(ref)
    tag_exists?(ref) && branch_exists?(ref)
  end
192

193
  def expand_ref(ref)
194
    if tag_exists?(ref)
195
      Gitlab::Git::TAG_REF_PREFIX + ref
196
    elsif branch_exists?(ref)
197 198 199 200
      Gitlab::Git::BRANCH_REF_PREFIX + ref
    end
  end

201
  def add_branch(user, branch_name, ref)
202
    branch = raw_repository.add_branch(branch_name, user: user, target: ref)
203

204
    after_create_branch
205 206 207 208

    branch
  rescue Gitlab::Git::Repository::InvalidRef
    false
209 210
  end

211
  def add_tag(user, tag_name, target, message = nil)
212
    raw_repository.add_tag(tag_name, user: user, target: target, message: message)
213 214
  rescue Gitlab::Git::Repository::InvalidRef
    false
215 216
  end

217
  def rm_branch(user, branch_name)
218
    before_remove_branch
219

220
    raw_repository.rm_branch(branch_name, user: user)
221

222
    after_remove_branch
223
    true
224 225
  end

Lin Jen-Shin's avatar
Lin Jen-Shin committed
226
  def rm_tag(user, tag_name)
227
    before_remove_tag
228

229
    raw_repository.rm_tag(tag_name, user: user)
Lin Jen-Shin's avatar
Lin Jen-Shin committed
230 231 232

    after_remove_tag
    true
233 234
  end

235 236 237 238
  def ref_names
    branch_names + tag_names
  end

239
  def branch_exists?(branch_name)
240 241
    return false unless raw_repository

242
    branch_names_include?(branch_name)
243 244
  end

245 246 247
  def tag_exists?(tag_name)
    return false unless raw_repository

248
    tag_names_include?(tag_name)
249 250
  end

251
  def ref_exists?(ref)
252 253
    !!raw_repository&.ref_exists?(ref)
  rescue ArgumentError
254
    false
255 256
  end

257 258 259 260 261 262
  def languages
    return [] if empty?

    raw_repository.languages(root_ref)
  end

263 264 265 266
  # 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.
267 268 269 270 271
  #
  # 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|
Nick Thomas's avatar
Nick Thomas committed
272
      next unless sha.present? && commit_by(oid: sha)
273

Nick Thomas's avatar
Nick Thomas committed
274
      next if kept_around?(sha)
275

Nick Thomas's avatar
Nick Thomas committed
276 277 278
      # This will still fail if the file is corrupted (e.g. 0 bytes)
      raw_repository.write_ref(keep_around_ref_name(sha), sha)
    rescue Gitlab::Git::CommandError => ex
279
      Rails.logger.error "Unable to create keep-around reference for repository #{disk_path}: #{ex}" # rubocop:disable Gitlab/RailsLogger
280
    end
281 282 283
  end

  def kept_around?(sha)
284
    ref_exists?(keep_around_ref_name(sha))
285
  end
286

287
  def archive_metadata(ref, storage_path, format = "tar.gz", append_sha:, path: nil)
288 289 290 291 292
    raw_repository.archive_metadata(
      ref,
      storage_path,
      project.path,
      format,
293 294
      append_sha: append_sha,
      path: path
295 296 297
    )
  end

298 299 300 301
  def cached_methods
    CACHED_METHODS
  end

302 303 304
  def expire_tags_cache
    expire_method_caches(%i(tag_names tag_count))
    @tags = nil
305
  end
306

307
  def expire_branches_cache
308
    expire_method_caches(%i(branch_names branch_count has_visible_content?))
309
    @local_branches = nil
310
    @branch_exists_memo = nil
311 312
  end

313 314
  def expire_statistics_caches
    expire_method_caches(%i(size commit_count))
315 316
  end

317 318
  def expire_all_method_caches
    expire_method_caches(CACHED_METHODS)
319 320
  end

321 322 323 324 325 326 327 328 329
  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)
330 331
    return if types.empty?

332 333 334 335 336 337
    to_refresh = []

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

      to_refresh.concat(Array(methods)) if methods
338
    end
339

340
    expire_method_caches(to_refresh)
341

342
    to_refresh.each { |method| send(method) } # rubocop:disable GitlabSecurity/PublicSend
343
  end
344

345 346 347 348 349 350 351
  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}")
352
        cache.expire(:"commit_count_#{branch.name}")
353 354 355 356 357
      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}")
358
      cache.expire(:"commit_count_#{branch_name}")
359
    end
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
360 361
  end

362
  def expire_root_ref_cache
363
    expire_method_caches(%i(root_ref))
364 365
  end

366 367
  # Expires the cache(s) used to determine if a repository is empty or not.
  def expire_emptiness_caches
368
    return unless empty?
369

370
    expire_method_caches(%i(has_visible_content?))
371
    raw_repository.expire_has_local_branches_cache
372 373
  end

374 375 376 377
  def lookup_cache
    @lookup_cache ||= {}
  end

378
  def expire_exists_cache
379
    expire_method_caches(%i(exists?))
380 381
  end

382 383 384 385 386 387 388
  # 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
389
    expire_statistics_caches
390 391
  end

392
  def expire_status_cache
393
    expire_exists_cache
394 395
    expire_root_ref_cache
    expire_emptiness_caches
396 397 398 399 400
  end

  # Runs code after a repository has been created.
  def after_create
    expire_status_cache
Yorick Peterse's avatar
Yorick Peterse committed
401 402

    repository_event(:create_repository)
403 404
  end

405 406
  # Runs code just before a repository is deleted.
  def before_delete
407
    expire_exists_cache
408 409
    expire_all_method_caches
    expire_branch_cache if exists?
410
    expire_content_cache
Yorick Peterse's avatar
Yorick Peterse committed
411 412

    repository_event(:remove_repository)
413 414 415 416 417 418 419
  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
Yorick Peterse's avatar
Yorick Peterse committed
420 421

    repository_event(:change_default_branch)
422 423
  end

424
  # Runs code before pushing (= creating or removing) a tag.
425 426 427
  #
  # Note that this doesn't expire the tags. You may need to call
  # expire_caches_for_tags or expire_tags_cache.
428
  def before_push_tag
429 430 431 432
    repository_event(:push_tag)
  end

  def expire_caches_for_tags
433 434
    expire_statistics_caches
    expire_emptiness_caches
435
    expire_tags_cache
436 437 438 439
  end

  # Runs code before removing a tag.
  def before_remove_tag
440
    expire_caches_for_tags
Yorick Peterse's avatar
Yorick Peterse committed
441 442

    repository_event(:remove_tag)
443 444
  end

Lin Jen-Shin's avatar
Lin Jen-Shin committed
445 446
  # Runs code after removing a tag.
  def after_remove_tag
447
    expire_caches_for_tags
Lin Jen-Shin's avatar
Lin Jen-Shin committed
448 449
  end

450 451
  # Runs code after the HEAD of a repository is changed.
  def after_change_head
452
    expire_all_method_caches
453 454
  end

455 456
  # Runs code after a repository has been forked/imported.
  def after_import
457
    expire_content_cache
458

459 460 461 462
    # 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
463
    DetectRepositoryLanguagesWorker.perform_async(project.id)
464 465 466
  end

  # Runs code after a new commit has been pushed.
467 468 469
  def after_push_commit(branch_name)
    expire_statistics_caches
    expire_branch_cache(branch_name)
Yorick Peterse's avatar
Yorick Peterse committed
470 471

    repository_event(:push_commit, branch: branch_name)
472 473 474
  end

  # Runs code after a new branch has been created.
475 476
  def after_create_branch(expire_cache: true)
    expire_branches_cache if expire_cache
Yorick Peterse's avatar
Yorick Peterse committed
477 478

    repository_event(:push_branch)
479 480
  end

481 482 483
  # Runs code before removing an existing branch.
  def before_remove_branch
    expire_branches_cache
Yorick Peterse's avatar
Yorick Peterse committed
484 485

    repository_event(:remove_branch)
486 487
  end

488
  # Runs code after an existing branch has been removed.
489 490
  def after_remove_branch(expire_cache: true)
    expire_branches_cache if expire_cache
491 492
  end

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

502 503
  def respond_to_missing?(method, include_private = false)
    raw_repository.respond_to?(method, include_private) || super
504
  end
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
505 506

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

525 526
  # items is an Array like: [[oid, path], [oid1, path1]]
  def blobs_at(items)
527 528
    return [] unless exists?

529 530 531
    raw_repository.batch_blobs(items).map { |blob| Blob.decorate(blob, project) }
  end

532
  def root_ref
533
    raw_repository&.root_ref
534
  end
535
  cache_method_asymmetrically :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
  cache_method_as_redis_set :branch_names, fallback: []
573

Douwe Maan's avatar
Douwe Maan committed
574
  delegate :tag_names, to: :raw_repository
575
  cache_method_as_redis_set :tag_names, fallback: []
576

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

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 603 604 605 606
  def metrics_dashboard_paths
    Gitlab::Metrics::Dashboard::Finder.find_all_paths_from_source(project)
  end
  cache_method :metrics_dashboard_paths

607
  def readme
608
    head_tree&.readme
609 610
  end

611 612 613 614 615
  def readme_path
    readme&.path
  end
  cache_method :readme_path

616
  def rendered_readme
617 618 619 620 621
    return unless readme

    context = { project: project }

    MarkupHelper.markup_unsafe(readme.name, readme.data, context)
622 623
  end
  cache_method :rendered_readme
624

625
  def contribution_guide
626
    file_on_head(:contributing)
627
  end
628
  cache_method :contribution_guide
629 630

  def changelog
631
    file_on_head(:changelog)
632
  end
633
  cache_method :changelog
634

635
  def license_blob
636
    file_on_head(:license)
637
  end
638
  cache_method :license_blob
639

640
  def license_key
641
    return unless exists?
642

643
    raw_repository.license_short_name
644
  end
645
  cache_method :license_key
646

647 648
  def license
    return unless license_key
649

650
    Licensee::License.new(license_key)
651
  end
652
  memoize_method :license
653 654

  def gitignore
655
    file_on_head(:gitignore)
656
  end
657
  cache_method :gitignore
658

659
  def gitlab_ci_yml
660
    file_on_head(:gitlab_ci)
661
  end
662
  cache_method :gitlab_ci_yml
663

664
  def xcode_project?
665
    file_on_head(:xcode_config, :tree).present?
666 667 668
  end
  cache_method :xcode_project?

669
  def head_commit
670 671 672 673
    @head_commit ||= commit(self.root_ref)
  end

  def head_tree
674 675 676
    if head_commit
      @head_tree ||= Tree.new(self, head_commit.sha, nil)
    end
677 678
  end

679
  def tree(sha = :head, path = nil, recursive: false)
680
    if sha == :head
681 682
      return unless head_commit

683 684 685 686 687
      if path.nil?
        return head_tree
      else
        sha = head_commit.sha
      end
688 689
    end

690
    Tree.new(self, sha, path, recursive: recursive)
691
  end
692 693

  def blob_at_branch(branch_name, path)
694
    last_commit = commit(branch_name)
695

696 697 698 699 700
    if last_commit
      blob_at(last_commit.sha, path)
    else
      nil
    end
701
  end
702

703 704 705 706 707 708 709 710
  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

711
  def last_commit_for_path(sha, path)
712 713
    commit = raw_repository.last_commit_for_path(sha, path)
    ::Commit.new(commit, @project) if commit
714
  end
715

Hiroyuki Sato's avatar
Hiroyuki Sato committed
716 717
  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)}"
Hiroyuki Sato's avatar
Hiroyuki Sato committed
718

719
    cache.fetch(key) do
720
      last_commit_for_path(sha, path)&.id
721 722 723
    end
  end

724
  def next_branch(name, opts = {})
725 726
    branch_ids = self.branch_names.map do |n|
      next 1 if n == name
727

728
      result = n.match(/\A#{name}-([0-9]+)\z/)
729 730 731
      result[1].to_i if result
    end.compact

732
    highest_branch_id = branch_ids.max || 0
733

734 735 736
    return name if opts[:mild] && 0 == highest_branch_id

    "#{name}-#{highest_branch_id + 1}"
737 738
  end

739
  def branches_sorted_by(value)
740
    raw_repository.local_branches(sort_by: value)
741
  end
742

743 744
  def tags_sorted_by(value)
    case value
haseeb's avatar
haseeb committed
745 746 747
    when 'name_asc'
      VersionSorter.sort(tags) { |tag| tag.name }
    when 'name_desc'
748
      VersionSorter.rsort(tags) { |tag| tag.name }
749 750 751 752 753 754 755 756 757
    when 'updated_desc'
      tags_sorted_by_committed_date.reverse
    when 'updated_asc'
      tags_sorted_by_committed_date
    else
      tags
    end
  end

758 759 760 761 762
  # Params:
  #
  # order_by: name|email|commits
  # sort: asc|desc default: 'asc'
  def contributors(order_by: nil, sort: 'asc')
763
    commits = self.commits(nil, limit: 2000, offset: 0, skip_merges: true)
764

765
    commits = commits.group_by(&:author_email).map do |email, commits|
766 767
      contributor = Gitlab::Contributor.new
      contributor.email = email
768

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
769
      commits.each do |commit|
770
        if contributor.name.blank?
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
771
          contributor.name = commit.author_name
772 773
        end

774
        contributor.commits += 1
775 776
      end

777 778
      contributor
    end
779
    Commit.order_by(collection: commits, order_by: order_by, sort: sort)
780
  end
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
781

782
  def branch_names_contains(sha)
783
    raw_repository.branch_names_contains_sha(sha)
784
  end
785

786
  def tag_names_contains(sha)
787
    raw_repository.tag_names_contains_sha(sha)
788
  end
789

790
  def local_branches
791
    @local_branches ||= raw_repository.local_branches
792 793
  end

794 795
  alias_method :branches, :local_branches

796 797 798 799
  def tags
    @tags ||= raw_repository.tags
  end

Douwe Maan's avatar
Douwe Maan committed
800 801
  def create_dir(user, path, **options)
    options[:actions] = [{ action: :create_dir, file_path: path }]
802

803
    multi_action(user, **options)
Stan Hu's avatar
Stan Hu committed
804 805
  end

Douwe Maan's avatar
Douwe Maan committed
806 807
  def create_file(user, path, content, **options)
    options[:actions] = [{ action: :create, file_path: path, content: content }]
808

809
    multi_action(user, **options)
Stan Hu's avatar
Stan Hu committed
810
  end
811

Douwe Maan's avatar
Douwe Maan committed
812 813 814
  def update_file(user, path, content, **options)
    previous_path = options.delete(:previous_path)
    action = previous_path && previous_path != path ? :move : :update
815

Douwe Maan's avatar
Douwe Maan committed
816
    options[:actions] = [{ action: action, file_path: path, previous_path: previous_path, content: content }]
817

818
    multi_action(user, **options)
819 820
  end

Douwe Maan's avatar
Douwe Maan committed
821 822
  def delete_file(user, path, **options)
    options[:actions] = [{ action: :delete, file_path: path }]
823

824
    multi_action(user, **options)
825 826
  end

827 828
  def with_cache_hooks
    result = yield
829

830
    return unless result
831

832 833
    after_create if result.repo_created?
    after_create_branch if result.branch_created?
834

835 836 837
    result.newrev
  end

838 839
  def multi_action(user, **options)
    start_project = options.delete(:start_project)
Marc Siegfriedt's avatar
Marc Siegfriedt committed
840

841 842
    if start_project
      options[:start_repository] = start_project.repository.raw_repository
Marc Siegfriedt's avatar
Marc Siegfriedt committed
843 844
    end

845
    with_cache_hooks { raw.multi_action(user, **options) }
846 847
  end

848 849 850 851 852 853
  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
854
    end
855 856
  end

857
  def merge_to_ref(user, source_sha, merge_request, target_ref, message, first_parent_ref)
858 859
    branch = merge_request.target_branch

860
    raw.merge_to_ref(user, source_sha, branch, target_ref, message, first_parent_ref)
861 862
  end

863 864 865 866
  def delete_refs(*ref_names)
    raw.delete_refs(*ref_names)
  end

867
  def ff_merge(user, source, target_branch, merge_request: nil)
868 869
    their_commit_id = commit(source)&.id
    raise 'Invalid merge source' if their_commit_id.nil?
870

871
    merge_request&.update(in_progress_merge_commit_sha: their_commit_id)
872

873
    with_cache_hooks { raw.ff_merge(user, their_commit_id, target_branch) }
874 875
  end

876
  def revert(
877
    user, commit, branch_name, message,
878
    start_branch_name: nil, start_project: project)
879

880 881 882 883 884 885 886 887 888
    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
      )
889
    end
890 891
  end

892
  def cherry_pick(
893
    user, commit, branch_name, message,
894
    start_branch_name: nil, start_project: project)
895

896 897 898 899 900 901 902 903 904
    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
      )
905 906 907
    end
  end

908
  def merged_to_root_ref?(branch_or_name)
909 910 911
    branch = Gitlab::Git::Branch.find(self, branch_or_name)

    if branch
912 913
      same_head = branch.target == root_ref_sha
      merged = ancestor?(branch.target, root_ref_sha)
914
      !same_head && merged
915 916 917 918 919
    else
      nil
    end
  end

920 921 922 923
  def root_ref_sha
    @root_ref_sha ||= commit(root_ref).sha
  end

924
  delegate :merged_branch_names, to: :raw_repository
925

926 927 928 929 930 931
  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)
932 933
  end

934
  def ancestor?(ancestor_id, descendant_id)
935
    return false if ancestor_id.nil? || descendant_id.nil?
936

937
    raw_repository.ancestor?(ancestor_id, descendant_id)
938 939
  end

940
  def fetch_as_mirror(url, forced: false, refmap: :all_refs, remote_name: nil, prune: true)
941 942 943 944 945
    unless remote_name
      remote_name = "tmp-#{SecureRandom.hex}"
      tmp_remote_name = true
    end

946
    add_remote(remote_name, url, mirror_refmap: refmap)
947
    fetch_remote(remote_name, forced: forced, prune: prune)
948
  ensure
949
    async_remove_remote(remote_name) if tmp_remote_name
950 951
  end

952
  # rubocop:disable Gitlab/RailsLogger
953 954 955 956 957 958 959 960 961 962 963 964 965
  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
966
  # rubocop:enable Gitlab/RailsLogger
967

968 969
  def fetch_source_branch!(source_repository, source_branch, local_ref)
    raw_repository.fetch_source_branch!(source_repository.raw_repository, source_branch, local_ref)
970
  end
971

972 973
  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)
974
  end
975

976
  def create_ref(ref, ref_path)
977
    raw_repository.write_ref(ref_path, ref)
978 979
  end

980 981 982 983 984
  def ls_files(ref)
    actual_ref = ref || root_ref
    raw_repository.ls_files(actual_ref)
  end

985 986 987 988 989 990 991 992 993 994 995 996
  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

997 998 999 1000 1001 1002 1003 1004 1005 1006
  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

1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017
  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"
1018
      end
1019 1020 1021

    objects.find do |object|
      Gitlab::FileDetector.type_of(object.path) == type
1022 1023 1024
    end
  end

Douwe Maan's avatar
Douwe Maan committed
1025 1026 1027 1028
  def route_map_for(sha)
    blob_data_at(sha, '.gitlab/route-map.yml')
  end

1029 1030
  def gitlab_ci_yml_for(sha, path = '.gitlab-ci.yml')
    blob_data_at(sha, path)
Douwe Maan's avatar
Douwe Maan committed
1031 1032
  end

1033 1034 1035 1036
  def lfsconfig_for(sha)
    blob_data_at(sha, '.lfsconfig')
  end

1037 1038 1039 1040
  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

1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053
  # 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
1054
    merge_request.update(rebase_commit_sha: rebase_sha, merge_error: nil)
1055 1056 1057 1058

    rebase_sha
  end

1059
  def rebase(user, merge_request)
Douwe Maan's avatar
Douwe Maan committed
1060
    if Feature.disabled?(:two_step_rebase, default_enabled: true)
1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072
      return rebase_deprecated(user, merge_request)
    end

    MergeRequest.transaction do
      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|
1073
        merge_request.update!(rebase_commit_sha: commit_id, merge_error: nil)
1074 1075
      end
    end
1076 1077
  end

1078
  def squash(user, merge_request, message)
1079 1080 1081 1082
    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,
1083
                                       message: message)
1084 1085
  end

1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097
  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

1098 1099 1100 1101 1102 1103 1104 1105
  def blob_data_at(sha, path)
    blob = blob_at(sha, path)
    return unless blob

    blob.load_all_data!
    blob.data
  end

1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118
  def create_if_not_exists
    return if exists?

    raw.create_repository
    after_create
  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

1119 1120
  private

1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132
  # 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

1133
  def cache
1134
    @cache ||= Gitlab::RepositoryCache.new(self)
1135
  end
1136

1137 1138 1139 1140
  def redis_set_cache
    @redis_set_cache ||= Gitlab::RepositorySetCache.new(self)
  end

1141
  def request_store_cache
1142
    @request_store_cache ||= Gitlab::RepositoryCache.new(self, backend: Gitlab::SafeRequestStore)
1143 1144
  end

1145
  def tags_sorted_by_committed_date
1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157
    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
1158
  end
1159 1160

  def keep_around_ref_name(sha)
1161
    "refs/#{REF_KEEP_AROUND}/#{sha}"
1162
  end
Yorick Peterse's avatar
Yorick Peterse committed
1163 1164

  def repository_event(event, tags = {})
1165
    Gitlab::Metrics.add_event(event, tags)
Yorick Peterse's avatar
Yorick Peterse committed
1166
  end
1167

1168
  def initialize_raw_repository
1169 1170
    Gitlab::Git::Repository.new(project.repository_storage,
                                disk_path + '.git',
1171
                                repo_type.identifier_for_subject(project),
1172
                                project.full_path)
1173
  end
1174
end