repository.rb 13.2 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 71 72 73 74 75 76
    commits = Gitlab::Git::Commit.where(
      repo: raw_repository,
      ref: ref,
      path: path,
      limit: limit,
      offset: offset,
    )
77
    commits = Commit.decorate(commits, @project) if commits.present?
78 79 80
    commits
  end

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

87 88 89 90 91 92 93 94
  def find_branch(name)
    branches.find { |branch| branch.name == name }
  end

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

95
  def add_branch(branch_name, ref)
96
    cache.expire(:branch_names)
97
    @branches = nil
98 99 100 101

    gitlab_shell.add_branch(path_with_namespace, branch_name, ref)
  end

102
  def add_tag(tag_name, ref, message = nil)
103
    cache.expire(:tag_names)
104
    @tags = nil
105

106
    gitlab_shell.add_tag(path_with_namespace, tag_name, ref, message)
107 108
  end

109
  def rm_branch(branch_name)
110
    cache.expire(:branch_names)
111
    @branches = nil
112

113 114 115
    gitlab_shell.rm_branch(path_with_namespace, branch_name)
  end

116
  def rm_tag(tag_name)
117
    cache.expire(:tag_names)
118
    @tags = nil
119

120 121 122
    gitlab_shell.rm_tag(path_with_namespace, tag_name)
  end

123
  def branch_names
124
    cache.fetch(:branch_names) { raw_repository.branch_names }
125 126 127
  end

  def tag_names
128
    cache.fetch(:tag_names) { raw_repository.tag_names }
129 130
  end

131
  def commit_count
132
    cache.fetch(:commit_count) do
133
      begin
134
        raw_repository.commit_count(self.root_ref)
135 136 137
      rescue
        0
      end
138
    end
139 140
  end

141 142 143
  # Return repo size in megabytes
  # Cached in redis
  def size
144
    cache.fetch(:size) { raw_repository.size }
145 146
  end

147
  def cache_keys
148
    %i(size branch_names tag_names commit_count
149 150 151 152 153 154 155 156 157 158 159
       readme version contribution_guide changelog license)
  end

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

160
  def expire_cache
161
    cache_keys.each do |key|
162 163
      cache.expire(key)
    end
D
Dmitriy Zaporozhets 已提交
164 165
  end

166 167
  def rebuild_cache
    cache_keys.each do |key|
168
      cache.expire(key)
169
      send(key)
D
Dmitriy Zaporozhets 已提交
170
    end
171 172
  end

173 174 175 176
  def lookup_cache
    @lookup_cache ||= {}
  end

177 178 179 180
  def expire_branch_names
    cache.expire(:branch_names)
  end

181
  def method_missing(m, *args, &block)
182 183 184 185 186 187
    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
188 189
  end

190 191
  def respond_to_missing?(method, include_private = false)
    raw_repository.respond_to?(method, include_private) || super
192
  end
D
Dmitriy Zaporozhets 已提交
193 194

  def blob_at(sha, path)
195 196 197
    unless Gitlab::Git.blank_ref?(sha)
      Gitlab::Git::Blob.find(self, sha, path)
    end
D
Dmitriy Zaporozhets 已提交
198
  end
199

200 201 202 203
  def blob_by_oid(oid)
    Gitlab::Git::Blob.raw(self, oid)
  end

204
  def readme
205
    cache.fetch(:readme) { tree(:head).readme }
206
  end
207

208
  def version
209
    cache.fetch(:version) do
210 211 212 213 214 215
      tree(:head).blobs.find do |file|
        file.name.downcase == 'version'
      end
    end
  end

216
  def contribution_guide
217 218 219 220 221 222
    cache.fetch(:contribution_guide) do
      tree(:head).blobs.find do |file|
        file.contributing?
      end
    end
  end
223 224 225 226

  def changelog
    cache.fetch(:changelog) do
      tree(:head).blobs.find do |file|
227
        file.name =~ /\A(changelog|history)/i
228 229
      end
    end
230 231
  end

232 233 234
  def license
    cache.fetch(:license) do
      tree(:head).blobs.find do |file|
235
        file.name =~ /\Alicense/i
236 237
      end
    end
238 239
  end

240
  def head_commit
241 242 243 244 245
    @head_commit ||= commit(self.root_ref)
  end

  def head_tree
    @head_tree ||= Tree.new(self, head_commit.sha, nil)
246 247 248 249
  end

  def tree(sha = :head, path = nil)
    if sha == :head
250 251 252 253 254
      if path.nil?
        return head_tree
      else
        sha = head_commit.sha
      end
255 256 257 258
    end

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

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

D
Dmitriy Zaporozhets 已提交
263 264 265 266 267
    if last_commit
      blob_at(last_commit.sha, path)
    else
      nil
    end
D
Dmitriy Zaporozhets 已提交
268
  end
D
Dmitriy Zaporozhets 已提交
269 270 271 272 273 274 275 276

  # Returns url for submodule
  #
  # Ex.
  #   @repository.submodule_url_for('master', 'rack')
  #   # => git@localhost:rack.git
  #
  def submodule_url_for(ref, path)
D
Dmitriy Zaporozhets 已提交
277
    if submodules(ref).any?
D
Dmitriy Zaporozhets 已提交
278 279 280 281 282 283 284
      submodule = submodules(ref)[path]

      if submodule
        submodule['url']
      end
    end
  end
285 286

  def last_commit_for_path(sha, path)
D
Dmitriy Zaporozhets 已提交
287
    args = %W(git rev-list --max-count=1 #{sha} -- #{path})
288 289
    sha = Gitlab::Popen.popen(args, path_to_repo).first.strip
    commit(sha)
290
  end
291 292

  # Remove archives older than 2 hours
293 294 295 296 297 298 299 300 301 302 303 304 305 306
  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
307 308

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

D
Dmitriy Zaporozhets 已提交
311
    commits.group_by(&:author_email).map do |email, commits|
312 313
      contributor = Gitlab::Contributor.new
      contributor.email = email
314

D
Dmitriy Zaporozhets 已提交
315
      commits.each do |commit|
316
        if contributor.name.blank?
D
Dmitriy Zaporozhets 已提交
317
          contributor.name = commit.author_name
318 319
        end

320
        contributor.commits += 1
321 322
      end

323 324
      contributor
    end
325
  end
D
Dmitriy Zaporozhets 已提交
326 327

  def blob_for_diff(commit, diff)
328
    blob_at(commit.id, diff.file_path)
D
Dmitriy Zaporozhets 已提交
329 330 331 332 333 334 335
  end

  def prev_blob_for_diff(commit, diff)
    if commit.parent_id
      blob_at(commit.parent_id, diff.old_path)
    end
  end
336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352

  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 已提交
353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369

  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
370

371 372 373 374 375 376 377 378 379 380 381 382
  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 已提交
383
  def commit_dir(user, path, message, branch)
384
    commit_with_hooks(user, branch) do |ref|
S
Stan Hu 已提交
385 386 387 388 389 390 391 392 393 394 395 396 397
      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
398

S
Stan Hu 已提交
399 400 401
  def commit_file(user, path, content, message, branch, update)
    commit_with_hooks(user, branch) do |ref|
      committer = user_to_committer(user)
402 403 404 405 406 407 408
      options = {}
      options[:committer] = committer
      options[:author] = committer
      options[:commit] = {
        message: message,
        branch: ref,
      }
409

410 411
      options[:file] = {
        content: content,
S
Stan Hu 已提交
412 413
        path: path,
        update: update
414
      }
415

416 417
      Gitlab::Git::Blob.commit(raw_repository, options)
    end
418 419
  end

420
  def remove_file(user, path, message, branch)
421
    commit_with_hooks(user, branch) do |ref|
S
Stan Hu 已提交
422
      committer = user_to_committer(user)
423 424 425 426 427 428 429
      options = {}
      options[:committer] = committer
      options[:author] = committer
      options[:commit] = {
        message: message,
        branch: ref
      }
430

431 432 433
      options[:file] = {
        path: path
      }
434

435 436
      Gitlab::Git::Blob.remove(raw_repository, options)
    end
437 438
  end

S
Stan Hu 已提交
439
  def user_to_committer(user)
440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457
    {
      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

458
  def merge(user, source_sha, target_branch, options = {})
459 460 461 462 463 464 465 466 467
    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?

468 469 470 471 472 473
    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
      )
474

475 476
      Rugged::Commit.create(rugged, actual_options)
    end
477 478
  end

F
Florent (HP) 已提交
479 480 481 482 483 484 485 486 487 488 489
  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 已提交
490 491 492 493
  def merge_base(first_commit_id, second_commit_id)
    rugged.merge_base(first_commit_id, second_commit_id)
  end

494 495 496 497 498 499
  def search_files(query, ref)
    offset = 2
    args = %W(git grep -i -n --before-context #{offset} --after-context #{offset} #{query} #{ref || root_ref})
    Gitlab::Popen.popen(args, path_to_repo).first.scrub.split(/^--$/)
  end

D
Dmitriy Zaporozhets 已提交
500
  def parse_search_result(result)
501 502 503 504
    ref = nil
    filename = nil
    startline = 0

505
    result.each_line.each_with_index do |line, index|
506 507 508 509 510 511 512
      if line =~ /^.*:.*:\d+:/
        ref, filename, startline = line.split(':')
        startline = startline.to_i - index
        break
      end
    end

513
    data = ""
514

515 516 517
    result.each_line do |line|
      data << line.sub(ref, '').sub(filename, '').sub(/^:-\d+-/, '').sub(/^::\d+:/, '')
    end
518 519 520 521 522 523 524 525 526

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

527 528 529 530 531
  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

532 533 534 535
  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)
536
    was_empty = empty?
537 538 539 540 541

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

542
    unless was_empty
543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558
      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
559
      if was_empty
560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575
        # 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 已提交
576
      post_receive_hook.trigger(gl_id, oldrev, newrev, ref)
577 578 579 580
    else
      # Remove tmp ref and return error to user
      rugged.references.delete(tmp_ref)

581
      raise PreReceiveError.new('Commit was rejected by pre-receive hook')
582 583 584
    end
  end

585 586
  private

587 588 589
  def cache
    @cache ||= RepositoryCache.new(path_with_namespace)
  end
590
end