Chris@909: # Redmine - project management software Chris@909: # Copyright (C) 2006-2011 Jean-Philippe Lang Chris@909: # Chris@909: # This program is free software; you can redistribute it and/or Chris@909: # modify it under the terms of the GNU General Public License Chris@909: # as published by the Free Software Foundation; either version 2 Chris@909: # of the License, or (at your option) any later version. Chris@909: # Chris@909: # This program is distributed in the hope that it will be useful, Chris@909: # but WITHOUT ANY WARRANTY; without even the implied warranty of Chris@909: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the Chris@909: # GNU General Public License for more details. Chris@909: # Chris@909: # You should have received a copy of the GNU General Public License Chris@909: # along with this program; if not, write to the Free Software Chris@909: # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. Chris@909: Chris@909: require 'redmine/scm/adapters/abstract_adapter' Chris@909: Chris@909: module Redmine Chris@909: module Scm Chris@909: module Adapters Chris@909: class GitAdapter < AbstractAdapter Chris@909: Chris@909: # Git executable name Chris@909: GIT_BIN = Redmine::Configuration['scm_git_command'] || "git" Chris@909: Chris@909: class << self Chris@909: def client_command Chris@909: @@bin ||= GIT_BIN Chris@909: end Chris@909: Chris@909: def sq_bin Chris@909: @@sq_bin ||= shell_quote_command Chris@909: end Chris@909: Chris@909: def client_version Chris@909: @@client_version ||= (scm_command_version || []) Chris@909: end Chris@909: Chris@909: def client_available Chris@909: !client_version.empty? Chris@909: end Chris@909: Chris@909: def scm_command_version Chris@909: scm_version = scm_version_from_command_line.dup Chris@909: if scm_version.respond_to?(:force_encoding) Chris@909: scm_version.force_encoding('ASCII-8BIT') Chris@909: end Chris@909: if m = scm_version.match(%r{\A(.*?)((\d+\.)+\d+)}) Chris@909: m[2].scan(%r{\d+}).collect(&:to_i) Chris@909: end Chris@909: end Chris@909: Chris@909: def scm_version_from_command_line Chris@909: shellout("#{sq_bin} --version --no-color") { |io| io.read }.to_s Chris@909: end Chris@909: end Chris@909: Chris@909: def initialize(url, root_url=nil, login=nil, password=nil, path_encoding=nil) Chris@909: super Chris@909: @path_encoding = path_encoding.blank? ? 'UTF-8' : path_encoding Chris@909: end Chris@909: Chris@909: def path_encoding Chris@909: @path_encoding Chris@909: end Chris@909: Chris@909: def info Chris@909: begin Chris@909: Info.new(:root_url => url, :lastrev => lastrev('',nil)) Chris@909: rescue Chris@909: nil Chris@909: end Chris@909: end Chris@909: Chris@909: def branches Chris@909: return @branches if @branches Chris@909: @branches = [] Chris@909: cmd_args = %w|branch --no-color --verbose --no-abbrev| Chris@909: scm_cmd(*cmd_args) do |io| Chris@909: io.each_line do |line| Chris@909: branch_rev = line.match('\s*\*?\s*(.*?)\s*([0-9a-f]{40}).*$') Chris@909: bran = Branch.new(branch_rev[1]) Chris@909: bran.revision = branch_rev[2] Chris@909: bran.scmid = branch_rev[2] Chris@909: @branches << bran Chris@909: end Chris@909: end Chris@909: @branches.sort! Chris@909: rescue ScmCommandAborted Chris@909: nil Chris@909: end Chris@909: Chris@909: def tags Chris@909: return @tags if @tags Chris@909: cmd_args = %w|tag| Chris@909: scm_cmd(*cmd_args) do |io| Chris@909: @tags = io.readlines.sort!.map{|t| t.strip} Chris@909: end Chris@909: rescue ScmCommandAborted Chris@909: nil Chris@909: end Chris@909: Chris@909: def default_branch Chris@909: bras = self.branches Chris@909: return nil if bras.nil? Chris@909: bras.include?('master') ? 'master' : bras.first Chris@909: end Chris@909: Chris@909: def entry(path=nil, identifier=nil) Chris@909: parts = path.to_s.split(%r{[\/\\]}).select {|n| !n.blank?} Chris@909: search_path = parts[0..-2].join('/') Chris@909: search_name = parts[-1] Chris@909: if search_path.blank? && search_name.blank? Chris@909: # Root entry Chris@909: Entry.new(:path => '', :kind => 'dir') Chris@909: else Chris@909: # Search for the entry in the parent directory Chris@909: es = entries(search_path, identifier, Chris@909: options = {:report_last_commit => false}) Chris@909: es ? es.detect {|e| e.name == search_name} : nil Chris@909: end Chris@909: end Chris@909: Chris@909: def entries(path=nil, identifier=nil, options={}) Chris@909: path ||= '' Chris@909: p = scm_iconv(@path_encoding, 'UTF-8', path) Chris@909: entries = Entries.new Chris@909: cmd_args = %w|ls-tree -l| Chris@909: cmd_args << "HEAD:#{p}" if identifier.nil? Chris@909: cmd_args << "#{identifier}:#{p}" if identifier Chris@909: scm_cmd(*cmd_args) do |io| Chris@909: io.each_line do |line| Chris@909: e = line.chomp.to_s Chris@909: if e =~ /^\d+\s+(\w+)\s+([0-9a-f]{40})\s+([0-9-]+)\t(.+)$/ Chris@909: type = $1 Chris@909: sha = $2 Chris@909: size = $3 Chris@909: name = $4 Chris@909: if name.respond_to?(:force_encoding) Chris@909: name.force_encoding(@path_encoding) Chris@909: end Chris@909: full_path = p.empty? ? name : "#{p}/#{name}" Chris@909: n = scm_iconv('UTF-8', @path_encoding, name) Chris@909: full_p = scm_iconv('UTF-8', @path_encoding, full_path) Chris@909: entries << Entry.new({:name => n, Chris@909: :path => full_p, Chris@909: :kind => (type == "tree") ? 'dir' : 'file', Chris@909: :size => (type == "tree") ? nil : size, Chris@909: :lastrev => options[:report_last_commit] ? Chris@909: lastrev(full_path, identifier) : Revision.new Chris@909: }) unless entries.detect{|entry| entry.name == name} Chris@909: end Chris@909: end Chris@909: end Chris@909: entries.sort_by_name Chris@909: rescue ScmCommandAborted Chris@909: nil Chris@909: end Chris@909: Chris@909: def lastrev(path, rev) Chris@909: return nil if path.nil? Chris@909: cmd_args = %w|log --no-color --encoding=UTF-8 --date=iso --pretty=fuller --no-merges -n 1| Chris@909: cmd_args << rev if rev Chris@909: cmd_args << "--" << path unless path.empty? Chris@909: lines = [] Chris@909: scm_cmd(*cmd_args) { |io| lines = io.readlines } Chris@909: begin Chris@909: id = lines[0].split[1] Chris@909: author = lines[1].match('Author:\s+(.*)$')[1] Chris@909: time = Time.parse(lines[4].match('CommitDate:\s+(.*)$')[1]) Chris@909: Chris@909: Revision.new({ Chris@909: :identifier => id, Chris@909: :scmid => id, Chris@909: :author => author, Chris@909: :time => time, Chris@909: :message => nil, Chris@909: :paths => nil Chris@909: }) Chris@909: rescue NoMethodError => e Chris@909: logger.error("The revision '#{path}' has a wrong format") Chris@909: return nil Chris@909: end Chris@909: rescue ScmCommandAborted Chris@909: nil Chris@909: end Chris@909: Chris@909: def revisions(path, identifier_from, identifier_to, options={}) Chris@909: revs = Revisions.new Chris@909: cmd_args = %w|log --no-color --encoding=UTF-8 --raw --date=iso --pretty=fuller --parents| Chris@909: cmd_args << "--reverse" if options[:reverse] Chris@909: cmd_args << "--all" if options[:all] Chris@909: cmd_args << "-n" << "#{options[:limit].to_i}" if options[:limit] Chris@909: from_to = "" Chris@909: from_to << "#{identifier_from}.." if identifier_from Chris@909: from_to << "#{identifier_to}" if identifier_to Chris@909: cmd_args << from_to if !from_to.empty? Chris@909: cmd_args << "--since=#{options[:since].strftime("%Y-%m-%d %H:%M:%S")}" if options[:since] Chris@909: cmd_args << "--" << scm_iconv(@path_encoding, 'UTF-8', path) if path && !path.empty? Chris@909: Chris@909: scm_cmd *cmd_args do |io| Chris@909: files=[] Chris@909: changeset = {} Chris@909: parsing_descr = 0 #0: not parsing desc or files, 1: parsing desc, 2: parsing files Chris@909: Chris@909: io.each_line do |line| Chris@909: if line =~ /^commit ([0-9a-f]{40})(( [0-9a-f]{40})*)$/ Chris@909: key = "commit" Chris@909: value = $1 Chris@909: parents_str = $2 Chris@909: if (parsing_descr == 1 || parsing_descr == 2) Chris@909: parsing_descr = 0 Chris@909: revision = Revision.new({ Chris@909: :identifier => changeset[:commit], Chris@909: :scmid => changeset[:commit], Chris@909: :author => changeset[:author], Chris@909: :time => Time.parse(changeset[:date]), Chris@909: :message => changeset[:description], Chris@909: :paths => files, Chris@909: :parents => changeset[:parents] Chris@909: }) Chris@909: if block_given? Chris@909: yield revision Chris@909: else Chris@909: revs << revision Chris@909: end Chris@909: changeset = {} Chris@909: files = [] Chris@909: end Chris@909: changeset[:commit] = $1 Chris@909: unless parents_str.nil? or parents_str == "" Chris@909: changeset[:parents] = parents_str.strip.split(' ') Chris@909: end Chris@909: elsif (parsing_descr == 0) && line =~ /^(\w+):\s*(.*)$/ Chris@909: key = $1 Chris@909: value = $2 Chris@909: if key == "Author" Chris@909: changeset[:author] = value Chris@909: elsif key == "CommitDate" Chris@909: changeset[:date] = value Chris@909: end Chris@909: elsif (parsing_descr == 0) && line.chomp.to_s == "" Chris@909: parsing_descr = 1 Chris@909: changeset[:description] = "" Chris@909: elsif (parsing_descr == 1 || parsing_descr == 2) \ Chris@909: && line =~ /^:\d+\s+\d+\s+[0-9a-f.]+\s+[0-9a-f.]+\s+(\w)\t(.+)$/ Chris@909: parsing_descr = 2 Chris@909: fileaction = $1 Chris@909: filepath = $2 Chris@909: p = scm_iconv('UTF-8', @path_encoding, filepath) Chris@909: files << {:action => fileaction, :path => p} Chris@909: elsif (parsing_descr == 1 || parsing_descr == 2) \ Chris@909: && line =~ /^:\d+\s+\d+\s+[0-9a-f.]+\s+[0-9a-f.]+\s+(\w)\d+\s+(\S+)\t(.+)$/ Chris@909: parsing_descr = 2 Chris@909: fileaction = $1 Chris@909: filepath = $3 Chris@909: p = scm_iconv('UTF-8', @path_encoding, filepath) Chris@909: files << {:action => fileaction, :path => p} Chris@909: elsif (parsing_descr == 1) && line.chomp.to_s == "" Chris@909: parsing_descr = 2 Chris@909: elsif (parsing_descr == 1) Chris@909: changeset[:description] << line[4..-1] Chris@909: end Chris@909: end Chris@909: Chris@909: if changeset[:commit] Chris@909: revision = Revision.new({ Chris@909: :identifier => changeset[:commit], Chris@909: :scmid => changeset[:commit], Chris@909: :author => changeset[:author], Chris@909: :time => Time.parse(changeset[:date]), Chris@909: :message => changeset[:description], Chris@909: :paths => files, Chris@909: :parents => changeset[:parents] Chris@909: }) Chris@909: if block_given? Chris@909: yield revision Chris@909: else Chris@909: revs << revision Chris@909: end Chris@909: end Chris@909: end Chris@909: revs Chris@909: rescue ScmCommandAborted => e Chris@909: logger.error("git log #{from_to.to_s} error: #{e.message}") Chris@909: revs Chris@909: end Chris@909: Chris@909: def diff(path, identifier_from, identifier_to=nil) Chris@909: path ||= '' Chris@909: cmd_args = [] Chris@909: if identifier_to Chris@909: cmd_args << "diff" << "--no-color" << identifier_to << identifier_from Chris@909: else Chris@909: cmd_args << "show" << "--no-color" << identifier_from Chris@909: end Chris@909: cmd_args << "--" << scm_iconv(@path_encoding, 'UTF-8', path) unless path.empty? Chris@909: diff = [] Chris@909: scm_cmd *cmd_args do |io| Chris@909: io.each_line do |line| Chris@909: diff << line Chris@909: end Chris@909: end Chris@909: diff Chris@909: rescue ScmCommandAborted Chris@909: nil Chris@909: end Chris@909: Chris@909: def annotate(path, identifier=nil) Chris@909: identifier = 'HEAD' if identifier.blank? Chris@909: cmd_args = %w|blame| Chris@909: cmd_args << "-p" << identifier << "--" << scm_iconv(@path_encoding, 'UTF-8', path) Chris@909: blame = Annotate.new Chris@909: content = nil Chris@909: scm_cmd(*cmd_args) { |io| io.binmode; content = io.read } Chris@909: # git annotates binary files Chris@909: return nil if content.is_binary_data? Chris@909: identifier = '' Chris@909: # git shows commit author on the first occurrence only Chris@909: authors_by_commit = {} Chris@909: content.split("\n").each do |line| Chris@909: if line =~ /^([0-9a-f]{39,40})\s.*/ Chris@909: identifier = $1 Chris@909: elsif line =~ /^author (.+)/ Chris@909: authors_by_commit[identifier] = $1.strip Chris@909: elsif line =~ /^\t(.*)/ Chris@909: blame.add_line($1, Revision.new( Chris@909: :identifier => identifier, Chris@909: :revision => identifier, Chris@909: :scmid => identifier, Chris@909: :author => authors_by_commit[identifier] Chris@909: )) Chris@909: identifier = '' Chris@909: author = '' Chris@909: end Chris@909: end Chris@909: blame Chris@909: rescue ScmCommandAborted Chris@909: nil Chris@909: end Chris@909: Chris@909: def cat(path, identifier=nil) Chris@909: if identifier.nil? Chris@909: identifier = 'HEAD' Chris@909: end Chris@909: cmd_args = %w|show --no-color| Chris@909: cmd_args << "#{identifier}:#{scm_iconv(@path_encoding, 'UTF-8', path)}" Chris@909: cat = nil Chris@909: scm_cmd(*cmd_args) do |io| Chris@909: io.binmode Chris@909: cat = io.read Chris@909: end Chris@909: cat Chris@909: rescue ScmCommandAborted Chris@909: nil Chris@909: end Chris@909: Chris@909: class Revision < Redmine::Scm::Adapters::Revision Chris@909: # Returns the readable identifier Chris@909: def format_identifier Chris@909: identifier[0,8] Chris@909: end Chris@909: end Chris@909: Chris@909: def scm_cmd(*args, &block) Chris@909: repo_path = root_url || url Chris@909: full_args = ['--git-dir', repo_path] Chris@909: if self.class.client_version_above?([1, 7, 2]) Chris@909: full_args << '-c' << 'core.quotepath=false' Chris@909: full_args << '-c' << 'log.decorate=no' Chris@909: end Chris@909: full_args += args Chris@909: ret = shellout( Chris@909: self.class.sq_bin + ' ' + full_args.map { |e| shell_quote e.to_s }.join(' '), Chris@909: &block Chris@909: ) Chris@909: if $? && $?.exitstatus != 0 Chris@909: raise ScmCommandAborted, "git exited with non-zero status: #{$?.exitstatus}" Chris@909: end Chris@909: ret Chris@909: end Chris@909: private :scm_cmd Chris@909: end Chris@909: end Chris@909: end Chris@909: end