repository.rb 28.7 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::ShellAdapter
21
  include Gitlab::RepositoryCacheAdapter
22

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

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

28
  CreateTreeError = 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 188 189 190 191 192 193 194 195 196 197 198 199
  def resolve_ref(ref)
    tag_exists = tag_exists?(ref)
    branch_exists = branch_exists?(ref)

    if tag_exists && branch_exists
      nil
    elsif tag_exists
      Gitlab::Git::TAG_REF_PREFIX + ref
    elsif branch_exists
      Gitlab::Git::BRANCH_REF_PREFIX + ref
    else
      ref
    end
  end

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

203
    after_create_branch
204 205 206 207

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

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

216
  def rm_branch(user, branch_name)
217
    before_remove_branch
218

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

221
    after_remove_branch
222
    true
223 224
  end

L
Lin Jen-Shin 已提交
225
  def rm_tag(user, tag_name)
Y
Yorick Peterse 已提交
226
    before_remove_tag
227

228
    raw_repository.rm_tag(tag_name, user: user)
L
Lin Jen-Shin 已提交
229 230 231

    after_remove_tag
    true
232 233
  end

234 235 236 237
  def ref_names
    branch_names + tag_names
  end

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

241
    branch_names.include?(branch_name)
242 243
  end

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

    tag_names.include?(tag_name)
  end

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

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

    raw_repository.languages(root_ref)
  end

D
Douwe Maan 已提交
262 263 264 265
  # 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.
266 267 268 269 270 271 272
  #
  # 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)
273

274
        next if kept_around?(sha)
275

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

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

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

300 301 302
      { behind: number_commits_behind, ahead: number_commits_ahead }
    end
  end
303

304 305 306 307 308 309 310 311 312 313
  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

314 315 316 317
  def cached_methods
    CACHED_METHODS
  end

318 319 320
  def expire_tags_cache
    expire_method_caches(%i(tag_names tag_count))
    @tags = nil
321
  end
322

323
  def expire_branches_cache
324
    expire_method_caches(%i(branch_names branch_count has_visible_content?))
325
    @local_branches = nil
326
    @branch_exists_memo = nil
327 328
  end

329 330
  def expire_statistics_caches
    expire_method_caches(%i(size commit_count))
331 332
  end

333 334
  def expire_all_method_caches
    expire_method_caches(CACHED_METHODS)
D
Douwe Maan 已提交
335 336
  end

337 338 339 340 341 342 343 344 345
  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)
346 347
    return if types.empty?

348 349 350 351 352 353
    to_refresh = []

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

      to_refresh.concat(Array(methods)) if methods
354
    end
355

356
    expire_method_caches(to_refresh)
357

358
    to_refresh.each { |method| send(method) } # rubocop:disable GitlabSecurity/PublicSend
359
  end
360

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

378
  def expire_root_ref_cache
379
    expire_method_caches(%i(root_ref))
380 381
  end

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

386
    expire_method_caches(%i(has_visible_content?))
387
    raw_repository.expire_has_local_branches_cache
Y
Yorick Peterse 已提交
388 389
  end

390 391 392 393
  def lookup_cache
    @lookup_cache ||= {}
  end

394
  def expire_exists_cache
395
    expire_method_caches(%i(exists?))
396 397
  end

398 399 400 401 402 403 404
  # 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
405
    expire_statistics_caches
406 407 408 409 410
  end

  # Runs code after a repository has been created.
  def after_create
    expire_exists_cache
411 412
    expire_root_ref_cache
    expire_emptiness_caches
Y
Yorick Peterse 已提交
413 414

    repository_event(:create_repository)
415 416
  end

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

    repository_event(:remove_repository)
425 426 427 428 429 430 431
  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 已提交
432 433

    repository_event(:change_default_branch)
434 435
  end

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

    repository_event(:push_tag)
Y
Yorick Peterse 已提交
443 444 445 446 447
  end

  # Runs code before removing a tag.
  def before_remove_tag
    expire_tags_cache
448
    expire_statistics_caches
Y
Yorick Peterse 已提交
449 450

    repository_event(:remove_tag)
451 452
  end

L
Lin Jen-Shin 已提交
453 454 455 456 457
  # Runs code after removing a tag.
  def after_remove_tag
    expire_tags_cache
  end

458 459
  # Runs code after the HEAD of a repository is changed.
  def after_change_head
460
    expire_all_method_caches
461 462
  end

463 464
  # Runs code after a repository has been forked/imported.
  def after_import
465
    expire_content_cache
466 467

    DetectRepositoryLanguagesWorker.perform_async(project.id, project.owner.id)
468 469 470
  end

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

    repository_event(:push_commit, branch: branch_name)
476 477 478 479
  end

  # Runs code after a new branch has been created.
  def after_create_branch
480
    expire_branches_cache
Y
Yorick Peterse 已提交
481 482

    repository_event(:push_branch)
483 484
  end

485 486 487
  # Runs code before removing an existing branch.
  def before_remove_branch
    expire_branches_cache
Y
Yorick Peterse 已提交
488 489

    repository_event(:remove_branch)
490 491
  end

492 493
  # Runs code after an existing branch has been removed.
  def after_remove_branch
494
    expire_branches_cache
495 496
  end

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

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

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

529 530 531 532 533
  # 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

534
  def root_ref
535 536
    # 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
537
  end
538
  cache_method :root_ref
539

540
  # Gitaly migration: https://gitlab.com/gitlab-org/gitaly/issues/314
541
  def exists?
542
    return false unless full_path
543

544
    raw_repository.exists?
545
  end
546
  cache_method_asymmetrically :exists?
547

548 549 550
  # 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.
551 552 553 554 555
  def empty?
    return true unless exists?

    !has_visible_content?
  end
556 557 558 559 560 561 562 563 564 565 566 567

  # 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

568
  def commit_count_for_ref(ref)
569
    return 0 unless exists?
570

571
    cache.fetch(:"commit_count_#{ref}") { raw_repository.commit_count(ref) }
572 573
  end

574
  delegate :branch_names, to: :raw_repository
575 576
  cache_method :branch_names, fallback: []

D
Douwe Maan 已提交
577
  delegate :tag_names, to: :raw_repository
578 579
  cache_method :tag_names, fallback: []

580
  delegate :branch_count, :tag_count, :has_visible_content?, to: :raw_repository
581 582
  cache_method :branch_count, fallback: 0
  cache_method :tag_count, fallback: 0
583
  cache_method :has_visible_content?, fallback: false
584 585

  def avatar
586 587 588 589 590
    # 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
591 592
    end
  end
593
  cache_method :avatar
594

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

605
  def readme
606
    head_tree&.readme
607 608
  end

609 610 611 612 613
  def readme_path
    readme&.path
  end
  cache_method :readme_path

614
  def rendered_readme
615 616 617 618 619 620
    return unless readme

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

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

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

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

634
  def license_blob
635
    file_on_head(:license)
636
  end
637
  cache_method :license_blob
Z
Zeger-Jan van de Weg 已提交
638

639
  def license_key
640
    return unless exists?
641

642
    raw_repository.license_short_name
643
  end
644
  cache_method :license_key
645

D
Douwe Maan 已提交
646 647
  def license
    return unless license_key
648

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

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

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

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

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

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

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

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

689
    Tree.new(self, sha, path, recursive: recursive)
690
  end
D
Dmitriy Zaporozhets 已提交
691 692

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

D
Dmitriy Zaporozhets 已提交
695 696 697 698 699
    if last_commit
      blob_at(last_commit.sha, path)
    else
      nil
    end
D
Dmitriy Zaporozhets 已提交
700
  end
D
Dmitriy Zaporozhets 已提交
701

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

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

H
Hiroyuki Sato 已提交
715 716
  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 已提交
717

H
Hiroyuki Sato 已提交
718
    cache.fetch(key) do
719
      last_commit_for_path(sha, path)&.id
H
Hiroyuki Sato 已提交
720 721 722
    end
  end

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

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

P
P.S.V.R 已提交
731
    highest_branch_id = branch_ids.max || 0
732

P
P.S.V.R 已提交
733 734 735
    return name if opts[:mild] && 0 == highest_branch_id

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

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

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

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

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

D
Dmitriy Zaporozhets 已提交
768
      commits.each do |commit|
769
        if contributor.name.blank?
D
Dmitriy Zaporozhets 已提交
770
          contributor.name = commit.author_name
771 772
        end

773
        contributor.commits += 1
774 775
      end

776 777
      contributor
    end
778
    Commit.order_by(collection: commits, order_by: order_by, sort: sort)
779
  end
D
Dmitriy Zaporozhets 已提交
780

781
  def branch_names_contains(sha)
782
    raw_repository.branch_names_contains_sha(sha)
783
  end
H
Hannes Rosenögger 已提交
784

785
  def tag_names_contains(sha)
786
    raw_repository.tag_names_contains_sha(sha)
H
Hannes Rosenögger 已提交
787
  end
788

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

793 794
  alias_method :branches, :local_branches

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

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

802
    multi_action(user, **options)
S
Stan Hu 已提交
803 804
  end

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

808
    multi_action(user, **options)
S
Stan Hu 已提交
809
  end
810

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

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

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

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

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

826 827
  def with_cache_hooks
    result = yield
828

829
    return unless result
830

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

834 835 836
    result.newrev
  end

837 838
  def multi_action(user, **options)
    start_project = options.delete(:start_project)
M
Marc Siegfriedt 已提交
839

840 841
    if start_project
      options[:start_repository] = start_project.repository.raw_repository
M
Marc Siegfriedt 已提交
842 843
    end

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

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

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

860
    merge_request&.update(in_progress_merge_commit_sha: their_commit_id)
861

862
    with_cache_hooks { raw.ff_merge(user, their_commit_id, target_branch) }
863 864
  end

865
  def revert(
866
    user, commit, branch_name, message,
867
    start_branch_name: nil, start_project: project)
868

869 870 871 872 873 874 875 876 877
    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
      )
878
    end
879 880
  end

881
  def cherry_pick(
882
    user, commit, branch_name, message,
883
    start_branch_name: nil, start_project: project)
P
P.S.V.R 已提交
884

885 886 887 888 889 890 891 892 893
    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 已提交
894 895 896
    end
  end

897
  def merged_to_root_ref?(branch_or_name)
898 899 900
    branch = Gitlab::Git::Branch.find(self, branch_or_name)

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

909 910 911 912
  def root_ref_sha
    @root_ref_sha ||= commit(root_ref).sha
  end

913
  delegate :merged_branch_names, to: :raw_repository
914

915 916 917 918 919 920
  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 已提交
921 922
  end

923
  def ancestor?(ancestor_id, descendant_id)
924
    return false if ancestor_id.nil? || descendant_id.nil?
925

926
    raw_repository.ancestor?(ancestor_id, descendant_id)
927 928
  end

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

935
    add_remote(remote_name, url, mirror_refmap: refmap)
936
    fetch_remote(remote_name, forced: forced, prune: prune)
937
  ensure
938
    async_remove_remote(remote_name) if tmp_remote_name
939 940
  end

941 942 943 944 945 946 947 948 949 950 951 952 953 954
  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

955 956
  def fetch_source_branch!(source_repository, source_branch, local_ref)
    raw_repository.fetch_source_branch!(source_repository.raw_repository, source_branch, local_ref)
957
  end
958

959 960
  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)
961
  end
962

963
  def create_ref(ref, ref_path)
964
    raw_repository.write_ref(ref_path, ref)
965 966
  end

967 968 969 970 971
  def ls_files(ref)
    actual_ref = ref || root_ref
    raw_repository.ls_files(actual_ref)
  end

972 973 974 975 976 977 978 979 980 981 982 983
  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

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

994 995 996 997 998 999 1000 1001 1002 1003 1004
  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"
1005
      end
1006 1007 1008

    objects.find do |object|
      Gitlab::FileDetector.type_of(object.path) == type
1009 1010 1011
    end
  end

D
Douwe Maan 已提交
1012 1013 1014 1015
  def route_map_for(sha)
    blob_data_at(sha, '.gitlab/route-map.yml')
  end

1016 1017
  def gitlab_ci_yml_for(sha, path = '.gitlab-ci.yml')
    blob_data_at(sha, path)
D
Douwe Maan 已提交
1018 1019
  end

1020 1021 1022 1023
  def lfsconfig_for(sha)
    blob_data_at(sha, '.lfsconfig')
  end

1024 1025 1026 1027
  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

1028 1029 1030 1031 1032 1033 1034
  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

1035 1036 1037 1038 1039 1040 1041 1042
  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

1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054
  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

1055 1056 1057 1058 1059 1060 1061 1062
  def blob_data_at(sha, path)
    blob = blob_at(sha, path)
    return unless blob

    blob.load_all_data!
    blob.data
  end

1063 1064
  private

1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076
  # 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

1077
  def cache
1078 1079 1080 1081 1082
    @cache ||= if is_wiki
                 Gitlab::RepositoryCache.new(self, extra_namespace: 'wiki')
               else
                 Gitlab::RepositoryCache.new(self)
               end
1083
  end
1084

1085
  def request_store_cache
1086 1087 1088 1089 1090
    @request_store_cache ||= if is_wiki
                               Gitlab::RepositoryCache.new(self, extra_namespace: 'wiki', backend: Gitlab::SafeRequestStore)
                             else
                               Gitlab::RepositoryCache.new(self, backend: Gitlab::SafeRequestStore)
                             end
1091 1092
  end

1093
  def tags_sorted_by_committed_date
1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105
    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
1106
  end
D
Douwe Maan 已提交
1107 1108

  def keep_around_ref_name(sha)
1109
    "refs/#{REF_KEEP_AROUND}/#{sha}"
D
Douwe Maan 已提交
1110
  end
Y
Yorick Peterse 已提交
1111 1112

  def repository_event(event, tags = {})
1113
    Gitlab::Metrics.add_event(event, tags)
Y
Yorick Peterse 已提交
1114
  end
1115

1116
  def initialize_raw_repository
1117
    Gitlab::Git::Repository.new(project.repository_storage, disk_path + '.git', Gitlab::GlRepository.gl_repository(project, is_wiki))
1118
  end
1119
end