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

3
class Repository
L
Lin Jen-Shin 已提交
4 5 6
  REF_MERGE_REQUEST = 'merge-requests'.freeze
  REF_KEEP_AROUND = 'keep-around'.freeze
  REF_ENVIRONMENTS = 'environments'.freeze
7
  MAX_DIVERGING_COUNT = 1000
8 9 10 11

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

18 19
  include Gitlab::ShellAdapter

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

22
  delegate :ref_name_for_sha, to: :raw_repository
23
  delegate :bundle_to_disk, :create_from_bundle, to: :raw_repository
24

25
  CreateTreeError = Class.new(StandardError)
26

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

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

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

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

67
    alias_method(original, name)
68

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

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

84
  def ==(other)
H
http://jneen.net/ 已提交
85 86 87
    @disk_path == other.disk_path
  end

88
  def raw_repository
89
    return nil unless full_path
90

91
    @raw_repository ||= initialize_raw_repository
92 93
  end

94 95
  alias_method :raw, :raw_repository

96 97 98 99
  def cleanup
    @raw_repository&.cleanup
  end

100
  # Return absolute path to repository
101
  def path_to_repo
102
    @path_to_repo ||= File.expand_path(
103
      File.join(repository_storage_path, disk_path + '.git')
104
    )
105 106
  end

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

111 112 113 114
  def create_hooks
    Gitlab::Git::Repository.create_hooks(path_to_repo, Gitlab.config.gitlab_shell.hooks_path)
  end

L
Lin Jen-Shin 已提交
115
  def commit(ref = 'HEAD')
116
    return nil unless exists?
117
    return ref if ref.is_a?(::Commit)
118

119 120
    find_commit(ref)
  end
121

122 123 124 125 126 127
  # 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)
128 129
  end

130 131 132 133 134 135 136 137 138 139 140 141
  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

142
  def commits(ref, path: nil, limit: nil, offset: nil, skip_merges: false, after: nil, before: nil)
143
    options = {
144 145 146 147 148
      repo: raw_repository,
      ref: ref,
      path: path,
      limit: limit,
      offset: offset,
149 150
      after: after,
      before: before,
151
      follow: Array(path).length == 1,
152
      skip_merges: skip_merges
153 154 155
    }

    commits = Gitlab::Git::Commit.where(options)
156
    commits = Commit.decorate(commits, @project) if commits.present?
157 158

    CommitCollection.new(project, commits, ref)
159 160
  end

161 162
  def commits_between(from, to)
    commits = Gitlab::Git::Commit.between(raw_repository, from, to)
163
    commits = Commit.decorate(commits, @project) if commits.present?
164 165 166
    commits
  end

J
Jacob Vosmaer 已提交
167
  # Gitaly migration: https://gitlab.com/gitlab-org/gitaly/issues/384
168
  def find_commits_by_message(query, ref = nil, path = nil, limit = 1000, offset = 0)
169 170 171 172
    unless exists? && has_visible_content? && query.present?
      return []
    end

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

179
  def find_branch(name, fresh_repo: true)
180
    raw_repository.find_branch(name, fresh_repo)
181 182 183
  end

  def find_tag(name)
184
    tags.find { |tag| tag.name == name }
185 186
  end

187
  def add_branch(user, branch_name, ref)
188
    branch = raw_repository.add_branch(branch_name, user: user, target: ref)
189

190
    after_create_branch
191 192 193 194

    branch
  rescue Gitlab::Git::Repository::InvalidRef
    false
195 196
  end

197
  def add_tag(user, tag_name, target, message = nil)
198
    raw_repository.add_tag(tag_name, user: user, target: target, message: message)
199 200
  rescue Gitlab::Git::Repository::InvalidRef
    false
201 202
  end

203
  def rm_branch(user, branch_name)
204
    before_remove_branch
205

206
    raw_repository.rm_branch(branch_name, user: user)
207

208
    after_remove_branch
209
    true
210 211
  end

L
Lin Jen-Shin 已提交
212
  def rm_tag(user, tag_name)
Y
Yorick Peterse 已提交
213
    before_remove_tag
214

215
    raw_repository.rm_tag(tag_name, user: user)
L
Lin Jen-Shin 已提交
216 217 218

    after_remove_tag
    true
219 220
  end

221 222 223 224
  def ref_names
    branch_names + tag_names
  end

225
  def branch_exists?(branch_name)
226 227
    return false unless raw_repository

228
    branch_names.include?(branch_name)
229 230
  end

231 232 233 234 235 236
  def tag_exists?(tag_name)
    return false unless raw_repository

    tag_names.include?(tag_name)
  end

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

D
Douwe Maan 已提交
243 244 245 246
  # 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.
247
  def keep_around(sha)
248
    return unless sha && commit_by(oid: sha)
249 250 251

    return if kept_around?(sha)

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

  def kept_around?(sha)
259
    ref_exists?(keep_around_ref_name(sha))
260
  end
261

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

274 275 276
      { behind: number_commits_behind, ahead: number_commits_ahead }
    end
  end
277

278 279 280
  def expire_tags_cache
    expire_method_caches(%i(tag_names tag_count))
    @tags = nil
281
  end
282

283
  def expire_branches_cache
284
    expire_method_caches(%i(branch_names branch_count has_visible_content?))
285
    @local_branches = nil
286
    @branch_exists_memo = nil
287 288
  end

289 290
  def expire_statistics_caches
    expire_method_caches(%i(size commit_count))
291 292
  end

293 294
  def expire_all_method_caches
    expire_method_caches(CACHED_METHODS)
D
Douwe Maan 已提交
295 296
  end

297 298 299 300 301 302 303 304 305
  # 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
D
Douwe Maan 已提交
306 307
  end

308 309 310 311 312 313 314 315 316 317 318 319 320 321 322
  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
323
    end
324

325
    expire_method_caches(to_refresh)
326

327
    to_refresh.each { |method| send(method) } # rubocop:disable GitlabSecurity/PublicSend
328
  end
329

330 331 332 333 334 335 336
  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}")
337
        cache.expire(:"commit_count_#{branch.name}")
338 339 340 341 342
      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}")
343
      cache.expire(:"commit_count_#{branch_name}")
344
    end
D
Dmitriy Zaporozhets 已提交
345 346
  end

347
  def expire_root_ref_cache
348
    expire_method_caches(%i(root_ref))
349 350
  end

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

355
    expire_method_caches(%i(empty? has_visible_content?))
Y
Yorick Peterse 已提交
356 357
  end

358 359 360 361
  def lookup_cache
    @lookup_cache ||= {}
  end

362
  def expire_exists_cache
363
    expire_method_caches(%i(exists?))
364 365
  end

366 367 368 369 370 371 372
  # 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
373
    expire_statistics_caches
374 375 376 377 378
  end

  # Runs code after a repository has been created.
  def after_create
    expire_exists_cache
379 380
    expire_root_ref_cache
    expire_emptiness_caches
Y
Yorick Peterse 已提交
381 382

    repository_event(:create_repository)
383 384
  end

385 386
  # Runs code just before a repository is deleted.
  def before_delete
387
    expire_exists_cache
388 389
    expire_all_method_caches
    expire_branch_cache if exists?
390
    expire_content_cache
Y
Yorick Peterse 已提交
391 392

    repository_event(:remove_repository)
393 394 395 396 397 398 399
  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 已提交
400 401

    repository_event(:change_default_branch)
402 403
  end

Y
Yorick Peterse 已提交
404 405
  # Runs code before pushing (= creating or removing) a tag.
  def before_push_tag
406 407
    expire_statistics_caches
    expire_emptiness_caches
408
    expire_tags_cache
Y
Yorick Peterse 已提交
409 410

    repository_event(:push_tag)
Y
Yorick Peterse 已提交
411 412 413 414 415
  end

  # Runs code before removing a tag.
  def before_remove_tag
    expire_tags_cache
416
    expire_statistics_caches
Y
Yorick Peterse 已提交
417 418

    repository_event(:remove_tag)
419 420
  end

L
Lin Jen-Shin 已提交
421 422 423 424 425
  # Runs code after removing a tag.
  def after_remove_tag
    expire_tags_cache
  end

426 427 428
  # Runs code after the HEAD of a repository is changed.
  def after_change_head
    expire_method_caches(METHOD_CACHES_FOR_FILE_TYPES.keys)
429 430
  end

431 432
  # Runs code after a repository has been forked/imported.
  def after_import
433
    expire_content_cache
434 435 436
  end

  # Runs code after a new commit has been pushed.
437 438 439
  def after_push_commit(branch_name)
    expire_statistics_caches
    expire_branch_cache(branch_name)
Y
Yorick Peterse 已提交
440 441

    repository_event(:push_commit, branch: branch_name)
442 443 444 445
  end

  # Runs code after a new branch has been created.
  def after_create_branch
446
    expire_branches_cache
Y
Yorick Peterse 已提交
447 448

    repository_event(:push_branch)
449 450
  end

451 452 453
  # Runs code before removing an existing branch.
  def before_remove_branch
    expire_branches_cache
Y
Yorick Peterse 已提交
454 455

    repository_event(:remove_branch)
456 457
  end

458 459
  # Runs code after an existing branch has been removed.
  def after_remove_branch
460
    expire_branches_cache
461 462
  end

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

472 473
  def respond_to_missing?(method, include_private = false)
    raw_repository.respond_to?(method, include_private) || super
474
  end
D
Dmitriy Zaporozhets 已提交
475 476

  def blob_at(sha, path)
477
    Blob.decorate(raw_repository.blob_at(sha, path), project)
D
Douwe Maan 已提交
478 479
  rescue Gitlab::Git::Repository::NoRepository
    nil
D
Dmitriy Zaporozhets 已提交
480
  end
481

482 483 484 485 486
  # 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

487 488 489 490 491
  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.
492
      raise Gitlab::Git::Repository::NoRepository
493
    end
494
  end
495
  cache_method :root_ref
496

497
  # Gitaly migration: https://gitlab.com/gitlab-org/gitaly/issues/314
498
  def exists?
499
    return false unless full_path
500

501
    raw_repository.exists?
502 503 504
  end
  cache_method :exists?

505 506 507 508 509
  def empty?
    return true unless exists?

    !has_visible_content?
  end
510 511 512 513 514 515 516 517 518 519 520 521 522
  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

523
  def commit_count_for_ref(ref)
524
    return 0 unless exists?
525

526
    cache.fetch(:"commit_count_#{ref}") { raw_repository.commit_count(ref) }
527 528
  end

529
  delegate :branch_names, to: :raw_repository
530 531
  cache_method :branch_names, fallback: []

D
Douwe Maan 已提交
532
  delegate :tag_names, to: :raw_repository
533 534
  cache_method :tag_names, fallback: []

535
  delegate :branch_count, :tag_count, :has_visible_content?, to: :raw_repository
536 537
  cache_method :branch_count, fallback: 0
  cache_method :tag_count, fallback: 0
538
  cache_method :has_visible_content?, fallback: false
539 540

  def avatar
541 542 543 544 545
    # 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
546 547
    end
  end
548
  cache_method :avatar
549

S
Sean McGivern 已提交
550 551 552 553 554 555 556 557 558 559
  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: []

560
  def readme
561 562
    if readme = tree(:head)&.readme
      ReadmeBlob.new(readme, self)
563
    end
564 565
  end

566
  def rendered_readme
T
Toon Claes 已提交
567
    MarkupHelper.markup_unsafe(readme.name, readme.data, project: project) if readme
568 569
  end
  cache_method :rendered_readme
570

571
  def contribution_guide
572
    file_on_head(:contributing)
573
  end
574
  cache_method :contribution_guide
575 576

  def changelog
577
    file_on_head(:changelog)
578
  end
579
  cache_method :changelog
580

581
  def license_blob
582
    file_on_head(:license)
583
  end
584
  cache_method :license_blob
Z
Zeger-Jan van de Weg 已提交
585

586
  def license_key
587
    return unless exists?
588

589
    Licensee.license(path).try(:key)
590
  end
591
  cache_method :license_key
592

D
Douwe Maan 已提交
593 594
  def license
    return unless license_key
595

596
    Licensee::License.new(license_key)
597
  end
598
  cache_method :license, memoize_only: true
599 600

  def gitignore
601
    file_on_head(:gitignore)
602
  end
603
  cache_method :gitignore
604 605

  def koding_yml
606
    file_on_head(:koding)
607
  end
608
  cache_method :koding_yml
609

610
  def gitlab_ci_yml
611
    file_on_head(:gitlab_ci)
612
  end
613
  cache_method :gitlab_ci_yml
614

615
  def head_commit
616 617 618 619
    @head_commit ||= commit(self.root_ref)
  end

  def head_tree
620 621 622
    if head_commit
      @head_tree ||= Tree.new(self, head_commit.sha, nil)
    end
623 624
  end

625
  def tree(sha = :head, path = nil, recursive: false)
626
    if sha == :head
627 628
      return unless head_commit

629 630 631 632 633
      if path.nil?
        return head_tree
      else
        sha = head_commit.sha
      end
634 635
    end

636
    Tree.new(self, sha, path, recursive: recursive)
637
  end
D
Dmitriy Zaporozhets 已提交
638 639

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

D
Dmitriy Zaporozhets 已提交
642 643 644 645 646
    if last_commit
      blob_at(last_commit.sha, path)
    else
      nil
    end
D
Dmitriy Zaporozhets 已提交
647
  end
D
Dmitriy Zaporozhets 已提交
648

649
  def last_commit_for_path(sha, path)
650
    commit_by(oid: last_commit_id_for_path(sha, path))
651
  end
652

H
Hiroyuki Sato 已提交
653 654
  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 已提交
655

H
Hiroyuki Sato 已提交
656
    cache.fetch(key) do
657
      raw_repository.last_commit_id_for_path(sha, path)
H
Hiroyuki Sato 已提交
658 659 660
    end
  end

661
  def next_branch(name, opts = {})
P
P.S.V.R 已提交
662 663
    branch_ids = self.branch_names.map do |n|
      next 1 if n == name
664

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

P
P.S.V.R 已提交
669
    highest_branch_id = branch_ids.max || 0
670

P
P.S.V.R 已提交
671 672 673
    return name if opts[:mild] && 0 == highest_branch_id

    "#{name}-#{highest_branch_id + 1}"
674 675
  end

676
  def branches_sorted_by(value)
677
    raw_repository.local_branches(sort_by: value)
678
  end
679

680 681
  def tags_sorted_by(value)
    case value
H
haseeb 已提交
682 683 684
    when 'name_asc'
      VersionSorter.sort(tags) { |tag| tag.name }
    when 'name_desc'
685
      VersionSorter.rsort(tags) { |tag| tag.name }
686 687 688 689 690 691 692 693 694
    when 'updated_desc'
      tags_sorted_by_committed_date.reverse
    when 'updated_asc'
      tags_sorted_by_committed_date
    else
      tags
    end
  end

695 696 697 698 699
  # Params:
  #
  # order_by: name|email|commits
  # sort: asc|desc default: 'asc'
  def contributors(order_by: nil, sort: 'asc')
700
    commits = self.commits(nil, limit: 2000, offset: 0, skip_merges: true)
701

702
    commits = commits.group_by(&:author_email).map do |email, commits|
703 704
      contributor = Gitlab::Contributor.new
      contributor.email = email
705

D
Dmitriy Zaporozhets 已提交
706
      commits.each do |commit|
707
        if contributor.name.blank?
D
Dmitriy Zaporozhets 已提交
708
          contributor.name = commit.author_name
709 710
        end

711
        contributor.commits += 1
712 713
      end

714 715
      contributor
    end
716
    Commit.order_by(collection: commits, order_by: order_by, sort: sort)
717
  end
D
Dmitriy Zaporozhets 已提交
718

719
  def branch_names_contains(sha)
720
    raw_repository.branch_names_contains_sha(sha)
721
  end
H
Hannes Rosenögger 已提交
722

723
  def tag_names_contains(sha)
724
    raw_repository.tag_names_contains_sha(sha)
H
Hannes Rosenögger 已提交
725
  end
726

727
  def local_branches
728
    @local_branches ||= raw_repository.local_branches
729 730
  end

731 732
  alias_method :branches, :local_branches

733 734 735 736
  def tags
    @tags ||= raw_repository.tags
  end

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

740
    multi_action(user, **options)
S
Stan Hu 已提交
741 742
  end

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

746
    multi_action(user, **options)
S
Stan Hu 已提交
747
  end
748

D
Douwe Maan 已提交
749 750 751
  def update_file(user, path, content, **options)
    previous_path = options.delete(:previous_path)
    action = previous_path && previous_path != path ? :move : :update
752

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

755
    multi_action(user, **options)
756 757
  end

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

761
    multi_action(user, **options)
762 763
  end

764 765
  def with_cache_hooks
    result = yield
766

767
    return unless result
768

769 770
    after_create if result.repo_created?
    after_create_branch if result.branch_created?
771

772 773 774
    result.newrev
  end

775 776
  def multi_action(user, **options)
    start_project = options.delete(:start_project)
M
Marc Siegfriedt 已提交
777

778 779
    if start_project
      options[:start_repository] = start_project.repository.raw_repository
M
Marc Siegfriedt 已提交
780 781
    end

782
    with_cache_hooks { raw.multi_action(user, **options) }
783 784
  end

785 786 787 788 789 790
  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
791
    end
792 793
  end

794
  def ff_merge(user, source, target_branch, merge_request: nil)
795 796
    their_commit_id = commit(source)&.id
    raise 'Invalid merge source' if their_commit_id.nil?
797

798
    merge_request&.update(in_progress_merge_commit_sha: their_commit_id)
799

800
    with_cache_hooks { raw.ff_merge(user, their_commit_id, target_branch) }
801 802
  end

803
  def revert(
804
    user, commit, branch_name, message,
805
    start_branch_name: nil, start_project: project)
806

807 808 809 810 811 812 813 814 815
    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
      )
816
    end
817 818
  end

819
  def cherry_pick(
820
    user, commit, branch_name, message,
821
    start_branch_name: nil, start_project: project)
P
P.S.V.R 已提交
822

823 824 825 826 827 828 829 830 831
    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 已提交
832 833 834
    end
  end

835
  def merged_to_root_ref?(branch_or_name)
836 837 838
    branch = Gitlab::Git::Branch.find(self, branch_or_name)

    if branch
839 840
      same_head = branch.target == root_ref_sha
      merged = ancestor?(branch.target, root_ref_sha)
841
      !same_head && merged
F
Florent (HP) 已提交
842 843 844 845 846
    else
      nil
    end
  end

847 848 849 850
  def root_ref_sha
    @root_ref_sha ||= commit(root_ref).sha
  end

851
  delegate :merged_branch_names, :can_be_merged?, to: :raw_repository
852

S
Stan Hu 已提交
853
  def merge_base(first_commit_id, second_commit_id)
854 855
    first_commit_id = commit(first_commit_id).try(:id) || first_commit_id
    second_commit_id = commit(second_commit_id).try(:id) || second_commit_id
856
    raw_repository.merge_base(first_commit_id, second_commit_id)
S
Stan Hu 已提交
857 858
  end

859
  def ancestor?(ancestor_id, descendant_id)
860
    return false if ancestor_id.nil? || descendant_id.nil?
861

862
    raw_repository.ancestor?(ancestor_id, descendant_id)
863 864
  end

D
Douwe Maan 已提交
865
  def fetch_as_mirror(url, forced: false, refmap: :all_refs, remote_name: nil)
866 867 868 869 870
    unless remote_name
      remote_name = "tmp-#{SecureRandom.hex}"
      tmp_remote_name = true
    end

871
    add_remote(remote_name, url, mirror_refmap: refmap)
872 873 874 875 876
    fetch_remote(remote_name, forced: forced)
  ensure
    remove_remote(remote_name) if tmp_remote_name
  end

877 878
  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)
879 880
  end

881 882
  def fetch_source_branch!(source_repository, source_branch, local_ref)
    raw_repository.fetch_source_branch!(source_repository.raw_repository, source_branch, local_ref)
883
  end
884

885 886
  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)
887
  end
888

889
  def create_ref(ref, ref_path)
890
    raw_repository.write_ref(ref_path, ref)
891 892
  end

893 894 895 896 897
  def ls_files(ref)
    actual_ref = ref || root_ref
    raw_repository.ls_files(actual_ref)
  end

898 899 900 901 902 903 904 905 906 907 908 909
  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

910 911 912 913 914 915 916 917 918 919
  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

920 921 922 923 924 925 926 927 928 929 930
  # 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.
931
  def cache_method_output(key, fallback: nil, memoize_only: false, &block)
932
    ivar = cache_instance_variable_name(key)
933

934 935 936
    if instance_variable_defined?(ivar)
      instance_variable_get(ivar)
    else
937 938 939 940
      # 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?

941
      begin
942 943 944 945 946 947
        value =
          if memoize_only
            yield
          else
            cache.fetch(key, &block)
          end
948

949
        instance_variable_set(ivar, value)
950
      rescue Gitlab::Git::Repository::NoRepository
951 952 953
        # 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
954
        fallback
955 956 957
      end
    end
  end
958

959 960 961
  def cache_instance_variable_name(key)
    :"@#{key.to_s.tr('?!', '')}"
  end
962

963 964
  def file_on_head(type)
    if head = tree(:head)
D
Douwe Maan 已提交
965 966
      head.blobs.find do |blob|
        Gitlab::FileDetector.type_of(blob.path) == type
967 968 969 970
      end
    end
  end

D
Douwe Maan 已提交
971 972 973 974
  def route_map_for(sha)
    blob_data_at(sha, '.gitlab/route-map.yml')
  end

975 976
  def gitlab_ci_yml_for(sha, path = '.gitlab-ci.yml')
    blob_data_at(sha, path)
D
Douwe Maan 已提交
977 978
  end

979 980 981 982
  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

983 984 985 986
  def repository_storage_path
    @project.repository_storage_path
  end

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

994 995
  private

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

D
Douwe Maan 已提交
1008 1009
  def blob_data_at(sha, path)
    blob = blob_at(sha, path)
1010
    return unless blob
1011

1012
    blob.load_all_data!
1013
    blob.data
1014
  end
1015

1016
  def cache
1017 1018
    # TODO: should we use UUIDs here? We could move repositories without clearing this cache
    @cache ||= RepositoryCache.new(full_path, @project.id)
1019
  end
1020 1021

  def tags_sorted_by_committed_date
1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033
    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
1034
  end
D
Douwe Maan 已提交
1035 1036

  def keep_around_ref_name(sha)
1037
    "refs/#{REF_KEEP_AROUND}/#{sha}"
D
Douwe Maan 已提交
1038
  end
Y
Yorick Peterse 已提交
1039 1040

  def repository_event(event, tags = {})
1041
    Gitlab::Metrics.add_event(event, { path: full_path }.merge(tags))
Y
Yorick Peterse 已提交
1042
  end
1043

1044
  def initialize_raw_repository
1045
    Gitlab::Git::Repository.new(project.repository_storage, disk_path + '.git', Gitlab::GlRepository.gl_repository(project, is_wiki))
1046
  end
1047
end