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

3
class Repository
4 5
  class CommitError < StandardError; end

6 7
  include Gitlab::ShellAdapter

8
  attr_accessor :path_with_namespace, :project
9

J
Jacob Vosmaer 已提交
10 11 12 13 14 15 16 17
  def self.clean_old_archives
    repository_downloads_path = Gitlab.config.gitlab.repository_downloads_path

    return unless File.directory?(repository_downloads_path)

    Gitlab::Popen.popen(%W(find #{repository_downloads_path} -not -path #{repository_downloads_path} -mmin +120 -delete))
  end

18
  def initialize(path_with_namespace, default_branch = nil, project = nil)
19
    @path_with_namespace = path_with_namespace
20
    @project = project
21
  end
22

23 24
  def raw_repository
    return nil unless path_with_namespace
25

26 27 28 29 30 31 32
    @raw_repository ||= begin
      repo = Gitlab::Git::Repository.new(path_to_repo)
      repo.autocrlf = :input
      repo
    rescue Gitlab::Git::Repository::NoRepository
      nil
    end
33 34
  end

35
  # Return absolute path to repository
36
  def path_to_repo
37 38 39
    @path_to_repo ||= File.expand_path(
      File.join(Gitlab.config.gitlab_shell.repos_path, path_with_namespace + ".git")
    )
40 41
  end

42 43 44 45 46 47
  def exists?
    raw_repository
  end

  def empty?
    raw_repository.empty?
48 49
  end

50 51 52 53 54 55 56 57 58 59 60 61 62
  #
  # 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.
  #
  # This method return true if repository contains some content visible in project page.
  #
  def has_visible_content?
    !raw_repository.branches.empty?
  end

63
  def commit(id = 'HEAD')
64
    return nil unless raw_repository
65
    commit = Gitlab::Git::Commit.find(raw_repository, id)
66
    commit = Commit.new(commit, @project) if commit
67
    commit
68
  rescue Rugged::OdbError
69
    nil
70 71
  end

D
Dmitriy Zaporozhets 已提交
72
  def commits(ref, path = nil, limit = nil, offset = nil, skip_merges = false)
73
    options = {
74 75 76 77 78
      repo: raw_repository,
      ref: ref,
      path: path,
      limit: limit,
      offset: offset,
79
      follow: path.present?
80 81 82
    }

    commits = Gitlab::Git::Commit.where(options)
83
    commits = Commit.decorate(commits, @project) if commits.present?
84 85 86
    commits
  end

87 88
  def commits_between(from, to)
    commits = Gitlab::Git::Commit.between(raw_repository, from, to)
89
    commits = Commit.decorate(commits, @project) if commits.present?
90 91 92
    commits
  end

93
  def find_commits_by_message(query)
94
    # Limited to 1000 commits for now, could be parameterized?
95
    args = %W(#{Gitlab.config.git.bin_path} log --pretty=%H --max-count 1000 --grep=#{query})
96

97 98
    git_log_results = Gitlab::Popen.popen(args, path_to_repo).first.lines.map(&:chomp)
    commits = git_log_results.map { |c| commit(c) }
99
    commits
100 101
  end

102
  def find_branch(name)
103
    raw_repository.branches.find { |branch| branch.name == name }
104 105 106
  end

  def find_tag(name)
107
    raw_repository.tags.find { |tag| tag.name == name }
108 109
  end

110 111 112 113 114 115 116 117 118 119
  def add_branch(user, branch_name, target)
    oldrev = Gitlab::Git::BLANK_SHA
    ref    = Gitlab::Git::BRANCH_REF_PREFIX + branch_name
    target = commit(target).try(:id)

    return false unless target

    GitHooksService.new.execute(user, path_to_repo, oldrev, target, ref) do
      rugged.branches.create(branch_name, target)
    end
120

121 122
    expire_branches_cache
    find_branch(branch_name)
123 124
  end

125
  def add_tag(tag_name, ref, message = nil)
D
Douwe Maan 已提交
126
    expire_tags_cache
127

128
    gitlab_shell.add_tag(path_with_namespace, tag_name, ref, message)
129 130
  end

131
  def rm_branch(user, branch_name)
D
Douwe Maan 已提交
132
    expire_branches_cache
133

134 135 136 137 138 139 140 141 142 143 144
    branch = find_branch(branch_name)
    oldrev = branch.try(:target)
    newrev = Gitlab::Git::BLANK_SHA
    ref    = Gitlab::Git::BRANCH_REF_PREFIX + branch_name

    GitHooksService.new.execute(user, path_to_repo, oldrev, newrev, ref) do
      rugged.branches.delete(branch_name)
    end

    expire_branches_cache
    true
145 146
  end

147
  def rm_tag(tag_name)
D
Douwe Maan 已提交
148
    expire_tags_cache
149

150 151 152
    gitlab_shell.rm_tag(path_with_namespace, tag_name)
  end

153
  def branch_names
154
    cache.fetch(:branch_names) { raw_repository.branch_names }
155 156 157
  end

  def tag_names
158
    cache.fetch(:tag_names) { raw_repository.tag_names }
159 160
  end

161
  def commit_count
162
    cache.fetch(:commit_count) do
163
      begin
164
        raw_repository.commit_count(self.root_ref)
165 166 167
      rescue
        0
      end
168
    end
169 170
  end

171 172 173
  # Return repo size in megabytes
  # Cached in redis
  def size
174
    cache.fetch(:size) { raw_repository.size }
175 176
  end

177
  def cache_keys
178
    %i(size branch_names tag_names commit_count
179 180 181 182 183 184 185 186 187 188 189
       readme version contribution_guide changelog license)
  end

  def build_cache
    cache_keys.each do |key|
      unless cache.exist?(key)
        send(key)
      end
    end
  end

D
Douwe Maan 已提交
190 191 192 193 194 195 196 197 198 199
  def expire_tags_cache
    cache.expire(:tag_names)
    @tags = nil
  end

  def expire_branches_cache
    cache.expire(:branch_names)
    @branches = nil
  end

200
  def expire_cache
201
    cache_keys.each do |key|
202 203
      cache.expire(key)
    end
D
Dmitriy Zaporozhets 已提交
204 205
  end

206 207
  def rebuild_cache
    cache_keys.each do |key|
208
      cache.expire(key)
209
      send(key)
D
Dmitriy Zaporozhets 已提交
210
    end
211 212
  end

213 214 215 216
  def lookup_cache
    @lookup_cache ||= {}
  end

217 218 219 220
  def expire_branch_names
    cache.expire(:branch_names)
  end

221
  def method_missing(m, *args, &block)
222 223 224 225 226 227
    if m == :lookup && !block_given?
      lookup_cache[m] ||= {}
      lookup_cache[m][args.join(":")] ||= raw_repository.send(m, *args, &block)
    else
      raw_repository.send(m, *args, &block)
    end
228 229
  end

230 231
  def respond_to_missing?(method, include_private = false)
    raw_repository.respond_to?(method, include_private) || super
232
  end
D
Dmitriy Zaporozhets 已提交
233 234

  def blob_at(sha, path)
235 236 237
    unless Gitlab::Git.blank_ref?(sha)
      Gitlab::Git::Blob.find(self, sha, path)
    end
D
Dmitriy Zaporozhets 已提交
238
  end
239

240 241 242 243
  def blob_by_oid(oid)
    Gitlab::Git::Blob.raw(self, oid)
  end

244
  def readme
245
    cache.fetch(:readme) { tree(:head).readme }
246
  end
247

248
  def version
249
    cache.fetch(:version) do
250 251 252 253 254 255
      tree(:head).blobs.find do |file|
        file.name.downcase == 'version'
      end
    end
  end

256
  def contribution_guide
257 258 259 260 261 262
    cache.fetch(:contribution_guide) do
      tree(:head).blobs.find do |file|
        file.contributing?
      end
    end
  end
263 264 265 266

  def changelog
    cache.fetch(:changelog) do
      tree(:head).blobs.find do |file|
267
        file.name =~ /\A(changelog|history)/i
268 269
      end
    end
270 271
  end

272 273 274
  def license
    cache.fetch(:license) do
      tree(:head).blobs.find do |file|
275
        file.name =~ /\Alicense/i
276 277
      end
    end
278 279
  end

280
  def head_commit
281 282 283 284 285
    @head_commit ||= commit(self.root_ref)
  end

  def head_tree
    @head_tree ||= Tree.new(self, head_commit.sha, nil)
286 287 288 289
  end

  def tree(sha = :head, path = nil)
    if sha == :head
290 291 292 293 294
      if path.nil?
        return head_tree
      else
        sha = head_commit.sha
      end
295 296 297 298
    end

    Tree.new(self, sha, path)
  end
D
Dmitriy Zaporozhets 已提交
299 300

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

D
Dmitriy Zaporozhets 已提交
303 304 305 306 307
    if last_commit
      blob_at(last_commit.sha, path)
    else
      nil
    end
D
Dmitriy Zaporozhets 已提交
308
  end
D
Dmitriy Zaporozhets 已提交
309 310 311 312 313 314 315 316

  # Returns url for submodule
  #
  # Ex.
  #   @repository.submodule_url_for('master', 'rack')
  #   # => git@localhost:rack.git
  #
  def submodule_url_for(ref, path)
D
Dmitriy Zaporozhets 已提交
317
    if submodules(ref).any?
D
Dmitriy Zaporozhets 已提交
318 319 320 321 322 323 324
      submodule = submodules(ref)[path]

      if submodule
        submodule['url']
      end
    end
  end
325 326

  def last_commit_for_path(sha, path)
327
    args = %W(#{Gitlab.config.git.bin_path} rev-list --max-count=1 #{sha} -- #{path})
328 329
    sha = Gitlab::Popen.popen(args, path_to_repo).first.strip
    commit(sha)
330
  end
331

332 333 334 335 336 337 338 339 340 341 342
  def next_patch_branch
    patch_branch_ids = self.branch_names.map do |n|
      result = n.match(/\Apatch-([0-9]+)\z/)
      result[1].to_i if result
    end.compact

    highest_patch_branch_id = patch_branch_ids.max || 0

    "patch-#{highest_patch_branch_id + 1}"
  end

343
  # Remove archives older than 2 hours
344 345 346 347 348 349 350 351 352 353 354 355 356 357
  def branches_sorted_by(value)
    case value
    when 'recently_updated'
      branches.sort do |a, b|
        commit(b.target).committed_date <=> commit(a.target).committed_date
      end
    when 'last_updated'
      branches.sort do |a, b|
        commit(a.target).committed_date <=> commit(b.target).committed_date
      end
    else
      branches
    end
  end
358 359

  def contributors
D
Dmitriy Zaporozhets 已提交
360
    commits = self.commits(nil, nil, 2000, 0, true)
361

D
Dmitriy Zaporozhets 已提交
362
    commits.group_by(&:author_email).map do |email, commits|
363 364
      contributor = Gitlab::Contributor.new
      contributor.email = email
365

D
Dmitriy Zaporozhets 已提交
366
      commits.each do |commit|
367
        if contributor.name.blank?
D
Dmitriy Zaporozhets 已提交
368
          contributor.name = commit.author_name
369 370
        end

371
        contributor.commits += 1
372 373
      end

374 375
      contributor
    end
376
  end
D
Dmitriy Zaporozhets 已提交
377 378

  def blob_for_diff(commit, diff)
379
    blob_at(commit.id, diff.file_path)
D
Dmitriy Zaporozhets 已提交
380 381 382 383 384 385 386
  end

  def prev_blob_for_diff(commit, diff)
    if commit.parent_id
      blob_at(commit.parent_id, diff.old_path)
    end
  end
387

388 389
  def refs_contains_sha(ref_type, sha)
    args = %W(#{Gitlab.config.git.bin_path} #{ref_type} --contains #{sha})
390 391 392 393 394 395 396 397 398 399 400 401 402 403
    names = Gitlab::Popen.popen(args, path_to_repo).first

    if names.respond_to?(:split)
      names = names.split("\n").map(&:strip)

      names.each do |name|
        name.slice! '* '
      end

      names
    else
      []
    end
  end
H
Hannes Rosenögger 已提交
404

405 406 407
  def branch_names_contains(sha)
    refs_contains_sha('branch', sha)
  end
H
Hannes Rosenögger 已提交
408

409 410
  def tag_names_contains(sha)
    refs_contains_sha('tag', sha)
H
Hannes Rosenögger 已提交
411
  end
412

413 414 415 416 417 418 419 420 421 422 423 424
  def branches
    @branches ||= raw_repository.branches
  end

  def tags
    @tags ||= raw_repository.tags
  end

  def root_ref
    @root_ref ||= raw_repository.root_ref
  end

S
Stan Hu 已提交
425
  def commit_dir(user, path, message, branch)
426
    commit_with_hooks(user, branch) do |ref|
S
Stan Hu 已提交
427 428 429 430 431 432 433 434 435 436 437 438 439
      committer = user_to_committer(user)
      options = {}
      options[:committer] = committer
      options[:author] = committer

      options[:commit] = {
        message: message,
        branch: ref,
      }

      raw_repository.mkdir(path, options)
    end
  end
440

S
Stan Hu 已提交
441 442 443
  def commit_file(user, path, content, message, branch, update)
    commit_with_hooks(user, branch) do |ref|
      committer = user_to_committer(user)
444 445 446 447 448 449 450
      options = {}
      options[:committer] = committer
      options[:author] = committer
      options[:commit] = {
        message: message,
        branch: ref,
      }
451

452 453
      options[:file] = {
        content: content,
S
Stan Hu 已提交
454 455
        path: path,
        update: update
456
      }
457

458 459
      Gitlab::Git::Blob.commit(raw_repository, options)
    end
460 461
  end

462
  def remove_file(user, path, message, branch)
463
    commit_with_hooks(user, branch) do |ref|
S
Stan Hu 已提交
464
      committer = user_to_committer(user)
465 466 467 468 469 470 471
      options = {}
      options[:committer] = committer
      options[:author] = committer
      options[:commit] = {
        message: message,
        branch: ref
      }
472

473 474 475
      options[:file] = {
        path: path
      }
476

477 478
      Gitlab::Git::Blob.remove(raw_repository, options)
    end
479 480
  end

S
Stan Hu 已提交
481
  def user_to_committer(user)
482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499
    {
      email: user.email,
      name: user.name,
      time: Time.now
    }
  end

  def can_be_merged?(source_sha, target_branch)
    our_commit = rugged.branches[target_branch].target
    their_commit = rugged.lookup(source_sha)

    if our_commit && their_commit
      !rugged.merge_commits(our_commit, their_commit).conflicts?
    else
      false
    end
  end

500
  def merge(user, source_sha, target_branch, options = {})
501 502 503 504 505 506 507 508 509
    our_commit = rugged.branches[target_branch].target
    their_commit = rugged.lookup(source_sha)

    raise "Invalid merge target" if our_commit.nil?
    raise "Invalid merge source" if their_commit.nil?

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

510 511 512 513 514 515
    commit_with_hooks(user, target_branch) do |ref|
      actual_options = options.merge(
        parents: [our_commit, their_commit],
        tree: merge_index.write_tree(rugged),
        update_ref: ref
      )
516

517 518
      Rugged::Commit.create(rugged, actual_options)
    end
519 520
  end

F
Florent (HP) 已提交
521 522 523 524 525
  def merged_to_root_ref?(branch_name)
    branch_commit = commit(branch_name)
    root_ref_commit = commit(root_ref)

    if branch_commit
526
      is_ancestor?(branch_commit.id, root_ref_commit.id)
F
Florent (HP) 已提交
527 528 529 530 531
    else
      nil
    end
  end

S
Stan Hu 已提交
532 533 534 535
  def merge_base(first_commit_id, second_commit_id)
    rugged.merge_base(first_commit_id, second_commit_id)
  end

536 537 538 539 540
  def is_ancestor?(ancestor_id, descendant_id)
    merge_base(ancestor_id, descendant_id) == ancestor_id
  end


541 542
  def search_files(query, ref)
    offset = 2
543
    args = %W(#{Gitlab.config.git.bin_path} grep -i -n --before-context #{offset} --after-context #{offset} -e #{query} #{ref || root_ref})
544 545 546
    Gitlab::Popen.popen(args, path_to_repo).first.scrub.split(/^--$/)
  end

D
Dmitriy Zaporozhets 已提交
547
  def parse_search_result(result)
548 549 550 551
    ref = nil
    filename = nil
    startline = 0

552
    result.each_line.each_with_index do |line, index|
553 554 555 556 557 558 559
      if line =~ /^.*:.*:\d+:/
        ref, filename, startline = line.split(':')
        startline = startline.to_i - index
        break
      end
    end

560
    data = ""
561

562 563 564
    result.each_line do |line|
      data << line.sub(ref, '').sub(filename, '').sub(/^:-\d+-/, '').sub(/^::\d+:/, '')
    end
565 566 567 568 569 570 571 572 573

    OpenStruct.new(
      filename: filename,
      ref: ref,
      startline: startline,
      data: data
    )
  end

574
  def fetch_ref(source_path, source_ref, target_ref)
575
    args = %W(#{Gitlab.config.git.bin_path} fetch -f #{source_path} #{source_ref}:#{target_ref})
576 577 578
    Gitlab::Popen.popen(args, path_to_repo)
  end

579 580 581
  def commit_with_hooks(current_user, branch)
    oldrev = Gitlab::Git::BLANK_SHA
    ref = Gitlab::Git::BRANCH_REF_PREFIX + branch
582
    was_empty = empty?
583 584 585 586 587

    # Create temporary ref
    random_string = SecureRandom.hex
    tmp_ref = "refs/tmp/#{random_string}/head"

588
    unless was_empty
589 590 591 592 593 594 595 596 597 598 599
      oldrev = find_branch(branch).target
      rugged.references.create(tmp_ref, oldrev)
    end

    # Make commit in tmp ref
    newrev = yield(tmp_ref)

    unless newrev
      raise CommitError.new('Failed to create commit')
    end

600
    GitHooksService.new.execute(current_user, path_to_repo, oldrev, newrev, ref) do
601
      if was_empty
602 603 604 605 606 607 608 609 610 611 612 613 614 615
        # Create branch
        rugged.references.create(ref, newrev)
      else
        # Update head
        current_head = find_branch(branch).target

        # Make sure target branch was not changed during pre-receive hook
        if current_head == oldrev
          rugged.references.update(ref, newrev)
        else
          raise CommitError.new('Commit was rejected because branch received new push')
        end
      end
    end
616 617 618 619
  rescue GitHooksService::PreReceiveError
    # Remove tmp ref and return error to user
    rugged.references.delete(tmp_ref)
    raise
620 621
  end

622 623
  private

624 625 626
  def cache
    @cache ||= RepositoryCache.new(path_with_namespace)
  end
627
end