repository.rb 25.3 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
  include Gitlab::ShellAdapter
19
  include Gitlab::RepositoryCacheAdapter
20

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

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

26
  CreateTreeError = Class.new(StandardError)
27

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

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

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

61
  def initialize(full_path, project, disk_path: nil, is_wiki: false)
62
    @full_path = full_path
63
    @disk_path = disk_path || full_path
64
    @project = project
65
    @commit_cache = {}
66
    @is_wiki = is_wiki
67
  end
68

69
  def ==(other)
H
http://jneen.net/ 已提交
70 71 72
    @disk_path == other.disk_path
  end

73
  def raw_repository
74
    return nil unless full_path
75

76
    @raw_repository ||= initialize_raw_repository
77 78
  end

79 80
  alias_method :raw, :raw_repository

81 82 83 84
  def cleanup
    @raw_repository&.cleanup
  end

85
  # Return absolute path to repository
86
  def path_to_repo
87 88 89 90 91 92 93 94
    @path_to_repo ||=
      begin
        storage = Gitlab.config.repositories.storages[@project.repository_storage]

        File.expand_path(
          File.join(storage.legacy_disk_path, disk_path + '.git')
        )
      end
95 96
  end

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

L
Lin Jen-Shin 已提交
101
  def commit(ref = 'HEAD')
102
    return nil unless exists?
103
    return ref if ref.is_a?(::Commit)
104

105 106
    find_commit(ref)
  end
107

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

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

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

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

    CommitCollection.new(project, commits, ref)
146 147
  end

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

154 155 156 157 158 159 160
  # Returns a list of commits that are not present in any reference
  def new_commits(newrev)
    refs = ::Gitlab::Git::RevList.new(raw, newrev: newrev).new_refs

    refs.map { |sha| commit(sha.strip) }
  end

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

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

173
  def find_branch(name, fresh_repo: true)
174
    raw_repository.find_branch(name, fresh_repo)
175 176 177
  end

  def find_tag(name)
178
    tags.find { |tag| tag.name == name }
179 180
  end

181
  def add_branch(user, branch_name, ref)
182
    branch = raw_repository.add_branch(branch_name, user: user, target: ref)
183

184
    after_create_branch
185 186 187 188

    branch
  rescue Gitlab::Git::Repository::InvalidRef
    false
189 190
  end

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

197
  def rm_branch(user, branch_name)
198
    before_remove_branch
199

200
    raw_repository.rm_branch(branch_name, user: user)
201

202
    after_remove_branch
203
    true
204 205
  end

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

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

    after_remove_tag
    true
213 214
  end

215 216 217 218
  def ref_names
    branch_names + tag_names
  end

219
  def branch_exists?(branch_name)
220 221
    return false unless raw_repository

222
    branch_names.include?(branch_name)
223 224
  end

225 226 227 228 229 230
  def tag_exists?(tag_name)
    return false unless raw_repository

    tag_names.include?(tag_name)
  end

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

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

    return if kept_around?(sha)

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

  def kept_around?(sha)
253
    ref_exists?(keep_around_ref_name(sha))
254
  end
255

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

268 269 270
      { behind: number_commits_behind, ahead: number_commits_ahead }
    end
  end
271

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

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

283 284
  def expire_statistics_caches
    expire_method_caches(%i(size commit_count))
285 286
  end

287 288
  def expire_all_method_caches
    expire_method_caches(CACHED_METHODS)
D
Douwe Maan 已提交
289 290
  end

291 292 293 294 295 296 297 298 299 300 301 302 303 304 305
  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
306
    end
307

308
    expire_method_caches(to_refresh)
309

310
    to_refresh.each { |method| send(method) } # rubocop:disable GitlabSecurity/PublicSend
311
  end
312

313 314 315 316 317 318 319
  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}")
320
        cache.expire(:"commit_count_#{branch.name}")
321 322 323 324 325
      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}")
326
      cache.expire(:"commit_count_#{branch_name}")
327
    end
D
Dmitriy Zaporozhets 已提交
328 329
  end

330
  def expire_root_ref_cache
331
    expire_method_caches(%i(root_ref))
332 333
  end

334 335
  # Expires the cache(s) used to determine if a repository is empty or not.
  def expire_emptiness_caches
336
    return unless empty?
337

338
    expire_method_caches(%i(has_visible_content?))
339
    raw_repository.expire_has_local_branches_cache
Y
Yorick Peterse 已提交
340 341
  end

342 343 344 345
  def lookup_cache
    @lookup_cache ||= {}
  end

346
  def expire_exists_cache
347
    expire_method_caches(%i(exists?))
348 349
  end

350 351 352 353 354 355 356
  # 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
357
    expire_statistics_caches
358 359 360 361 362
  end

  # Runs code after a repository has been created.
  def after_create
    expire_exists_cache
363 364
    expire_root_ref_cache
    expire_emptiness_caches
Y
Yorick Peterse 已提交
365 366

    repository_event(:create_repository)
367 368
  end

369 370
  # Runs code just before a repository is deleted.
  def before_delete
371
    expire_exists_cache
372 373
    expire_all_method_caches
    expire_branch_cache if exists?
374
    expire_content_cache
Y
Yorick Peterse 已提交
375 376

    repository_event(:remove_repository)
377 378 379 380 381 382 383
  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 已提交
384 385

    repository_event(:change_default_branch)
386 387
  end

Y
Yorick Peterse 已提交
388 389
  # Runs code before pushing (= creating or removing) a tag.
  def before_push_tag
390 391
    expire_statistics_caches
    expire_emptiness_caches
392
    expire_tags_cache
Y
Yorick Peterse 已提交
393 394

    repository_event(:push_tag)
Y
Yorick Peterse 已提交
395 396 397 398 399
  end

  # Runs code before removing a tag.
  def before_remove_tag
    expire_tags_cache
400
    expire_statistics_caches
Y
Yorick Peterse 已提交
401 402

    repository_event(:remove_tag)
403 404
  end

L
Lin Jen-Shin 已提交
405 406 407 408 409
  # Runs code after removing a tag.
  def after_remove_tag
    expire_tags_cache
  end

410 411 412
  # Runs code after the HEAD of a repository is changed.
  def after_change_head
    expire_method_caches(METHOD_CACHES_FOR_FILE_TYPES.keys)
413 414
  end

415 416
  # Runs code after a repository has been forked/imported.
  def after_import
417
    expire_content_cache
418 419 420
  end

  # Runs code after a new commit has been pushed.
421 422 423
  def after_push_commit(branch_name)
    expire_statistics_caches
    expire_branch_cache(branch_name)
Y
Yorick Peterse 已提交
424 425

    repository_event(:push_commit, branch: branch_name)
426 427 428 429
  end

  # Runs code after a new branch has been created.
  def after_create_branch
430
    expire_branches_cache
Y
Yorick Peterse 已提交
431 432

    repository_event(:push_branch)
433 434
  end

435 436 437
  # Runs code before removing an existing branch.
  def before_remove_branch
    expire_branches_cache
Y
Yorick Peterse 已提交
438 439

    repository_event(:remove_branch)
440 441
  end

442 443
  # Runs code after an existing branch has been removed.
  def after_remove_branch
444
    expire_branches_cache
445 446
  end

447
  def method_missing(m, *args, &block)
448 449
    if m == :lookup && !block_given?
      lookup_cache[m] ||= {}
450
      lookup_cache[m][args.join(":")] ||= raw_repository.__send__(m, *args, &block) # rubocop:disable GitlabSecurity/PublicSend
451
    else
452
      raw_repository.__send__(m, *args, &block) # rubocop:disable GitlabSecurity/PublicSend
453
    end
454 455
  end

456 457
  def respond_to_missing?(method, include_private = false)
    raw_repository.respond_to?(method, include_private) || super
458
  end
D
Dmitriy Zaporozhets 已提交
459 460

  def blob_at(sha, path)
461
    Blob.decorate(raw_repository.blob_at(sha, path), project)
D
Douwe Maan 已提交
462 463
  rescue Gitlab::Git::Repository::NoRepository
    nil
D
Dmitriy Zaporozhets 已提交
464
  end
465

466 467 468 469 470
  # 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

471
  def root_ref
472 473
    # When the repo does not exist, or there is no root ref, we raise this error so no data is cached.
    raw_repository&.root_ref or raise Gitlab::Git::Repository::NoRepository # rubocop:disable Style/AndOr
474
  end
475
  cache_method :root_ref
476

477
  # Gitaly migration: https://gitlab.com/gitlab-org/gitaly/issues/314
478
  def exists?
479
    return false unless full_path
480

481
    raw_repository.exists?
482 483 484
  end
  cache_method :exists?

485 486 487
  # We don't need to cache the output of this method because both exists? and
  # has_visible_content? are already memoized and cached. There's no guarantee
  # that the values are expired and loaded atomically.
488 489 490 491 492
  def empty?
    return true unless exists?

    !has_visible_content?
  end
493 494 495 496 497 498 499 500 501 502 503 504

  # 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

505
  def commit_count_for_ref(ref)
506
    return 0 unless exists?
507

508
    cache.fetch(:"commit_count_#{ref}") { raw_repository.commit_count(ref) }
509 510
  end

511
  delegate :branch_names, to: :raw_repository
512 513
  cache_method :branch_names, fallback: []

D
Douwe Maan 已提交
514
  delegate :tag_names, to: :raw_repository
515 516
  cache_method :tag_names, fallback: []

517
  delegate :branch_count, :tag_count, :has_visible_content?, to: :raw_repository
518 519
  cache_method :branch_count, fallback: 0
  cache_method :tag_count, fallback: 0
520
  cache_method :has_visible_content?, fallback: false
521 522

  def avatar
523 524 525 526 527
    # 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
528 529
    end
  end
530
  cache_method :avatar
531

S
Sean McGivern 已提交
532 533 534 535 536 537 538 539 540 541
  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: []

542
  def readme
543 544
    if readme = tree(:head)&.readme
      ReadmeBlob.new(readme, self)
545
    end
546 547
  end

548
  def rendered_readme
T
Toon Claes 已提交
549
    MarkupHelper.markup_unsafe(readme.name, readme.data, project: project) if readme
550 551
  end
  cache_method :rendered_readme
552

553
  def contribution_guide
554
    file_on_head(:contributing)
555
  end
556
  cache_method :contribution_guide
557 558

  def changelog
559
    file_on_head(:changelog)
560
  end
561
  cache_method :changelog
562

563
  def license_blob
564
    file_on_head(:license)
565
  end
566
  cache_method :license_blob
Z
Zeger-Jan van de Weg 已提交
567

568
  def license_key
569
    return unless exists?
570

571
    raw_repository.license_short_name
572
  end
573
  cache_method :license_key
574

D
Douwe Maan 已提交
575 576
  def license
    return unless license_key
577

578
    Licensee::License.new(license_key)
579
  end
580
  cache_method :license, memoize_only: true
581 582

  def gitignore
583
    file_on_head(:gitignore)
584
  end
585
  cache_method :gitignore
586 587

  def koding_yml
588
    file_on_head(:koding)
589
  end
590
  cache_method :koding_yml
591

592
  def gitlab_ci_yml
593
    file_on_head(:gitlab_ci)
594
  end
595
  cache_method :gitlab_ci_yml
596

597
  def head_commit
598 599 600 601
    @head_commit ||= commit(self.root_ref)
  end

  def head_tree
602 603 604
    if head_commit
      @head_tree ||= Tree.new(self, head_commit.sha, nil)
    end
605 606
  end

607
  def tree(sha = :head, path = nil, recursive: false)
608
    if sha == :head
609 610
      return unless head_commit

611 612 613 614 615
      if path.nil?
        return head_tree
      else
        sha = head_commit.sha
      end
616 617
    end

618
    Tree.new(self, sha, path, recursive: recursive)
619
  end
D
Dmitriy Zaporozhets 已提交
620 621

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

D
Dmitriy Zaporozhets 已提交
624 625 626 627 628
    if last_commit
      blob_at(last_commit.sha, path)
    else
      nil
    end
D
Dmitriy Zaporozhets 已提交
629
  end
D
Dmitriy Zaporozhets 已提交
630

631
  def last_commit_for_path(sha, path)
632 633
    commit = raw_repository.last_commit_for_path(sha, path)
    ::Commit.new(commit, @project) if commit
634
  end
635

H
Hiroyuki Sato 已提交
636 637
  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 已提交
638

H
Hiroyuki Sato 已提交
639
    cache.fetch(key) do
640
      last_commit_for_path(sha, path)&.id
H
Hiroyuki Sato 已提交
641 642 643
    end
  end

644
  def next_branch(name, opts = {})
P
P.S.V.R 已提交
645 646
    branch_ids = self.branch_names.map do |n|
      next 1 if n == name
647

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

P
P.S.V.R 已提交
652
    highest_branch_id = branch_ids.max || 0
653

P
P.S.V.R 已提交
654 655 656
    return name if opts[:mild] && 0 == highest_branch_id

    "#{name}-#{highest_branch_id + 1}"
657 658
  end

659
  def branches_sorted_by(value)
660
    raw_repository.local_branches(sort_by: value)
661
  end
662

663 664
  def tags_sorted_by(value)
    case value
H
haseeb 已提交
665 666 667
    when 'name_asc'
      VersionSorter.sort(tags) { |tag| tag.name }
    when 'name_desc'
668
      VersionSorter.rsort(tags) { |tag| tag.name }
669 670 671 672 673 674 675 676 677
    when 'updated_desc'
      tags_sorted_by_committed_date.reverse
    when 'updated_asc'
      tags_sorted_by_committed_date
    else
      tags
    end
  end

678 679 680 681 682
  # Params:
  #
  # order_by: name|email|commits
  # sort: asc|desc default: 'asc'
  def contributors(order_by: nil, sort: 'asc')
683
    commits = self.commits(nil, limit: 2000, offset: 0, skip_merges: true)
684

685
    commits = commits.group_by(&:author_email).map do |email, commits|
686 687
      contributor = Gitlab::Contributor.new
      contributor.email = email
688

D
Dmitriy Zaporozhets 已提交
689
      commits.each do |commit|
690
        if contributor.name.blank?
D
Dmitriy Zaporozhets 已提交
691
          contributor.name = commit.author_name
692 693
        end

694
        contributor.commits += 1
695 696
      end

697 698
      contributor
    end
699
    Commit.order_by(collection: commits, order_by: order_by, sort: sort)
700
  end
D
Dmitriy Zaporozhets 已提交
701

702
  def branch_names_contains(sha)
703
    raw_repository.branch_names_contains_sha(sha)
704
  end
H
Hannes Rosenögger 已提交
705

706
  def tag_names_contains(sha)
707
    raw_repository.tag_names_contains_sha(sha)
H
Hannes Rosenögger 已提交
708
  end
709

710
  def local_branches
711
    @local_branches ||= raw_repository.local_branches
712 713
  end

714 715
  alias_method :branches, :local_branches

716 717 718 719
  def tags
    @tags ||= raw_repository.tags
  end

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

723
    multi_action(user, **options)
S
Stan Hu 已提交
724 725
  end

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

729
    multi_action(user, **options)
S
Stan Hu 已提交
730
  end
731

D
Douwe Maan 已提交
732 733 734
  def update_file(user, path, content, **options)
    previous_path = options.delete(:previous_path)
    action = previous_path && previous_path != path ? :move : :update
735

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

738
    multi_action(user, **options)
739 740
  end

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

744
    multi_action(user, **options)
745 746
  end

747 748
  def with_cache_hooks
    result = yield
749

750
    return unless result
751

752 753
    after_create if result.repo_created?
    after_create_branch if result.branch_created?
754

755 756 757
    result.newrev
  end

758 759
  def multi_action(user, **options)
    start_project = options.delete(:start_project)
M
Marc Siegfriedt 已提交
760

761 762
    if start_project
      options[:start_repository] = start_project.repository.raw_repository
M
Marc Siegfriedt 已提交
763 764
    end

765
    with_cache_hooks { raw.multi_action(user, **options) }
766 767
  end

768 769 770 771 772 773
  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
774
    end
775 776
  end

777
  def ff_merge(user, source, target_branch, merge_request: nil)
778 779
    their_commit_id = commit(source)&.id
    raise 'Invalid merge source' if their_commit_id.nil?
780

781
    merge_request&.update(in_progress_merge_commit_sha: their_commit_id)
782

783
    with_cache_hooks { raw.ff_merge(user, their_commit_id, target_branch) }
784 785
  end

786
  def revert(
787
    user, commit, branch_name, message,
788
    start_branch_name: nil, start_project: project)
789

790 791 792 793 794 795 796 797 798
    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
      )
799
    end
800 801
  end

802
  def cherry_pick(
803
    user, commit, branch_name, message,
804
    start_branch_name: nil, start_project: project)
P
P.S.V.R 已提交
805

806 807 808 809 810 811 812 813 814
    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 已提交
815 816 817
    end
  end

818
  def merged_to_root_ref?(branch_or_name)
819 820 821
    branch = Gitlab::Git::Branch.find(self, branch_or_name)

    if branch
822 823
      same_head = branch.target == root_ref_sha
      merged = ancestor?(branch.target, root_ref_sha)
824
      !same_head && merged
F
Florent (HP) 已提交
825 826 827 828 829
    else
      nil
    end
  end

830 831 832 833
  def root_ref_sha
    @root_ref_sha ||= commit(root_ref).sha
  end

834
  delegate :merged_branch_names, :can_be_merged?, to: :raw_repository
835

S
Stan Hu 已提交
836
  def merge_base(first_commit_id, second_commit_id)
837 838
    first_commit_id = commit(first_commit_id).try(:id) || first_commit_id
    second_commit_id = commit(second_commit_id).try(:id) || second_commit_id
839
    raw_repository.merge_base(first_commit_id, second_commit_id)
S
Stan Hu 已提交
840 841
  end

842
  def ancestor?(ancestor_id, descendant_id)
843
    return false if ancestor_id.nil? || descendant_id.nil?
844

845
    raw_repository.ancestor?(ancestor_id, descendant_id)
846 847
  end

848
  def fetch_as_mirror(url, forced: false, refmap: :all_refs, remote_name: nil, prune: true)
849 850 851 852 853
    unless remote_name
      remote_name = "tmp-#{SecureRandom.hex}"
      tmp_remote_name = true
    end

854
    add_remote(remote_name, url, mirror_refmap: refmap)
855
    fetch_remote(remote_name, forced: forced, prune: prune)
856 857 858 859
  ensure
    remove_remote(remote_name) if tmp_remote_name
  end

860 861
  def fetch_remote(remote, forced: false, ssh_auth: nil, no_tags: false, prune: true)
    gitlab_shell.fetch_remote(raw_repository, remote, ssh_auth: ssh_auth, forced: forced, no_tags: no_tags, prune: prune)
862 863
  end

864 865
  def fetch_source_branch!(source_repository, source_branch, local_ref)
    raw_repository.fetch_source_branch!(source_repository.raw_repository, source_branch, local_ref)
866
  end
867

868 869
  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)
870
  end
871

872
  def create_ref(ref, ref_path)
873
    raw_repository.write_ref(ref_path, ref)
874 875
  end

876 877 878 879 880
  def ls_files(ref)
    actual_ref = ref || root_ref
    raw_repository.ls_files(actual_ref)
  end

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

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

903 904
  def file_on_head(type)
    if head = tree(:head)
D
Douwe Maan 已提交
905 906
      head.blobs.find do |blob|
        Gitlab::FileDetector.type_of(blob.path) == type
907 908 909 910
      end
    end
  end

D
Douwe Maan 已提交
911 912 913 914
  def route_map_for(sha)
    blob_data_at(sha, '.gitlab/route-map.yml')
  end

915 916
  def gitlab_ci_yml_for(sha, path = '.gitlab-ci.yml')
    blob_data_at(sha, path)
D
Douwe Maan 已提交
917 918
  end

919 920 921 922
  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

923 924 925 926 927 928 929
  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

930 931
  private

932 933 934 935 936 937 938 939 940 941 942 943
  # 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 已提交
944 945
  def blob_data_at(sha, path)
    blob = blob_at(sha, path)
946
    return unless blob
947

948
    blob.load_all_data!
949
    blob.data
950
  end
951

952
  def cache
953
    @cache ||= Gitlab::RepositoryCache.new(self)
954
  end
955 956

  def tags_sorted_by_committed_date
957 958 959 960 961 962 963 964 965 966 967 968
    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
969
  end
D
Douwe Maan 已提交
970 971

  def keep_around_ref_name(sha)
972
    "refs/#{REF_KEEP_AROUND}/#{sha}"
D
Douwe Maan 已提交
973
  end
Y
Yorick Peterse 已提交
974 975

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

979
  def initialize_raw_repository
980
    Gitlab::Git::Repository.new(project.repository_storage, disk_path + '.git', Gitlab::GlRepository.gl_repository(project, is_wiki))
981
  end
982
end