repository.rb 31.2 KB
Newer Older
1 2
require 'securerandom'

3
class Repository
Lin Jen-Shin's avatar
Lin Jen-Shin committed
4 5 6
  REF_MERGE_REQUEST = 'merge-requests'.freeze
  REF_KEEP_AROUND = 'keep-around'.freeze
  REF_ENVIRONMENTS = 'environments'.freeze
7 8 9 10

  RESERVED_REFS_NAMES = %W[
    heads
    tags
11
    replace
12 13 14 15 16
    #{REF_ENVIRONMENTS}
    #{REF_KEEP_AROUND}
    #{REF_ENVIRONMENTS}
  ].freeze

17 18
  include Gitlab::ShellAdapter

19
  attr_accessor :full_path, :disk_path, :project, :is_wiki
20

21
  delegate :ref_name_for_sha, to: :raw_repository
22
  delegate :write_ref, to: :raw_repository
23

24
  CreateTreeError = Class.new(StandardError)
25

26 27 28 29 30 31
  # 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.
  #
32 33 34
  # 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
35 36
                      changelog license_blob license_key gitignore koding_yml
                      gitlab_ci_yml branch_names tag_names branch_count
37 38
                      tag_count avatar exists? empty? root_ref has_visible_content?
                      issue_template_names merge_request_template_names).freeze
39 40

  # Methods that use cache_method but only memoize the value
41
  MEMOIZED_CACHED_METHODS = %i(license).freeze
42 43 44 45 46

  # 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 = {
47
    readme: :rendered_readme,
48
    changelog: :changelog,
49
    license: %i(license_blob license_key license),
50 51 52 53
    contributing: :contribution_guide,
    gitignore: :gitignore,
    koding: :koding_yml,
    gitlab_ci: :gitlab_ci_yml,
54 55 56
    avatar: :avatar,
    issue_template: :issue_template_names,
    merge_request_template: :merge_request_template_names
57
  }.freeze
58 59 60 61 62

  # Wraps around the given method and caches its output in Redis and an instance
  # variable.
  #
  # This only works for methods that do not take any arguments.
63
  def self.cache_method(name, fallback: nil, memoize_only: false)
64
    original = :"_uncached_#{name}"
65

66
    alias_method(original, name)
67

68
    define_method(name) do
69 70 71
      cache_method_output(name, fallback: fallback, memoize_only: memoize_only) do
        __send__(original) # rubocop:disable GitlabSecurity/PublicSend
      end
72
    end
73
  end
74

75
  def initialize(full_path, project, disk_path: nil, is_wiki: false)
76
    @full_path = full_path
77
    @disk_path = disk_path || full_path
78
    @project = project
79
    @commit_cache = {}
80
    @is_wiki = is_wiki
81
  end
82

83
  def ==(other)
84 85 86
    @disk_path == other.disk_path
  end

87
  def raw_repository
88
    return nil unless full_path
89

90
    @raw_repository ||= initialize_raw_repository
91 92
  end

93 94
  alias_method :raw, :raw_repository

95
  # Return absolute path to repository
96
  def path_to_repo
97
    @path_to_repo ||= File.expand_path(
98
      File.join(repository_storage_path, disk_path + '.git')
99
    )
100 101
  end

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

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

110 111
    find_commit(ref)
  end
112

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

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

133
  def commits(ref, path: nil, limit: nil, offset: nil, skip_merges: false, after: nil, before: nil)
134
    options = {
135 136 137 138 139
      repo: raw_repository,
      ref: ref,
      path: path,
      limit: limit,
      offset: offset,
140 141
      after: after,
      before: before,
142
      follow: Array(path).length == 1,
143
      skip_merges: skip_merges
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

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

164
    raw_repository.gitaly_migrate(:commits_by_message) do |is_enabled|
165 166 167 168 169 170 171 172
      commits =
        if is_enabled
          find_commits_by_message_by_gitaly(query, ref, path, limit, offset)
        else
          find_commits_by_message_by_shelling_out(query, ref, path, limit, offset)
        end

      CommitCollection.new(project, commits, ref)
173
    end
174 175
  end

176 177 178 179 180 181 182
  def find_branch(name, fresh_repo: true)
    # Since the Repository object may have in-memory index changes, invalidating the memoized Repository object may
    # cause unintended side effects. Because finding a branch is a read-only operation, we can safely instantiate
    # a new repo here to ensure a consistent state to avoid a libgit2 bug where concurrent access (e.g. via git gc)
    # may cause the branch to "disappear" erroneously or have the wrong SHA.
    #
    # See: https://github.com/libgit2/libgit2/issues/1534 and https://gitlab.com/gitlab-org/gitlab-ce/issues/15392
183
    raw_repo = fresh_repo ? initialize_raw_repository : raw_repository
184 185

    raw_repo.find_branch(name)
186 187 188
  end

  def find_tag(name)
189
    tags.find { |tag| tag.name == name }
190 191
  end

192
  def add_branch(user, branch_name, ref)
193
    branch = raw_repository.add_branch(branch_name, user: user, target: ref)
194

195
    after_create_branch
196 197 198 199

    branch
  rescue Gitlab::Git::Repository::InvalidRef
    false
200 201
  end

202
  def add_tag(user, tag_name, target, message = nil)
203
    raw_repository.add_tag(tag_name, user: user, target: target, message: message)
204 205
  rescue Gitlab::Git::Repository::InvalidRef
    false
206 207
  end

208
  def rm_branch(user, branch_name)
209
    before_remove_branch
210

211
    raw_repository.rm_branch(branch_name, user: user)
212

213
    after_remove_branch
214
    true
215 216
  end

Lin Jen-Shin's avatar
Lin Jen-Shin committed
217
  def rm_tag(user, tag_name)
218
    before_remove_tag
219

220
    raw_repository.rm_tag(tag_name, user: user)
Lin Jen-Shin's avatar
Lin Jen-Shin committed
221 222 223

    after_remove_tag
    true
224 225
  end

226 227 228 229
  def ref_names
    branch_names + tag_names
  end

230
  def branch_exists?(branch_name)
231 232
    return false unless raw_repository

233
    branch_names.include?(branch_name)
234 235
  end

236
  def ref_exists?(ref)
237 238
    !!raw_repository&.ref_exists?(ref)
  rescue ArgumentError
239
    false
240 241
  end

242 243 244 245
  # 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.
246
  def keep_around(sha)
247
    return unless sha && commit_by(oid: sha)
248 249 250

    return if kept_around?(sha)

251 252
    # This will still fail if the file is corrupted (e.g. 0 bytes)
    begin
253 254 255 256
      write_ref(keep_around_ref_name(sha), sha, force: true)
    rescue Gitlab::Git::Repository::GitError => ex
      # Necessary because https://gitlab.com/gitlab-org/gitlab-ce/issues/20156
      return true if ex.message =~ /Failed to create locked file/ && ex.message =~ /File exists/
257

258
      Rails.logger.error "Unable to create #{REF_KEEP_AROUND} reference for repository #{path}: #{ex}"
259
    end
260 261 262
  end

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

266
  def diverging_commit_counts(branch)
267
    root_ref_hash = raw_repository.commit(root_ref).id
Jeff Stubler's avatar
Jeff Stubler committed
268
    cache.fetch(:"diverging_commit_counts_#{branch.name}") do
269 270
      # Rugged seems to throw a `ReferenceError` when given branch_names rather
      # than SHA-1 hashes
271 272
      number_commits_behind = raw_repository
        .count_commits_between(branch.dereferenced_target.sha, root_ref_hash)
273

274 275
      number_commits_ahead = raw_repository
        .count_commits_between(root_ref_hash, branch.dereferenced_target.sha)
276

277 278 279
      { behind: number_commits_behind, ahead: number_commits_ahead }
    end
  end
280

281 282 283
  def expire_tags_cache
    expire_method_caches(%i(tag_names tag_count))
    @tags = nil
284
  end
285

286
  def expire_branches_cache
287
    expire_method_caches(%i(branch_names branch_count has_visible_content?))
288
    @local_branches = nil
289
    @branch_exists_memo = nil
290 291
  end

292 293
  def expire_statistics_caches
    expire_method_caches(%i(size commit_count))
294 295
  end

296 297
  def expire_all_method_caches
    expire_method_caches(CACHED_METHODS)
298 299
  end

300 301 302 303 304 305 306 307 308
  # Expires the caches of a specific set of methods
  def expire_method_caches(methods)
    methods.each do |key|
      cache.expire(key)

      ivar = cache_instance_variable_name(key)

      remove_instance_variable(ivar) if instance_variable_defined?(ivar)
    end
309 310
  end

311 312 313 314 315 316 317 318 319 320 321 322 323 324 325
  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)
    to_refresh = []

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

      to_refresh.concat(Array(methods)) if methods
326
    end
327

328
    expire_method_caches(to_refresh)
329

330
    to_refresh.each { |method| send(method) } # rubocop:disable GitlabSecurity/PublicSend
331
  end
332

333 334 335 336 337 338 339
  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}")
340
        cache.expire(:"commit_count_#{branch.name}")
341 342 343 344 345
      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}")
346
      cache.expire(:"commit_count_#{branch_name}")
347
    end
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
348 349
  end

350
  def expire_root_ref_cache
351
    expire_method_caches(%i(root_ref))
352 353
  end

354 355
  # Expires the cache(s) used to determine if a repository is empty or not.
  def expire_emptiness_caches
356
    return unless empty?
357

358
    expire_method_caches(%i(empty? has_visible_content?))
359 360
  end

361 362 363 364
  def lookup_cache
    @lookup_cache ||= {}
  end

365
  def expire_exists_cache
366
    expire_method_caches(%i(exists?))
367 368
  end

369 370 371 372 373 374 375
  # 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
376
    expire_statistics_caches
377 378 379 380 381
  end

  # Runs code after a repository has been created.
  def after_create
    expire_exists_cache
382 383
    expire_root_ref_cache
    expire_emptiness_caches
384 385

    repository_event(:create_repository)
386 387
  end

388 389
  # Runs code just before a repository is deleted.
  def before_delete
390
    expire_exists_cache
391 392
    expire_all_method_caches
    expire_branch_cache if exists?
393
    expire_content_cache
394 395

    repository_event(:remove_repository)
396 397 398 399 400 401 402
  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
403 404

    repository_event(:change_default_branch)
405 406
  end

407 408
  # Runs code before pushing (= creating or removing) a tag.
  def before_push_tag
409 410
    expire_statistics_caches
    expire_emptiness_caches
411
    expire_tags_cache
412 413

    repository_event(:push_tag)
414 415 416 417 418
  end

  # Runs code before removing a tag.
  def before_remove_tag
    expire_tags_cache
419
    expire_statistics_caches
420 421

    repository_event(:remove_tag)
422 423
  end

Lin Jen-Shin's avatar
Lin Jen-Shin committed
424 425 426 427 428
  # Runs code after removing a tag.
  def after_remove_tag
    expire_tags_cache
  end

429 430 431
  # Runs code after the HEAD of a repository is changed.
  def after_change_head
    expire_method_caches(METHOD_CACHES_FOR_FILE_TYPES.keys)
432 433
  end

434 435
  # Runs code after a repository has been forked/imported.
  def after_import
436
    expire_content_cache
437 438 439
  end

  # Runs code after a new commit has been pushed.
440 441 442
  def after_push_commit(branch_name)
    expire_statistics_caches
    expire_branch_cache(branch_name)
443 444

    repository_event(:push_commit, branch: branch_name)
445 446 447 448
  end

  # Runs code after a new branch has been created.
  def after_create_branch
449
    expire_branches_cache
450 451

    repository_event(:push_branch)
452 453
  end

454 455 456
  # Runs code before removing an existing branch.
  def before_remove_branch
    expire_branches_cache
457 458

    repository_event(:remove_branch)
459 460
  end

461 462
  # Runs code after an existing branch has been removed.
  def after_remove_branch
463
    expire_branches_cache
464 465
  end

466
  def method_missing(m, *args, &block)
467 468
    if m == :lookup && !block_given?
      lookup_cache[m] ||= {}
469
      lookup_cache[m][args.join(":")] ||= raw_repository.__send__(m, *args, &block) # rubocop:disable GitlabSecurity/PublicSend
470
    else
471
      raw_repository.__send__(m, *args, &block) # rubocop:disable GitlabSecurity/PublicSend
472
    end
473 474
  end

475 476
  def respond_to_missing?(method, include_private = false)
    raw_repository.respond_to?(method, include_private) || super
477
  end
478 479

  def blob_at(sha, path)
480
    Blob.decorate(raw_repository.blob_at(sha, path), project)
Douwe Maan's avatar
Douwe Maan committed
481 482
  rescue Gitlab::Git::Repository::NoRepository
    nil
483
  end
484

485 486 487 488 489
  # 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

490 491 492 493 494 495 496
  def root_ref
    if raw_repository
      raw_repository.root_ref
    else
      # When the repo does not exist we raise this error so no data is cached.
      raise Rugged::ReferenceError
    end
497
  end
498
  cache_method :root_ref
499

500
  # Gitaly migration: https://gitlab.com/gitlab-org/gitaly/issues/314
501
  def exists?
502
    return false unless full_path
503

504
    raw_repository.exists?
505 506 507
  end
  cache_method :exists?

508 509 510 511 512
  def empty?
    return true unless exists?

    !has_visible_content?
  end
513 514 515 516 517 518 519 520 521 522 523 524 525
  cache_method :empty?

  # 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

526
  def commit_count_for_ref(ref)
527
    return 0 unless exists?
528

529 530 531 532
    begin
      cache.fetch(:"commit_count_#{ref}") { raw_repository.commit_count(ref) }
    rescue Rugged::ReferenceError
      0
533 534 535
    end
  end

536
  delegate :branch_names, to: :raw_repository
537 538
  cache_method :branch_names, fallback: []

Douwe Maan's avatar
Douwe Maan committed
539
  delegate :tag_names, to: :raw_repository
540 541
  cache_method :tag_names, fallback: []

542
  delegate :branch_count, :tag_count, :has_visible_content?, to: :raw_repository
543 544
  cache_method :branch_count, fallback: 0
  cache_method :tag_count, fallback: 0
545
  cache_method :has_visible_content?, fallback: false
546 547

  def avatar
548 549 550 551 552
    # 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
553 554
    end
  end
555
  cache_method :avatar
556

557 558 559 560 561 562 563 564 565 566
  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: []

567
  def readme
568 569
    if readme = tree(:head)&.readme
      ReadmeBlob.new(readme, self)
570
    end
571 572
  end

573
  def rendered_readme
574
    MarkupHelper.markup_unsafe(readme.name, readme.data, project: project) if readme
575 576
  end
  cache_method :rendered_readme
577

578
  def contribution_guide
579
    file_on_head(:contributing)
580
  end
581
  cache_method :contribution_guide
582 583

  def changelog
584
    file_on_head(:changelog)
585
  end
586
  cache_method :changelog
587

588
  def license_blob
589
    file_on_head(:license)
590
  end
591
  cache_method :license_blob
592

593
  def license_key
594
    return unless exists?
595

596
    Licensee.license(path).try(:key)
597
  end
598
  cache_method :license_key
599

600 601
  def license
    return unless license_key
602

603
    Licensee::License.new(license_key)
604
  end
605
  cache_method :license, memoize_only: true
606 607

  def gitignore
608
    file_on_head(:gitignore)
609
  end
610
  cache_method :gitignore
611 612

  def koding_yml
613
    file_on_head(:koding)
614
  end
615
  cache_method :koding_yml
616

617
  def gitlab_ci_yml
618
    file_on_head(:gitlab_ci)
619
  end
620
  cache_method :gitlab_ci_yml
621

622
  def head_commit
623 624 625 626
    @head_commit ||= commit(self.root_ref)
  end

  def head_tree
627 628 629
    if head_commit
      @head_tree ||= Tree.new(self, head_commit.sha, nil)
    end
630 631
  end

632
  def tree(sha = :head, path = nil, recursive: false)
633
    if sha == :head
634 635
      return unless head_commit

636 637 638 639 640
      if path.nil?
        return head_tree
      else
        sha = head_commit.sha
      end
641 642
    end

643
    Tree.new(self, sha, path, recursive: recursive)
644
  end
645 646

  def blob_at_branch(branch_name, path)
647
    last_commit = commit(branch_name)
648

649 650 651 652 653
    if last_commit
      blob_at(last_commit.sha, path)
    else
      nil
    end
654
  end
655

656
  def last_commit_for_path(sha, path)
657 658 659 660 661 662 663
    raw_repository.gitaly_migrate(:last_commit_for_path) do |is_enabled|
      if is_enabled
        last_commit_for_path_by_gitaly(sha, path)
      else
        last_commit_for_path_by_rugged(sha, path)
      end
    end
664
  end
665

Hiroyuki Sato's avatar
Hiroyuki Sato committed
666 667
  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
668

669
    cache.fetch(key) do
670 671 672 673 674 675 676
      raw_repository.gitaly_migrate(:last_commit_for_path) do |is_enabled|
        if is_enabled
          last_commit_for_path_by_gitaly(sha, path).id
        else
          last_commit_id_for_path_by_shelling_out(sha, path)
        end
      end
677 678 679
    end
  end

680
  def next_branch(name, opts = {})
681 682
    branch_ids = self.branch_names.map do |n|
      next 1 if n == name
683

684
      result = n.match(/\A#{name}-([0-9]+)\z/)
685 686 687
      result[1].to_i if result
    end.compact

688
    highest_branch_id = branch_ids.max || 0
689

690 691 692
    return name if opts[:mild] && 0 == highest_branch_id

    "#{name}-#{highest_branch_id + 1}"
693 694
  end

695
  def branches_sorted_by(value)
696
    raw_repository.local_branches(sort_by: value)
697
  end
698

699 700
  def tags_sorted_by(value)
    case value
haseeb's avatar
haseeb committed
701 702 703
    when 'name_asc'
      VersionSorter.sort(tags) { |tag| tag.name }
    when 'name_desc'
704
      VersionSorter.rsort(tags) { |tag| tag.name }
705 706 707 708 709 710 711 712 713
    when 'updated_desc'
      tags_sorted_by_committed_date.reverse
    when 'updated_asc'
      tags_sorted_by_committed_date
    else
      tags
    end
  end

714 715 716 717 718
  # Params:
  #
  # order_by: name|email|commits
  # sort: asc|desc default: 'asc'
  def contributors(order_by: nil, sort: 'asc')
719
    commits = self.commits(nil, limit: 2000, offset: 0, skip_merges: true)
720

721
    commits = commits.group_by(&:author_email).map do |email, commits|
722 723
      contributor = Gitlab::Contributor.new
      contributor.email = email
724

725
      commits.each do |commit|
726
        if contributor.name.blank?
727
          contributor.name = commit.author_name
728 729
        end

730
        contributor.commits += 1
731 732
      end

733 734
      contributor
    end
735
    Commit.order_by(collection: commits, order_by: order_by, sort: sort)
736
  end
737

738
  def refs_contains_sha(ref_type, sha)
739 740
    args = %W(#{ref_type} --contains #{sha})
    names = run_git(args).first
741 742 743 744 745 746 747 748 749 750 751 752 753

    if names.respond_to?(:split)
      names = names.split("\n").map(&:strip)

      names.each do |name|
        name.slice! '* '
      end

      names
    else
      []
    end
  end
754

755 756 757
  def branch_names_contains(sha)
    refs_contains_sha('branch', sha)
  end
758

759 760
  def tag_names_contains(sha)
    refs_contains_sha('tag', sha)
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

Douwe Maan's avatar
Douwe Maan committed
773 774 775
  def create_dir(user, path, **options)
    options[:user] = user
    options[:actions] = [{ action: :create_dir, file_path: path }]
776

Douwe Maan's avatar
Douwe Maan committed
777
    multi_action(**options)
Stan Hu's avatar
Stan Hu committed
778 779
  end

Douwe Maan's avatar
Douwe Maan committed
780 781 782
  def create_file(user, path, content, **options)
    options[:user] = user
    options[:actions] = [{ action: :create, file_path: path, content: content }]
783

Douwe Maan's avatar
Douwe Maan committed
784
    multi_action(**options)
Stan Hu's avatar
Stan Hu committed
785
  end
786

Douwe Maan's avatar
Douwe Maan committed
787 788 789
  def update_file(user, path, content, **options)
    previous_path = options.delete(:previous_path)
    action = previous_path && previous_path != path ? :move : :update
790

Douwe Maan's avatar
Douwe Maan committed
791 792
    options[:user] = user
    options[:actions] = [{ action: action, file_path: path, previous_path: previous_path, content: content }]
793

Douwe Maan's avatar
Douwe Maan committed
794
    multi_action(**options)
795 796
  end

Douwe Maan's avatar
Douwe Maan committed
797 798 799
  def delete_file(user, path, **options)
    options[:user] = user
    options[:actions] = [{ action: :delete, file_path: path }]
800

Douwe Maan's avatar
Douwe Maan committed
801
    multi_action(**options)
802 803
  end

804 805
  def with_cache_hooks
    result = yield
806

807
    return unless result
808

809 810
    after_create if result.repo_created?
    after_create_branch if result.branch_created?
811

812 813 814 815 816 817 818 819 820
    result.newrev
  end

  def with_branch(user, *args)
    with_cache_hooks do
      Gitlab::Git::OperationService.new(user, raw_repository).with_branch(*args) do |start_commit|
        yield start_commit
      end
    end
821 822
  end

823
  # rubocop:disable Metrics/ParameterLists
824
  def multi_action(
825
    user:, branch_name:, message:, actions:,
826
    author_email: nil, author_name: nil,
827
    start_branch_name: nil, start_project: project)
828

829 830
    with_branch(
      user,
831
      branch_name,
832
      start_branch_name: start_branch_name,
833
      start_repository: start_project.repository.raw_repository) do |start_commit|
834

835
      index = Gitlab::Git::Index.new(raw_repository)
836

837
      if start_commit
838
        index.read_tree(start_commit.rugged_commit.tree)
839 840 841
        parents = [start_commit.sha]
      else
        parents = []
Marc Siegfriedt's avatar
Marc Siegfriedt committed
842 843
      end

844
      actions.each do |options|
845
        index.public_send(options.delete(:action), options) # rubocop:disable GitlabSecurity/PublicSend
Marc Siegfriedt's avatar
Marc Siegfriedt committed
846 847 848
      end

      options = {
849
        tree: index.write_tree,
Marc Siegfriedt's avatar
Marc Siegfriedt committed
850 851 852 853 854
        message: message,
        parents: parents
      }
      options.merge!(get_committer_and_author(user, email: author_email, name: author_name))

855
      create_commit(options)
Marc Siegfriedt's avatar
Marc Siegfriedt committed
856 857
    end
  end
858
  # rubocop:enable Metrics/ParameterLists
Marc Siegfriedt's avatar
Marc Siegfriedt committed
859

860 861
  def get_committer_and_author(user, email: nil, name: nil)
    committer = user_to_committer(user)
862
    author = Gitlab::Git.committer_hash(email: email, name: name) || committer
863

864
    {
865 866
      author: author,
      committer: committer
867 868 869 870 871 872 873 874 875 876 877 878 879 880
    }
  end

  def can_be_merged?(source_sha, target_branch)
    our_commit = rugged.branches[target_branch].target
    their_commit = rugged.lookup(source_sha)

    if our_commit && their_commit
      !rugged.merge_commits(our_commit, their_commit).conflicts?
    else
      false
    end
  end

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

890
  def ff_merge(user, source, target_branch, merge_request: nil)
891 892
    their_commit_id = commit(source)&.id
    raise 'Invalid merge source' if their_commit_id.nil?
893

894
    merge_request&.update(in_progress_merge_commit_sha: their_commit_id)
895

896
    with_cache_hooks { raw.ff_merge(user, their_commit_id, target_branch) }
897 898
  end

899
  def revert(
900
    user, commit, branch_name, message,
901
    start_branch_name: nil, start_project: project)
902

903 904 905 906 907 908 909 910 911
    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
      )
912
    end
913 914
  end

915
  def cherry_pick(
916
    user, commit, branch_name, message,
917
    start_branch_name: nil, start_project: project)
918

919 920 921 922 923 924 925 926 927
    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
      )
928 929 930
    end
  end

931
  def merged_to_root_ref?(branch_or_name)
932 933 934
    branch = Gitlab::Git::Branch.find(self, branch_or_name)

    if branch
935 936
      @root_ref_sha ||= commit(root_ref).sha
      same_head = branch.target == @root_ref_sha
937
      merged = ancestor?(branch.target, @root_ref_sha)
938
      !same_head && merged
939 940 941 942 943
    else
      nil
    end
  end

944 945
  delegate :merged_branch_names, to: :raw_repository

946
  def merge_base(first_commit_id, second_commit_id)
947 948
    first_commit_id = commit(first_commit_id).try(:id) || first_commit_id
    second_commit_id = commit(second_commit_id).try(:id) || second_commit_id
949
    raw_repository.merge_base(first_commit_id, second_commit_id)
Douwe Maan's avatar
Douwe Maan committed
950 951
  rescue Rugged::ReferenceError
    nil
952 953
  end

954
  def ancestor?(ancestor_id, descendant_id)
955
    return false if ancestor_id.nil? || descendant_id.nil?
956

957 958
    Gitlab::GitalyClient.migrate(:is_ancestor) do |is_enabled|
      if is_enabled
959
        raw_repository.ancestor?(ancestor_id, descendant_id)
960
      else
961
        rugged_is_ancestor?(ancestor_id, descendant_id)
962 963
      end
    end
964 965
  end

966
  def search_files_by_content(query, ref)
967
    return [] if empty? || query.blank?
Valery Sizov's avatar
Valery Sizov committed
968

969
    offset = 2
970 971 972
    args = %W(grep -i -I -n --before-context #{offset} --after-context #{offset} -E -e #{Regexp.escape(query)} #{ref || root_ref})

    run_git(args).first.scrub.split(/^--$/)
973 974
  end

975
  def search_files_by_name(query, ref)
976
    return [] if empty? || query.blank?
977

978 979 980
    args = %W(ls-tree --full-tree -r #{ref || root_ref} --name-status | #{Regexp.escape(query)})

    run_git(args).first.lines.map(&:strip)
981 982
  end

Douwe Maan's avatar
Douwe Maan committed
983
  def fetch_as_mirror(url, forced: false, refmap: :all_refs, remote_name: nil)
984 985 986 987 988
    unless remote_name
      remote_name = "tmp-#{SecureRandom.hex}"
      tmp_remote_name = true
    end

989
    add_remote(remote_name, url, mirror_refmap: refmap)
990 991 992 993 994
    fetch_remote(remote_name, forced: forced)
  ensure
    remove_remote(remote_name) if tmp_remote_name
  end

995 996
  def fetch_remote(remote, forced: false, ssh_auth: nil, no_tags: false)
    gitlab_shell.fetch_remote(raw_repository, remote, ssh_auth: ssh_auth, forced: forced, no_tags: no_tags)
997 998
  end

999 1000
  def fetch_source_branch!(source_repository, source_branch, local_ref)
    raw_repository.fetch_source_branch!(source_repository.raw_repository, source_branch, local_ref)
1001
  end
1002

1003 1004 1005 1006
  def remote_exists?(name)
    raw_repository.remote_exists?(name)
  end

1007 1008
  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)
1009
  end
1010

1011
  def create_ref(ref, ref_path)
1012
    write_ref(ref_path, ref)
1013 1014
  end

1015 1016 1017 1018 1019
  def ls_files(ref)
    actual_ref = ref || root_ref
    raw_repository.ls_files(actual_ref)
  end

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

1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040
  # Caches the supplied block both in a cache and in an instance variable.
  #
  # The cache key and instance variable are named the same way as the value of
  # the `key` argument.
  #
  # This method will return `nil` if the corresponding instance variable is also
  # set to `nil`. This ensures we don't keep yielding the block when it returns
  # `nil`.
  #
  # key - The name of the key to cache the data in.
  # fallback - A value to fall back to in the event of a Git error.
1041
  def cache_method_output(key, fallback: nil, memoize_only: false, &block)
1042
    ivar = cache_instance_variable_name(key)
1043

1044 1045 1046
    if instance_variable_defined?(ivar)
      instance_variable_get(ivar)
    else
1047 1048 1049 1050
      # If the repository doesn't exist and a fallback was specified we return
      # that value inmediately. This saves us Rugged/gRPC invocations.
      return fallback unless fallback.nil? || exists?

1051
      begin
1052 1053 1054 1055 1056 1057 1058
        value =
          if memoize_only
            yield
          else
            cache.fetch(key, &block)
          end
        instance_variable_set(ivar, value)
1059
      rescue Rugged::ReferenceError, Gitlab::Git::Repository::NoRepository
1060 1061 1062
        # Even if the above `#exists?` check passes these errors might still
        # occur (for example because of a non-existing HEAD). We want to
        # gracefully handle this and not cache anything
1063
        fallback
1064 1065 1066
      end
    end
  end
1067

1068 1069 1070
  def cache_instance_variable_name(key)
    :"@#{key.to_s.tr('?!', '')}"
  end
1071

1072 1073
  def file_on_head(type)
    if head = tree(:head)
1074 1075
      head.blobs.find do |blob|
        Gitlab::FileDetector.type_of(blob.path) == type
1076 1077 1078 1079
      end
    end
  end

Douwe Maan's avatar
Douwe Maan committed
1080 1081 1082 1083
  def route_map_for(sha)
    blob_data_at(sha, '.gitlab/route-map.yml')
  end

1084 1085
  def gitlab_ci_yml_for(sha, path = '.gitlab-ci.yml')
    blob_data_at(sha, path)
Douwe Maan's avatar
Douwe Maan committed
1086 1087
  end

1088 1089 1090 1091
  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

1092 1093 1094 1095
  def repository_storage_path
    @project.repository_storage_path
  end

1096 1097
  private

1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109
  # 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

Douwe Maan's avatar
Douwe Maan committed
1110 1111
  def blob_data_at(sha, path)
    blob = blob_at(sha, path)
1112
    return unless blob
1113

1114
    blob.load_all_data!
1115
    blob.data
1116
  end
1117

1118
  def cache
1119 1120
    # TODO: should we use UUIDs here? We could move repositories without clearing this cache
    @cache ||= RepositoryCache.new(full_path, @project.id)
1121
  end
1122 1123

  def tags_sorted_by_committed_date
1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135
    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
1136
  end
1137 1138

  def keep_around_ref_name(sha)
1139
    "refs/#{REF_KEEP_AROUND}/#{sha}"
1140
  end
1141 1142

  def repository_event(event, tags = {})
1143
    Gitlab::Metrics.add_event(event, { path: full_path }.merge(tags))
1144
  end
1145