BigW Consortium Gitlab

repository.rb 13.9 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 :path_with_namespace, :project
10

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
  end
23

24 25
  def raw_repository
    return nil unless path_with_namespace
26

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

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

43 44 45 46 47 48
  def exists?
    raw_repository
  end

  def empty?
    raw_repository.empty?
49 50
  end

51 52 53 54 55 56 57 58 59 60 61 62 63
  #
  # 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

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

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

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

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

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

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

103 104 105 106 107 108 109 110
  def find_branch(name)
    branches.find { |branch| branch.name == name }
  end

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

111
  def add_branch(branch_name, ref)
112
    expire_branches_cache
113 114 115 116

    gitlab_shell.add_branch(path_with_namespace, branch_name, ref)
  end

117
  def add_tag(tag_name, ref, message = nil)
118
    expire_tags_cache
119

120
    gitlab_shell.add_tag(path_with_namespace, tag_name, ref, message)
121 122
  end

123
  def rm_branch(branch_name)
124
    expire_branches_cache
125

126 127 128
    gitlab_shell.rm_branch(path_with_namespace, branch_name)
  end

129
  def rm_tag(tag_name)
130
    expire_tags_cache
131

132 133 134
    gitlab_shell.rm_tag(path_with_namespace, tag_name)
  end

135
  def branch_names
136
    cache.fetch(:branch_names) { raw_repository.branch_names }
137 138 139
  end

  def tag_names
140
    cache.fetch(:tag_names) { raw_repository.tag_names }
141 142
  end

143
  def commit_count
144
    cache.fetch(:commit_count) do
145
      begin
146
        raw_repository.commit_count(self.root_ref)
147 148 149
      rescue
        0
      end
150
    end
151 152
  end

153 154 155
  # Return repo size in megabytes
  # Cached in redis
  def size
156
    cache.fetch(:size) { raw_repository.size }
157 158
  end

159
  def cache_keys
160
    %i(size branch_names tag_names commit_count
161 162 163 164 165 166 167 168 169 170 171
       readme version contribution_guide changelog license)
  end

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

172 173 174 175 176 177 178 179 180 181
  def expire_tags_cache
    cache.expire(:tag_names)
    @tags = nil
  end

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

182
  def expire_cache
183
    cache_keys.each do |key|
184 185
      cache.expire(key)
    end
Dmitriy Zaporozhets committed
186 187
  end

188 189
  def rebuild_cache
    cache_keys.each do |key|
190
      cache.expire(key)
191
      send(key)
Dmitriy Zaporozhets committed
192
    end
193 194
  end

195 196 197 198
  def lookup_cache
    @lookup_cache ||= {}
  end

199 200 201 202
  def expire_branch_names
    cache.expire(:branch_names)
  end

203
  def method_missing(m, *args, &block)
204 205 206 207 208 209
    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
210 211
  end

212 213
  def respond_to_missing?(method, include_private = false)
    raw_repository.respond_to?(method, include_private) || super
214
  end
215 216

  def blob_at(sha, path)
217 218 219
    unless Gitlab::Git.blank_ref?(sha)
      Gitlab::Git::Blob.find(self, sha, path)
    end
220
  end
221

222 223 224 225
  def blob_by_oid(oid)
    Gitlab::Git::Blob.raw(self, oid)
  end

226
  def readme
227
    cache.fetch(:readme) { tree(:head).readme }
228
  end
229

230
  def version
231
    cache.fetch(:version) do
232 233 234 235 236 237
      tree(:head).blobs.find do |file|
        file.name.downcase == 'version'
      end
    end
  end

238
  def contribution_guide
239 240 241 242 243 244
    cache.fetch(:contribution_guide) do
      tree(:head).blobs.find do |file|
        file.contributing?
      end
    end
  end
245 246 247 248

  def changelog
    cache.fetch(:changelog) do
      tree(:head).blobs.find do |file|
249
        file.name =~ /\A(changelog|history)/i
250 251
      end
    end
252 253
  end

254 255 256
  def license
    cache.fetch(:license) do
      tree(:head).blobs.find do |file|
257
        file.name =~ /\Alicense/i
258 259
      end
    end
260 261
  end

262
  def head_commit
263 264 265 266 267
    @head_commit ||= commit(self.root_ref)
  end

  def head_tree
    @head_tree ||= Tree.new(self, head_commit.sha, nil)
268 269 270 271
  end

  def tree(sha = :head, path = nil)
    if sha == :head
272 273 274 275 276
      if path.nil?
        return head_tree
      else
        sha = head_commit.sha
      end
277 278 279 280
    end

    Tree.new(self, sha, path)
  end
281 282

  def blob_at_branch(branch_name, path)
283
    last_commit = commit(branch_name)
284

285 286 287 288 289
    if last_commit
      blob_at(last_commit.sha, path)
    else
      nil
    end
290
  end
291 292 293 294 295 296 297 298

  # Returns url for submodule
  #
  # Ex.
  #   @repository.submodule_url_for('master', 'rack')
  #   # => git@localhost:rack.git
  #
  def submodule_url_for(ref, path)
299
    if submodules(ref).any?
300 301 302 303 304 305 306
      submodule = submodules(ref)[path]

      if submodule
        submodule['url']
      end
    end
  end
307 308

  def last_commit_for_path(sha, path)
309
    args = %W(#{Gitlab.config.git.bin_path} rev-list --max-count=1 #{sha} -- #{path})
310 311
    sha = Gitlab::Popen.popen(args, path_to_repo).first.strip
    commit(sha)
312
  end
313 314

  # Remove archives older than 2 hours
315 316 317 318 319 320 321 322 323 324 325 326 327 328
  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
329 330

  def contributors
331
    commits = self.commits(nil, nil, 2000, 0, true)
332

333
    commits.group_by(&:author_email).map do |email, commits|
334 335
      contributor = Gitlab::Contributor.new
      contributor.email = email
336

337
      commits.each do |commit|
338
        if contributor.name.blank?
339
          contributor.name = commit.author_name
340 341
        end

342
        contributor.commits += 1
343 344
      end

345 346
      contributor
    end
347
  end
348 349

  def blob_for_diff(commit, diff)
350
    blob_at(commit.id, diff.file_path)
351 352 353 354 355 356 357
  end

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

359 360
  def refs_contains_sha(ref_type, sha)
    args = %W(#{Gitlab.config.git.bin_path} #{ref_type} --contains #{sha})
361 362 363 364 365 366 367 368 369 370 371 372 373 374
    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
375

376 377 378
  def branch_names_contains(sha)
    refs_contains_sha('branch', sha)
  end
379

380 381
  def tag_names_contains(sha)
    refs_contains_sha('tag', sha)
382
  end
383

384 385 386 387 388 389 390 391 392 393 394 395
  def branches
    @branches ||= raw_repository.branches
  end

  def tags
    @tags ||= raw_repository.tags
  end

  def root_ref
    @root_ref ||= raw_repository.root_ref
  end

Stan Hu committed
396
  def commit_dir(user, path, message, branch)
397
    commit_with_hooks(user, branch) do |ref|
Stan Hu committed
398 399 400 401 402 403 404 405 406 407 408 409 410
      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
411

Stan Hu committed
412 413 414
  def commit_file(user, path, content, message, branch, update)
    commit_with_hooks(user, branch) do |ref|
      committer = user_to_committer(user)
415 416 417 418 419 420 421
      options = {}
      options[:committer] = committer
      options[:author] = committer
      options[:commit] = {
        message: message,
        branch: ref,
      }
422

423 424
      options[:file] = {
        content: content,
Stan Hu committed
425 426
        path: path,
        update: update
427
      }
428

429 430
      Gitlab::Git::Blob.commit(raw_repository, options)
    end
431 432
  end

433
  def remove_file(user, path, message, branch)
434
    commit_with_hooks(user, branch) do |ref|
Stan Hu committed
435
      committer = user_to_committer(user)
436 437 438 439 440 441 442
      options = {}
      options[:committer] = committer
      options[:author] = committer
      options[:commit] = {
        message: message,
        branch: ref
      }
443

444 445 446
      options[:file] = {
        path: path
      }
447

448 449
      Gitlab::Git::Blob.remove(raw_repository, options)
    end
450 451
  end

Stan Hu committed
452
  def user_to_committer(user)
453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470
    {
      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

471
  def merge(user, source_sha, target_branch, options = {})
472 473 474 475 476 477 478 479 480
    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?

481 482 483 484 485 486
    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
      )
487

488 489
      Rugged::Commit.create(rugged, actual_options)
    end
490 491
  end

492 493 494 495 496
  def merged_to_root_ref?(branch_name)
    branch_commit = commit(branch_name)
    root_ref_commit = commit(root_ref)

    if branch_commit
497
      is_ancestor?(branch_commit.id, root_ref_commit.id)
498 499 500 501 502
    else
      nil
    end
  end

503 504 505 506
  def merge_base(first_commit_id, second_commit_id)
    rugged.merge_base(first_commit_id, second_commit_id)
  end

507 508 509 510 511
  def is_ancestor?(ancestor_id, descendant_id)
    merge_base(ancestor_id, descendant_id) == ancestor_id
  end


512 513
  def search_files(query, ref)
    offset = 2
514
    args = %W(#{Gitlab.config.git.bin_path} grep -i -n --before-context #{offset} --after-context #{offset} -e #{query} #{ref || root_ref})
515 516 517
    Gitlab::Popen.popen(args, path_to_repo).first.scrub.split(/^--$/)
  end

518
  def parse_search_result(result)
519 520 521 522
    ref = nil
    filename = nil
    startline = 0

523
    result.each_line.each_with_index do |line, index|
524 525 526 527 528 529 530
      if line =~ /^.*:.*:\d+:/
        ref, filename, startline = line.split(':')
        startline = startline.to_i - index
        break
      end
    end

531
    data = ""
532

533 534 535
    result.each_line do |line|
      data << line.sub(ref, '').sub(filename, '').sub(/^:-\d+-/, '').sub(/^::\d+:/, '')
    end
536 537 538 539 540 541 542 543 544

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

545
  def fetch_ref(source_path, source_ref, target_ref)
546
    args = %W(#{Gitlab.config.git.bin_path} fetch -f #{source_path} #{source_ref}:#{target_ref})
547 548 549
    Gitlab::Popen.popen(args, path_to_repo)
  end

550 551 552 553
  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)
554
    was_empty = empty?
555 556 557 558 559

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

560
    unless was_empty
561 562 563 564 565 566 567 568 569 570 571 572 573
      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)
574
    pre_receive_hook_status = pre_receive_hook.trigger(gl_id, oldrev, newrev, ref)
575

576 577 578 579 580
    # Run GitLab update hook
    update_hook = Gitlab::Git::Hook.new('update', path_to_repo)
    update_hook_status = update_hook.trigger(gl_id, oldrev, newrev, ref)

    if pre_receive_hook_status && update_hook_status
581
      if was_empty
582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597
        # 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)
598
      post_receive_hook.trigger(gl_id, oldrev, newrev, ref)
599 600 601 602
    else
      # Remove tmp ref and return error to user
      rugged.references.delete(tmp_ref)

603
      raise PreReceiveError.new('Commit was rejected by git hook')
604 605 606
    end
  end

607 608
  private

609 610 611
  def cache
    @cache ||= RepositoryCache.new(path_with_namespace)
  end
612
end