repository.rb 27.0 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
  # Return absolute path to repository
97
  def path_to_repo
98
    @path_to_repo ||= File.expand_path(
99
      File.join(repository_storage_path, disk_path + '.git')
100
    )
101 102
  end

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

107 108 109 110
  def create_hooks
    Gitlab::Git::Repository.create_hooks(path_to_repo, Gitlab.config.gitlab_shell.hooks_path)
  end

L
Lin Jen-Shin 已提交
111
  def commit(ref = 'HEAD')
112
    return nil unless exists?
113
    return ref if ref.is_a?(::Commit)
114

115 116
    find_commit(ref)
  end
117

118 119 120 121 122 123
  # 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)
124 125
  end

126 127 128 129 130 131 132 133 134 135 136 137
  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

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

    commits = Gitlab::Git::Commit.where(options)
152
    commits = Commit.decorate(commits, @project) if commits.present?
153 154

    CommitCollection.new(project, commits, ref)
155 156
  end

157 158
  def commits_between(from, to)
    commits = Gitlab::Git::Commit.between(raw_repository, from, to)
159
    commits = Commit.decorate(commits, @project) if commits.present?
160 161 162
    commits
  end

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

169 170
    commits = raw_repository.find_commits_by_message(query, ref, path, limit, offset).map do |c|
      commit(c)
171
    end
172
    CommitCollection.new(project, commits, ref)
173 174
  end

175
  def find_branch(name, fresh_repo: true)
176
    raw_repository.find_branch(name, fresh_repo)
177 178 179
  end

  def find_tag(name)
180
    tags.find { |tag| tag.name == name }
181 182
  end

183
  def add_branch(user, branch_name, ref)
184
    branch = raw_repository.add_branch(branch_name, user: user, target: ref)
185

186
    after_create_branch
187 188 189 190

    branch
  rescue Gitlab::Git::Repository::InvalidRef
    false
191 192
  end

193
  def add_tag(user, tag_name, target, message = nil)
194
    raw_repository.add_tag(tag_name, user: user, target: target, message: message)
195 196
  rescue Gitlab::Git::Repository::InvalidRef
    false
197 198
  end

199
  def rm_branch(user, branch_name)
200
    before_remove_branch
201

202
    raw_repository.rm_branch(branch_name, user: user)
203

204
    after_remove_branch
205
    true
206 207
  end

L
Lin Jen-Shin 已提交
208
  def rm_tag(user, tag_name)
Y
Yorick Peterse 已提交
209
    before_remove_tag
210

211
    raw_repository.rm_tag(tag_name, user: user)
L
Lin Jen-Shin 已提交
212 213 214

    after_remove_tag
    true
215 216
  end

217 218 219 220
  def ref_names
    branch_names + tag_names
  end

221
  def branch_exists?(branch_name)
222 223
    return false unless raw_repository

224
    branch_names.include?(branch_name)
225 226
  end

227 228 229 230 231 232
  def tag_exists?(tag_name)
    return false unless raw_repository

    tag_names.include?(tag_name)
  end

233
  def ref_exists?(ref)
234 235
    !!raw_repository&.ref_exists?(ref)
  rescue ArgumentError
236
    false
237 238
  end

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

    return if kept_around?(sha)

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

  def kept_around?(sha)
255
    ref_exists?(keep_around_ref_name(sha))
256
  end
257

258
  def diverging_commit_counts(branch)
259
    root_ref_hash = raw_repository.commit(root_ref).id
J
Jeff Stubler 已提交
260
    cache.fetch(:"diverging_commit_counts_#{branch.name}") do
261 262
      # Rugged seems to throw a `ReferenceError` when given branch_names rather
      # than SHA-1 hashes
263 264 265 266 267 268
      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)
269

270 271 272
      { behind: number_commits_behind, ahead: number_commits_ahead }
    end
  end
273

274 275 276
  def expire_tags_cache
    expire_method_caches(%i(tag_names tag_count))
    @tags = nil
277
  end
278

279
  def expire_branches_cache
280
    expire_method_caches(%i(branch_names branch_count has_visible_content?))
281
    @local_branches = nil
282
    @branch_exists_memo = nil
283 284
  end

285 286
  def expire_statistics_caches
    expire_method_caches(%i(size commit_count))
287 288
  end

289 290
  def expire_all_method_caches
    expire_method_caches(CACHED_METHODS)
D
Douwe Maan 已提交
291 292
  end

293 294 295 296 297 298 299 300 301
  # 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 已提交
302 303
  end

304 305 306 307 308 309 310 311 312 313 314 315 316 317 318
  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
319
    end
320

321
    expire_method_caches(to_refresh)
322

323
    to_refresh.each { |method| send(method) } # rubocop:disable GitlabSecurity/PublicSend
324
  end
325

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

343
  def expire_root_ref_cache
344
    expire_method_caches(%i(root_ref))
345 346
  end

347 348
  # Expires the cache(s) used to determine if a repository is empty or not.
  def expire_emptiness_caches
349
    return unless empty?
350

351
    expire_method_caches(%i(empty? has_visible_content?))
Y
Yorick Peterse 已提交
352 353
  end

354 355 356 357
  def lookup_cache
    @lookup_cache ||= {}
  end

358
  def expire_exists_cache
359
    expire_method_caches(%i(exists?))
360 361
  end

362 363 364 365 366 367 368
  # 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
369
    expire_statistics_caches
370 371 372 373 374
  end

  # Runs code after a repository has been created.
  def after_create
    expire_exists_cache
375 376
    expire_root_ref_cache
    expire_emptiness_caches
Y
Yorick Peterse 已提交
377 378

    repository_event(:create_repository)
379 380
  end

381 382
  # Runs code just before a repository is deleted.
  def before_delete
383
    expire_exists_cache
384 385
    expire_all_method_caches
    expire_branch_cache if exists?
386
    expire_content_cache
Y
Yorick Peterse 已提交
387 388

    repository_event(:remove_repository)
389 390 391 392 393 394 395
  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 已提交
396 397

    repository_event(:change_default_branch)
398 399
  end

Y
Yorick Peterse 已提交
400 401
  # Runs code before pushing (= creating or removing) a tag.
  def before_push_tag
402 403
    expire_statistics_caches
    expire_emptiness_caches
404
    expire_tags_cache
Y
Yorick Peterse 已提交
405 406

    repository_event(:push_tag)
Y
Yorick Peterse 已提交
407 408 409 410 411
  end

  # Runs code before removing a tag.
  def before_remove_tag
    expire_tags_cache
412
    expire_statistics_caches
Y
Yorick Peterse 已提交
413 414

    repository_event(:remove_tag)
415 416
  end

L
Lin Jen-Shin 已提交
417 418 419 420 421
  # Runs code after removing a tag.
  def after_remove_tag
    expire_tags_cache
  end

422 423 424
  # Runs code after the HEAD of a repository is changed.
  def after_change_head
    expire_method_caches(METHOD_CACHES_FOR_FILE_TYPES.keys)
425 426
  end

427 428
  # Runs code after a repository has been forked/imported.
  def after_import
429
    expire_content_cache
430 431 432
  end

  # Runs code after a new commit has been pushed.
433 434 435
  def after_push_commit(branch_name)
    expire_statistics_caches
    expire_branch_cache(branch_name)
Y
Yorick Peterse 已提交
436 437

    repository_event(:push_commit, branch: branch_name)
438 439 440 441
  end

  # Runs code after a new branch has been created.
  def after_create_branch
442
    expire_branches_cache
Y
Yorick Peterse 已提交
443 444

    repository_event(:push_branch)
445 446
  end

447 448 449
  # Runs code before removing an existing branch.
  def before_remove_branch
    expire_branches_cache
Y
Yorick Peterse 已提交
450 451

    repository_event(:remove_branch)
452 453
  end

454 455
  # Runs code after an existing branch has been removed.
  def after_remove_branch
456
    expire_branches_cache
457 458
  end

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

468 469
  def respond_to_missing?(method, include_private = false)
    raw_repository.respond_to?(method, include_private) || super
470
  end
D
Dmitriy Zaporozhets 已提交
471 472

  def blob_at(sha, path)
473
    Blob.decorate(raw_repository.blob_at(sha, path), project)
D
Douwe Maan 已提交
474 475
  rescue Gitlab::Git::Repository::NoRepository
    nil
D
Dmitriy Zaporozhets 已提交
476
  end
477

478 479 480 481 482
  # 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

483 484 485 486 487
  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.
488
      raise Gitlab::Git::Repository::NoRepository
489
    end
490
  end
491
  cache_method :root_ref
492

493
  # Gitaly migration: https://gitlab.com/gitlab-org/gitaly/issues/314
494
  def exists?
495
    return false unless full_path
496

497
    raw_repository.exists?
498 499 500
  end
  cache_method :exists?

501 502 503 504 505
  def empty?
    return true unless exists?

    !has_visible_content?
  end
506 507 508 509 510 511 512 513 514 515 516 517 518
  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

519
  def commit_count_for_ref(ref)
520
    return 0 unless exists?
521

522
    cache.fetch(:"commit_count_#{ref}") { raw_repository.commit_count(ref) }
523 524
  end

525
  delegate :branch_names, to: :raw_repository
526 527
  cache_method :branch_names, fallback: []

D
Douwe Maan 已提交
528
  delegate :tag_names, to: :raw_repository
529 530
  cache_method :tag_names, fallback: []

531
  delegate :branch_count, :tag_count, :has_visible_content?, to: :raw_repository
532 533
  cache_method :branch_count, fallback: 0
  cache_method :tag_count, fallback: 0
534
  cache_method :has_visible_content?, fallback: false
535 536

  def avatar
537 538 539 540 541
    # 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
542 543
    end
  end
544
  cache_method :avatar
545

S
Sean McGivern 已提交
546 547 548 549 550 551 552 553 554 555
  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: []

556
  def readme
557 558
    if readme = tree(:head)&.readme
      ReadmeBlob.new(readme, self)
559
    end
560 561
  end

562
  def rendered_readme
T
Toon Claes 已提交
563
    MarkupHelper.markup_unsafe(readme.name, readme.data, project: project) if readme
564 565
  end
  cache_method :rendered_readme
566

567
  def contribution_guide
568
    file_on_head(:contributing)
569
  end
570
  cache_method :contribution_guide
571 572

  def changelog
573
    file_on_head(:changelog)
574
  end
575
  cache_method :changelog
576

577
  def license_blob
578
    file_on_head(:license)
579
  end
580
  cache_method :license_blob
Z
Zeger-Jan van de Weg 已提交
581

582
  def license_key
583
    return unless exists?
584

585
    Licensee.license(path).try(:key)
586
  end
587
  cache_method :license_key
588

D
Douwe Maan 已提交
589 590
  def license
    return unless license_key
591

592
    Licensee::License.new(license_key)
593
  end
594
  cache_method :license, memoize_only: true
595 596

  def gitignore
597
    file_on_head(:gitignore)
598
  end
599
  cache_method :gitignore
600 601

  def koding_yml
602
    file_on_head(:koding)
603
  end
604
  cache_method :koding_yml
605

606
  def gitlab_ci_yml
607
    file_on_head(:gitlab_ci)
608
  end
609
  cache_method :gitlab_ci_yml
610

611
  def head_commit
612 613 614 615
    @head_commit ||= commit(self.root_ref)
  end

  def head_tree
616 617 618
    if head_commit
      @head_tree ||= Tree.new(self, head_commit.sha, nil)
    end
619 620
  end

621
  def tree(sha = :head, path = nil, recursive: false)
622
    if sha == :head
623 624
      return unless head_commit

625 626 627 628 629
      if path.nil?
        return head_tree
      else
        sha = head_commit.sha
      end
630 631
    end

632
    Tree.new(self, sha, path, recursive: recursive)
633
  end
D
Dmitriy Zaporozhets 已提交
634 635

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

D
Dmitriy Zaporozhets 已提交
638 639 640 641 642
    if last_commit
      blob_at(last_commit.sha, path)
    else
      nil
    end
D
Dmitriy Zaporozhets 已提交
643
  end
D
Dmitriy Zaporozhets 已提交
644

645
  def last_commit_for_path(sha, path)
646
    commit_by(oid: last_commit_id_for_path(sha, path))
647
  end
648

H
Hiroyuki Sato 已提交
649 650
  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 已提交
651

H
Hiroyuki Sato 已提交
652
    cache.fetch(key) do
653
      raw_repository.last_commit_id_for_path(sha, path)
H
Hiroyuki Sato 已提交
654 655 656
    end
  end

657
  def next_branch(name, opts = {})
P
P.S.V.R 已提交
658 659
    branch_ids = self.branch_names.map do |n|
      next 1 if n == name
660

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

P
P.S.V.R 已提交
665
    highest_branch_id = branch_ids.max || 0
666

P
P.S.V.R 已提交
667 668 669
    return name if opts[:mild] && 0 == highest_branch_id

    "#{name}-#{highest_branch_id + 1}"
670 671
  end

672
  def branches_sorted_by(value)
673
    raw_repository.local_branches(sort_by: value)
674
  end
675

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

691 692 693 694 695
  # Params:
  #
  # order_by: name|email|commits
  # sort: asc|desc default: 'asc'
  def contributors(order_by: nil, sort: 'asc')
696
    commits = self.commits(nil, limit: 2000, offset: 0, skip_merges: true)
697

698
    commits = commits.group_by(&:author_email).map do |email, commits|
699 700
      contributor = Gitlab::Contributor.new
      contributor.email = email
701

D
Dmitriy Zaporozhets 已提交
702
      commits.each do |commit|
703
        if contributor.name.blank?
D
Dmitriy Zaporozhets 已提交
704
          contributor.name = commit.author_name
705 706
        end

707
        contributor.commits += 1
708 709
      end

710 711
      contributor
    end
712
    Commit.order_by(collection: commits, order_by: order_by, sort: sort)
713
  end
D
Dmitriy Zaporozhets 已提交
714

715
  def branch_names_contains(sha)
716
    raw_repository.branch_names_contains_sha(sha)
717
  end
H
Hannes Rosenögger 已提交
718

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

723
  def local_branches
724
    @local_branches ||= raw_repository.local_branches
725 726
  end

727 728
  alias_method :branches, :local_branches

729 730 731 732
  def tags
    @tags ||= raw_repository.tags
  end

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

736
    multi_action(user, **options)
S
Stan Hu 已提交
737 738
  end

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

742
    multi_action(user, **options)
S
Stan Hu 已提交
743
  end
744

D
Douwe Maan 已提交
745 746 747
  def update_file(user, path, content, **options)
    previous_path = options.delete(:previous_path)
    action = previous_path && previous_path != path ? :move : :update
748

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

751
    multi_action(user, **options)
752 753
  end

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

757
    multi_action(user, **options)
758 759
  end

760 761
  def with_cache_hooks
    result = yield
762

763
    return unless result
764

765 766
    after_create if result.repo_created?
    after_create_branch if result.branch_created?
767

768 769 770
    result.newrev
  end

771 772
  def multi_action(user, **options)
    start_project = options.delete(:start_project)
M
Marc Siegfriedt 已提交
773

774 775
    if start_project
      options[:start_repository] = start_project.repository.raw_repository
M
Marc Siegfriedt 已提交
776 777
    end

778
    with_cache_hooks { raw.multi_action(user, **options) }
779 780
  end

781 782 783 784 785 786
  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
787
    end
788 789
  end

790
  def ff_merge(user, source, target_branch, merge_request: nil)
791 792
    their_commit_id = commit(source)&.id
    raise 'Invalid merge source' if their_commit_id.nil?
793

794
    merge_request&.update(in_progress_merge_commit_sha: their_commit_id)
795

796
    with_cache_hooks { raw.ff_merge(user, their_commit_id, target_branch) }
797 798
  end

799
  def revert(
800
    user, commit, branch_name, message,
801
    start_branch_name: nil, start_project: project)
802

803 804 805 806 807 808 809 810 811
    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
      )
812
    end
813 814
  end

815
  def cherry_pick(
816
    user, commit, branch_name, message,
817
    start_branch_name: nil, start_project: project)
P
P.S.V.R 已提交
818

819 820 821 822 823 824 825 826 827
    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 已提交
828 829 830
    end
  end

831
  def merged_to_root_ref?(branch_or_name)
832 833 834
    branch = Gitlab::Git::Branch.find(self, branch_or_name)

    if branch
835 836
      same_head = branch.target == root_ref_sha
      merged = ancestor?(branch.target, root_ref_sha)
837
      !same_head && merged
F
Florent (HP) 已提交
838 839 840 841 842
    else
      nil
    end
  end

843 844 845 846
  def root_ref_sha
    @root_ref_sha ||= commit(root_ref).sha
  end

847
  delegate :merged_branch_names, :can_be_merged?, to: :raw_repository
848

S
Stan Hu 已提交
849
  def merge_base(first_commit_id, second_commit_id)
850 851
    first_commit_id = commit(first_commit_id).try(:id) || first_commit_id
    second_commit_id = commit(second_commit_id).try(:id) || second_commit_id
852
    raw_repository.merge_base(first_commit_id, second_commit_id)
S
Stan Hu 已提交
853 854
  end

855
  def ancestor?(ancestor_id, descendant_id)
856
    return false if ancestor_id.nil? || descendant_id.nil?
857

858
    raw_repository.ancestor?(ancestor_id, descendant_id)
859 860
  end

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

867
    add_remote(remote_name, url, mirror_refmap: refmap)
868 869 870 871 872
    fetch_remote(remote_name, forced: forced)
  ensure
    remove_remote(remote_name) if tmp_remote_name
  end

873 874
  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)
875 876
  end

877 878
  def fetch_source_branch!(source_repository, source_branch, local_ref)
    raw_repository.fetch_source_branch!(source_repository.raw_repository, source_branch, local_ref)
879
  end
880

881 882
  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)
883
  end
884

885
  def create_ref(ref, ref_path)
886
    raw_repository.write_ref(ref_path, ref)
887 888
  end

889 890 891 892 893
  def ls_files(ref)
    actual_ref = ref || root_ref
    raw_repository.ls_files(actual_ref)
  end

894 895 896 897 898 899 900 901 902 903 904 905
  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

906 907 908 909 910 911 912 913 914 915
  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

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

930 931 932
    if instance_variable_defined?(ivar)
      instance_variable_get(ivar)
    else
933 934 935 936
      # 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?

937
      begin
938 939 940 941 942 943
        value =
          if memoize_only
            yield
          else
            cache.fetch(key, &block)
          end
944

945
        instance_variable_set(ivar, value)
946
      rescue Gitlab::Git::Repository::NoRepository
947 948 949
        # 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
950
        fallback
951 952 953
      end
    end
  end
954

955 956 957
  def cache_instance_variable_name(key)
    :"@#{key.to_s.tr('?!', '')}"
  end
958

959 960
  def file_on_head(type)
    if head = tree(:head)
D
Douwe Maan 已提交
961 962
      head.blobs.find do |blob|
        Gitlab::FileDetector.type_of(blob.path) == type
963 964 965 966
      end
    end
  end

D
Douwe Maan 已提交
967 968 969 970
  def route_map_for(sha)
    blob_data_at(sha, '.gitlab/route-map.yml')
  end

971 972
  def gitlab_ci_yml_for(sha, path = '.gitlab-ci.yml')
    blob_data_at(sha, path)
D
Douwe Maan 已提交
973 974
  end

975 976 977 978
  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

979 980 981 982
  def repository_storage_path
    @project.repository_storage_path
  end

983 984 985 986 987 988 989
  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

990 991
  private

992 993 994 995 996 997 998 999 1000 1001 1002 1003
  # 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 已提交
1004 1005
  def blob_data_at(sha, path)
    blob = blob_at(sha, path)
1006
    return unless blob
1007

1008
    blob.load_all_data!
1009
    blob.data
1010
  end
1011

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

  def tags_sorted_by_committed_date
1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029
    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
1030
  end
D
Douwe Maan 已提交
1031 1032

  def keep_around_ref_name(sha)
1033
    "refs/#{REF_KEEP_AROUND}/#{sha}"
D
Douwe Maan 已提交
1034
  end
Y
Yorick Peterse 已提交
1035 1036

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

1040
  def initialize_raw_repository
1041
    Gitlab::Git::Repository.new(project.repository_storage, disk_path + '.git', Gitlab::GlRepository.gl_repository(project, is_wiki))
1042
  end
1043
end