repository.rb 81.4 KB
Newer Older
Robert Speicher's avatar
Robert Speicher committed
1 2 3 4 5 6 7 8
# Gitlab::Git::Repository is a wrapper around native Rugged::Repository object
require 'tempfile'
require 'forwardable'
require "rubygems/package"

module Gitlab
  module Git
    class Repository
9
      include Gitlab::Git::RepositoryMirroring
Robert Speicher's avatar
Robert Speicher committed
10
      include Gitlab::Git::Popen
11
      include Gitlab::EncodingHelper
12
      include Gitlab::Utils::StrongMemoize
Robert Speicher's avatar
Robert Speicher committed
13

14 15 16 17
      ALLOWED_OBJECT_DIRECTORIES_VARIABLES = %w[
        GIT_OBJECT_DIRECTORY
        GIT_ALTERNATE_OBJECT_DIRECTORIES
      ].freeze
18 19 20 21
      ALLOWED_OBJECT_RELATIVE_DIRECTORIES_VARIABLES = %w[
        GIT_OBJECT_DIRECTORY_RELATIVE
        GIT_ALTERNATE_OBJECT_DIRECTORIES_RELATIVE
      ].freeze
Robert Speicher's avatar
Robert Speicher committed
22
      SEARCH_CONTEXT_LINES = 3
23 24 25
      # In https://gitlab.com/gitlab-org/gitaly/merge_requests/698
      # We copied these two prefixes into gitaly-go, so don't change these
      # or things will break! (REBASE_WORKTREE_PREFIX and SQUASH_WORKTREE_PREFIX)
26 27
      REBASE_WORKTREE_PREFIX = 'rebase'.freeze
      SQUASH_WORKTREE_PREFIX = 'squash'.freeze
28
      GITALY_INTERNAL_URL = 'ssh://gitaly/internal.git'.freeze
29
      GITLAB_PROJECTS_TIMEOUT = Gitlab.config.gitlab_shell.git_timeout
30
      EMPTY_REPOSITORY_CHECKSUM = '0000000000000000000000000000000000000000'.freeze
Robert Speicher's avatar
Robert Speicher committed
31

32
      NoRepository = Class.new(StandardError)
33
      InvalidRepository = Class.new(StandardError)
34 35
      InvalidBlobName = Class.new(StandardError)
      InvalidRef = Class.new(StandardError)
36
      GitError = Class.new(StandardError)
37
      DeleteBranchError = Class.new(StandardError)
38
      CreateTreeError = Class.new(StandardError)
39
      TagExistsError = Class.new(StandardError)
40
      ChecksumError = Class.new(StandardError)
Robert Speicher's avatar
Robert Speicher committed
41

42
      class << self
43 44
        # Unlike `new`, `create` takes the repository path
        def create(repo_path, bare: true, symlink_hooks_to: nil)
45 46 47 48 49 50
          FileUtils.mkdir_p(repo_path, mode: 0770)

          # Equivalent to `git --git-path=#{repo_path} init [--bare]`
          repo = Rugged::Repository.init_at(repo_path, bare)
          repo.close

51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67
          create_hooks(repo_path, symlink_hooks_to) if symlink_hooks_to.present?

          true
        end

        def create_hooks(repo_path, global_hooks_path)
          local_hooks_path = File.join(repo_path, 'hooks')
          real_local_hooks_path = :not_found

          begin
            real_local_hooks_path = File.realpath(local_hooks_path)
          rescue Errno::ENOENT
            # real_local_hooks_path == :not_found
          end

          # Do nothing if hooks already exist
          unless real_local_hooks_path == File.realpath(global_hooks_path)
Rémy Coutable's avatar
Rémy Coutable committed
68 69 70 71 72 73
            if File.exist?(local_hooks_path)
              # Move the existing hooks somewhere safe
              FileUtils.mv(
                local_hooks_path,
                "#{local_hooks_path}.old.#{Time.now.to_i}")
            end
74 75 76

            # Create the hooks symlink
            FileUtils.ln_sf(global_hooks_path, local_hooks_path)
77 78 79 80 81 82
          end

          true
        end
      end

Robert Speicher's avatar
Robert Speicher committed
83 84 85
      # Directory name of repo
      attr_reader :name

86 87 88
      # Relative path of repo
      attr_reader :relative_path

Robert Speicher's avatar
Robert Speicher committed
89 90 91
      # Rugged repo object
      attr_reader :rugged

92
      attr_reader :gitlab_projects, :storage, :gl_repository, :relative_path
Jacob Vosmaer's avatar
Jacob Vosmaer committed
93

94 95
      # This initializer method is only used on the client side (gitlab-ce).
      # Gitaly-ruby uses a different initializer.
96
      def initialize(storage, relative_path, gl_repository)
Jacob Vosmaer's avatar
Jacob Vosmaer committed
97
        @storage = storage
98
        @relative_path = relative_path
99
        @gl_repository = gl_repository
100

101
        @gitlab_projects = Gitlab::Git::GitlabProjects.new(
102
          storage,
103 104 105 106
          relative_path,
          global_hooks_path: Gitlab.config.gitlab_shell.hooks_path,
          logger: Rails.logger
        )
107

108
        @name = @relative_path.split("/").last
Robert Speicher's avatar
Robert Speicher committed
109 110
      end

111
      def ==(other)
112
        [storage, relative_path] == [other.storage, other.relative_path]
113 114
      end

115 116 117 118 119 120
      def path
        @path ||= File.join(
          Gitlab.config.repositories.storages[@storage].legacy_disk_path, @relative_path
        )
      end

Robert Speicher's avatar
Robert Speicher committed
121 122
      # Default branch in the repository
      def root_ref
123 124 125 126 127
        gitaly_ref_client.default_branch_name
      rescue GRPC::NotFound => e
        raise NoRepository.new(e.message)
      rescue GRPC::Unknown => e
        raise Gitlab::Git::CommandError.new(e.message)
Robert Speicher's avatar
Robert Speicher committed
128 129 130
      end

      def rugged
131 132 133
        @rugged ||= circuit_breaker.perform do
          Rugged::Repository.new(path, alternates: alternate_object_directories)
        end
Robert Speicher's avatar
Robert Speicher committed
134 135 136 137
      rescue Rugged::RepositoryError, Rugged::OSError
        raise NoRepository.new('no repository for such path')
      end

138 139 140 141
      def cleanup
        @rugged&.close
      end

142 143 144 145
      def circuit_breaker
        @circuit_breaker ||= Gitlab::Git::Storage::CircuitBreaker.for_storage(storage)
      end

146
      def exists?
147
        gitaly_repository_client.exists?
148 149
      end

Robert Speicher's avatar
Robert Speicher committed
150 151 152
      # Returns an Array of branch names
      # sorted by name ASC
      def branch_names
153
        gitaly_migrate(:branch_names, status: Gitlab::GitalyClient::MigrationStatus::OPT_OUT) do |is_enabled|
154 155 156 157 158 159
          if is_enabled
            gitaly_ref_client.branch_names
          else
            branches.map(&:name)
          end
        end
Robert Speicher's avatar
Robert Speicher committed
160 161 162
      end

      # Returns an Array of Branches
163
      def branches
164
        gitaly_migrate(:branches, status: Gitlab::GitalyClient::MigrationStatus::OPT_OUT) do |is_enabled|
165 166 167 168 169 170
          if is_enabled
            gitaly_ref_client.branches
          else
            branches_filter
          end
        end
Robert Speicher's avatar
Robert Speicher committed
171 172 173 174 175 176 177 178 179 180 181 182 183 184
      end

      def reload_rugged
        @rugged = nil
      end

      # Directly find a branch with a simple name (e.g. master)
      #
      # force_reload causes a new Rugged repository to be instantiated
      #
      # This is to work around a bug in libgit2 that causes in-memory refs to
      # be stale/invalid when packed-refs is changed.
      # See https://gitlab.com/gitlab-org/gitlab-ce/issues/15392#note_14538333
      def find_branch(name, force_reload = false)
185 186 187 188 189
        gitaly_migrate(:find_branch) do |is_enabled|
          if is_enabled
            gitaly_ref_client.find_branch(name)
          else
            reload_rugged if force_reload
Robert Speicher's avatar
Robert Speicher committed
190

191 192 193 194 195 196
            rugged_ref = rugged.branches[name]
            if rugged_ref
              target_commit = Gitlab::Git::Commit.find(self, rugged_ref.target)
              Gitlab::Git::Branch.new(self, rugged_ref.name, rugged_ref.target, target_commit)
            end
          end
197
        end
Robert Speicher's avatar
Robert Speicher committed
198 199
      end

200
      def local_branches(sort_by: nil)
201
        gitaly_migrate(:local_branches, status: Gitlab::GitalyClient::MigrationStatus::OPT_OUT) do |is_enabled|
202
          if is_enabled
203
            gitaly_ref_client.local_branches(sort_by: sort_by)
204
          else
205
            branches_filter(filter: :local, sort_by: sort_by)
206
          end
Robert Speicher's avatar
Robert Speicher committed
207 208 209 210 211
        end
      end

      # Returns the number of valid branches
      def branch_count
212
        gitaly_migrate(:branch_names) do |is_enabled|
213 214 215
          if is_enabled
            gitaly_ref_client.count_branch_names
          else
216
            rugged.branches.each(:local).count do |ref|
217 218 219 220 221 222 223 224 225 226 227
              begin
                ref.name && ref.target # ensures the branch is valid

                true
              rescue Rugged::ReferenceError
                false
              end
            end
          end
        end
      end
Robert Speicher's avatar
Robert Speicher committed
228

229 230 231 232
      def expire_has_local_branches_cache
        clear_memoization(:has_local_branches)
      end

233
      def has_local_branches?
234 235 236 237 238
        strong_memoize(:has_local_branches) do
          uncached_has_local_branches?
        end
      end

239 240 241 242 243 244 245
      # Git repository can contains some hidden refs like:
      #   /refs/notes/*
      #   /refs/git-as-svn/*
      #   /refs/pulls/*
      # This refs by default not visible in project page and not cloned to client side.
      alias_method :has_visible_content?, :has_local_branches?

246 247 248 249 250 251 252 253 254 255 256 257
      def has_local_branches_rugged?
        rugged.branches.each(:local).any? do |ref|
          begin
            ref.name && ref.target # ensures the branch is valid

            true
          rescue Rugged::ReferenceError
            false
          end
        end
      end

258 259
      # Returns the number of valid tags
      def tag_count
260
        gitaly_migrate(:tag_names) do |is_enabled|
261 262 263 264
          if is_enabled
            gitaly_ref_client.count_tag_names
          else
            rugged.tags.count
Robert Speicher's avatar
Robert Speicher committed
265 266 267 268 269 270
          end
        end
      end

      # Returns an Array of tag names
      def tag_names
271
        gitaly_migrate(:tag_names, status: Gitlab::GitalyClient::MigrationStatus::OPT_OUT) do |is_enabled|
272 273 274 275 276 277
          if is_enabled
            gitaly_ref_client.tag_names
          else
            rugged.tags.map { |t| t.name }
          end
        end
Robert Speicher's avatar
Robert Speicher committed
278 279 280
      end

      # Returns an Array of Tags
281 282
      #
      # Gitaly migration: https://gitlab.com/gitlab-org/gitaly/issues/390
Robert Speicher's avatar
Robert Speicher committed
283
      def tags
284
        gitaly_migrate(:tags, status: Gitlab::GitalyClient::MigrationStatus::OPT_OUT) do |is_enabled|
285 286 287 288
          if is_enabled
            tags_from_gitaly
          else
            tags_from_rugged
Robert Speicher's avatar
Robert Speicher committed
289
          end
290
        end
Robert Speicher's avatar
Robert Speicher committed
291 292
      end

293 294 295 296
      # Returns true if the given ref name exists
      #
      # Ref names must start with `refs/`.
      def ref_exists?(ref_name)
297 298
        gitaly_migrate(:ref_exists,
                      status: Gitlab::GitalyClient::MigrationStatus::OPT_OUT) do |is_enabled|
299 300 301 302 303 304 305 306
          if is_enabled
            gitaly_ref_exists?(ref_name)
          else
            rugged_ref_exists?(ref_name)
          end
        end
      end

Robert Speicher's avatar
Robert Speicher committed
307 308 309 310
      # Returns true if the given tag exists
      #
      # name - The name of the tag as a String.
      def tag_exists?(name)
311
        gitaly_migrate(:ref_exists_tags, status: Gitlab::GitalyClient::MigrationStatus::OPT_OUT) do |is_enabled|
312 313 314 315 316 317
          if is_enabled
            gitaly_ref_exists?("refs/tags/#{name}")
          else
            rugged_tag_exists?(name)
          end
        end
Robert Speicher's avatar
Robert Speicher committed
318 319 320 321 322 323
      end

      # Returns true if the given branch exists
      #
      # name - The name of the branch as a String.
      def branch_exists?(name)
324
        gitaly_migrate(:ref_exists_branches, status: Gitlab::GitalyClient::MigrationStatus::OPT_OUT) do |is_enabled|
325 326 327 328 329 330
          if is_enabled
            gitaly_ref_exists?("refs/heads/#{name}")
          else
            rugged_branch_exists?(name)
          end
        end
Robert Speicher's avatar
Robert Speicher committed
331 332
      end

333 334 335 336 337 338
      def batch_existence(object_ids, existing: true)
        filter_method = existing ? :select : :reject

        object_ids.public_send(filter_method) do |oid| # rubocop:disable GitlabSecurity/PublicSend
          rugged.exists?(oid)
        end
Robert Speicher's avatar
Robert Speicher committed
339 340 341 342 343 344 345
      end

      # Returns an Array of branch and tag names
      def ref_names
        branch_names + tag_names
      end

346
      def delete_all_refs_except(prefixes)
347 348 349 350 351 352 353
        gitaly_migrate(:ref_delete_refs) do |is_enabled|
          if is_enabled
            gitaly_ref_client.delete_refs(except_with_prefixes: prefixes)
          else
            delete_refs(*all_ref_names_except(prefixes))
          end
        end
354 355
      end

Lin Jen-Shin's avatar
Lin Jen-Shin committed
356 357 358
      # Returns an Array of all ref names, except when it's matching pattern
      #
      # regexp - The pattern for ref names we don't want
359 360 361 362
      def all_ref_names_except(prefixes)
        rugged.references.reject do |ref|
          prefixes.any? { |p| ref.name.start_with?(p) }
        end.map(&:name)
Lin Jen-Shin's avatar
Lin Jen-Shin committed
363 364
      end

Robert Speicher's avatar
Robert Speicher committed
365 366 367 368 369 370
      def rugged_head
        rugged.head
      rescue Rugged::ReferenceError
        nil
      end

371
      def archive_metadata(ref, storage_path, project_path, format = "tar.gz", append_sha:)
Robert Speicher's avatar
Robert Speicher committed
372 373 374 375
        ref ||= root_ref
        commit = Gitlab::Git::Commit.find(self, ref)
        return {} if commit.nil?

376
        prefix = archive_prefix(ref, commit.id, project_path, append_sha: append_sha)
Robert Speicher's avatar
Robert Speicher committed
377 378 379

        {
          'ArchivePrefix' => prefix,
380
          'ArchivePath' => archive_file_path(storage_path, commit.id, prefix, format),
381 382
          'CommitId' => commit.id,
          'GitalyRepository' => gitaly_repository.to_h
Robert Speicher's avatar
Robert Speicher committed
383 384 385
        }
      end

386 387
      # This is both the filename of the archive (missing the extension) and the
      # name of the top-level member of the archive under which all files go
388
      def archive_prefix(ref, sha, project_path, append_sha:)
389 390 391 392
        append_sha = (ref != sha) if append_sha.nil?

        formatted_ref = ref.tr('/', '-')

393
        prefix_segments = [project_path, formatted_ref]
394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414
        prefix_segments << sha if append_sha

        prefix_segments.join('-')
      end
      private :archive_prefix

      # The full path on disk where the archive should be stored. This is used
      # to cache the archive between requests.
      #
      # The path is a global namespace, so needs to be globally unique. This is
      # achieved by including `gl_repository` in the path.
      #
      # Archives relating to a particular ref when the SHA is not present in the
      # filename must be invalidated when the ref is updated to point to a new
      # SHA. This is achieved by including the SHA in the path.
      #
      # As this is a full path on disk, it is not "cloud native". This should
      # be resolved by either removing the cache, or moving the implementation
      # into Gitaly and removing the ArchivePath parameter from the git-archive
      # senddata response.
      def archive_file_path(storage_path, sha, name, format = "tar.gz")
Robert Speicher's avatar
Robert Speicher committed
415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431
        # Build file path
        return nil unless name

        extension =
          case format
          when "tar.bz2", "tbz", "tbz2", "tb2", "bz2"
            "tar.bz2"
          when "tar"
            "tar"
          when "zip"
            "zip"
          else
            # everything else should fall back to tar.gz
            "tar.gz"
          end

        file_name = "#{name}.#{extension}"
432
        File.join(storage_path, self.gl_repository, sha, file_name)
Robert Speicher's avatar
Robert Speicher committed
433
      end
434
      private :archive_file_path
Robert Speicher's avatar
Robert Speicher committed
435 436 437

      # Return repo size in megabytes
      def size
438 439 440 441 442 443 444 445
        size = gitaly_migrate(:repository_size) do |is_enabled|
          if is_enabled
            size_by_gitaly
          else
            size_by_shelling_out
          end
        end

Robert Speicher's avatar
Robert Speicher committed
446 447 448 449 450 451 452 453 454 455 456 457 458 459
        (size.to_f / 1024).round(2)
      end

      # Use the Rugged Walker API to build an array of commits.
      #
      # Usage.
      #   repo.log(
      #     ref: 'master',
      #     path: 'app/models',
      #     limit: 10,
      #     offset: 5,
      #     after: Time.new(2016, 4, 21, 14, 32, 10)
      #   )
      #
460
      # Gitaly migration: https://gitlab.com/gitlab-org/gitaly/issues/446
Robert Speicher's avatar
Robert Speicher committed
461
      def log(options)
462 463 464 465 466 467 468
        default_options = {
          limit: 10,
          offset: 0,
          path: nil,
          follow: false,
          skip_merges: false,
          after: nil,
Tiago Botelho's avatar
Tiago Botelho committed
469 470
          before: nil,
          all: false
471 472 473 474 475
        }

        options = default_options.merge(options)
        options[:offset] ||= 0

476 477 478 479 480
        limit = options[:limit]
        if limit == 0 || !limit.is_a?(Integer)
          raise ArgumentError.new("invalid Repository#log limit: #{limit.inspect}")
        end

481
        gitaly_migrate(:find_commits) do |is_enabled|
482
          if is_enabled
483 484 485 486 487
            gitaly_commit_client.find_commits(options)
          else
            raw_log(options).map { |c| Commit.decorate(self, c) }
          end
        end
Robert Speicher's avatar
Robert Speicher committed
488 489
      end

Jacob Vosmaer's avatar
Jacob Vosmaer committed
490 491
      # Used in gitaly-ruby
      def raw_log(options)
492 493 494 495 496 497 498 499 500 501
        sha =
          unless options[:all]
            actual_ref = options[:ref] || root_ref
            begin
              sha_from_ref(actual_ref)
            rescue Rugged::OdbError, Rugged::InvalidError, Rugged::ReferenceError
              # Return an empty array if the ref wasn't found
              return []
            end
          end
Jacob Vosmaer's avatar
Jacob Vosmaer committed
502

503
        log_by_shell(sha, options)
Jacob Vosmaer's avatar
Jacob Vosmaer committed
504 505
      end

506
      def count_commits(options)
507 508
        count_commits_options = process_count_commits_options(options)

509
        gitaly_migrate(:count_commits, status: Gitlab::GitalyClient::MigrationStatus::OPT_OUT) do |is_enabled|
510
          if is_enabled
511
            count_commits_by_gitaly(count_commits_options)
512
          else
513
            count_commits_by_shelling_out(count_commits_options)
514 515
          end
        end
516 517
      end

Robert Speicher's avatar
Robert Speicher committed
518 519 520 521 522 523 524 525 526 527
      # Return the object that +revspec+ points to.  If +revspec+ is an
      # annotated tag, then return the tag's target instead.
      def rev_parse_target(revspec)
        obj = rugged.rev_parse(revspec)
        Ref.dereference_object(obj)
      end

      # Return a collection of Rugged::Commits between the two revspec arguments.
      # See http://git-scm.com/docs/git-rev-parse.html#_specifying_revisions for
      # a detailed list of valid arguments.
528 529 530
      #
      # Gitaly note: JV: to be deprecated in favor of Commit.between
      def rugged_commits_between(from, to)
Robert Speicher's avatar
Robert Speicher committed
531
        walker = Rugged::Walker.new(rugged)
532
        walker.sorting(Rugged::SORT_NONE | Rugged::SORT_REVERSE)
Robert Speicher's avatar
Robert Speicher committed
533 534 535 536 537 538 539 540 541 542 543 544 545 546

        sha_from = sha_from_ref(from)
        sha_to = sha_from_ref(to)

        walker.push(sha_to)
        walker.hide(sha_from)

        commits = walker.to_a
        walker.reset

        commits
      end

      # Counts the amount of commits between `from` and `to`.
547 548
      def count_commits_between(from, to, options = {})
        count_commits(from: from, to: to, **options)
Robert Speicher's avatar
Robert Speicher committed
549 550
      end

Rubén Dávila's avatar
Rubén Dávila committed
551 552 553
      # old_rev and new_rev are commit ID's
      # the result of this method is an array of Gitlab::Git::RawDiffChange
      def raw_changes_between(old_rev, new_rev)
554 555 556 557 558 559 560 561 562 563 564 565 566
        @raw_changes_between ||= {}

        @raw_changes_between[[old_rev, new_rev]] ||= begin
          return [] if new_rev.blank? || new_rev == Gitlab::Git::BLANK_SHA

          gitaly_migrate(:raw_changes_between) do |is_enabled|
            if is_enabled
              gitaly_repository_client.raw_changes_between(old_rev, new_rev)
                .each_with_object([]) do |msg, arr|
                msg.raw_changes.each { |change| arr << ::Gitlab::Git::RawDiffChange.new(change) }
              end
            else
              result = []
Rubén Dávila's avatar
Rubén Dávila committed
567

568 569 570
              circuit_breaker.perform do
                Open3.pipeline_r(git_diff_cmd(old_rev, new_rev), format_git_cat_file_script, git_cat_file_cmd) do |last_stdout, wait_threads|
                  last_stdout.each_line { |line| result << ::Gitlab::Git::RawDiffChange.new(line.chomp!) }
Rubén Dávila's avatar
Rubén Dávila committed
571

572 573 574
                  if wait_threads.any? { |waiter| !waiter.value&.success? }
                    raise ::Gitlab::Git::Repository::GitError, "Unabled to obtain changes between #{old_rev} and #{new_rev}"
                  end
575 576 577
                end
              end

578 579
              result
            end
Rubén Dávila's avatar
Rubén Dávila committed
580 581
          end
        end
582 583
      rescue ArgumentError => e
        raise Gitlab::Git::Repository::GitError.new(e)
Rubén Dávila's avatar
Rubén Dávila committed
584 585
      end

Robert Speicher's avatar
Robert Speicher committed
586
      # Returns the SHA of the most recent common ancestor of +from+ and +to+
587
      def merge_base(from, to)
588 589 590 591
        gitaly_migrate(:merge_base) do |is_enabled|
          if is_enabled
            gitaly_repository_client.find_merge_base(from, to)
          else
592
            rugged_merge_base(from, to)
593 594
          end
        end
Robert Speicher's avatar
Robert Speicher committed
595 596
      end

597 598 599 600
      # Gitaly note: JV: check gitlab-ee before removing this method.
      def rugged_is_ancestor?(ancestor_id, descendant_id)
        return false if ancestor_id.nil? || descendant_id.nil?

601
        rugged_merge_base(ancestor_id, descendant_id) == ancestor_id
602 603
      rescue Rugged::OdbError
        false
604 605
      end

606
      # Returns true is +from+ is direct ancestor to +to+, otherwise false
607
      def ancestor?(from, to)
608 609 610 611 612 613 614
        Gitlab::GitalyClient.migrate(:is_ancestor) do |is_enabled|
          if is_enabled
            gitaly_commit_client.ancestor?(from, to)
          else
            rugged_is_ancestor?(from, to)
          end
        end
615 616
      end

617
      def merged_branch_names(branch_names = [])
618 619 620 621 622 623 624 625 626 627 628 629 630 631 632
        return [] unless root_ref

        root_sha = find_branch(root_ref)&.target

        return [] unless root_sha

        branches = gitaly_migrate(:merged_branch_names) do |is_enabled|
          if is_enabled
            gitaly_merged_branch_names(branch_names, root_sha)
          else
            git_merged_branch_names(branch_names, root_sha)
          end
        end

        Set.new(branches)
633 634
      end

Robert Speicher's avatar
Robert Speicher committed
635 636 637 638 639
      # Return an array of Diff objects that represent the diff
      # between +from+ and +to+.  See Diff::filter_diff_options for the allowed
      # diff options.  The +options+ hash can also include :break_rewrites to
      # split larger rewrites into delete/add pairs.
      def diff(from, to, options = {}, *paths)
640 641 642 643 644 645 646 647 648
        iterator = gitaly_migrate(:diff_between) do |is_enabled|
          if is_enabled
            gitaly_commit_client.diff(from, to, options.merge(paths: paths))
          else
            diff_patches(from, to, options, *paths)
          end
        end

        Gitlab::Git::DiffCollection.new(iterator, options)
Robert Speicher's avatar
Robert Speicher committed
649 650
      end

651 652
      # Returns a RefName for a given SHA
      def ref_name_for_sha(ref_path, sha)
653 654 655 656 657 658
        raise ArgumentError, "sha can't be empty" unless sha.present?

        gitaly_migrate(:find_ref_name) do |is_enabled|
          if is_enabled
            gitaly_ref_client.find_ref_name(sha, ref_path)
          else
659
            args = %W(for-each-ref --count=1 #{ref_path} --contains #{sha})
660 661 662

            # Not found -> ["", 0]
            # Found -> ["b8d95eb4969eefacb0a58f6a28f6803f8070e7b9 commit\trefs/environments/production/77\n", 0]
663
            run_git(args).first.split.last
664 665
          end
        end
666 667
      end

668 669 670
      # Get refs hash which key is is the commit id
      # and value is a Gitlab::Git::Tag or Gitlab::Git::Branch
      # Note that both inherit from Gitlab::Git::Ref
Robert Speicher's avatar
Robert Speicher committed
671
      def refs_hash
672 673 674 675 676 677 678 679
        return @refs_hash if @refs_hash

        @refs_hash = Hash.new { |h, k| h[k] = [] }

        (tags + branches).each do |ref|
          next unless ref.target && ref.name

          @refs_hash[ref.dereferenced_target.id] << ref.name
Robert Speicher's avatar
Robert Speicher committed
680
        end
681

Robert Speicher's avatar
Robert Speicher committed
682 683 684 685 686 687 688 689
        @refs_hash
      end

      # Lookup for rugged object by oid or ref name
      def lookup(oid_or_ref_name)
        rugged.rev_parse(oid_or_ref_name)
      end

690
      # Returns url for submodule
Robert Speicher's avatar
Robert Speicher committed
691 692
      #
      # Ex.
693 694
      #   @repository.submodule_url_for('master', 'rack')
      #   # => git@localhost:rack.git
Robert Speicher's avatar
Robert Speicher committed
695
      #
696
      # Gitaly migration: https://gitlab.com/gitlab-org/gitaly/issues/329
697
      def submodule_url_for(ref, path)
698 699 700 701 702 703 704 705
        Gitlab::GitalyClient.migrate(:submodule_url_for) do |is_enabled|
          if is_enabled
            gitaly_submodule_url_for(ref, path)
          else
            if submodules(ref).any?
              submodule = submodules(ref)[path]
              submodule['url'] if submodule
            end
706
          end
Robert Speicher's avatar
Robert Speicher committed
707 708 709 710
        end
      end

      # Return total commits count accessible from passed ref
711 712
      #
      # Gitaly migration: https://gitlab.com/gitlab-org/gitaly/issues/330
Robert Speicher's avatar
Robert Speicher committed
713
      def commit_count(ref)
714
        gitaly_migrate(:commit_count, status: Gitlab::GitalyClient::MigrationStatus::OPT_OUT) do |is_enabled|
715 716 717
          if is_enabled
            gitaly_commit_client.commit_count(ref)
          else
718
            rugged_commit_count(ref)
719 720
          end
        end
Robert Speicher's avatar
Robert Speicher committed
721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746
      end

      # Mimic the `git clean` command and recursively delete untracked files.
      # Valid keys that can be passed in the +options+ hash are:
      #
      # :d - Remove untracked directories
      # :f - Remove untracked directories that are managed by a different
      #      repository
      # :x - Remove ignored files
      #
      # The value in +options+ must evaluate to true for an option to take
      # effect.
      #
      # Examples:
      #
      #   repo.clean(d: true, f: true) # Enable the -d and -f options
      #
      #   repo.clean(d: false, x: true) # -x is enabled, -d is not
      def clean(options = {})
        strategies = [:remove_untracked]
        strategies.push(:force) if options[:f]
        strategies.push(:remove_ignored) if options[:x]

        # TODO: implement this method
      end

747
      def add_branch(branch_name, user:, target:)
748 749 750
        gitaly_operation_client.user_create_branch(branch_name, user, target)
      rescue GRPC::FailedPrecondition => ex
        raise InvalidRef, ex
751 752
      end

753
      def add_tag(tag_name, user:, target:, message: nil)
754
        gitaly_migrate(:operation_user_add_tag, status: Gitlab::GitalyClient::MigrationStatus::OPT_OUT) do |is_enabled|
755 756 757 758 759
          if is_enabled
            gitaly_add_tag(tag_name, user: user, target: target, message: message)
          else
            rugged_add_tag(tag_name, user: user, target: target, message: message)
          end
760 761 762
        end
      end

763
      def rm_branch(branch_name, user:)
764
        gitaly_migrate(:operation_user_delete_branch, status: Gitlab::GitalyClient::MigrationStatus::OPT_OUT) do |is_enabled|
765 766 767 768 769 770
          if is_enabled
            gitaly_operations_client.user_delete_branch(branch_name, user)
          else
            OperationService.new(user, self).rm_branch(find_branch(branch_name))
          end
        end
771 772
      end

773
      def rm_tag(tag_name, user:)
774 775 776 777 778 779 780
        gitaly_migrate(:operation_user_delete_tag) do |is_enabled|
          if is_enabled
            gitaly_operations_client.rm_tag(tag_name, user)
          else
            Gitlab::Git::OperationService.new(user, self).rm_tag(find_tag(tag_name))
          end
        end
781 782 783 784 785 786
      end

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

787 788 789 790 791 792 793 794 795 796 797
      def merge(user, source_sha, target_branch, message, &block)
        gitaly_migrate(:operation_user_merge_branch) do |is_enabled|
          if is_enabled
            gitaly_operation_client.user_merge_branch(user, source_sha, target_branch, message, &block)
          else
            rugged_merge(user, source_sha, target_branch, message, &block)
          end
        end
      end

      def rugged_merge(user, source_sha, target_branch, message)
798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827
        committer = Gitlab::Git.committer_hash(email: user.email, name: user.name)

        OperationService.new(user, self).with_branch(target_branch) do |start_commit|
          our_commit = start_commit.sha
          their_commit = source_sha

          raise 'Invalid merge target' unless our_commit
          raise 'Invalid merge source' unless their_commit

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

          options = {
            parents: [our_commit, their_commit],
            tree: merge_index.write_tree(rugged),
            message: message,
            author: committer,
            committer: committer
          }

          commit_id = create_commit(options)

          yield commit_id

          commit_id
        end
      rescue Gitlab::Git::CommitError # when merge_index.conflicts?
        nil
      end

828
      def ff_merge(user, source_sha, target_branch)
829 830 831 832 833 834
        gitaly_migrate(:operation_user_ff_branch) do |is_enabled|
          if is_enabled
            gitaly_ff_merge(user, source_sha, target_branch)
          else
            rugged_ff_merge(user, source_sha, target_branch)
          end
835 836 837
        end
      end

838
      def revert(user:, commit:, branch_name:, message:, start_branch_name:, start_repository:)
839
        gitaly_migrate(:revert, status: Gitlab::GitalyClient::MigrationStatus::OPT_OUT) do |is_enabled|
840 841 842 843 844 845 846 847
          args = {
            user: user,
            commit: commit,
            branch_name: branch_name,
            message: message,
            start_branch_name: start_branch_name,
            start_repository: start_repository
          }
848

849 850 851 852 853
          if is_enabled
            gitaly_operations_client.user_revert(args)
          else
            rugged_revert(args)
          end
854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870
        end
      end

      def check_revert_content(target_commit, source_sha)
        args = [target_commit.sha, source_sha]
        args << { mainline: 1 } if target_commit.merge_commit?

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

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

        tree_id
      end

      def cherry_pick(user:, commit:, branch_name:, message:, start_branch_name:, start_repository:)
871 872 873 874 875 876 877 878 879
        gitaly_migrate(:cherry_pick) do |is_enabled|
          args = {
            user: user,
            commit: commit,
            branch_name: branch_name,
            message: message,
            start_branch_name: start_branch_name,
            start_repository: start_repository
          }
880

881 882 883 884 885
          if is_enabled
            gitaly_operations_client.user_cherry_pick(args)
          else
            rugged_cherry_pick(args)
          end
886 887 888 889 890 891 892 893 894 895 896
        end
      end

      def diff_exists?(sha1, sha2)
        rugged.diff(sha1, sha2).size > 0
      end

      def user_to_committer(user)
        Gitlab::Git.committer_hash(email: user.email, name: user.name)
      end

897 898 899 900 901 902
      def create_commit(params = {})
        params[:message].delete!("\r")

        Rugged::Commit.create(rugged, params)
      end

Robert Speicher's avatar
Robert Speicher committed
903 904
      # Delete the specified branch from the repository
      def delete_branch(branch_name)
905
        gitaly_migrate(:delete_branch, status: Gitlab::GitalyClient::MigrationStatus::OPT_OUT) do |is_enabled|
906 907 908 909 910 911 912 913
          if is_enabled
            gitaly_ref_client.delete_branch(branch_name)
          else
            rugged.branches.delete(branch_name)
          end
        end
      rescue Rugged::ReferenceError, CommandError => e
        raise DeleteBranchError, e
Robert Speicher's avatar
Robert Speicher committed
914
      end
Lin Jen-Shin's avatar
Lin Jen-Shin committed
915

916
      def delete_refs(*ref_names)
917 918
        gitaly_migrate(:delete_refs,
                      status: Gitlab::GitalyClient::MigrationStatus::OPT_OUT) do |is_enabled|
919 920 921 922 923
          if is_enabled
            gitaly_delete_refs(*ref_names)
          else
            git_delete_refs(*ref_names)
          end
924
        end
Lin Jen-Shin's avatar
Lin Jen-Shin committed
925
      end
Robert Speicher's avatar
Robert Speicher committed
926 927 928 929 930 931 932

      # Create a new branch named **ref+ based on **stat_point+, HEAD by default
      #
      # Examples:
      #   create_branch("feature")
      #   create_branch("other-feature", "master")
      def create_branch(ref, start_point = "HEAD")
933
        gitaly_migrate(:create_branch, status: Gitlab::GitalyClient::MigrationStatus::OPT_OUT) do |is_enabled|
934 935 936 937 938 939
          if is_enabled
            gitaly_ref_client.create_branch(ref, start_point)
          else
            rugged_create_branch(ref, start_point)
          end
        end
Robert Speicher's avatar
Robert Speicher committed
940 941
      end

942 943
      # If `mirror_refmap` is present the remote is set as mirror with that mapping
      def add_remote(remote_name, url, mirror_refmap: nil)
944
        gitaly_migrate(:remote_add_remote) do |is_enabled|
945 946 947 948 949 950
          if is_enabled
            gitaly_remote_client.add_remote(remote_name, url, mirror_refmap)
          else
            rugged_add_remote(remote_name, url, mirror_refmap)
          end
        end
Robert Speicher's avatar
Robert Speicher committed
951 952
      end

953
      def remove_remote(remote_name)
954
        gitaly_migrate(:remote_remove_remote) do |is_enabled|
955 956 957 958 959
          if is_enabled
            gitaly_remote_client.remove_remote(remote_name)
          else
            rugged_remove_remote(remote_name)
          end
960
        end
961 962
      end

Robert Speicher's avatar
Robert Speicher committed
963 964 965 966
      # Update the specified remote using the values in the +options+ hash
      #
      # Example
      # repo.update_remote("origin", url: "path/to/repo")
Jacob Vosmaer's avatar
Jacob Vosmaer committed
967
      def remote_update(remote_name, url:)
Robert Speicher's avatar
Robert Speicher committed
968
        # TODO: Implement other remote options
Jacob Vosmaer's avatar
Jacob Vosmaer committed
969
        rugged.remotes.set_url(remote_name, url)
Jacob Vosmaer's avatar
Jacob Vosmaer committed
970
        nil
Robert Speicher's avatar
Robert Speicher committed
971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991
      end

      AUTOCRLF_VALUES = {
        "true" => true,
        "false" => false,
        "input" => :input
      }.freeze

      def autocrlf
        AUTOCRLF_VALUES[rugged.config['core.autocrlf']]
      end

      def autocrlf=(value)
        rugged.config['core.autocrlf'] = AUTOCRLF_VALUES.invert[value]
      end

      # Returns result like "git ls-files" , recursive and full file path
      #
      # Ex.
      #   repo.ls_files('master')
      #
992
      # Gitaly migration: https://gitlab.com/gitlab-org/gitaly/issues/327
Robert Speicher's avatar
Robert Speicher committed
993
      def ls_files(ref)
994 995 996 997 998 999
        gitaly_migrate(:ls_files) do |is_enabled|
          if is_enabled
            gitaly_ls_files(ref)
          else
            git_ls_files(ref)
          end
Robert Speicher's avatar
Robert Speicher committed
1000 1001 1002
        end
      end

1003
      # Gitaly migration: https://gitlab.com/gitlab-org/gitaly/issues/328
Robert Speicher's avatar
Robert Speicher committed
1004
      def copy_gitattributes(ref)
1005 1006 1007 1008 1009 1010
        Gitlab::GitalyClient.migrate(:apply_gitattributes) do |is_enabled|
          if is_enabled
            gitaly_copy_gitattributes(ref)
          else
            rugged_copy_gitattributes(ref)
          end
Robert Speicher's avatar
Robert Speicher committed
1011
        end
1012 1013
      rescue GRPC::InvalidArgument
        raise InvalidRef
Robert Speicher's avatar
Robert Speicher committed
1014 1015
      end

1016 1017 1018 1019
      def info_attributes
        return @info_attributes if @info_attributes

        content =
1020
          gitaly_migrate(:get_info_attributes, status: Gitlab::GitalyClient::MigrationStatus::OPT_OUT) do |is_enabled|
1021 1022 1023
            if is_enabled
              gitaly_repository_client.info_attributes
            else
1024
              attributes_path = File.join(File.expand_path(path), 'info', 'attributes')
1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036

              if File.exist?(attributes_path)
                File.read(attributes_path)
              else
                ""
              end
            end
          end

        @info_attributes = AttributesParser.new(content)
      end

Robert Speicher's avatar
Robert Speicher committed
1037 1038 1039 1040
      # Returns the Git attributes for the given file path.
      #
      # See `Gitlab::Git::Attributes` for more information.
      def attributes(path)
1041
        info_attributes.attributes(path)
Robert Speicher's avatar
Robert Speicher committed
1042 1043
      end

Sean McGivern's avatar
Sean McGivern committed
1044 1045 1046 1047
      def gitattribute(path, name)
        attributes(path)[name]
      end

1048 1049 1050 1051 1052
      # Check .gitattributes for a given ref
      #
      # This only checks the root .gitattributes file,
      # it does not traverse subfolders to find additional .gitattributes files
      #
1053 1054 1055
      # This method is around 30 times slower than `attributes`, which uses
      # `$GIT_DIR/info/attributes`. Consider caching AttributesAtRefParser
      # and reusing that for multiple calls instead of this method.
1056 1057 1058 1059 1060
      def attributes_at(ref, file_path)
        parser = AttributesAtRefParser.new(self, ref)
        parser.attributes(file_path)
      end

1061
      def languages(ref = nil)
1062
        gitaly_migrate(:commit_languages, status: Gitlab::GitalyClient::MigrationStatus::OPT_OUT) do |is_enabled|
1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087
          if is_enabled
            gitaly_commit_client.languages(ref)
          else
            ref ||= rugged.head.target_id
            languages = Linguist::Repository.new(rugged, ref).languages
            total = languages.map(&:last).sum

            languages = languages.map do |language|
              name, share = language
              color = Linguist::Language[name].color || "##{Digest::SHA256.hexdigest(name)[0...6]}"
              {
                value: (share.to_f * 100 / total).round(2),
                label: name,
                color: color,
                highlight: color
              }
            end

            languages.sort do |x, y|
              y[:value] <=> x[:value]
            end
          end
        end
      end

1088
      def license_short_name
1089 1090
        gitaly_migrate(:license_short_name,
                       status: Gitlab::GitalyClient::MigrationStatus::OPT_OUT) do |is_enabled|
1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103
          if is_enabled
            gitaly_repository_client.license_short_name
          else
            begin
              # The licensee gem creates a Rugged object from the path:
              # https://github.com/benbalter/licensee/blob/v8.7.0/lib/licensee/projects/git_project.rb
              Licensee.license(path).try(:key)
            rescue Rugged::Error
            end
          end
        end
      end

1104
      def with_repo_branch_commit(start_repository, start_branch_name)
1105
        Gitlab::Git.check_namespace!(start_repository)
1106
        start_repository = RemoteRepository.new(start_repository) unless start_repository.is_a?(RemoteRepository)
1107

1108
        return yield nil if start_repository.empty?
1109

1110
        if start_repository.same_repository?(self)
1111 1112
          yield commit(start_branch_name)
        else
1113
          start_commit_id = start_repository.commit_id(start_branch_name)
1114

1115
          return yield nil unless start_commit_id
1116

1117
          if branch_commit = commit(start_commit_id)
1118 1119 1120
            yield branch_commit
          else
            with_repo_tmp_commit(
1121
              start_repository, start_branch_name, start_commit_id) do |tmp_commit|
1122 1123 1124 1125 1126 1127 1128
              yield tmp_commit
            end
          end
        end
      end

      def with_repo_tmp_commit(start_repository, start_branch_name, sha)
1129 1130 1131 1132 1133 1134
        source_ref = start_branch_name

        unless Gitlab::Git.branch_ref?(source_ref)
          source_ref = "#{Gitlab::Git::BRANCH_REF_PREFIX}#{source_ref}"
        end

1135
        tmp_ref = fetch_ref(
1136
          start_repository,
1137
          source_ref: source_ref,
1138
          target_ref: "refs/tmp/#{SecureRandom.hex}"
1139 1140 1141 1142 1143 1144 1145
        )

        yield commit(sha)
      ensure
        delete_refs(tmp_ref) if tmp_ref
      end

1146
      def fetch_source_branch!(source_repository, source_branch, local_ref)
1147 1148 1149
        Gitlab::GitalyClient.migrate(:fetch_source_branch) do |is_enabled|
          if is_enabled
            gitaly_repository_client.fetch_source_branch(source_repository, source_branch, local_ref)
1150
          else
1151
            rugged_fetch_source_branch(source_repository, source_branch, local_ref)
1152 1153 1154 1155 1156
          end
        end
      end

      def compare_source_branch(target_branch_name, source_repository, source_branch_name, straight:)
1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168
        tmp_ref = "refs/tmp/#{SecureRandom.hex}"

        return unless fetch_source_branch!(source_repository, source_branch_name, tmp_ref)

        Gitlab::Git::Compare.new(
          self,
          target_branch_name,
          tmp_ref,
          straight: straight
        )
      ensure
        delete_refs(tmp_ref)
1169 1170
      end

1171
      def write_ref(ref_path, ref, old_ref: nil, shell: true)
1172 1173 1174 1175 1176 1177 1178 1179
        ref_path = "#{Gitlab::Git::BRANCH_REF_PREFIX}#{ref_path}" unless ref_path.start_with?("refs/") || ref_path == "HEAD"

        gitaly_migrate(:write_ref) do |is_enabled|
          if is_enabled
            gitaly_repository_client.write_ref(ref_path, ref, old_ref, shell)
          else
            local_write_ref(ref_path, ref, old_ref: old_ref, shell: shell)
          end
1180 1181 1182
        end
      end

1183
      def fetch_ref(source_repository, source_ref:, target_ref:)
1184 1185 1186
        Gitlab::Git.check_namespace!(source_repository)
        source_repository = RemoteRepository.new(source_repository) unless source_repository.is_a?(RemoteRepository)

1187 1188 1189 1190
        message, status = GitalyClient.migrate(:fetch_ref) do |is_enabled|
          if is_enabled
            gitaly_fetch_ref(source_repository, source_ref: source_ref, target_ref: target_ref)
          else
1191 1192
            # When removing this code, also remove source_repository#path
            # to remove deprecated method calls
1193 1194 1195
            local_fetch_ref(source_repository.path, source_ref: source_ref, target_ref: target_ref)
          end
        end
1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207

        # Make sure ref was created, and raise Rugged::ReferenceError when not
        raise Rugged::ReferenceError, message if status != 0

        target_ref
      end

      # Refactoring aid; allows us to copy code from app/models/repository.rb
      def commit(ref = 'HEAD')
        Gitlab::Git::Commit.find(self, ref)
      end

1208 1209
      def empty?
        !has_visible_content?
1210 1211
      end

1212
      def fetch_repository_as_mirror(repository)
1213
        gitaly_migrate(:remote_fetch_internal_remote) do |is_enabled|
1214
          if is_enabled
1215
            gitaly_remote_client.fetch_internal_remote(repository)
1216
          else
1217
            rugged_fetch_repository_as_mirror(repository)
1218 1219
          end
        end
1220 1221
      end

1222 1223 1224 1225
      def blob_at(sha, path)
        Gitlab::Git::Blob.find(self, sha, path) unless Gitlab::Git.blank_ref?(sha)
      end

1226
      # Items should be of format [[commit_id, path], [commit_id1, path1]]
1227
      def batch_blobs(items, blob_size_limit: Gitlab::Git::Blob::MAX_DATA_DISPLAY_SIZE)
1228 1229 1230
        Gitlab::Git::Blob.batch(self, items, blob_size_limit: blob_size_limit)
      end

1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244
      def commit_index(user, branch_name, index, options)
        committer = user_to_committer(user)

        OperationService.new(user, self).with_branch(branch_name) do
          commit_params = options.merge(
            tree: index.write_tree(rugged),
            author: committer,
            committer: committer
          )

          create_commit(commit_params)
        end
      end

1245
      def fsck
1246
        msg, status = gitaly_repository_client.fsck
1247

1248
        raise GitError.new("Could not fsck repository: #{msg}") unless status.zero?
1249 1250
      end

1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263
      def create_from_bundle(bundle_path)
        gitaly_migrate(:create_repo_from_bundle) do |is_enabled|
          if is_enabled
            gitaly_repository_client.create_from_bundle(bundle_path)
          else
            run_git!(%W(clone --bare -- #{bundle_path} #{path}), chdir: nil)
            self.class.create_hooks(path, File.expand_path(Gitlab.config.gitlab_shell.hooks_path))
          end
        end

        true
      end

1264 1265 1266 1267
      def create_from_snapshot(url, auth)
        gitaly_repository_client.create_from_snapshot(url, auth)
      end

1268
      def rebase(user, rebase_id, branch:, branch_sha:, remote_repository:, remote_branch:)
1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282
        gitaly_migrate(:rebase) do |is_enabled|
          if is_enabled
            gitaly_rebase(user, rebase_id,
                          branch: branch,
                          branch_sha: branch_sha,
                          remote_repository: remote_repository,
                          remote_branch: remote_branch)
          else
            git_rebase(user, rebase_id,
                       branch: branch,
                       branch_sha: branch_sha,
                       remote_repository: remote_repository,
                       remote_branch: remote_branch)
          end
1283 1284 1285 1286
        end
      end

      def rebase_in_progress?(rebase_id)
1287 1288 1289 1290 1291 1292 1293
        gitaly_migrate(:rebase_in_progress) do |is_enabled|
          if is_enabled
            gitaly_repository_client.rebase_in_progress?(rebase_id)
          else
            fresh_worktree?(worktree_path(REBASE_WORKTREE_PREFIX, rebase_id))
          end
        end
1294 1295 1296
      end

      def squash(user, squash_id, branch:, start_sha:, end_sha:, author:, message:)
1297 1298 1299 1300 1301 1302
        gitaly_migrate(:squash) do |is_enabled|
          if is_enabled
            gitaly_operation_client.user_squash(user, squash_id, branch,
              start_sha, end_sha, author, message)
          else
            git_squash(user, squash_id, branch, start_sha, end_sha, author, message)
1303 1304 1305 1306 1307
          end
        end
      end

      def squash_in_progress?(squash_id)
1308
        gitaly_migrate(:squash_in_progress, status: Gitlab::GitalyClient::MigrationStatus::OPT_OUT) do |is_enabled|
1309 1310 1311 1312 1313 1314
          if is_enabled
            gitaly_repository_client.squash_in_progress?(squash_id)
          else
            fresh_worktree?(worktree_path(SQUASH_WORKTREE_PREFIX, squash_id))
          end
        end
1315 1316
      end

1317 1318 1319 1320 1321 1322
      def push_remote_branches(remote_name, branch_names, forced: true)
        success = @gitlab_projects.push_branches(remote_name, GITLAB_PROJECTS_TIMEOUT, forced, branch_names)

        success || gitlab_projects_error
      end

1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334
      def delete_remote_branches(remote_name, branch_names)
        success = @gitlab_projects.delete_remote_branches(remote_name, branch_names)

        success || gitlab_projects_error
      end

      def delete_remote_branches(remote_name, branch_names)
        success = @gitlab_projects.delete_remote_branches(remote_name, branch_names)

        success || gitlab_projects_error
      end

1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346
      def bundle_to_disk(save_path)
        gitaly_migrate(:bundle_to_disk) do |is_enabled|
          if is_enabled
            gitaly_repository_client.create_bundle(save_path)
          else
            run_git!(%W(bundle create #{save_path} --all))
          end
        end

        true
      end

1347 1348 1349 1350 1351 1352
      # rubocop:disable Metrics/ParameterLists
      def multi_action(
        user, branch_name:, message:, actions:,
        author_email: nil, author_name: nil,
        start_branch_name: nil, start_repository: self)

1353 1354 1355 1356 1357 1358 1359 1360
        gitaly_migrate(:operation_user_commit_files) do |is_enabled|
          if is_enabled
            gitaly_operation_client.user_commit_files(user, branch_name,
              message, actions, author_email, author_name,
              start_branch_name, start_repository)
          else
            rugged_multi_action(user, branch_name, message, actions,
              author_email, author_name, start_branch_name, start_repository)
1361 1362 1363 1364 1365
          end
        end
      end
      # rubocop:enable Metrics/ParameterLists

1366
      def write_config(full_path:)
1367 1368
        return unless full_path.present?

1369 1370 1371 1372 1373
        # This guard avoids Gitaly log/error spam
        unless exists?
          raise NoRepository, 'repository does not exist'
        end

1374 1375 1376 1377 1378 1379 1380
        gitaly_migrate(:write_config) do |is_enabled|
          if is_enabled
            gitaly_repository_client.write_config(full_path: full_path)
          else
            rugged_write_config(full_path: full_path)
          end
        end
1381 1382
      end

1383
      def gitaly_repository
1384
        Gitlab::GitalyClient::Util.repository(@storage, @relative_path, @gl_repository)
1385 1386
      end

1387 1388 1389 1390
      def gitaly_operations_client
        @gitaly_operations_client ||= Gitlab::GitalyClient::OperationService.new(self)
      end

1391 1392 1393 1394 1395 1396
      def gitaly_ref_client
        @gitaly_ref_client ||= Gitlab::GitalyClient::RefService.new(self)
      end

      def gitaly_commit_client
        @gitaly_commit_client ||= Gitlab::GitalyClient::CommitService.new(self)
1397 1398 1399 1400
      end

      def gitaly_repository_client
        @gitaly_repository_client ||= Gitlab::GitalyClient::RepositoryService.new(self)
1401 1402
      end

1403 1404 1405 1406
      def gitaly_operation_client
        @gitaly_operation_client ||= Gitlab::GitalyClient::OperationService.new(self)
      end

1407 1408 1409 1410
      def gitaly_remote_client
        @gitaly_remote_client ||= Gitlab::GitalyClient::RemoteService.new(self)
      end

1411 1412 1413 1414
      def gitaly_blob_client
        @gitaly_blob_client ||= Gitlab::GitalyClient::BlobService.new(self)
      end

1415 1416
      def gitaly_conflicts_client(our_commit_oid, their_commit_oid)
        Gitlab::GitalyClient::ConflictsService.new(self, our_commit_oid, their_commit_oid)
1417 1418
      end

1419 1420
      def gitaly_migrate(method, status: Gitlab::GitalyClient::MigrationStatus::OPT_IN, &block)
        Gitlab::GitalyClient.migrate(method, status: status, &block)
1421 1422
      rescue GRPC::NotFound => e
        raise NoRepository.new(e)
1423 1424
      rescue GRPC::InvalidArgument => e
        raise ArgumentError.new(e)
1425 1426
      rescue GRPC::BadStatus => e
        raise CommandError.new(e)
1427 1428
      end

1429 1430 1431 1432 1433
      def clean_stale_repository_files
        gitaly_migrate(:repository_cleanup, status: Gitlab::GitalyClient::MigrationStatus::OPT_OUT) do |is_enabled|
          gitaly_repository_client.cleanup if is_enabled && exists?
        end
      rescue Gitlab::Git::CommandError => e # Don't fail if we can't cleanup
1434
        Rails.logger.error("Unable to clean repository on storage #{storage} with relative path #{relative_path}: #{e.message}")
1435 1436 1437 1438 1439 1440
        Gitlab::Metrics.counter(
          :failed_repository_cleanup_total,
          'Number of failed repository cleanup events'
        ).increment
      end

1441
      def branch_names_contains_sha(sha)
1442
        gitaly_ref_client.branch_names_contains_sha(sha)
1443
      end
1444

1445
      def tag_names_contains_sha(sha)
1446
        gitaly_ref_client.tag_names_contains_sha(sha)
1447 1448 1449 1450 1451
      end

      def search_files_by_content(query, ref)
        return [] if empty? || query.blank?

1452 1453 1454 1455 1456 1457 1458 1459 1460
        safe_query = Regexp.escape(query)
        ref ||= root_ref

        gitaly_migrate(:search_files_by_content) do |is_enabled|
          if is_enabled
            gitaly_repository_client.search_files_by_content(ref, safe_query)
          else
            offset = 2
            args = %W(grep -i -I -n -z --before-context #{offset} --after-context #{offset} -E -e #{safe_query} #{ref})
1461

1462 1463 1464
            run_git(args).first.scrub.split(/^--\n/)
          end
        end
1465 1466
      end

1467 1468 1469 1470 1471 1472 1473 1474 1475 1476
      def can_be_merged?(source_sha, target_branch)
        gitaly_migrate(:can_be_merged) do |is_enabled|
          if is_enabled
            gitaly_can_be_merged?(source_sha, find_branch(target_branch, true).target)
          else
            rugged_can_be_merged?(source_sha, target_branch)
          end
        end
      end

1477
      def search_files_by_name(query, ref)
1478
        safe_query = Regexp.escape(query.sub(%r{^/*}, ""))
1479
        ref ||= root_ref
1480 1481 1482

        return [] if empty? || safe_query.blank?

1483 1484 1485 1486 1487
        gitaly_migrate(:search_files_by_name) do |is_enabled|
          if is_enabled
            gitaly_repository_client.search_files_by_name(ref, safe_query)
          else
            args = %W(ls-tree -r --name-status --full-tree #{ref} -- #{safe_query})
1488

1489 1490 1491
            run_git(args).first.lines.map(&:strip)
          end
        end
1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503
      end

      def find_commits_by_message(query, ref, path, limit, offset)
        gitaly_migrate(:commits_by_message) do |is_enabled|
          if is_enabled
            find_commits_by_message_by_gitaly(query, ref, path, limit, offset)
          else
            find_commits_by_message_by_shelling_out(query, ref, path, limit, offset)
          end
        end
      end

1504 1505 1506 1507 1508
      def shell_blame(sha, path)
        output, _status = run_git(%W(blame -p #{sha} -- #{path}))
        output
      end

1509
      def last_commit_for_path(sha, path)
1510 1511
        gitaly_migrate(:last_commit_for_path) do |is_enabled|
          if is_enabled
1512
            last_commit_for_path_by_gitaly(sha, path)
1513
          else
1514
            last_commit_for_path_by_rugged(sha, path)
1515 1516 1517 1518
          end
        end
      end

1519
      def rev_list(including: [], excluding: [], options: [], objects: false, &block)
1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531
        args = ['rev-list']

        args.push(*rev_list_param(including))

        exclude_param = *rev_list_param(excluding)
        if exclude_param.any?
          args.push('--not')
          args.push(*exclude_param)
        end

        args.push('--objects') if objects

1532 1533 1534 1535
        if options.any?
          args.push(*options)
        end

1536 1537 1538 1539 1540 1541 1542
        run_git!(args, lazy_block: block)
      end

      def missed_ref(oldrev, newrev)
        run_git!(['rev-list', '--max-count=1', oldrev, "^#{newrev}"])
      end

1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569
      def with_worktree(worktree_path, branch, sparse_checkout_files: nil, env:)
        base_args = %w(worktree add --detach)

        # Note that we _don't_ want to test for `.present?` here: If the caller
        # passes an non nil empty value it means it still wants sparse checkout
        # but just isn't interested in any file, perhaps because it wants to
        # checkout files in by a changeset but that changeset only adds files.
        if sparse_checkout_files
          # Create worktree without checking out
          run_git!(base_args + ['--no-checkout', worktree_path], env: env)
          worktree_git_path = run_git!(%w(rev-parse --git-dir), chdir: worktree_path).chomp

          configure_sparse_checkout(worktree_git_path, sparse_checkout_files)

          # After sparse checkout configuration, checkout `branch` in worktree
          run_git!(%W(checkout --detach #{branch}), chdir: worktree_path, env: env)
        else
          # Create worktree and checkout `branch` in it
          run_git!(base_args + [worktree_path, branch], env: env)
        end

        yield
      ensure
        FileUtils.rm_rf(worktree_path) if File.exist?(worktree_path)
        FileUtils.rm_rf(worktree_git_path) if worktree_git_path && File.exist?(worktree_git_path)
      end

1570
      def checksum
1571 1572 1573 1574 1575 1576
        # The exists? RPC is much cheaper, so we perform this request first
        raise NoRepository, "Repository does not exists" unless exists?

        gitaly_repository_client.calculate_checksum
      rescue GRPC::NotFound
        raise NoRepository # Guard against data races.
1577 1578
      end

Robert Speicher's avatar
Robert Speicher committed
1579 1580
      private

1581 1582 1583 1584 1585 1586 1587 1588 1589 1590
      def uncached_has_local_branches?
        gitaly_migrate(:has_local_branches, status: Gitlab::GitalyClient::MigrationStatus::OPT_OUT) do |is_enabled|
          if is_enabled
            gitaly_repository_client.has_local_branches?
          else
            has_local_branches_rugged?
          end
        end
      end

1591 1592 1593 1594 1595 1596 1597 1598
      def local_write_ref(ref_path, ref, old_ref: nil, shell: true)
        if shell
          shell_write_ref(ref_path, ref, old_ref)
        else
          rugged_write_ref(ref_path, ref)
        end
      end

1599 1600 1601 1602
      def rugged_write_config(full_path:)
        rugged.config['gitlab.fullpath'] = full_path
      end

1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614
      def shell_write_ref(ref_path, ref, old_ref)
        raise ArgumentError, "invalid ref_path #{ref_path.inspect}" if ref_path.include?(' ')
        raise ArgumentError, "invalid ref #{ref.inspect}" if ref.include?("\x00")
        raise ArgumentError, "invalid old_ref #{old_ref.inspect}" if !old_ref.nil? && old_ref.include?("\x00")

        input = "update #{ref_path}\x00#{ref}\x00#{old_ref}\x00"
        run_git!(%w[update-ref --stdin -z]) { |stdin| stdin.write(input) }
      end

      def rugged_write_ref(ref_path, ref)
        rugged.references.create(ref_path, ref, force: true)
      rescue Rugged::ReferenceError => ex
1615
        Rails.logger.error "Unable to create #{ref_path} reference for repository #{path}: #{ex}"
1616
      rescue Rugged::OSError => ex
1617 1618 1619
        raise unless ex.message =~ /Failed to create locked file/ && ex.message =~ /File exists/

        Rails.logger.error "Unable to create #{ref_path} reference for repository #{path}: #{ex}"
1620 1621
      end

1622
      def run_git(args, chdir: path, env: {}, nice: false, lazy_block: nil, &block)
1623 1624
        cmd = [Gitlab.config.git.bin_path, *args]
        cmd.unshift("nice") if nice
1625 1626 1627 1628 1629 1630

        object_directories = alternate_object_directories
        if object_directories.any?
          env['GIT_ALTERNATE_OBJECT_DIRECTORIES'] = object_directories.join(File::PATH_SEPARATOR)
        end

1631
        circuit_breaker.perform do
1632
          popen(cmd, chdir, env, lazy_block: lazy_block, &block)
1633 1634 1635
        end
      end

1636 1637
      def run_git!(args, chdir: path, env: {}, nice: false, lazy_block: nil, &block)
        output, status = run_git(args, chdir: chdir, env: env, nice: nice, lazy_block: lazy_block, &block)
1638 1639 1640 1641 1642 1643

        raise GitError, output unless status.zero?

        output
      end

1644 1645 1646 1647 1648 1649
      def run_git_with_timeout(args, timeout, env: {})
        circuit_breaker.perform do
          popen_with_timeout([Gitlab.config.git.bin_path, *args], timeout, path, env)
        end
      end

1650 1651
      # This function is duplicated in Gitaly-Go, don't change it!
      # https://gitlab.com/gitlab-org/gitaly/merge_requests/698
1652 1653 1654
      def fresh_worktree?(path)
        File.exist?(path) && !clean_stuck_worktree(path)
      end
Kim Carlbäcker's avatar
Kim Carlbäcker committed
1655

1656 1657
      # This function is duplicated in Gitaly-Go, don't change it!
      # https://gitlab.com/gitlab-org/gitaly/merge_requests/698
1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677
      def clean_stuck_worktree(path)
        return false unless File.mtime(path) < 15.minutes.ago

        FileUtils.rm_rf(path)
        true
      end

      # Adding a worktree means checking out the repository. For large repos,
      # this can be very expensive, so set up sparse checkout for the worktree
      # to only check out the files we're interested in.
      def configure_sparse_checkout(worktree_git_path, files)
        run_git!(%w(config core.sparseCheckout true))

        return if files.empty?

        worktree_info_path = File.join(worktree_git_path, 'info')
        FileUtils.mkdir_p(worktree_info_path)
        File.write(File.join(worktree_info_path, 'sparse-checkout'), files)
      end

1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688
      def rugged_fetch_source_branch(source_repository, source_branch, local_ref)
        with_repo_branch_commit(source_repository, source_branch) do |commit|
          if commit
            write_ref(local_ref, commit.sha)
            true
          else
            false
          end
        end
      end

1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706
      def worktree_path(prefix, id)
        id = id.to_s
        raise ArgumentError, "worktree id can't be empty" unless id.present?
        raise ArgumentError, "worktree id can't contain slashes " if id.include?("/")

        File.join(path, 'gitlab-worktree', "#{prefix}-#{id}")
      end

      def git_env_for_user(user)
        {
          'GIT_COMMITTER_NAME' => user.name,
          'GIT_COMMITTER_EMAIL' => user.email,
          'GL_ID' => Gitlab::GlId.gl_id(user),
          'GL_PROTOCOL' => Gitlab::Git::Hook::GL_PROTOCOL,
          'GL_REPOSITORY' => gl_repository
        }
      end

1707 1708
      # Gitaly note: JV: Trying to get rid of the 'filter' option so we can implement this with 'git'.
      def branches_filter(filter: nil, sort_by: nil)
1709 1710 1711 1712 1713 1714 1715 1716
        branches = rugged.branches.each(filter).map do |rugged_ref|
          begin
            target_commit = Gitlab::Git::Commit.find(self, rugged_ref.target)
            Gitlab::Git::Branch.new(self, rugged_ref.name, rugged_ref.target, target_commit)
          rescue Rugged::ReferenceError
            # Omit invalid branch
          end
        end.compact
1717 1718 1719 1720

        sort_branches(branches, sort_by)
      end

1721
      def git_merged_branch_names(branch_names, root_sha)
1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732
        git_arguments =
          %W[branch --merged #{root_sha}
             --format=%(refname:short)\ %(objectname)] + branch_names

        lines = run_git(git_arguments).first.lines

        lines.each_with_object([]) do |line, branches|
          name, sha = line.strip.split(' ', 2)

          branches << name if sha != root_sha
        end
1733 1734
      end

1735 1736 1737 1738 1739 1740 1741 1742
      def gitaly_merged_branch_names(branch_names, root_sha)
        qualified_branch_names = branch_names.map { |b| "refs/heads/#{b}" }

        gitaly_ref_client.merged_branches(qualified_branch_names)
          .reject { |b| b.target == root_sha }
          .map(&:name)
      end

1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762
      def process_count_commits_options(options)
        if options[:from] || options[:to]
          ref =
            if options[:left_right] # Compare with merge-base for left-right
              "#{options[:from]}...#{options[:to]}"
            else
              "#{options[:from]}..#{options[:to]}"
            end

          options.merge(ref: ref)

        elsif options[:ref] && options[:left_right]
          from, to = options[:ref].match(/\A([^\.]*)\.{2,3}([^\.]*)\z/)[1..2]

          options.merge(from: from, to: to)
        else
          options
        end
      end

1763 1764 1765
      # Gitaly note: JV: although #log_by_shell shells out to Git I think the
      # complexity is such that we should migrate it as Ruby before trying to
      # do it in Go.
1766 1767 1768 1769 1770 1771 1772 1773 1774 1775
      def log_by_shell(sha, options)
        limit = options[:limit].to_i
        offset = options[:offset].to_i
        use_follow_flag = options[:follow] && options[:path].present?

        # We will perform the offset in Ruby because --follow doesn't play well with --skip.
        # See: https://gitlab.com/gitlab-org/gitlab-ce/issues/3574#note_3040520
        offset_in_ruby = use_follow_flag && options[:offset].present?
        limit += offset if offset_in_ruby

1776
        cmd = %w[log]
1777 1778 1779 1780 1781 1782 1783
        cmd << "--max-count=#{limit}"
        cmd << '--format=%H'
        cmd << "--skip=#{offset}" unless offset_in_ruby
        cmd << '--follow' if use_follow_flag
        cmd << '--no-merges' if options[:skip_merges]
        cmd << "--after=#{options[:after].iso8601}" if options[:after]
        cmd << "--before=#{options[:before].iso8601}" if options[:before]
1784 1785 1786

        if options[:all]
          cmd += %w[--all --reverse]
Tiago Botelho's avatar
Tiago Botelho committed
1787
        else
1788 1789
          cmd << sha
        end
1790 1791 1792 1793 1794 1795 1796

        # :path can be a string or an array of strings
        if options[:path].present?
          cmd << '--'
          cmd += Array(options[:path])
        end

1797
        raw_output, _status = run_git(cmd)
1798 1799 1800 1801 1802
        lines = offset_in_ruby ? raw_output.lines.drop(offset) : raw_output.lines

        lines.map! { |c| Rugged::Commit.new(rugged, c.strip) }
      end

1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819
      # We are trying to deprecate this method because it does a lot of work
      # but it seems to be used only to look up submodule URL's.
      # https://gitlab.com/gitlab-org/gitaly/issues/329
      def submodules(ref)
        commit = rev_parse_target(ref)
        return {} unless commit

        begin
          content = blob_content(commit, ".gitmodules")
        rescue InvalidBlobName
          return {}
        end

        parser = GitmodulesParser.new(content)
        fill_submodule_ids(commit, parser.parse)
      end

1820 1821 1822 1823 1824 1825
      def gitaly_submodule_url_for(ref, path)
        # We don't care about the contents so 1 byte is enough. Can't request 0 bytes, 0 means unlimited.
        commit_object = gitaly_commit_client.tree_entry(ref, path, 1)

        return unless commit_object && commit_object.type == :COMMIT

Clement Ho's avatar
Clement Ho committed
1826
        gitmodules = gitaly_commit_client.tree_entry(ref, '.gitmodules', Gitlab::Git::Blob::MAX_DATA_DISPLAY_SIZE)
1827 1828
        return unless gitmodules

1829 1830 1831 1832 1833
        found_module = GitmodulesParser.new(gitmodules.data).parse[path]

        found_module && found_module['url']
      end

1834
      def alternate_object_directories
1835
        relative_object_directories.map { |d| File.join(path, d) }
1836 1837
      end

1838
      def relative_object_directories
1839
        Gitlab::Git::HookEnv.all(gl_repository).values_at(*ALLOWED_OBJECT_RELATIVE_DIRECTORIES_VARIABLES).flatten.compact
1840 1841
      end

Robert Speicher's avatar
Robert Speicher committed
1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860
      # Get the content of a blob for a given commit.  If the blob is a commit
      # (for submodules) then return the blob's OID.
      def blob_content(commit, blob_name)
        blob_entry = tree_entry(commit, blob_name)

        unless blob_entry
          raise InvalidBlobName.new("Invalid blob name: #{blob_name}")
        end

        case blob_entry[:type]
        when :commit
          blob_entry[:oid]
        when :tree
          raise InvalidBlobName.new("#{blob_name} is a tree, not a blob")
        when :blob
          rugged.lookup(blob_entry[:oid]).content
        end
      end

1861 1862 1863 1864 1865 1866 1867 1868 1869
      # Fill in the 'id' field of a submodule hash from its values
      # as-of +commit+. Return a Hash consisting only of entries
      # from the submodule hash for which the 'id' field is filled.
      def fill_submodule_ids(commit, submodule_data)
        submodule_data.each do |path, data|
          id = begin
            blob_content(commit, path)
          rescue InvalidBlobName
            nil
Robert Speicher's avatar
Robert Speicher committed
1870
          end
1871
          data['id'] = id
Robert Speicher's avatar
Robert Speicher committed
1872
        end
1873
        submodule_data.select { |path, data| data['id'] }
Robert Speicher's avatar
Robert Speicher committed
1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888
      end

      # Find the entry for +path+ in the tree for +commit+
      def tree_entry(commit, path)
        pathname = Pathname.new(path)
        first = true
        tmp_entry = nil

        pathname.each_filename do |dir|
          if first
            tmp_entry = commit.tree[dir]
            first = false
          elsif tmp_entry.nil?
            return nil
          else
1889 1890 1891 1892 1893 1894
            begin
              tmp_entry = rugged.lookup(tmp_entry[:oid])
            rescue Rugged::OdbError, Rugged::InvalidError, Rugged::ReferenceError
              return nil
            end

Robert Speicher's avatar
Robert Speicher committed
1895
            return nil unless tmp_entry.type == :tree
1896

Robert Speicher's avatar
Robert Speicher committed
1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907
            tmp_entry = tmp_entry[dir]
          end
        end

        tmp_entry
      end

      # Return the Rugged patches for the diff between +from+ and +to+.
      def diff_patches(from, to, options = {}, *paths)
        options ||= {}
        break_rewrites = options[:break_rewrites]
1908
        actual_options = Gitlab::Git::Diff.filter_diff_options(options.merge(paths: paths))
Robert Speicher's avatar
Robert Speicher committed
1909 1910 1911 1912 1913

        diff = rugged.diff(from, to, actual_options)
        diff.find_similar!(break_rewrites: break_rewrites)
        diff.each_patch
      end
1914

1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931
      def sort_branches(branches, sort_by)
        case sort_by
        when 'name'
          branches.sort_by(&:name)
        when 'updated_desc'
          branches.sort do |a, b|
            b.dereferenced_target.committed_date <=> a.dereferenced_target.committed_date
          end
        when 'updated_asc'
          branches.sort do |a, b|
            a.dereferenced_target.committed_date <=> b.dereferenced_target.committed_date
          end
        else
          branches
        end
      end

1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944
      def tags_from_rugged
        rugged.references.each("refs/tags/*").map do |ref|
          message = nil

          if ref.target.is_a?(Rugged::Tag::Annotation)
            tag_message = ref.target.message

            if tag_message.respond_to?(:chomp)
              message = tag_message.chomp
            end
          end

          target_commit = Gitlab::Git::Commit.find(self, ref.target)
1945 1946 1947 1948 1949 1950
          Gitlab::Git::Tag.new(self, {
            name: ref.name,
            target: ref.target,
            target_commit: target_commit,
            message: message
          })
1951 1952 1953
        end.sort_by(&:name)
      end

1954
      def last_commit_for_path_by_rugged(sha, path)
1955
        sha = last_commit_id_for_path_by_shelling_out(sha, path)
1956 1957 1958
        commit(sha)
      end

1959 1960 1961 1962
      def tags_from_gitaly
        gitaly_ref_client.tags
      end

1963 1964 1965 1966 1967 1968 1969 1970
      def size_by_shelling_out
        popen(%w(du -sk), path).first.strip.to_i
      end

      def size_by_gitaly
        gitaly_repository_client.repository_size
      end

1971
      def count_commits_by_gitaly(options)
1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984
        if options[:left_right]
          from = options[:from]
          to = options[:to]

          right_count = gitaly_commit_client
            .commit_count("#{from}..#{to}", options)
          left_count = gitaly_commit_client
            .commit_count("#{to}..#{from}", options)

          [left_count, right_count]
        else
          gitaly_commit_client.commit_count(options[:ref], options)
        end
1985 1986 1987
      end

      def count_commits_by_shelling_out(options)
1988 1989
        cmd = count_commits_shelling_command(options)

1990
        raw_output, _status = run_git(cmd)
1991 1992 1993 1994 1995

        process_count_commits_raw_output(raw_output, options)
      end

      def count_commits_shelling_command(options)
1996
        cmd = %w[rev-list]
1997 1998
        cmd << "--after=#{options[:after].iso8601}" if options[:after]
        cmd << "--before=#{options[:before].iso8601}" if options[:before]
1999
        cmd << "--max-count=#{options[:max_count]}" if options[:max_count]
2000
        cmd << "--left-right" if options[:left_right]
Tiago Botelho's avatar
Tiago Botelho committed
2001
        cmd << '--count'
2002

Tiago Botelho's avatar
Tiago Botelho committed
2003 2004 2005 2006 2007 2008 2009
        cmd << if options[:all]
                 '--all'
               elsif options[:ref]
                 options[:ref]
               else
                 raise ArgumentError, "Please specify a valid ref or set the 'all' attribute to true"
               end
2010

2011
        cmd += %W[-- #{options[:path]}] if options[:path].present?
2012 2013
        cmd
      end
2014

2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027
      def process_count_commits_raw_output(raw_output, options)
        if options[:left_right]
          result = raw_output.scan(/\d+/).map(&:to_i)

          if result.sum != options[:max_count]
            result
          else # Reaching max count, right is not accurate
            right_option =
              process_count_commits_options(options
                .except(:left_right, :from, :to)
                .merge(ref: options[:to]))

            right = count_commits_by_shelling_out(right_option)
2028

2029 2030 2031 2032 2033
            [result.first, right] # left should be accurate in the first call
          end
        else
          raw_output.to_i
        end
2034
      end
2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049

      def gitaly_ls_files(ref)
        gitaly_commit_client.ls_files(ref)
      end

      def git_ls_files(ref)
        actual_ref = ref || root_ref

        begin
          sha_from_ref(actual_ref)
        rescue Rugged::OdbError, Rugged::InvalidError, Rugged::ReferenceError
          # Return an empty array if the ref wasn't found
          return []
        end

2050 2051
        cmd = %W(ls-tree -r --full-tree --full-name -- #{actual_ref})
        raw_output, _status = run_git(cmd)
2052

2053
        lines = raw_output.split("\n").map do |f|
2054 2055 2056 2057 2058 2059
          stuff, path = f.split("\t")
          _mode, type, _sha = stuff.split(" ")
          path if type == "blob"
          # Contain only blob type
        end

2060
        lines.compact
2061
      end
2062

2063 2064 2065
      # Returns true if the given ref name exists
      #
      # Ref names must start with `refs/`.
2066 2067
      def rugged_ref_exists?(ref_name)
        raise ArgumentError, 'invalid refname' unless ref_name.start_with?('refs/')
2068

2069 2070 2071 2072 2073 2074 2075 2076
        rugged.references.exist?(ref_name)
      rescue Rugged::ReferenceError
        false
      end

      # Returns true if the given ref name exists
      #
      # Ref names must start with `refs/`.
2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101
      def gitaly_ref_exists?(ref_name)
        gitaly_ref_client.ref_exists?(ref_name)
      end

      # Returns true if the given tag exists
      #
      # name - The name of the tag as a String.
      def rugged_tag_exists?(name)
        !!rugged.tags[name]
      end

      # Returns true if the given branch exists
      #
      # name - The name of the branch as a String.
      def rugged_branch_exists?(name)
        rugged.branches.exists?(name)

      # If the branch name is invalid (e.g. ".foo") Rugged will raise an error.
      # Whatever code calls this method shouldn't have to deal with that so
      # instead we just return `false` (which is true since a branch doesn't
      # exist when it has an invalid name).
      rescue Rugged::ReferenceError
        false
      end

2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128
      def gitaly_add_tag(tag_name, user:, target:, message: nil)
        gitaly_operations_client.add_tag(tag_name, user, target, message)
      end

      def rugged_add_tag(tag_name, user:, target:, message: nil)
        target_object = Ref.dereference_object(lookup(target))
        raise InvalidRef.new("target not found: #{target}") unless target_object

        user = Gitlab::Git::User.from_gitlab(user) unless user.respond_to?(:gl_id)

        options = nil # Use nil, not the empty hash. Rugged cares about this.
        if message
          options = {
            message: message,
            tagger: Gitlab::Git.committer_hash(email: user.email, name: user.name)
          }
        end

        Gitlab::Git::OperationService.new(user, self).add_tag(tag_name, target_object.oid, options)

        find_tag(tag_name)
      rescue Rugged::ReferenceError => ex
        raise InvalidRef, ex
      rescue Rugged::TagError
        raise TagExistsError
      end

2129 2130 2131 2132 2133
      def rugged_create_branch(ref, start_point)
        rugged_ref = rugged.branches.create(ref, start_point)
        target_commit = Gitlab::Git::Commit.find(self, rugged_ref.target)
        Gitlab::Git::Branch.new(self, rugged_ref.name, rugged_ref.target, target_commit)
      rescue Rugged::ReferenceError => e
2134
        raise InvalidRef.new("Branch #{ref} already exists") if e.to_s =~ %r{'refs/heads/#{ref}'}
2135

2136 2137 2138
        raise InvalidRef.new("Invalid reference #{start_point}")
      end

2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171
      def gitaly_copy_gitattributes(revision)
        gitaly_repository_client.apply_gitattributes(revision)
      end

      def rugged_copy_gitattributes(ref)
        begin
          commit = lookup(ref)
        rescue Rugged::ReferenceError
          raise InvalidRef.new("Ref #{ref} is invalid")
        end

        # Create the paths
        info_dir_path = File.join(path, 'info')
        info_attributes_path = File.join(info_dir_path, 'attributes')

        begin
          # Retrieve the contents of the blob
          gitattributes_content = blob_content(commit, '.gitattributes')
        rescue InvalidBlobName
          # No .gitattributes found. Should now remove any info/attributes and return
          File.delete(info_attributes_path) if File.exist?(info_attributes_path)
          return
        end

        # Create the info directory if needed
        Dir.mkdir(info_dir_path) unless File.directory?(info_dir_path)

        # Write the contents of the .gitattributes file to info/attributes
        # Use binary mode to prevent Rails from converting ASCII-8BIT to UTF-8
        File.open(info_attributes_path, "wb") do |file|
          file.write(gitattributes_content)
        end
      end
2172

2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194
      def rugged_revert(user:, commit:, branch_name:, message:, start_branch_name:, start_repository:)
        OperationService.new(user, self).with_branch(
          branch_name,
          start_branch_name: start_branch_name,
          start_repository: start_repository
        ) do |start_commit|

          Gitlab::Git.check_namespace!(commit, start_repository)

          revert_tree_id = check_revert_content(commit, start_commit.sha)
          raise CreateTreeError unless revert_tree_id

          committer = user_to_committer(user)

          create_commit(message: message,
                        author: committer,
                        committer: committer,
                        tree: revert_tree_id,
                        parents: [start_commit.sha])
        end
      end

2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233
      def rugged_cherry_pick(user:, commit:, branch_name:, message:, start_branch_name:, start_repository:)
        OperationService.new(user, self).with_branch(
          branch_name,
          start_branch_name: start_branch_name,
          start_repository: start_repository
        ) do |start_commit|

          Gitlab::Git.check_namespace!(commit, start_repository)

          cherry_pick_tree_id = check_cherry_pick_content(commit, start_commit.sha)
          raise CreateTreeError unless cherry_pick_tree_id

          committer = user_to_committer(user)

          create_commit(message: message,
                        author: {
                            email: commit.author_email,
                            name: commit.author_name,
                            time: commit.authored_date
                        },
                        committer: committer,
                        tree: cherry_pick_tree_id,
                        parents: [start_commit.sha])
        end
      end

      def check_cherry_pick_content(target_commit, source_sha)
        args = [target_commit.sha, source_sha]
        args << 1 if target_commit.merge_commit?

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

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

        tree_id
      end

2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267
      def gitaly_rebase(user, rebase_id, branch:, branch_sha:, remote_repository:, remote_branch:)
        gitaly_operation_client.user_rebase(user, rebase_id,
                                            branch: branch,
                                            branch_sha: branch_sha,
                                            remote_repository: remote_repository,
                                            remote_branch: remote_branch)
      end

      def git_rebase(user, rebase_id, branch:, branch_sha:, remote_repository:, remote_branch:)
        rebase_path = worktree_path(REBASE_WORKTREE_PREFIX, rebase_id)
        env = git_env_for_user(user)

        if remote_repository.is_a?(RemoteRepository)
          env.merge!(remote_repository.fetch_env)
          remote_repo_path = GITALY_INTERNAL_URL
        else
          remote_repo_path = remote_repository.path
        end

        with_worktree(rebase_path, branch, env: env) do
          run_git!(
            %W(pull --rebase #{remote_repo_path} #{remote_branch}),
            chdir: rebase_path, env: env
          )

          rebase_sha = run_git!(%w(rev-parse HEAD), chdir: rebase_path, env: env).strip

          Gitlab::Git::OperationService.new(user, self)
            .update_branch(branch, rebase_sha, branch_sha)

          rebase_sha
        end
      end

2268 2269 2270 2271 2272 2273 2274 2275
      def git_squash(user, squash_id, branch, start_sha, end_sha, author, message)
        squash_path = worktree_path(SQUASH_WORKTREE_PREFIX, squash_id)
        env = git_env_for_user(user).merge(
          'GIT_AUTHOR_NAME' => author.name,
          'GIT_AUTHOR_EMAIL' => author.email
        )
        diff_range = "#{start_sha}...#{end_sha}"
        diff_files = run_git!(
2276
          %W(diff --name-only --diff-filter=ar --binary #{diff_range})
2277 2278 2279 2280 2281
        ).chomp

        with_worktree(squash_path, branch, sparse_checkout_files: diff_files, env: env) do
          # Apply diff of the `diff_range` to the worktree
          diff = run_git!(%W(diff --binary #{diff_range}))
2282
          run_git!(%w(apply --index --whitespace=nowarn), chdir: squash_path, env: env) do |stdin|
2283
            stdin.binmode
2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299
            stdin.write(diff)
          end

          # Commit the `diff_range` diff
          run_git!(%W(commit --no-verify --message #{message}), chdir: squash_path, env: env)

          # Return the squash sha. May print a warning for ambiguous refs, but
          # we can ignore that with `--quiet` and just take the SHA, if present.
          # HEAD here always refers to the current HEAD commit, even if there is
          # another ref called HEAD.
          run_git!(
            %w(rev-parse --quiet --verify HEAD), chdir: squash_path, env: env
          ).chomp
        end
      end

2300 2301 2302 2303 2304 2305
      def local_fetch_ref(source_path, source_ref:, target_ref:)
        args = %W(fetch --no-tags -f #{source_path} #{source_ref}:#{target_ref})
        run_git(args)
      end

      def gitaly_fetch_ref(source_repository, source_ref:, target_ref:)
2306
        args = %W(fetch --no-tags -f #{GITALY_INTERNAL_URL} #{source_ref}:#{target_ref})
2307

2308
        run_git(args, env: source_repository.fetch_env)
2309
      end
2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322

      def gitaly_ff_merge(user, source_sha, target_branch)
        gitaly_operations_client.user_ff_branch(user, source_sha, target_branch)
      rescue GRPC::FailedPrecondition => e
        raise CommitError, e
      end

      def rugged_ff_merge(user, source_sha, target_branch)
        OperationService.new(user, self).with_branch(target_branch) do |our_commit|
          raise ArgumentError, 'Invalid merge target' unless our_commit

          source_sha
        end
2323
      rescue Rugged::ReferenceError, InvalidRef
2324 2325
        raise ArgumentError, 'Invalid merge source'
      end
2326

2327 2328 2329 2330 2331 2332 2333 2334
      def rugged_add_remote(remote_name, url, mirror_refmap)
        rugged.remotes.create(remote_name, url)

        set_remote_as_mirror(remote_name, refmap: mirror_refmap) if mirror_refmap
      rescue Rugged::ConfigError
        remote_update(remote_name, url: url)
      end

2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349
      def git_delete_refs(*ref_names)
        instructions = ref_names.map do |ref|
          "delete #{ref}\x00\x00"
        end

        message, status = run_git(%w[update-ref --stdin -z]) do |stdin|
          stdin.write(instructions.join)
        end

        unless status.zero?
          raise GitError.new("Could not delete refs #{ref_names}: #{message}")
        end
      end

      def gitaly_delete_refs(*ref_names)
2350
        gitaly_ref_client.delete_refs(refs: ref_names) if ref_names.any?
2351 2352
      end

2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367
      def rugged_remove_remote(remote_name)
        # When a remote is deleted all its remote refs are deleted too, but in
        # the case of mirrors we map its refs (that would usualy go under
        # [remote_name]/) to the top level namespace. We clean the mapping so
        # those don't get deleted.
        if rugged.config["remote.#{remote_name}.mirror"]
          rugged.config.delete("remote.#{remote_name}.fetch")
        end

        rugged.remotes.delete(remote_name)
        true
      rescue Rugged::ConfigError
        false
      end

2368 2369 2370 2371 2372 2373 2374 2375 2376 2377
      def rugged_fetch_repository_as_mirror(repository)
        remote_name = "tmp-#{SecureRandom.hex}"
        repository = RemoteRepository.new(repository) unless repository.is_a?(RemoteRepository)

        add_remote(remote_name, GITALY_INTERNAL_URL, mirror_refmap: :all_refs)
        fetch_remote(remote_name, env: repository.fetch_env)
      ensure
        remove_remote(remote_name)
      end

2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410
      def rugged_multi_action(
        user, branch_name, message, actions, author_email, author_name,
        start_branch_name, start_repository)

        OperationService.new(user, self).with_branch(
          branch_name,
          start_branch_name: start_branch_name,
          start_repository: start_repository
        ) do |start_commit|
          index = Gitlab::Git::Index.new(self)
          parents = []

          if start_commit
            index.read_tree(start_commit.rugged_commit.tree)
            parents = [start_commit.sha]
          end

          actions.each { |opts| index.apply(opts.delete(:action), opts) }

          committer = user_to_committer(user)
          author = Gitlab::Git.committer_hash(email: author_email, name: author_name) || committer
          options = {
            tree: index.write_tree,
            message: message,
            parents: parents,
            author: author,
            committer: committer
          }

          create_commit(options)
        end
      end

2411 2412 2413
      def fetch_remote(remote_name = 'origin', env: nil)
        run_git(['fetch', remote_name], env: env).last.zero?
      end
2414

2415 2416 2417 2418 2419 2420 2421 2422
      def gitaly_can_be_merged?(their_commit, our_commit)
        !gitaly_conflicts_client(our_commit, their_commit).conflicts?
      end

      def rugged_can_be_merged?(their_commit, our_commit)
        !rugged.merge_commits(our_commit, their_commit).conflicts?
      end

2423 2424 2425
      def gitlab_projects_error
        raise CommandError, @gitlab_projects.output
      end
2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445

      def find_commits_by_message_by_shelling_out(query, ref, path, limit, offset)
        ref ||= root_ref

        args = %W(
          log #{ref} --pretty=%H --skip #{offset}
          --max-count #{limit} --grep=#{query} --regexp-ignore-case
        )
        args = args.concat(%W(-- #{path})) if path.present?

        git_log_results = run_git(args).first.lines

        git_log_results.map { |c| commit(c.chomp) }.compact
      end

      def find_commits_by_message_by_gitaly(query, ref, path, limit, offset)
        gitaly_commit_client
          .commits_by_message(query, revision: ref, path: path, limit: limit, offset: offset)
          .map { |c| commit(c) }
      end
2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470

      def last_commit_for_path_by_gitaly(sha, path)
        gitaly_commit_client.last_commit_for_path(sha, path)
      end

      def last_commit_id_for_path_by_shelling_out(sha, path)
        args = %W(rev-list --max-count=1 #{sha} -- #{path})
        run_git_with_timeout(args, Gitlab::Git::Popen::FAST_GIT_PROCESS_TIMEOUT).first.strip
      end

      def rugged_merge_base(from, to)
        rugged.merge_base(from, to)
      rescue Rugged::ReferenceError
        nil
      end

      def rugged_commit_count(ref)
        walker = Rugged::Walker.new(rugged)
        walker.sorting(Rugged::SORT_TOPO | Rugged::SORT_REVERSE)
        oid = rugged.rev_parse_oid(ref)
        walker.push(oid)
        walker.count
      rescue Rugged::ReferenceError
        0
      end
2471 2472 2473 2474

      def rev_list_param(spec)
        spec == :all ? ['--all'] : spec
      end
2475 2476 2477 2478

      def sha_from_ref(ref)
        rev_parse_target(ref).oid
      end
2479

Rubén Dávila's avatar
Rubén Dávila committed
2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507
      def build_git_cmd(*args)
        object_directories = alternate_object_directories.join(File::PATH_SEPARATOR)

        env = { 'PWD' => self.path }
        env['GIT_ALTERNATE_OBJECT_DIRECTORIES'] = object_directories if object_directories.present?

        [
          env,
          ::Gitlab.config.git.bin_path,
          *args,
          { chdir: self.path }
        ]
      end

      def git_diff_cmd(old_rev, new_rev)
        old_rev = old_rev == ::Gitlab::Git::BLANK_SHA ? ::Gitlab::Git::EMPTY_TREE_ID : old_rev

        build_git_cmd('diff', old_rev, new_rev, '--raw')
      end

      def git_cat_file_cmd
        format = '%(objectname) %(objectsize) %(rest)'
        build_git_cmd('cat-file', "--batch-check=#{format}")
      end

      def format_git_cat_file_script
        File.expand_path('../support/format-git-cat-file-input', __FILE__)
      end
Robert Speicher's avatar
Robert Speicher committed
2508 2509 2510
    end
  end
end