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

3
class Repository
4 5 6
  class PreReceiveError < StandardError; end
  class CommitError < StandardError; end

7 8
  include Gitlab::ShellAdapter

9
  attr_accessor :raw_repository, :path_with_namespace, :project
10

J
Jacob Vosmaer 已提交
11 12 13 14 15 16 17 18
  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

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

    if path_with_namespace
24
      @raw_repository = Gitlab::Git::Repository.new(path_to_repo)
25 26 27
      @raw_repository.autocrlf = :input
    end

28 29 30 31
  rescue Gitlab::Git::Repository::NoRepository
    nil
  end

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

39 40 41 42 43 44
  def exists?
    raw_repository
  end

  def empty?
    raw_repository.empty?
45 46
  end

47 48 49 50 51 52 53 54 55 56 57 58 59
  #
  # 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

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

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

    commits = Gitlab::Git::Commit.where(options)
80
    commits = Commit.decorate(commits, @project) if commits.present?
81 82 83
    commits
  end

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

90 91 92 93 94 95 96 97
  def find_branch(name)
    branches.find { |branch| branch.name == name }
  end

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

98
  def add_branch(branch_name, ref)
99
    cache.expire(:branch_names)
100
    @branches = nil
101 102 103 104

    gitlab_shell.add_branch(path_with_namespace, branch_name, ref)
  end

105
  def add_tag(tag_name, ref, message = nil)
106
    cache.expire(:tag_names)
107
    @tags = nil
108

109
    gitlab_shell.add_tag(path_with_namespace, tag_name, ref, message)
110 111
  end

112
  def rm_branch(branch_name)
113
    cache.expire(:branch_names)
114
    @branches = nil
115

116 117 118
    gitlab_shell.rm_branch(path_with_namespace, branch_name)
  end

119
  def rm_tag(tag_name)
120
    cache.expire(:tag_names)
121
    @tags = nil
122

123 124 125
    gitlab_shell.rm_tag(path_with_namespace, tag_name)
  end

126
  def branch_names
127
    cache.fetch(:branch_names) { raw_repository.branch_names }
128 129 130
  end

  def tag_names
131
    cache.fetch(:tag_names) { raw_repository.tag_names }
132 133
  end

134
  def commit_count
135
    cache.fetch(:commit_count) do
136
      begin
137
        raw_repository.commit_count(self.root_ref)
138 139 140
      rescue
        0
      end
141
    end
142 143
  end

144 145 146
  # Return repo size in megabytes
  # Cached in redis
  def size
147
    cache.fetch(:size) { raw_repository.size }
148
  end
149 150 151 152 153 154 155 156 157 158
  
  def diverging_commit_counts(branch)
    branch_cache_key = ('diverging_commit_counts_' + branch.name).to_sym
    cache.fetch(branch_cache_key) do
      number_commits_behind = commits_between(branch.name, root_ref).size
      number_commits_ahead = commits_between(root_ref, branch.name).size
      
      { behind: number_commits_behind, ahead: number_commits_ahead }
    end
  end
159

160
  def cache_keys
161 162 163 164 165 166 167 168 169
    %i(size branch_names tag_names commit_count readme
       contribution_guide changelog license)
  end
  
  def branch_cache_keys
    branches.map do
      |branch|
      ('diverging_commit_counts_' + branch.name).to_sym
    end
170 171 172 173 174 175 176 177
  end

  def build_cache
    cache_keys.each do |key|
      unless cache.exist?(key)
        send(key)
      end
    end
178 179 180 181 182 183
    
    branches.each do |branch|
      unless cache.exist?(('diverging_commit_counts_' + branch.name).to_sym)
        send(:diverging_commit_counts, branch)
      end
    end
184 185
  end

186
  def expire_cache
187
    cache_keys.each do |key|
188 189
      cache.expire(key)
    end
190 191 192 193 194 195 196 197 198 199
    
    branches.each do |branch|
      cache.expire(('diverging_commit_counts_' + branch.name).to_sym)
    end
  end
  
  def expire_branch_cache
    branches.each do |branch|
      cache.expire(('diverging_commit_counts_' + branch.name).to_sym)
    end
D
Dmitriy Zaporozhets 已提交
200 201
  end

202 203
  def rebuild_cache
    cache_keys.each do |key|
204
      cache.expire(key)
205
      send(key)
D
Dmitriy Zaporozhets 已提交
206
    end
207 208 209 210 211
    
    branches.each do |branch|
      cache.expire(('diverging_commit_counts_' + branch.name).to_sym)
      send(:diverging_commit_counts, branch)
    end
212 213
  end

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

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

222
  def method_missing(m, *args, &block)
223 224 225 226 227 228
    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
229 230
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  def last_commit_for_path(sha, path)
D
Dmitriy Zaporozhets 已提交
328
    args = %W(git rev-list --max-count=1 #{sha} -- #{path})
329 330
    sha = Gitlab::Popen.popen(args, path_to_repo).first.strip
    commit(sha)
331
  end
332 333

  # Remove archives older than 2 hours
334 335 336 337 338 339 340 341 342 343 344 345 346 347
  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
348 349

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

D
Dmitriy Zaporozhets 已提交
352
    commits.group_by(&:author_email).map do |email, commits|
353 354
      contributor = Gitlab::Contributor.new
      contributor.email = email
355

D
Dmitriy Zaporozhets 已提交
356
      commits.each do |commit|
357
        if contributor.name.blank?
D
Dmitriy Zaporozhets 已提交
358
          contributor.name = commit.author_name
359 360
        end

361
        contributor.commits += 1
362 363
      end

364 365
      contributor
    end
366
  end
D
Dmitriy Zaporozhets 已提交
367 368

  def blob_for_diff(commit, diff)
369
    blob_at(commit.id, diff.file_path)
D
Dmitriy Zaporozhets 已提交
370 371 372 373 374 375 376
  end

  def prev_blob_for_diff(commit, diff)
    if commit.parent_id
      blob_at(commit.parent_id, diff.old_path)
    end
  end
377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393

  def branch_names_contains(sha)
    args = %W(git branch --contains #{sha})
    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 已提交
394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410

  def tag_names_contains(sha)
    args = %W(git tag --contains #{sha})
    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
411

412 413 414 415 416 417 418 419 420 421 422 423
  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 已提交
424
  def commit_dir(user, path, message, branch)
425
    commit_with_hooks(user, branch) do |ref|
S
Stan Hu 已提交
426 427 428 429 430 431 432 433 434 435 436 437 438
      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
439

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

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

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

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

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

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

S
Stan Hu 已提交
480
  def user_to_committer(user)
481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498
    {
      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

499
  def merge(user, source_sha, target_branch, options = {})
500 501 502 503 504 505 506 507 508
    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?

509 510 511 512 513 514
    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
      )
515

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

F
Florent (HP) 已提交
520 521 522 523 524 525 526 527 528 529 530
  def merged_to_root_ref?(branch_name)
    branch_commit = commit(branch_name)
    root_ref_commit = commit(root_ref)

    if branch_commit
      rugged.merge_base(root_ref_commit.id, branch_commit.id) == branch_commit.id
    else
      nil
    end
  end

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

535 536
  def search_files(query, ref)
    offset = 2
537
    args = %W(git grep -i -n --before-context #{offset} --after-context #{offset} -e #{query} #{ref || root_ref})
538 539 540
    Gitlab::Popen.popen(args, path_to_repo).first.scrub.split(/^--$/)
  end

D
Dmitriy Zaporozhets 已提交
541
  def parse_search_result(result)
542 543 544 545
    ref = nil
    filename = nil
    startline = 0

546
    result.each_line.each_with_index do |line, index|
547 548 549 550 551 552 553
      if line =~ /^.*:.*:\d+:/
        ref, filename, startline = line.split(':')
        startline = startline.to_i - index
        break
      end
    end

554
    data = ""
555

556 557 558
    result.each_line do |line|
      data << line.sub(ref, '').sub(filename, '').sub(/^:-\d+-/, '').sub(/^::\d+:/, '')
    end
559 560 561 562 563 564 565 566 567

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

568
  def fetch_ref(source_path, source_ref, target_ref)
569
    args = %W(git fetch -f #{source_path} #{source_ref}:#{target_ref})
570 571 572
    Gitlab::Popen.popen(args, path_to_repo)
  end

573 574 575 576
  def commit_with_hooks(current_user, branch)
    oldrev = Gitlab::Git::BLANK_SHA
    ref = Gitlab::Git::BRANCH_REF_PREFIX + branch
    gl_id = Gitlab::ShellEnv.gl_id(current_user)
577
    was_empty = empty?
578 579 580 581 582

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

583
    unless was_empty
584 585 586 587 588 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

    # Run GitLab pre-receive hook
    pre_receive_hook = Gitlab::Git::Hook.new('pre-receive', path_to_repo)
    status = pre_receive_hook.trigger(gl_id, oldrev, newrev, ref)

    if status
600
      if was_empty
601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616
        # 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

      # Run GitLab post receive hook
      post_receive_hook = Gitlab::Git::Hook.new('post-receive', path_to_repo)
G
Guilherme Garnier 已提交
617
      post_receive_hook.trigger(gl_id, oldrev, newrev, ref)
618 619 620 621
    else
      # Remove tmp ref and return error to user
      rugged.references.delete(tmp_ref)

622
      raise PreReceiveError.new('Commit was rejected by pre-receive hook')
623 624 625
    end
  end

626 627
  private

628 629 630
  def cache
    @cache ||= RepositoryCache.new(path_with_namespace)
  end
631
end