repository.rb 13.5 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
  def commits_with_log_matching(query)
    list = Gitlab::Git::Commit.where(repo: raw_repository, limit: 1000)
    list = Commit.decorate(list, @project) if list.present?
    list.select! { |c| c.message.match /#{query}/i }
  end

96 97 98 99 100 101 102 103
  def find_branch(name)
    branches.find { |branch| branch.name == name }
  end

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

104
  def add_branch(branch_name, ref)
105
    cache.expire(:branch_names)
106
    @branches = nil
107 108 109 110

    gitlab_shell.add_branch(path_with_namespace, branch_name, ref)
  end

111
  def add_tag(tag_name, ref, message = nil)
112
    cache.expire(:tag_names)
113
    @tags = nil
114

115
    gitlab_shell.add_tag(path_with_namespace, tag_name, ref, message)
116 117
  end

118
  def rm_branch(branch_name)
119
    cache.expire(:branch_names)
120
    @branches = nil
121

122 123 124
    gitlab_shell.rm_branch(path_with_namespace, branch_name)
  end

125
  def rm_tag(tag_name)
126
    cache.expire(:tag_names)
127
    @tags = nil
128

129 130 131
    gitlab_shell.rm_tag(path_with_namespace, tag_name)
  end

132
  def branch_names
133
    cache.fetch(:branch_names) { raw_repository.branch_names }
134 135 136
  end

  def tag_names
137
    cache.fetch(:tag_names) { raw_repository.tag_names }
138 139
  end

140
  def commit_count
141
    cache.fetch(:commit_count) do
142
      begin
143
        raw_repository.commit_count(self.root_ref)
144 145 146
      rescue
        0
      end
147
    end
148 149
  end

150 151 152
  # Return repo size in megabytes
  # Cached in redis
  def size
153
    cache.fetch(:size) { raw_repository.size }
154 155
  end

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

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

169
  def expire_cache
170
    cache_keys.each do |key|
171 172
      cache.expire(key)
    end
D
Dmitriy Zaporozhets 已提交
173 174
  end

175 176
  def rebuild_cache
    cache_keys.each do |key|
177
      cache.expire(key)
178
      send(key)
D
Dmitriy Zaporozhets 已提交
179
    end
180 181
  end

182 183 184 185
  def lookup_cache
    @lookup_cache ||= {}
  end

186 187 188 189
  def expire_branch_names
    cache.expire(:branch_names)
  end

190
  def method_missing(m, *args, &block)
191 192 193 194 195 196
    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
197 198
  end

199 200
  def respond_to_missing?(method, include_private = false)
    raw_repository.respond_to?(method, include_private) || super
201
  end
D
Dmitriy Zaporozhets 已提交
202 203

  def blob_at(sha, path)
204 205 206
    unless Gitlab::Git.blank_ref?(sha)
      Gitlab::Git::Blob.find(self, sha, path)
    end
D
Dmitriy Zaporozhets 已提交
207
  end
208

209 210 211 212
  def blob_by_oid(oid)
    Gitlab::Git::Blob.raw(self, oid)
  end

213
  def readme
214
    cache.fetch(:readme) { tree(:head).readme }
215
  end
216

217
  def version
218
    cache.fetch(:version) do
219 220 221 222 223 224
      tree(:head).blobs.find do |file|
        file.name.downcase == 'version'
      end
    end
  end

225
  def contribution_guide
226 227 228 229 230 231
    cache.fetch(:contribution_guide) do
      tree(:head).blobs.find do |file|
        file.contributing?
      end
    end
  end
232 233 234 235

  def changelog
    cache.fetch(:changelog) do
      tree(:head).blobs.find do |file|
236
        file.name =~ /\A(changelog|history)/i
237 238
      end
    end
239 240
  end

241 242 243
  def license
    cache.fetch(:license) do
      tree(:head).blobs.find do |file|
244
        file.name =~ /\Alicense/i
245 246
      end
    end
247 248
  end

249
  def head_commit
250 251 252 253 254
    @head_commit ||= commit(self.root_ref)
  end

  def head_tree
    @head_tree ||= Tree.new(self, head_commit.sha, nil)
255 256 257 258
  end

  def tree(sha = :head, path = nil)
    if sha == :head
259 260 261 262 263
      if path.nil?
        return head_tree
      else
        sha = head_commit.sha
      end
264 265 266 267
    end

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

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

D
Dmitriy Zaporozhets 已提交
272 273 274 275 276
    if last_commit
      blob_at(last_commit.sha, path)
    else
      nil
    end
D
Dmitriy Zaporozhets 已提交
277
  end
D
Dmitriy Zaporozhets 已提交
278 279 280 281 282 283 284 285

  # Returns url for submodule
  #
  # Ex.
  #   @repository.submodule_url_for('master', 'rack')
  #   # => git@localhost:rack.git
  #
  def submodule_url_for(ref, path)
D
Dmitriy Zaporozhets 已提交
286
    if submodules(ref).any?
D
Dmitriy Zaporozhets 已提交
287 288 289 290 291 292 293
      submodule = submodules(ref)[path]

      if submodule
        submodule['url']
      end
    end
  end
294 295

  def last_commit_for_path(sha, path)
D
Dmitriy Zaporozhets 已提交
296
    args = %W(git rev-list --max-count=1 #{sha} -- #{path})
297 298
    sha = Gitlab::Popen.popen(args, path_to_repo).first.strip
    commit(sha)
299
  end
300 301

  # Remove archives older than 2 hours
302 303 304 305 306 307 308 309 310 311 312 313 314 315
  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
316 317

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

D
Dmitriy Zaporozhets 已提交
320
    commits.group_by(&:author_email).map do |email, commits|
321 322
      contributor = Gitlab::Contributor.new
      contributor.email = email
323

D
Dmitriy Zaporozhets 已提交
324
      commits.each do |commit|
325
        if contributor.name.blank?
D
Dmitriy Zaporozhets 已提交
326
          contributor.name = commit.author_name
327 328
        end

329
        contributor.commits += 1
330 331
      end

332 333
      contributor
    end
334
  end
D
Dmitriy Zaporozhets 已提交
335 336

  def blob_for_diff(commit, diff)
337
    blob_at(commit.id, diff.file_path)
D
Dmitriy Zaporozhets 已提交
338 339 340 341 342 343 344
  end

  def prev_blob_for_diff(commit, diff)
    if commit.parent_id
      blob_at(commit.parent_id, diff.old_path)
    end
  end
345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361

  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 已提交
362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378

  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
379

380 381 382 383 384 385 386 387 388 389 390 391
  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 已提交
392
  def commit_dir(user, path, message, branch)
393
    commit_with_hooks(user, branch) do |ref|
S
Stan Hu 已提交
394 395 396 397 398 399 400 401 402 403 404 405 406
      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
407

S
Stan Hu 已提交
408 409 410
  def commit_file(user, path, content, message, branch, update)
    commit_with_hooks(user, branch) do |ref|
      committer = user_to_committer(user)
411 412 413 414 415 416 417
      options = {}
      options[:committer] = committer
      options[:author] = committer
      options[:commit] = {
        message: message,
        branch: ref,
      }
418

419 420
      options[:file] = {
        content: content,
S
Stan Hu 已提交
421 422
        path: path,
        update: update
423
      }
424

425 426
      Gitlab::Git::Blob.commit(raw_repository, options)
    end
427 428
  end

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

440 441 442
      options[:file] = {
        path: path
      }
443

444 445
      Gitlab::Git::Blob.remove(raw_repository, options)
    end
446 447
  end

S
Stan Hu 已提交
448
  def user_to_committer(user)
449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466
    {
      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

467
  def merge(user, source_sha, target_branch, options = {})
468 469 470 471 472 473 474 475 476
    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?

477 478 479 480 481 482
    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
      )
483

484 485
      Rugged::Commit.create(rugged, actual_options)
    end
486 487
  end

F
Florent (HP) 已提交
488 489 490 491 492 493 494 495 496 497 498
  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 已提交
499 500 501 502
  def merge_base(first_commit_id, second_commit_id)
    rugged.merge_base(first_commit_id, second_commit_id)
  end

503 504
  def search_files(query, ref)
    offset = 2
505
    args = %W(git grep -i -n --before-context #{offset} --after-context #{offset} -e #{query} #{ref || root_ref})
506 507 508
    Gitlab::Popen.popen(args, path_to_repo).first.scrub.split(/^--$/)
  end

D
Dmitriy Zaporozhets 已提交
509
  def parse_search_result(result)
510 511 512 513
    ref = nil
    filename = nil
    startline = 0

514
    result.each_line.each_with_index do |line, index|
515 516 517 518 519 520 521
      if line =~ /^.*:.*:\d+:/
        ref, filename, startline = line.split(':')
        startline = startline.to_i - index
        break
      end
    end

522
    data = ""
523

524 525 526
    result.each_line do |line|
      data << line.sub(ref, '').sub(filename, '').sub(/^:-\d+-/, '').sub(/^::\d+:/, '')
    end
527 528 529 530 531 532 533 534 535

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

536 537 538 539 540
  def fetch_ref(source_path, source_ref, target_ref)
    args = %W(git fetch #{source_path} #{source_ref}:#{target_ref})
    Gitlab::Popen.popen(args, path_to_repo)
  end

541 542 543 544
  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)
545
    was_empty = empty?
546 547 548 549 550

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

551
    unless was_empty
552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567
      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
568
      if was_empty
569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584
        # 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 已提交
585
      post_receive_hook.trigger(gl_id, oldrev, newrev, ref)
586 587 588 589
    else
      # Remove tmp ref and return error to user
      rugged.references.delete(tmp_ref)

590
      raise PreReceiveError.new('Commit was rejected by pre-receive hook')
591 592 593
    end
  end

594 595
  private

596 597 598
  def cache
    @cache ||= RepositoryCache.new(path_with_namespace)
  end
599
end