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

3
class Repository
4
  include Gitlab::ShellAdapter
5
  include RepositoryMirroring
6

7
  attr_accessor :path_with_namespace, :project
8

9 10
  delegate :ref_name_for_sha, to: :raw_repository

11
  CommitError = Class.new(StandardError)
12
  CreateTreeError = Class.new(StandardError)
13

14 15 16 17 18 19 20 21 22 23 24
  # 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.
  #
  # For example, for entry `:readme` there's a method called `readme` which
  # stores its data in the `readme` cache key.
  CACHED_METHODS = %i(size commit_count readme version contribution_guide
                      changelog license_blob license_key gitignore koding_yml
                      gitlab_ci_yml branch_names tag_names branch_count
Douwe Maan's avatar
Douwe Maan committed
25
                      tag_count avatar exists? empty? root_ref).freeze
26 27 28 29 30 31 32 33 34 35 36 37 38 39

  # 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 = {
    readme: :readme,
    changelog: :changelog,
    license: %i(license_blob license_key),
    contributing: :contribution_guide,
    version: :version,
    gitignore: :gitignore,
    koding: :koding_yml,
    gitlab_ci: :gitlab_ci_yml,
    avatar: :avatar
Douwe Maan's avatar
Douwe Maan committed
40
  }.freeze
41 42 43 44 45 46 47

  # 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.
  def self.cache_method(name, fallback: nil)
    original = :"_uncached_#{name}"
48

49
    alias_method(original, name)
50

51 52
    define_method(name) do
      cache_method_output(name, fallback: fallback) { __send__(original) }
53
    end
54
  end
55

56
  def initialize(path_with_namespace, project)
57
    @path_with_namespace = path_with_namespace
58
    @project = project
59
  end
60

61 62
  def raw_repository
    return nil unless path_with_namespace
63

64
    @raw_repository ||= initialize_raw_repository
65 66
  end

67
  # Return absolute path to repository
68
  def path_to_repo
69
    @path_to_repo ||= File.expand_path(
70
      File.join(repository_storage_path, path_with_namespace + ".git")
71
    )
72 73
  end

74 75 76 77 78 79 80 81 82 83
  #
  # Git repository can contains some hidden refs like:
  #   /refs/notes/*
  #   /refs/git-as-svn/*
  #   /refs/pulls/*
  # This refs by default not visible in project page and not cloned to client side.
  #
  # This method return true if repository contains some content visible in project page.
  #
  def has_visible_content?
84
    branch_count > 0
85 86
  end

87
  def commit(ref = 'HEAD')
88
    return nil unless exists?
89

90 91 92 93 94 95
    commit =
      if ref.is_a?(Gitlab::Git::Commit)
        ref
      else
        Gitlab::Git::Commit.find(raw_repository, ref)
      end
96

97
    commit = ::Commit.new(commit, @project) if commit
98
    commit
99
  rescue Rugged::OdbError, Rugged::TreeError
100
    nil
101 102
  end

103
  def commits(ref, path: nil, limit: nil, offset: nil, skip_merges: false, after: nil, before: nil)
104
    options = {
105 106 107 108 109
      repo: raw_repository,
      ref: ref,
      path: path,
      limit: limit,
      offset: offset,
110 111
      after: after,
      before: before,
112
      follow: path.present?,
113
      skip_merges: skip_merges
114 115 116
    }

    commits = Gitlab::Git::Commit.where(options)
117
    commits = Commit.decorate(commits, @project) if commits.present?
118 119 120
    commits
  end

121 122
  def commits_between(from, to)
    commits = Gitlab::Git::Commit.between(raw_repository, from, to)
123
    commits = Commit.decorate(commits, @project) if commits.present?
124 125 126
    commits
  end

127
  def find_commits_by_message(query, ref = nil, path = nil, limit = 1000, offset = 0)
128 129 130 131
    unless exists? && has_visible_content? && query.present?
      return []
    end

132 133
    ref ||= root_ref

134 135 136 137
    args = %W(
      #{Gitlab.config.git.bin_path} log #{ref} --pretty=%H --skip #{offset}
      --max-count #{limit} --grep=#{query} --regexp-ignore-case
    )
138
    args = args.concat(%W(-- #{path})) if path.present?
139

140 141
    git_log_results = Gitlab::Popen.popen(args, path_to_repo).first.lines
    git_log_results.map { |c| commit(c.chomp) }.compact
142 143
  end

144 145 146 147 148 149 150
  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
151
    raw_repo = fresh_repo ? initialize_raw_repository : raw_repository
152 153

    raw_repo.find_branch(name)
154 155 156
  end

  def find_tag(name)
157
    tags.find { |tag| tag.name == name }
158 159
  end

160 161
  def add_branch(user, branch_name, ref)
    newrev = commit(ref).try(:sha)
162

163
    return false unless newrev
164

165
    GitOperationService.new(user, self).add_branch(branch_name, newrev)
166

167
    after_create_branch
168
    find_branch(branch_name)
169 170
  end

171
  def add_tag(user, tag_name, target, message = nil)
172
    newrev = commit(target).try(:id)
173 174
    options = { message: message, tagger: user_to_committer(user) } if message

175 176 177
    return false unless newrev

    GitOperationService.new(user, self).add_tag(tag_name, newrev, options)
178

179
    find_tag(tag_name)
180 181
  end

182
  def rm_branch(user, branch_name)
183
    before_remove_branch
184 185
    branch = find_branch(branch_name)

186
    GitOperationService.new(user, self).rm_branch(branch)
187

188
    after_remove_branch
189
    true
190 191
  end

Lin Jen-Shin's avatar
Lin Jen-Shin committed
192
  def rm_tag(user, tag_name)
193
    before_remove_tag
Lin Jen-Shin's avatar
Lin Jen-Shin committed
194
    tag = find_tag(tag_name)
195

Lin Jen-Shin's avatar
Lin Jen-Shin committed
196 197 198 199
    GitOperationService.new(user, self).rm_tag(tag)

    after_remove_tag
    true
200 201
  end

202 203 204 205
  def ref_names
    branch_names + tag_names
  end

206 207 208 209
  def branch_exists?(branch_name)
    branch_names.include?(branch_name)
  end

210 211
  def ref_exists?(ref)
    rugged.references.exist?(ref)
212 213
  rescue Rugged::ReferenceError
    false
214 215
  end

216 217 218 219
  # 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.
220 221 222 223 224
  def keep_around(sha)
    return unless sha && commit(sha)

    return if kept_around?(sha)

225 226 227 228 229
    # This will still fail if the file is corrupted (e.g. 0 bytes)
    begin
      rugged.references.create(keep_around_ref_name(sha), sha, force: true)
    rescue Rugged::ReferenceError => ex
      Rails.logger.error "Unable to create keep-around reference for repository #{path}: #{ex}"
230 231 232
    rescue Rugged::OSError => ex
      raise unless ex.message =~ /Failed to create locked file/ && ex.message =~ /File exists/
      Rails.logger.error "Unable to create keep-around reference for repository #{path}: #{ex}"
233
    end
234 235 236
  end

  def kept_around?(sha)
237
    ref_exists?(keep_around_ref_name(sha))
238 239
  end

240
  def diverging_commit_counts(branch)
241
    root_ref_hash = raw_repository.rev_parse_target(root_ref).oid
Jeff Stubler's avatar
Jeff Stubler committed
242
    cache.fetch(:"diverging_commit_counts_#{branch.name}") do
243 244
      # Rugged seems to throw a `ReferenceError` when given branch_names rather
      # than SHA-1 hashes
245 246
      number_commits_behind = raw_repository.
        count_commits_between(branch.dereferenced_target.sha, root_ref_hash)
247

248 249
      number_commits_ahead = raw_repository.
        count_commits_between(root_ref_hash, branch.dereferenced_target.sha)
250

251 252 253
      { behind: number_commits_behind, ahead: number_commits_ahead }
    end
  end
254

255 256 257
  def expire_tags_cache
    expire_method_caches(%i(tag_names tag_count))
    @tags = nil
258
  end
259

260 261 262
  def expire_branches_cache
    expire_method_caches(%i(branch_names branch_count))
    @local_branches = nil
263 264
  end

265 266
  def expire_statistics_caches
    expire_method_caches(%i(size commit_count))
267 268
  end

269 270
  def expire_all_method_caches
    expire_method_caches(CACHED_METHODS)
271 272
  end

273 274 275 276 277 278 279 280 281
  # 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
282 283
  end

284 285 286 287 288 289 290 291 292 293 294 295 296 297 298
  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
299
    end
300

301
    expire_method_caches(to_refresh)
302

303
    to_refresh.each { |method| send(method) }
304
  end
305

306 307 308 309 310 311 312
  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}")
313
        cache.expire(:"commit_count_#{branch.name}")
314 315 316 317 318
      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}")
319
      cache.expire(:"commit_count_#{branch_name}")
320
    end
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
321 322
  end

323
  def expire_root_ref_cache
324
    expire_method_caches(%i(root_ref))
325 326
  end

327 328
  # Expires the cache(s) used to determine if a repository is empty or not.
  def expire_emptiness_caches
329
    return unless empty?
330

331
    expire_method_caches(%i(empty?))
332 333
  end

334 335 336 337
  def lookup_cache
    @lookup_cache ||= {}
  end

338
  def expire_exists_cache
339
    expire_method_caches(%i(exists?))
340 341
  end

342 343 344 345 346 347 348
  # 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
349
    expire_statistics_caches
350 351
  end

352 353 354
  # Runs code after a repository has been created.
  def after_create
    expire_exists_cache
355 356
    expire_root_ref_cache
    expire_emptiness_caches
Yorick Peterse's avatar
Yorick Peterse committed
357 358

    repository_event(:create_repository)
359 360
  end

361 362
  # Runs code just before a repository is deleted.
  def before_delete
363
    expire_exists_cache
364 365
    expire_all_method_caches
    expire_branch_cache if exists?
366
    expire_content_cache
Yorick Peterse's avatar
Yorick Peterse committed
367 368

    repository_event(:remove_repository)
369 370 371 372 373 374 375
  end

  # Runs code just before the HEAD of a repository is changed.
  def before_change_head
    # Cached divergent commit counts are based on repository head
    expire_branch_cache
    expire_root_ref_cache
Yorick Peterse's avatar
Yorick Peterse committed
376 377

    repository_event(:change_default_branch)
378 379
  end

380 381
  # Runs code before pushing (= creating or removing) a tag.
  def before_push_tag
382 383
    expire_statistics_caches
    expire_emptiness_caches
384
    expire_tags_cache
Yorick Peterse's avatar
Yorick Peterse committed
385 386

    repository_event(:push_tag)
387 388 389 390 391
  end

  # Runs code before removing a tag.
  def before_remove_tag
    expire_tags_cache
392
    expire_statistics_caches
Yorick Peterse's avatar
Yorick Peterse committed
393 394

    repository_event(:remove_tag)
395 396
  end

Lin Jen-Shin's avatar
Lin Jen-Shin committed
397 398 399 400 401
  # Runs code after removing a tag.
  def after_remove_tag
    expire_tags_cache
  end

402 403 404 405 406
  # Runs code after the HEAD of a repository is changed.
  def after_change_head
    expire_method_caches(METHOD_CACHES_FOR_FILE_TYPES.keys)
  end

407 408
  # Runs code after a repository has been forked/imported.
  def after_import
409
    expire_content_cache
410 411
    expire_tags_cache
    expire_branches_cache
412 413 414
  end

  # Runs code after a new commit has been pushed.
415 416 417
  def after_push_commit(branch_name)
    expire_statistics_caches
    expire_branch_cache(branch_name)
Yorick Peterse's avatar
Yorick Peterse committed
418 419

    repository_event(:push_commit, branch: branch_name)
420 421 422 423
  end

  # Runs code after a new branch has been created.
  def after_create_branch
424
    expire_branches_cache
Yorick Peterse's avatar
Yorick Peterse committed
425 426

    repository_event(:push_branch)
427 428
  end

429 430 431
  # Runs code before removing an existing branch.
  def before_remove_branch
    expire_branches_cache
Yorick Peterse's avatar
Yorick Peterse committed
432 433

    repository_event(:remove_branch)
434 435
  end

436 437
  # Runs code after an existing branch has been removed.
  def after_remove_branch
438
    expire_branches_cache
439 440
  end

441
  def method_missing(m, *args, &block)
442 443 444 445 446 447
    if m == :lookup && !block_given?
      lookup_cache[m] ||= {}
      lookup_cache[m][args.join(":")] ||= raw_repository.send(m, *args, &block)
    else
      raw_repository.send(m, *args, &block)
    end
448 449
  end

450 451
  def respond_to_missing?(method, include_private = false)
    raw_repository.respond_to?(method, include_private) || super
452
  end
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
453 454

  def blob_at(sha, path)
455
    unless Gitlab::Git.blank_ref?(sha)
456
      Blob.decorate(Gitlab::Git::Blob.find(self, sha, path))
457
    end
Douwe Maan's avatar
Douwe Maan committed
458 459
  rescue Gitlab::Git::Repository::NoRepository
    nil
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
460
  end
461

462 463 464 465
  def blob_by_oid(oid)
    Gitlab::Git::Blob.raw(self, oid)
  end

466 467 468 469 470 471 472 473 474 475 476 477 478 479 480
  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
  end
  cache_method :root_ref

  def exists?
    refs_directory_exists?
  end
  cache_method :exists?

Douwe Maan's avatar
Douwe Maan committed
481
  delegate :empty?, to: :raw_repository
482 483 484 485 486 487 488 489 490 491 492 493 494
  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

495
  def commit_count_for_ref(ref)
496
    return 0 unless exists?
497

498 499 500 501
    begin
      cache.fetch(:"commit_count_#{ref}") { raw_repository.commit_count(ref) }
    rescue Rugged::ReferenceError
      0
502 503 504
    end
  end

505
  delegate :branch_names, to: :raw_repository
506 507
  cache_method :branch_names, fallback: []

Douwe Maan's avatar
Douwe Maan committed
508
  delegate :tag_names, to: :raw_repository
509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527
  cache_method :tag_names, fallback: []

  def branch_count
    branches.size
  end
  cache_method :branch_count, fallback: 0

  def tag_count
    raw_repository.rugged.tags.count
  end
  cache_method :tag_count, fallback: 0

  def avatar
    if tree = file_on_head(:avatar)
      tree.path
    end
  end
  cache_method :avatar

528
  def readme
529 530 531
    if head = tree(:head)
      head.readme
    end
532
  end
533
  cache_method :readme
534

535
  def version
536
    file_on_head(:version)
537
  end
538
  cache_method :version
539

540
  def contribution_guide
541
    file_on_head(:contributing)
542
  end
543
  cache_method :contribution_guide
544 545

  def changelog
546
    file_on_head(:changelog)
547
  end
548
  cache_method :changelog
549

550
  def license_blob
551
    file_on_head(:license)
552
  end
553
  cache_method :license_blob
554

555
  def license_key
556
    return unless exists?
557

558
    Licensee.license(path).try(:key)
559
  end
560
  cache_method :license_key
561

562
  def gitignore
563
    file_on_head(:gitignore)
564
  end
565
  cache_method :gitignore
566

567
  def koding_yml
568
    file_on_head(:koding)
569
  end
570
  cache_method :koding_yml
571

572
  def gitlab_ci_yml
573
    file_on_head(:gitlab_ci)
574
  end
575
  cache_method :gitlab_ci_yml
576

577
  def head_commit
578 579 580 581
    @head_commit ||= commit(self.root_ref)
  end

  def head_tree
582 583 584
    if head_commit
      @head_tree ||= Tree.new(self, head_commit.sha, nil)
    end
585 586
  end

587
  def tree(sha = :head, path = nil, recursive: false)
588
    if sha == :head
589 590
      return unless head_commit

591 592 593 594 595
      if path.nil?
        return head_tree
      else
        sha = head_commit.sha
      end
596 597
    end

598
    Tree.new(self, sha, path, recursive: recursive)
599
  end
600 601

  def blob_at_branch(branch_name, path)
602
    last_commit = commit(branch_name)
603

604 605 606 607 608
    if last_commit
      blob_at(last_commit.sha, path)
    else
      nil
    end
609
  end
610 611 612 613 614 615 616 617

  # Returns url for submodule
  #
  # Ex.
  #   @repository.submodule_url_for('master', 'rack')
  #   # => git@localhost:rack.git
  #
  def submodule_url_for(ref, path)
618
    if submodules(ref).any?
619 620 621 622 623 624 625
      submodule = submodules(ref)[path]

      if submodule
        submodule['url']
      end
    end
  end
626 627

  def last_commit_for_path(sha, path)
Hiroyuki Sato's avatar
Hiroyuki Sato committed
628
    sha = last_commit_id_for_path(sha, path)
629
    commit(sha)
630
  end
631

Hiroyuki Sato's avatar
Hiroyuki Sato committed
632 633
  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
634

635
    cache.fetch(key) do
Hiroyuki Sato's avatar
Hiroyuki Sato committed
636 637
      args = %W(#{Gitlab.config.git.bin_path} rev-list --max-count=1 #{sha} -- #{path})
      Gitlab::Popen.popen(args, path_to_repo).first.strip
638 639 640
    end
  end

641
  def next_branch(name, opts = {})
642 643 644
    branch_ids = self.branch_names.map do |n|
      next 1 if n == name
      result = n.match(/\A#{name}-([0-9]+)\z/)
645 646 647
      result[1].to_i if result
    end.compact

648
    highest_branch_id = branch_ids.max || 0
649

650 651 652
    return name if opts[:mild] && 0 == highest_branch_id

    "#{name}-#{highest_branch_id + 1}"
653 654
  end

655
  # Remove archives older than 2 hours
656 657
  def branches_sorted_by(value)
    case value
658 659
    when 'name'
      branches.sort_by(&:name)
660
    when 'updated_desc'
661
      branches.sort do |a, b|
662
        commit(b.dereferenced_target).committed_date <=> commit(a.dereferenced_target).committed_date
663
      end
664
    when 'updated_asc'
665
      branches.sort do |a, b|
666
        commit(a.dereferenced_target).committed_date <=> commit(b.dereferenced_target).committed_date
667 668 669 670 671
      end
    else
      branches
    end
  end
672

673 674 675
  def tags_sorted_by(value)
    case value
    when 'name'
676
      VersionSorter.rsort(tags) { |tag| tag.name }
677 678 679 680 681 682 683 684 685
    when 'updated_desc'
      tags_sorted_by_committed_date.reverse
    when 'updated_asc'
      tags_sorted_by_committed_date
    else
      tags
    end
  end

686
  def contributors
687
    commits = self.commits(nil, limit: 2000, offset: 0, skip_merges: true)
688

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
689
    commits.group_by(&:author_email).map do |email, commits|
690 691
      contributor = Gitlab::Contributor.new
      contributor.email = email
692

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
693
      commits.each do |commit|
694
        if contributor.name.blank?
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
695
          contributor.name = commit.author_name
696 697
        end

698
        contributor.commits += 1
699 700
      end

701 702
      contributor
    end
703
  end
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
704

705 706
  def refs_contains_sha(ref_type, sha)
    args = %W(#{Gitlab.config.git.bin_path} #{ref_type} --contains #{sha})
707 708 709 710 711 712 713 714 715 716 717 718 719 720
    names = Gitlab::Popen.popen(args, path_to_repo).first

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

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

      names
    else
      []
    end
  end
721

722 723 724
  def branch_names_contains(sha)
    refs_contains_sha('branch', sha)
  end
725

726 727
  def tag_names_contains(sha)
    refs_contains_sha('tag', sha)
728
  end
729

730
  def local_branches
731
    @local_branches ||= raw_repository.local_branches
732 733
  end

734 735
  alias_method :branches, :local_branches

736 737 738 739
  def tags
    @tags ||= raw_repository.tags
  end

Douwe Maan's avatar
Douwe Maan committed
740 741 742
  def create_dir(user, path, **options)
    options[:user] = user
    options[:actions] = [{ action: :create_dir, file_path: path }]
743

Douwe Maan's avatar
Douwe Maan committed
744
    multi_action(**options)
Stan Hu's avatar
Stan Hu committed
745
  end
746

Douwe Maan's avatar
Douwe Maan committed
747 748 749
  def create_file(user, path, content, **options)
    options[:user] = user
    options[:actions] = [{ action: :create, file_path: path, content: content }]
750

Douwe Maan's avatar
Douwe Maan committed
751
    multi_action(**options)
752 753
  end

Douwe Maan's avatar
Douwe Maan committed
754 755 756 757 758 759 760 761
  def update_file(user, path, content, **options)
    previous_path = options.delete(:previous_path)
    action = previous_path && previous_path != path ? :move : :update

    options[:user] = user
    options[:actions] = [{ action: action, file_path: path, previous_path: previous_path, content: content }]

    multi_action(**options)
762 763
  end

Douwe Maan's avatar
Douwe Maan committed
764 765 766
  def delete_file(user, path, **options)
    options[:user] = user
    options[:actions] = [{ action: :delete, file_path: path }]
767

Douwe Maan's avatar
Douwe Maan committed
768
    multi_action(**options)
769 770
  end

771
  # rubocop:disable Metrics/ParameterLists
Lin Jen-Shin's avatar
Lin Jen-Shin committed
772
  def multi_action(
773
    user:, branch_name:, message:, actions:,
774
    author_email: nil, author_name: nil,
775
    start_branch_name: nil, start_project: project)
Douwe Maan's avatar
Douwe Maan committed
776

777
    GitOperationService.new(user, self).with_branch(
778
      branch_name,
779 780
      start_branch_name: start_branch_name,
      start_project: start_project) do |start_commit|
781

782
      index = Gitlab::Git::Index.new(raw_repository)
Marc Siegfriedt's avatar
Marc Siegfriedt committed
783

784 785 786 787 788 789 790 791
      if start_commit
        index.read_tree(start_commit.raw_commit.tree)
        parents = [start_commit.sha]
      else
        parents = []
      end

      actions.each do |options|
Douwe Maan's avatar
Douwe Maan committed
792
        index.public_send(options.delete(:action), options)
Marc Siegfriedt's avatar
Marc Siegfriedt committed
793 794 795
      end

      options = {
796
        tree: index.write_tree,
Marc Siegfriedt's avatar
Marc Siegfriedt committed
797 798 799 800 801 802 803 804
        message: message,
        parents: parents
      }
      options.merge!(get_committer_and_author(user, email: author_email, name: author_name))

      Rugged::Commit.create(rugged, options)
    end
  end
805
  # rubocop:enable Metrics/ParameterLists
Marc Siegfriedt's avatar
Marc Siegfriedt committed
806

807 808
  def get_committer_and_author(user, email: nil, name: nil)
    committer = user_to_committer(user)
Douwe Maan's avatar
Douwe Maan committed
809
    author = Gitlab::Git.committer_hash(email: email, name: name) || committer
810

811
    {
812 813
      author: author,
      committer: committer
814 815 816
    }
  end

817
  def user_to_committer(user)
818
    Gitlab::Git.committer_hash(email: user.email, name: user.name)
819 820
  end

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

832
  def merge(user, source, merge_request, options = {})
833
    GitOperationService.new(user, self).with_branch(
834 835
      merge_request.target_branch) do |start_commit|
      our_commit = start_commit.sha
836
      their_commit = source
837

838 839
      raise 'Invalid merge target' unless our_commit
      raise 'Invalid merge source' unless their_commit
840

841 842
      merge_index = rugged.merge_commits(our_commit, their_commit)
      break if merge_index.conflicts?
843

844 845 846 847
      actual_options = options.merge(
        parents: [our_commit, their_commit],
        tree: merge_index.write_tree(rugged),
      )
848

849 850 851
      commit_id = Rugged::Commit.create(rugged, actual_options)
      merge_request.update(in_progress_merge_commit_sha: commit_id)
      commit_id
852
    end
853 854
  rescue Repository::CommitError # when merge_index.conflicts?
    false
855 856
  end

857
  def revert(
858
    user, commit, branch_name,
859
    start_branch_name: nil, start_project: project)
860
    GitOperationService.new(user, self).with_branch(
861
      branch_name,
862 863
      start_branch_name: start_branch_name,
      start_project: start_project) do |start_commit|
864

865 866
      revert_tree_id = check_revert_content(commit, start_commit.sha)
      unless revert_tree_id
867
        raise Repository::CreateTreeError.new('Failed to revert commit')
868 869
      end

870
      committer = user_to_committer(user)
871

Lin Jen-Shin's avatar
Lin Jen-Shin committed
872
      Rugged::Commit.create(rugged,
873
        message: commit.revert_message(user),
874 875
        author: committer,
        committer: committer,
876
        tree: revert_tree_id,
877
        parents: [start_commit.sha])
878
    end
879 880
  end

881
  def cherry_pick(
882
    user, commit, branch_name,
883
    start_branch_name: nil, start_project: project)
884
    GitOperationService.new(user, self).with_branch(
885
      branch_name,
886 887
      start_branch_name: start_branch_name,
      start_project: start_project) do |start_commit|
888

889 890
      cherry_pick_tree_id = check_cherry_pick_content(commit, start_commit.sha)
      unless cherry_pick_tree_id
891
        raise Repository::CreateTreeError.new('Failed to cherry-pick commit')
892 893
      end

894
      committer = user_to_committer(user)
895

Lin Jen-Shin's avatar
Lin Jen-Shin committed
896
      Rugged::Commit.create(rugged,
897 898 899 900 901 902 903 904
        message: commit.message,
        author: {
          email: commit.author_email,
          name: commit.author_name,
          time: commit.authored_date
        },
        committer: committer,
        tree: cherry_pick_tree_id,
905
        parents: [start_commit.sha])
906 907 908
    end
  end

909 910
  def resolve_conflicts(user, branch_name, params)
    GitOperationService.new(user, self).with_branch(branch_name) do
911 912 913 914 915 916
      committer = user_to_committer(user)

      Rugged::Commit.create(rugged, params.merge(author: committer, committer: committer))
    end
  end

917 918
  def check_revert_content(target_commit, source_sha)
    args = [target_commit.sha, source_sha]
919
    args << { mainline: 1 } if target_commit.merge_commit?
920 921 922 923 924 925 926 927 928 929

    revert_index = rugged.revert_commit(*args)
    return false if revert_index.conflicts?

    tree_id = revert_index.write_tree(rugged)
    return false unless diff_exists?(source_sha, tree_id)

    tree_id
  end

930 931
  def check_cherry_pick_content(target_commit, source_sha)
    args = [target_commit.sha, source_sha]
932
    args << 1 if target_commit.merge_commit?
933 934 935 936 937 938 939 940 941 942

    cherry_pick_index = rugged.cherrypick_commit(*args)
    return false if cherry_pick_index.conflicts?

    tree_id = cherry_pick_index.write_tree(rugged)
    return false unless diff_exists?(source_sha, tree_id)

    tree_id
  end

943 944
  def diff_exists?(sha1, sha2)
    rugged.diff(sha1, sha2).size > 0
945 946
  end

947 948 949 950 951
  def merged_to_root_ref?(branch_name)
    branch_commit = commit(branch_name)
    root_ref_commit = commit(root_ref)

    if branch_commit
952 953
      same_head = branch_commit.id == root_ref_commit.id
      !same_head && is_ancestor?(branch_commit.id, root_ref_commit.id)
954 955 956 957 958
    else
      nil
    end
  end

959
  def merge_base(first_commit_id, second_commit_id)
960 961
    first_commit_id = commit(first_commit_id).try(:id) || first_commit_id
    second_commit_id = commit(second_commit_id).try(:id) || second_commit_id
962
    rugged.merge_base(first_commit_id, second_commit_id)
Douwe Maan's avatar
Douwe Maan committed
963 964
  rescue Rugged::ReferenceError
    nil
965 966
  end

967
  def is_ancestor?(ancestor_id, descendant_id)
968 969 970 971 972 973 974
    Gitlab::GitalyClient.migrate(:is_ancestor) do |is_enabled|
      if is_enabled
        raw_repository.is_ancestor?(ancestor_id, descendant_id)
      else
        merge_base_commit(ancestor_id, descendant_id) == ancestor_id
      end
    end
975 976
  end

977 978 979 980 981 982
  def empty_repo?
    !exists? || !has_visible_content?
  end

  def search_files_by_content(query, ref)
    return [] if empty_repo? || query.blank?
Valery Sizov's avatar
Valery Sizov committed
983

984
    offset = 2
985
    args = %W(#{Gitlab.config.git.bin_path} grep -i -I -n --before-context #{offset} --after-context #{offset} -E -e #{Regexp.escape(query)} #{ref || root_ref})
986 987 988
    Gitlab::Popen.popen(args, path_to_repo).first.scrub.split(/^--$/)
  end

989 990 991 992 993 994 995
  def search_files_by_name(query, ref)
    return [] if empty_repo? || query.blank?

    args = %W(#{Gitlab.config.git.bin_path} ls-tree --full-tree -r #{ref || root_ref} --name-status | #{Regexp.escape(query)})
    Gitlab::Popen.popen(args, path_to_repo).first.lines.map(&:strip)
  end

996
  def with_repo_branch_commit(start_repository, start_branch_name)
997 998
    return yield(nil) if start_repository.empty_repo?

999
    branch_name_or_sha =
1000 1001
      if start_repository == self
        start_branch_name
1002 1003
      else
        tmp_ref = "refs/tmp/#{SecureRandom.hex}/head"
1004

1005
        fetch_ref(
1006 1007
          start_repository.path_to_repo,
          "#{Gitlab::Git::BRANCH_REF_PREFIX}#{start_branch_name}",
1008 1009 1010
          tmp_ref
        )

1011
        start_repository.commit(start_branch_name).sha
1012
      end
1013

1014
    yield(commit(branch_name_or_sha))
1015 1016

  ensure
1017
    rugged.references.delete(tmp_ref) if tmp_ref
1018 1019
  end

1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034
  def add_remote(name, url)
    raw_repository.remote_add(name, url)
  rescue Rugged::ConfigError
    raw_repository.remote_update(name, url: url)
  end

  def remove_remote(name)
    raw_repository.remote_delete(name)
    true
  rescue Rugged::ConfigError
    false
  end

  def fetch_remote(remote, forced: false, no_tags: false)
    gitlab_shell.fetch_remote(repository_storage_path, path_with_namespace, remote, forced: forced, no_tags: no_tags)
1035 1036
  end

1037
  def fetch_ref(source_path, source_ref, target_ref)
1038
    args = %W(#{Gitlab.config.git.bin_path} fetch --no-tags -f #{source_path} #{source_ref}:#{target_ref})
1039 1040 1041
    Gitlab::Popen.popen(args, path_to_repo)
  end

1042 1043 1044 1045
  def create_ref(ref, ref_path)
    fetch_ref(path_to_repo, ref, ref_path)
  end

1046 1047 1048 1049 1050
  def ls_files(ref)
    actual_ref = ref || root_ref
    raw_repository.ls_files(actual_ref)
  end

1051 1052 1053 1054
  def gitattribute(path, name)
    raw_repository.attributes(path)[name]
  end

1055 1056 1057 1058 1059 1060 1061 1062 1063 1064
  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

1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077
  # 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.
  def cache_method_output(key, fallback: nil, &block)
    ivar = cache_instance_variable_name(key)
1078

1079 1080 1081 1082 1083 1084 1085 1086 1087
    if instance_variable_defined?(ivar)
      instance_variable_get(ivar)
    else
      begin
        instance_variable_set(ivar, cache.fetch(key, &block))
      rescue Rugged::ReferenceError, Gitlab::Git::Repository::NoRepository
        # if e.g. HEAD or the entire repository doesn't exist we want to
        # gracefully handle this and not cache anything.
        fallback
1088 1089 1090 1091
      end
    end
  end

1092 1093 1094
  def cache_instance_variable_name(key)
    :"@#{key.to_s.tr('?!', '')}"
  end
1095

1096 1097 1098 1099
  def file_on_head(type)
    if head = tree(:head)
      head.blobs.find do |file|
        Gitlab::FileDetector.type_of(file.name) == type
1100 1101
      end
    end
1102
  end
1103

Douwe Maan's avatar
Douwe Maan committed
1104 1105 1106 1107 1108 1109 1110 1111 1112
  def route_map_for(sha)
    blob_data_at(sha, '.gitlab/route-map.yml')
  end

  def gitlab_ci_yml_for(sha)
    blob_data_at(sha, '.gitlab-ci.yml')
  end

  private
1113

Douwe Maan's avatar
Douwe Maan committed
1114 1115
  def blob_data_at(sha, path)
    blob = blob_at(sha, path)
1116
    return unless blob
1117

1118 1119 1120 1121
    blob.load_all_data!(self)
    blob.data
  end

1122 1123 1124 1125
  def refs_directory_exists?
    return false unless path_with_namespace

    File.exist?(File.join(path_to_repo, 'refs'))
1126
  end
1127

1128
  def cache
1129
    @cache ||= RepositoryCache.new(path_with_namespace, @project.id)
1130
  end
1131 1132

  def tags_sorted_by_committed_date
1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144
    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
1145
  end
1146 1147 1148 1149

  def keep_around_ref_name(sha)
    "refs/keep-around/#{sha}"
  end
Yorick Peterse's avatar
Yorick Peterse committed
1150 1151 1152 1153

  def repository_event(event, tags = {})
    Gitlab::Metrics.add_event(event, { path: path_with_namespace }.merge(tags))
  end
1154 1155 1156 1157

  def repository_storage_path
    @project.repository_storage_path
  end
1158

1159
  delegate :gitaly_channel, :gitaly_repository, to: :raw_repository
1160

1161
  def initialize_raw_repository
1162 1163
    Gitlab::Git::Repository.new(project.repository_storage, path_with_namespace + '.git')
  end
1164
end