repository.rb 28.2 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 38
  # For example, for entry `:commit_count` there's a method called `commit_count` which
  # stores its data in the `commit_count` cache key.
  CACHED_METHODS = %i(size commit_count rendered_readme 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: :rendered_readme,
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)
H
http://jneen.net/ 已提交
72 73 74
    @disk_path == other.disk_path
  end

75
  def raw_repository
76
    return nil unless full_path
77

78
    @raw_repository ||= initialize_raw_repository
79 80
  end

81 82
  alias_method :raw, :raw_repository

83
  # Don't use this! It's going away. Use Gitaly to read or write from repos.
84
  def path_to_repo
85 86 87 88 89 90 91 92
    @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
93 94
  end

95 96 97 98
  def inspect
    "#<#{self.class.name}:#{@disk_path}>"
  end

99
  def commit(ref = nil)
100
    return nil unless exists?
101
    return ref if ref.is_a?(::Commit)
102

103
    find_commit(ref || root_ref)
104
  end
105

106 107 108 109 110 111
  # 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)
112 113
  end

114 115 116 117 118 119 120 121 122 123 124 125
  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

126
  def commits(ref = nil, path: nil, limit: nil, offset: nil, skip_merges: false, after: nil, before: nil, all: nil)
127
    options = {
128 129 130 131 132
      repo: raw_repository,
      ref: ref,
      path: path,
      limit: limit,
      offset: offset,
133 134
      after: after,
      before: before,
135
      follow: Array(path).length == 1,
136 137
      skip_merges: skip_merges,
      all: all
138 139 140
    }

    commits = Gitlab::Git::Commit.where(options)
141
    commits = Commit.decorate(commits, @project) if commits.present?
142 143

    CommitCollection.new(project, commits, ref)
144 145
  end

146 147
  def commits_between(from, to)
    commits = Gitlab::Git::Commit.between(raw_repository, from, to)
148
    commits = Commit.decorate(commits, @project) if commits.present?
149 150 151
    commits
  end

152 153
  # Returns a list of commits that are not present in any reference
  def new_commits(newrev)
154
    commits = raw.new_commits(newrev)
155

156
    ::Commit.decorate(commits, project)
157 158
  end

J
Jacob Vosmaer 已提交
159
  # Gitaly migration: https://gitlab.com/gitlab-org/gitaly/issues/384
160
  def find_commits_by_message(query, ref = nil, path = nil, limit = 1000, offset = 0)
161 162 163 164
    unless exists? && has_visible_content? && query.present?
      return []
    end

165 166
    commits = raw_repository.find_commits_by_message(query, ref, path, limit, offset).map do |c|
      commit(c)
167
    end
168
    CommitCollection.new(project, commits, ref)
169 170
  end

J
Jacob Vosmaer 已提交
171 172
  def find_branch(name)
    raw_repository.find_branch(name)
173 174 175
  end

  def find_tag(name)
176
    tags.find { |tag| tag.name == name }
177 178
  end

179
  def add_branch(user, branch_name, ref)
180
    branch = raw_repository.add_branch(branch_name, user: user, target: ref)
181

182
    after_create_branch
183 184 185 186

    branch
  rescue Gitlab::Git::Repository::InvalidRef
    false
187 188
  end

189
  def add_tag(user, tag_name, target, message = nil)
190
    raw_repository.add_tag(tag_name, user: user, target: target, message: message)
191 192
  rescue Gitlab::Git::Repository::InvalidRef
    false
193 194
  end

195
  def rm_branch(user, branch_name)
196
    before_remove_branch
197

198
    raw_repository.rm_branch(branch_name, user: user)
199

200
    after_remove_branch
201
    true
202 203
  end

L
Lin Jen-Shin 已提交
204
  def rm_tag(user, tag_name)
Y
Yorick Peterse 已提交
205
    before_remove_tag
206

207
    raw_repository.rm_tag(tag_name, user: user)
L
Lin Jen-Shin 已提交
208 209 210

    after_remove_tag
    true
211 212
  end

213 214 215 216
  def ref_names
    branch_names + tag_names
  end

217
  def branch_exists?(branch_name)
218 219
    return false unless raw_repository

220
    branch_names.include?(branch_name)
221 222
  end

223 224 225 226 227 228
  def tag_exists?(tag_name)
    return false unless raw_repository

    tag_names.include?(tag_name)
  end

229
  def ref_exists?(ref)
230 231
    !!raw_repository&.ref_exists?(ref)
  rescue ArgumentError
232
    false
233 234
  end

235 236 237 238 239 240
  def languages
    return [] if empty?

    raw_repository.languages(root_ref)
  end

D
Douwe Maan 已提交
241 242 243 244
  # 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.
245 246 247 248 249 250 251
  #
  # 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)
252

253
        next if kept_around?(sha)
254

255 256 257 258 259 260
        # This will still fail if the file is corrupted (e.g. 0 bytes)
        raw_repository.write_ref(keep_around_ref_name(sha), sha, shell: false)
      rescue Gitlab::Git::CommandError => ex
        Rails.logger.error "Unable to create keep-around reference for repository #{disk_path}: #{ex}"
      end
    end
261 262 263
  end

  def kept_around?(sha)
264
    ref_exists?(keep_around_ref_name(sha))
265
  end
266

267
  def diverging_commit_counts(branch)
268
    @root_ref_hash ||= raw_repository.commit(root_ref).id
J
Jeff Stubler 已提交
269
    cache.fetch(:"diverging_commit_counts_#{branch.name}") do
270 271
      # Rugged seems to throw a `ReferenceError` when given branch_names rather
      # than SHA-1 hashes
272 273
      number_commits_behind, number_commits_ahead =
        raw_repository.count_commits_between(
274
          @root_ref_hash,
275 276 277
          branch.dereferenced_target.sha,
          left_right: true,
          max_count: MAX_DIVERGING_COUNT)
278

279 280 281
      { behind: number_commits_behind, ahead: number_commits_ahead }
    end
  end
282

283 284 285 286 287 288 289 290 291 292
  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

293 294 295 296
  def cached_methods
    CACHED_METHODS
  end

297 298 299
  def expire_tags_cache
    expire_method_caches(%i(tag_names tag_count))
    @tags = nil
300
  end
301

302
  def expire_branches_cache
303
    expire_method_caches(%i(branch_names branch_count has_visible_content?))
304
    @local_branches = nil
305
    @branch_exists_memo = nil
306 307
  end

308 309
  def expire_statistics_caches
    expire_method_caches(%i(size commit_count))
310 311
  end

312 313
  def expire_all_method_caches
    expire_method_caches(CACHED_METHODS)
D
Douwe Maan 已提交
314 315
  end

316 317 318 319 320 321 322 323 324
  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)
325 326
    return if types.empty?

327 328 329 330 331 332
    to_refresh = []

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

      to_refresh.concat(Array(methods)) if methods
333
    end
334

335
    expire_method_caches(to_refresh)
336

337
    to_refresh.each { |method| send(method) } # rubocop:disable GitlabSecurity/PublicSend
338
  end
339

340 341 342 343 344 345 346
  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}")
347
        cache.expire(:"commit_count_#{branch.name}")
348 349 350 351 352
      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}")
353
      cache.expire(:"commit_count_#{branch_name}")
354
    end
D
Dmitriy Zaporozhets 已提交
355 356
  end

357
  def expire_root_ref_cache
358
    expire_method_caches(%i(root_ref))
359 360
  end

361 362
  # Expires the cache(s) used to determine if a repository is empty or not.
  def expire_emptiness_caches
363
    return unless empty?
364

365
    expire_method_caches(%i(has_visible_content?))
366
    raw_repository.expire_has_local_branches_cache
Y
Yorick Peterse 已提交
367 368
  end

369 370 371 372
  def lookup_cache
    @lookup_cache ||= {}
  end

373
  def expire_exists_cache
374
    expire_method_caches(%i(exists?))
375 376
  end

377 378 379 380 381 382 383
  # 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
384
    expire_statistics_caches
385 386 387 388 389
  end

  # Runs code after a repository has been created.
  def after_create
    expire_exists_cache
390 391
    expire_root_ref_cache
    expire_emptiness_caches
Y
Yorick Peterse 已提交
392 393

    repository_event(:create_repository)
394 395
  end

396 397
  # Runs code just before a repository is deleted.
  def before_delete
398
    expire_exists_cache
399 400
    expire_all_method_caches
    expire_branch_cache if exists?
401
    expire_content_cache
Y
Yorick Peterse 已提交
402 403

    repository_event(:remove_repository)
404 405 406 407 408 409 410
  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 已提交
411 412

    repository_event(:change_default_branch)
413 414
  end

Y
Yorick Peterse 已提交
415 416
  # Runs code before pushing (= creating or removing) a tag.
  def before_push_tag
417 418
    expire_statistics_caches
    expire_emptiness_caches
419
    expire_tags_cache
Y
Yorick Peterse 已提交
420 421

    repository_event(:push_tag)
Y
Yorick Peterse 已提交
422 423 424 425 426
  end

  # Runs code before removing a tag.
  def before_remove_tag
    expire_tags_cache
427
    expire_statistics_caches
Y
Yorick Peterse 已提交
428 429

    repository_event(:remove_tag)
430 431
  end

L
Lin Jen-Shin 已提交
432 433 434 435 436
  # Runs code after removing a tag.
  def after_remove_tag
    expire_tags_cache
  end

437 438
  # Runs code after the HEAD of a repository is changed.
  def after_change_head
439
    expire_all_method_caches
440 441
  end

442 443
  # Runs code after a repository has been forked/imported.
  def after_import
444
    expire_content_cache
445 446

    DetectRepositoryLanguagesWorker.perform_async(project.id, project.owner.id)
447 448 449
  end

  # Runs code after a new commit has been pushed.
450 451 452
  def after_push_commit(branch_name)
    expire_statistics_caches
    expire_branch_cache(branch_name)
Y
Yorick Peterse 已提交
453 454

    repository_event(:push_commit, branch: branch_name)
455 456 457 458
  end

  # Runs code after a new branch has been created.
  def after_create_branch
459
    expire_branches_cache
Y
Yorick Peterse 已提交
460 461

    repository_event(:push_branch)
462 463
  end

464 465 466
  # Runs code before removing an existing branch.
  def before_remove_branch
    expire_branches_cache
Y
Yorick Peterse 已提交
467 468

    repository_event(:remove_branch)
469 470
  end

471 472
  # Runs code after an existing branch has been removed.
  def after_remove_branch
473
    expire_branches_cache
474 475
  end

476 477 478 479
  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
480
    else
481
      raw_repository.__send__(msg, *args, &block) # rubocop:disable GitlabSecurity/PublicSend
482
    end
483 484
  end

485 486
  def respond_to_missing?(method, include_private = false)
    raw_repository.respond_to?(method, include_private) || super
487
  end
D
Dmitriy Zaporozhets 已提交
488 489

  def blob_at(sha, path)
490 491 492 493 494 495 496 497 498 499 500 501 502 503
    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 已提交
504 505
  rescue Gitlab::Git::Repository::NoRepository
    nil
D
Dmitriy Zaporozhets 已提交
506
  end
507

508 509 510 511 512
  # 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

513
  def root_ref
514 515
    # 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
516
  end
517
  cache_method :root_ref
518

519
  # Gitaly migration: https://gitlab.com/gitlab-org/gitaly/issues/314
520
  def exists?
521
    return false unless full_path
522

523
    raw_repository.exists?
524
  end
525
  cache_method_asymmetrically :exists?
526

527 528 529
  # 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.
530 531 532 533 534
  def empty?
    return true unless exists?

    !has_visible_content?
  end
535 536 537 538 539 540 541 542 543 544 545 546

  # 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

547
  def commit_count_for_ref(ref)
548
    return 0 unless exists?
549

550
    cache.fetch(:"commit_count_#{ref}") { raw_repository.commit_count(ref) }
551 552
  end

553
  delegate :branch_names, to: :raw_repository
554 555
  cache_method :branch_names, fallback: []

D
Douwe Maan 已提交
556
  delegate :tag_names, to: :raw_repository
557 558
  cache_method :tag_names, fallback: []

559
  delegate :branch_count, :tag_count, :has_visible_content?, to: :raw_repository
560 561
  cache_method :branch_count, fallback: 0
  cache_method :tag_count, fallback: 0
562
  cache_method :has_visible_content?, fallback: false
563 564

  def avatar
565 566 567 568 569
    # 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
570 571
    end
  end
572
  cache_method :avatar
573

S
Sean McGivern 已提交
574 575 576 577 578 579 580 581 582 583
  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: []

584
  def readme
585
    head_tree&.readme
586 587
  end

588
  def rendered_readme
589 590 591 592 593 594
    return unless readme

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

    MarkupHelper.markup_unsafe(readme.name, readme.data, context)
595 596
  end
  cache_method :rendered_readme
597

598
  def contribution_guide
599
    file_on_head(:contributing)
600
  end
601
  cache_method :contribution_guide
602 603

  def changelog
604
    file_on_head(:changelog)
605
  end
606
  cache_method :changelog
607

608
  def license_blob
609
    file_on_head(:license)
610
  end
611
  cache_method :license_blob
Z
Zeger-Jan van de Weg 已提交
612

613
  def license_key
614
    return unless exists?
615

616
    raw_repository.license_short_name
617
  end
618
  cache_method :license_key
619

D
Douwe Maan 已提交
620 621
  def license
    return unless license_key
622

623
    Licensee::License.new(license_key)
624
  end
625
  memoize_method :license
626 627

  def gitignore
628
    file_on_head(:gitignore)
629
  end
630
  cache_method :gitignore
631

632
  def gitlab_ci_yml
633
    file_on_head(:gitlab_ci)
634
  end
635
  cache_method :gitlab_ci_yml
636

637
  def xcode_project?
638
    file_on_head(:xcode_config, :tree).present?
639 640 641
  end
  cache_method :xcode_project?

642
  def head_commit
643 644 645 646
    @head_commit ||= commit(self.root_ref)
  end

  def head_tree
647 648 649
    if head_commit
      @head_tree ||= Tree.new(self, head_commit.sha, nil)
    end
650 651
  end

652
  def tree(sha = :head, path = nil, recursive: false)
653
    if sha == :head
654 655
      return unless head_commit

656 657 658 659 660
      if path.nil?
        return head_tree
      else
        sha = head_commit.sha
      end
661 662
    end

663
    Tree.new(self, sha, path, recursive: recursive)
664
  end
D
Dmitriy Zaporozhets 已提交
665 666

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

D
Dmitriy Zaporozhets 已提交
669 670 671 672 673
    if last_commit
      blob_at(last_commit.sha, path)
    else
      nil
    end
D
Dmitriy Zaporozhets 已提交
674
  end
D
Dmitriy Zaporozhets 已提交
675

676 677 678 679 680 681 682 683
  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

684
  def last_commit_for_path(sha, path)
685 686
    commit = raw_repository.last_commit_for_path(sha, path)
    ::Commit.new(commit, @project) if commit
687
  end
688

H
Hiroyuki Sato 已提交
689 690
  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 已提交
691

H
Hiroyuki Sato 已提交
692
    cache.fetch(key) do
693
      last_commit_for_path(sha, path)&.id
H
Hiroyuki Sato 已提交
694 695 696
    end
  end

697
  def next_branch(name, opts = {})
P
P.S.V.R 已提交
698 699
    branch_ids = self.branch_names.map do |n|
      next 1 if n == name
700

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

P
P.S.V.R 已提交
705
    highest_branch_id = branch_ids.max || 0
706

P
P.S.V.R 已提交
707 708 709
    return name if opts[:mild] && 0 == highest_branch_id

    "#{name}-#{highest_branch_id + 1}"
710 711
  end

712
  def branches_sorted_by(value)
713
    raw_repository.local_branches(sort_by: value)
714
  end
715

716 717
  def tags_sorted_by(value)
    case value
H
haseeb 已提交
718 719 720
    when 'name_asc'
      VersionSorter.sort(tags) { |tag| tag.name }
    when 'name_desc'
721
      VersionSorter.rsort(tags) { |tag| tag.name }
722 723 724 725 726 727 728 729 730
    when 'updated_desc'
      tags_sorted_by_committed_date.reverse
    when 'updated_asc'
      tags_sorted_by_committed_date
    else
      tags
    end
  end

731 732 733 734 735
  # Params:
  #
  # order_by: name|email|commits
  # sort: asc|desc default: 'asc'
  def contributors(order_by: nil, sort: 'asc')
736
    commits = self.commits(nil, limit: 2000, offset: 0, skip_merges: true)
737

738
    commits = commits.group_by(&:author_email).map do |email, commits|
739 740
      contributor = Gitlab::Contributor.new
      contributor.email = email
741

D
Dmitriy Zaporozhets 已提交
742
      commits.each do |commit|
743
        if contributor.name.blank?
D
Dmitriy Zaporozhets 已提交
744
          contributor.name = commit.author_name
745 746
        end

747
        contributor.commits += 1
748 749
      end

750 751
      contributor
    end
752
    Commit.order_by(collection: commits, order_by: order_by, sort: sort)
753
  end
D
Dmitriy Zaporozhets 已提交
754

755
  def branch_names_contains(sha)
756
    raw_repository.branch_names_contains_sha(sha)
757
  end
H
Hannes Rosenögger 已提交
758

759
  def tag_names_contains(sha)
760
    raw_repository.tag_names_contains_sha(sha)
H
Hannes Rosenögger 已提交
761
  end
762

763
  def local_branches
764
    @local_branches ||= raw_repository.local_branches
765 766
  end

767 768
  alias_method :branches, :local_branches

769 770 771 772
  def tags
    @tags ||= raw_repository.tags
  end

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

776
    multi_action(user, **options)
S
Stan Hu 已提交
777 778
  end

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

782
    multi_action(user, **options)
S
Stan Hu 已提交
783
  end
784

D
Douwe Maan 已提交
785 786 787
  def update_file(user, path, content, **options)
    previous_path = options.delete(:previous_path)
    action = previous_path && previous_path != path ? :move : :update
788

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

791
    multi_action(user, **options)
792 793
  end

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

797
    multi_action(user, **options)
798 799
  end

800 801
  def with_cache_hooks
    result = yield
802

803
    return unless result
804

805 806
    after_create if result.repo_created?
    after_create_branch if result.branch_created?
807

808 809 810
    result.newrev
  end

811 812
  def multi_action(user, **options)
    start_project = options.delete(:start_project)
M
Marc Siegfriedt 已提交
813

814 815
    if start_project
      options[:start_repository] = start_project.repository.raw_repository
M
Marc Siegfriedt 已提交
816 817
    end

818
    with_cache_hooks { raw.multi_action(user, **options) }
819 820
  end

821 822 823 824 825 826
  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
827
    end
828 829
  end

830
  def ff_merge(user, source, target_branch, merge_request: nil)
831 832
    their_commit_id = commit(source)&.id
    raise 'Invalid merge source' if their_commit_id.nil?
833

834
    merge_request&.update(in_progress_merge_commit_sha: their_commit_id)
835

836
    with_cache_hooks { raw.ff_merge(user, their_commit_id, target_branch) }
837 838
  end

839
  def revert(
840
    user, commit, branch_name, message,
841
    start_branch_name: nil, start_project: project)
842

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

855
  def cherry_pick(
856
    user, commit, branch_name, message,
857
    start_branch_name: nil, start_project: project)
P
P.S.V.R 已提交
858

859 860 861 862 863 864 865 866 867
    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 已提交
868 869 870
    end
  end

871
  def merged_to_root_ref?(branch_or_name)
872 873 874
    branch = Gitlab::Git::Branch.find(self, branch_or_name)

    if branch
875 876
      same_head = branch.target == root_ref_sha
      merged = ancestor?(branch.target, root_ref_sha)
877
      !same_head && merged
F
Florent (HP) 已提交
878 879 880 881 882
    else
      nil
    end
  end

883 884 885 886
  def root_ref_sha
    @root_ref_sha ||= commit(root_ref).sha
  end

887
  delegate :merged_branch_names, to: :raw_repository
888

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

897
  def ancestor?(ancestor_id, descendant_id)
898
    return false if ancestor_id.nil? || descendant_id.nil?
899

900
    raw_repository.ancestor?(ancestor_id, descendant_id)
901 902
  end

903
  def fetch_as_mirror(url, forced: false, refmap: :all_refs, remote_name: nil, prune: true)
904 905 906 907 908
    unless remote_name
      remote_name = "tmp-#{SecureRandom.hex}"
      tmp_remote_name = true
    end

909
    add_remote(remote_name, url, mirror_refmap: refmap)
910
    fetch_remote(remote_name, forced: forced, prune: prune)
911
  ensure
912
    async_remove_remote(remote_name) if tmp_remote_name
913 914
  end

915 916 917 918 919 920 921 922 923 924 925 926 927 928
  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

929 930
  def fetch_source_branch!(source_repository, source_branch, local_ref)
    raw_repository.fetch_source_branch!(source_repository.raw_repository, source_branch, local_ref)
931
  end
932

933 934
  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)
935
  end
936

937
  def create_ref(ref, ref_path)
938
    raw_repository.write_ref(ref_path, ref)
939 940
  end

941 942 943 944 945
  def ls_files(ref)
    actual_ref = ref || root_ref
    raw_repository.ls_files(actual_ref)
  end

946 947 948 949 950 951 952 953 954 955 956 957
  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

958 959 960 961 962 963 964 965 966 967
  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

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

    objects.find do |object|
      Gitlab::FileDetector.type_of(object.path) == type
983 984 985
    end
  end

D
Douwe Maan 已提交
986 987 988 989
  def route_map_for(sha)
    blob_data_at(sha, '.gitlab/route-map.yml')
  end

990 991
  def gitlab_ci_yml_for(sha, path = '.gitlab-ci.yml')
    blob_data_at(sha, path)
D
Douwe Maan 已提交
992 993
  end

994 995 996 997
  def lfsconfig_for(sha)
    blob_data_at(sha, '.lfsconfig')
  end

998 999 1000 1001
  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

1002 1003 1004 1005 1006 1007 1008
  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

1009 1010 1011 1012 1013 1014 1015 1016
  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

1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028
  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

1029 1030 1031 1032 1033 1034 1035 1036
  def blob_data_at(sha, path)
    blob = blob_at(sha, path)
    return unless blob

    blob.load_all_data!
    blob.data
  end

1037 1038
  private

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

1051
  def cache
1052 1053 1054 1055 1056
    @cache ||= if is_wiki
                 Gitlab::RepositoryCache.new(self, extra_namespace: 'wiki')
               else
                 Gitlab::RepositoryCache.new(self)
               end
1057
  end
1058

1059
  def request_store_cache
1060 1061 1062 1063 1064
    @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
1065 1066
  end

1067
  def tags_sorted_by_committed_date
1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079
    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
1080
  end
D
Douwe Maan 已提交
1081 1082

  def keep_around_ref_name(sha)
1083
    "refs/#{REF_KEEP_AROUND}/#{sha}"
D
Douwe Maan 已提交
1084
  end
Y
Yorick Peterse 已提交
1085 1086

  def repository_event(event, tags = {})
1087
    Gitlab::Metrics.add_event(event, tags)
Y
Yorick Peterse 已提交
1088
  end
1089

1090
  def initialize_raw_repository
1091
    Gitlab::Git::Repository.new(project.repository_storage, disk_path + '.git', Gitlab::GlRepository.gl_repository(project, is_wiki))
1092
  end
1093
end