repository.rb 26.8 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?
40
                      issue_template_names merge_request_template_names xcode_project?).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
    avatar: :avatar,
    issue_template: :issue_template_names,
58 59
    merge_request_template: :merge_request_template_names,
    xcode_config: :xcode_project?
D
Douwe Maan 已提交
60
  }.freeze
61

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

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

74
  def raw_repository
75
    return nil unless full_path
76

77
    @raw_repository ||= initialize_raw_repository
78 79
  end

80 81
  alias_method :raw, :raw_repository

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

86
  # Return absolute path to repository
87
  def path_to_repo
88 89 90 91 92 93 94 95
    @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
96 97
  end

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

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

106 107
    find_commit(ref)
  end
108

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

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

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

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

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

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

155 156 157 158 159 160 161
  # 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 已提交
162
  # Gitaly migration: https://gitlab.com/gitlab-org/gitaly/issues/384
163
  def find_commits_by_message(query, ref = nil, path = nil, limit = 1000, offset = 0)
164 165 166 167
    unless exists? && has_visible_content? && query.present?
      return []
    end

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

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

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

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

185
    after_create_branch
186 187 188 189

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

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

198
  def rm_branch(user, branch_name)
199
    before_remove_branch
200

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

203
    after_remove_branch
204
    true
205 206
  end

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

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

    after_remove_tag
    true
214 215
  end

216 217 218 219
  def ref_names
    branch_names + tag_names
  end

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

223
    branch_names.include?(branch_name)
224 225
  end

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

    tag_names.include?(tag_name)
  end

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

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

    return if kept_around?(sha)

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

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

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

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

273 274 275 276 277 278 279 280 281 282
  def archive_metadata(ref, storage_path, format = "tar.gz", append_sha:)
    raw_repository.archive_metadata(
      ref,
      storage_path,
      project.path,
      format,
      append_sha: append_sha
    )
  end

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

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

294 295
  def expire_statistics_caches
    expire_method_caches(%i(size commit_count))
296 297
  end

298 299
  def expire_all_method_caches
    expire_method_caches(CACHED_METHODS)
D
Douwe Maan 已提交
300 301
  end

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

319
    expire_method_caches(to_refresh)
320

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

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

341
  def expire_root_ref_cache
342
    expire_method_caches(%i(root_ref))
343 344
  end

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

349
    expire_method_caches(%i(has_visible_content?))
350
    raw_repository.expire_has_local_branches_cache
Y
Yorick Peterse 已提交
351 352
  end

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

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

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

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

    repository_event(:create_repository)
378 379
  end

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

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

    repository_event(:change_default_branch)
397 398
  end

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

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

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

    repository_event(:remove_tag)
414 415
  end

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

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

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

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

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

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

    repository_event(:push_branch)
444 445
  end

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

    repository_event(:remove_branch)
451 452
  end

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

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

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

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

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

482
  def root_ref
483 484
    # 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
485
  end
486
  cache_method :root_ref
487

488
  # Gitaly migration: https://gitlab.com/gitlab-org/gitaly/issues/314
489
  def exists?
490
    return false unless full_path
491

492
    raw_repository.exists?
493 494 495
  end
  cache_method :exists?

496 497 498
  # 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.
499 500 501 502 503
  def empty?
    return true unless exists?

    !has_visible_content?
  end
504 505 506 507 508 509 510 511 512 513 514 515

  # 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

516
  def commit_count_for_ref(ref)
517
    return 0 unless exists?
518

519
    cache.fetch(:"commit_count_#{ref}") { raw_repository.commit_count(ref) }
520 521
  end

522
  delegate :branch_names, to: :raw_repository
523 524
  cache_method :branch_names, fallback: []

D
Douwe Maan 已提交
525
  delegate :tag_names, to: :raw_repository
526 527
  cache_method :tag_names, fallback: []

528
  delegate :branch_count, :tag_count, :has_visible_content?, to: :raw_repository
529 530
  cache_method :branch_count, fallback: 0
  cache_method :tag_count, fallback: 0
531
  cache_method :has_visible_content?, fallback: false
532 533

  def avatar
534 535 536 537 538
    # 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
539 540
    end
  end
541
  cache_method :avatar
542

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

553
  def readme
554 555
    if readme = tree(:head)&.readme
      ReadmeBlob.new(readme, self)
556
    end
557 558
  end

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

564
  def contribution_guide
565
    file_on_head(:contributing)
566
  end
567
  cache_method :contribution_guide
568 569

  def changelog
570
    file_on_head(:changelog)
571
  end
572
  cache_method :changelog
573

574
  def license_blob
575
    file_on_head(:license)
576
  end
577
  cache_method :license_blob
Z
Zeger-Jan van de Weg 已提交
578

579
  def license_key
580
    return unless exists?
581

582
    raw_repository.license_short_name
583
  end
584
  cache_method :license_key
585

D
Douwe Maan 已提交
586 587
  def license
    return unless license_key
588

589
    Licensee::License.new(license_key)
590
  end
591
  cache_method :license, memoize_only: true
592 593

  def gitignore
594
    file_on_head(:gitignore)
595
  end
596
  cache_method :gitignore
597 598

  def koding_yml
599
    file_on_head(:koding)
600
  end
601
  cache_method :koding_yml
602

603
  def gitlab_ci_yml
604
    file_on_head(:gitlab_ci)
605
  end
606
  cache_method :gitlab_ci_yml
607

608
  def xcode_project?
609
    file_on_head(:xcode_config, :tree).present?
610 611 612
  end
  cache_method :xcode_project?

613
  def head_commit
614 615 616 617
    @head_commit ||= commit(self.root_ref)
  end

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

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

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

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

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

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

647
  def last_commit_for_path(sha, path)
648 649
    commit = raw_repository.last_commit_for_path(sha, path)
    ::Commit.new(commit, @project) if commit
650
  end
651

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

H
Hiroyuki Sato 已提交
655
    cache.fetch(key) do
656
      last_commit_for_path(sha, path)&.id
H
Hiroyuki Sato 已提交
657 658 659
    end
  end

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

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

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

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

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

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

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

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

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

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

710
        contributor.commits += 1
711 712
      end

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

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

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

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

730 731
  alias_method :branches, :local_branches

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

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

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

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

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

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

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

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

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

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

763 764
  def with_cache_hooks
    result = yield
765

766
    return unless result
767

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

771 772 773
    result.newrev
  end

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

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

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

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

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

797
    merge_request&.update(in_progress_merge_commit_sha: their_commit_id)
798

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

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

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

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

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

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

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

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

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

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

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

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

864
  def fetch_as_mirror(url, forced: false, refmap: :all_refs, remote_name: nil, prune: true)
865 866 867 868 869
    unless remote_name
      remote_name = "tmp-#{SecureRandom.hex}"
      tmp_remote_name = true
    end

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

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

880 881 882 883 884 885 886 887 888 889 890 891 892 893
  def async_remove_remote(remote_name)
    return unless remote_name

    job_id = RepositoryRemoveRemoteWorker.perform_async(project.id, remote_name)

    if job_id
      Rails.logger.info("Remove remote job scheduled for #{project.id} with remote name: #{remote_name} job ID #{job_id}.")
    else
      Rails.logger.info("Remove remote job failed to create for #{project.id} with remote name #{remote_name}.")
    end

    job_id
  end

894 895
  def fetch_source_branch!(source_repository, source_branch, local_ref)
    raw_repository.fetch_source_branch!(source_repository.raw_repository, source_branch, local_ref)
896
  end
897

898 899
  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)
900
  end
901

902
  def create_ref(ref, ref_path)
903
    raw_repository.write_ref(ref_path, ref)
904 905
  end

906 907 908 909 910
  def ls_files(ref)
    actual_ref = ref || root_ref
    raw_repository.ls_files(actual_ref)
  end

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

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

933 934 935 936 937 938 939 940 941 942 943
  def file_on_head(type, object_type = :blob)
    return unless head = tree(:head)

    objects =
      case object_type
      when :blob
        head.blobs
      when :tree
        head.trees
      else
        raise ArgumentError, "Object type #{object_type} is not supported"
944
      end
945 946 947

    objects.find do |object|
      Gitlab::FileDetector.type_of(object.path) == type
948 949 950
    end
  end

D
Douwe Maan 已提交
951 952 953 954
  def route_map_for(sha)
    blob_data_at(sha, '.gitlab/route-map.yml')
  end

955 956
  def gitlab_ci_yml_for(sha, path = '.gitlab-ci.yml')
    blob_data_at(sha, path)
D
Douwe Maan 已提交
957 958
  end

959 960 961 962
  def lfsconfig_for(sha)
    blob_data_at(sha, '.lfsconfig')
  end

963 964 965 966
  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

967 968 969 970 971 972 973
  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

974 975 976 977 978 979 980 981
  def blob_data_at(sha, path)
    blob = blob_at(sha, path)
    return unless blob

    blob.load_all_data!
    blob.data
  end

982 983 984 985 986 987 988 989
  def squash(user, merge_request)
    raw.squash(user, merge_request.id, branch: merge_request.target_branch,
                                       start_sha: merge_request.diff_start_sha,
                                       end_sha: merge_request.diff_head_sha,
                                       author: merge_request.author,
                                       message: merge_request.title)
  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

1004
  def cache
1005
    @cache ||= Gitlab::RepositoryCache.new(self)
1006
  end
1007 1008

  def tags_sorted_by_committed_date
1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020
    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
1021
  end
D
Douwe Maan 已提交
1022 1023

  def keep_around_ref_name(sha)
1024
    "refs/#{REF_KEEP_AROUND}/#{sha}"
D
Douwe Maan 已提交
1025
  end
Y
Yorick Peterse 已提交
1026 1027

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

1031
  def initialize_raw_repository
1032
    Gitlab::Git::Repository.new(project.repository_storage, disk_path + '.git', Gitlab::GlRepository.gl_repository(project, is_wiki))
1033
  end
1034
end