Class: Redmine::Scm::Adapters::GitAdapter

Inherits:
AbstractAdapter show all
Defined in:
lib/redmine/scm/adapters/git_adapter.rb

Defined Under Namespace

Classes: Revision, ScmCommandAborted

Constant Summary collapse

SCM_GIT_REPORT_LAST_COMMIT =
true
GIT_BIN =
Redmine::Configuration['scm_git_command'] || "git"

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from AbstractAdapter

#adapter_name, client_version_above?, client_version_string, #entry, #properties, #root_url, shell_quote, #shell_quote, #supports_annotate?, #supports_cat?, #url, #with_leading_slash, #with_trailling_slash, #without_leading_slash, #without_trailling_slash

Constructor Details

#initialize(url, root_url = nil, login = nil, password = nil, path_encoding = nil) ⇒ GitAdapter

Returns a new instance of GitAdapter


62
63
64
65
66
# File 'lib/redmine/scm/adapters/git_adapter.rb', line 62

def initialize(url, root_url=nil, =nil, password=nil, path_encoding=nil)
  super
  @path_encoding = path_encoding || 'UTF-8'
  @flag_report_last_commit = SCM_GIT_REPORT_LAST_COMMIT
end

Class Method Details

.client_availableObject


43
44
45
# File 'lib/redmine/scm/adapters/git_adapter.rb', line 43

def client_available
  !client_version.empty?
end

.client_commandObject


31
32
33
# File 'lib/redmine/scm/adapters/git_adapter.rb', line 31

def client_command
  @@bin    ||= GIT_BIN
end

.client_versionObject


39
40
41
# File 'lib/redmine/scm/adapters/git_adapter.rb', line 39

def client_version
  @@client_version ||= (scm_command_version || [])
end

.scm_command_versionObject


47
48
49
50
51
52
53
54
55
# File 'lib/redmine/scm/adapters/git_adapter.rb', line 47

def scm_command_version
  scm_version = scm_version_from_command_line.dup
  if scm_version.respond_to?(:force_encoding)
    scm_version.force_encoding('ASCII-8BIT')
  end
  if m = scm_version.match(%r{\A(.*?)((\d+\.)+\d+)})
    m[2].scan(%r{\d+}).collect(&:to_i)
  end
end

.scm_version_from_command_lineObject


57
58
59
# File 'lib/redmine/scm/adapters/git_adapter.rb', line 57

def scm_version_from_command_line
  shellout("#{sq_bin} --version --no-color") { |io| io.read }.to_s
end

.sq_binObject


35
36
37
# File 'lib/redmine/scm/adapters/git_adapter.rb', line 35

def sq_bin
  @@sq_bin ||= shell_quote(GIT_BIN)
end

Instance Method Details

#annotate(path, identifier = nil) ⇒ Object


291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
# File 'lib/redmine/scm/adapters/git_adapter.rb', line 291

def annotate(path, identifier=nil)
  identifier = 'HEAD' if identifier.blank?
  cmd_args = %w|blame|
  cmd_args << "-p" << identifier << "--" <<  scm_iconv(@path_encoding, 'UTF-8', path)
  blame = Annotate.new
  content = nil
  scm_cmd(*cmd_args) { |io| io.binmode; content = io.read }
  # git annotates binary files
  if content.respond_to?("is_binary_data?") && content.is_binary_data? # Ruby 1.8.x and <1.9.2
    return nil
  elsif content.respond_to?(:force_encoding) && (content.dup.force_encoding("UTF-8") != content.dup.force_encoding("BINARY")) # Ruby 1.9.2
    # TODO: need to handle edge cases of non-binary content that isn't UTF-8
    return nil
  end
  identifier = ''
  # git shows commit author on the first occurrence only
  authors_by_commit = {}
  content.split("\n").each do |line|
    if line =~ /^([0-9a-f]{39,40})\s.*/
      identifier = $1
    elsif line =~ /^author (.+)/
      authors_by_commit[identifier] = $1.strip
    elsif line =~ /^\t(.*)/
      blame.add_line($1, Revision.new(
                            :identifier => identifier,
                            :author => authors_by_commit[identifier]))
      identifier = ''
      author = ''
    end
  end
  blame
rescue ScmCommandAborted
  nil
end

#branchesObject


76
77
78
79
80
81
82
83
84
85
86
87
88
# File 'lib/redmine/scm/adapters/git_adapter.rb', line 76

def branches
  return @branches if @branches
  @branches = []
  cmd_args = %w|branch --no-color|
  scm_cmd(*cmd_args) do |io|
    io.each_line do |line|
      @branches << line.match('\s*\*?\s*(.*)$')[1]
    end
  end
  @branches.sort!
rescue ScmCommandAborted
  nil
end

#cat(path, identifier = nil) ⇒ Object


326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
# File 'lib/redmine/scm/adapters/git_adapter.rb', line 326

def cat(path, identifier=nil)
  if identifier.nil?
    identifier = 'HEAD'
  end
  cmd_args = %w|show --no-color|
  cmd_args << "#{identifier}:#{scm_iconv(@path_encoding, 'UTF-8', path)}"
  cat = nil
  scm_cmd(*cmd_args) do |io|
    io.binmode
    cat = io.read
  end
  cat
rescue ScmCommandAborted
  nil
end

#default_branchObject


100
101
102
103
104
105
106
107
108
109
110
111
# File 'lib/redmine/scm/adapters/git_adapter.rb', line 100

def default_branch
  bras = self.branches
  return nil if bras.nil?
   head = nil
   scm_cmd('symbolic-ref', 'HEAD') do |io|
     head = io.readline
   end
   /^refs\/heads\/(.*)$/.match(head)
   bras.include?($1) ? $1 : bras.first
 rescue ScmCommandAborted, EOFError
  bras.include?('master') ? 'master' : bras.first
end

#diff(path, identifier_from, identifier_to = nil) ⇒ Object


271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
# File 'lib/redmine/scm/adapters/git_adapter.rb', line 271

def diff(path, identifier_from, identifier_to=nil)
  path ||= ''
  cmd_args = []
  if identifier_to
    cmd_args << "diff" << "--no-color" <<  identifier_to << identifier_from
  else
    cmd_args << "show" << "--no-color" << identifier_from
  end
  cmd_args << "--" <<  scm_iconv(@path_encoding, 'UTF-8', path) unless path.empty?
  diff = []
  scm_cmd *cmd_args do |io|
    io.each_line do |line|
      diff << line
    end
  end
  diff
rescue ScmCommandAborted
  nil
end

#entries(path = nil, identifier = nil) ⇒ Object


113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
# File 'lib/redmine/scm/adapters/git_adapter.rb', line 113

def entries(path=nil, identifier=nil)
  path ||= ''
  p = scm_iconv(@path_encoding, 'UTF-8', path)
  entries = Entries.new
  cmd_args = %w|ls-tree -l|
  cmd_args << "HEAD:#{p}"          if identifier.nil?
  cmd_args << "#{identifier}:#{p}" if identifier
  scm_cmd(*cmd_args) do |io|
    io.each_line do |line|
      e = line.chomp.to_s
      if e =~ /^\d+\s+(\w+)\s+([0-9a-f]{40})\s+([0-9-]+)\t(.+)$/
        type = $1
        sha  = $2
        size = $3
        name = $4
        if name.respond_to?(:force_encoding)
          name.force_encoding(@path_encoding)
        end
        full_path = p.empty? ? name : "#{p}/#{name}"
        n      = scm_iconv('UTF-8', @path_encoding, name)
        full_p = scm_iconv('UTF-8', @path_encoding, full_path)
        entries << Entry.new({:name => n,
         :path => full_p,
         :kind => (type == "tree") ? 'dir' : 'file',
         :size => (type == "tree") ? nil : size,
         :lastrev => @flag_report_last_commit ? lastrev(full_path, identifier) : Revision.new
        }) unless entries.detect{|entry| entry.name == name}
      end
    end
  end
  entries.sort_by_name
rescue ScmCommandAborted
  nil
end

#infoObject


68
69
70
71
72
73
74
# File 'lib/redmine/scm/adapters/git_adapter.rb', line 68

def info
  begin
    Info.new(:root_url => url, :lastrev => lastrev('',nil))
  rescue
    nil
  end
end

#lastrev(path, rev) ⇒ Object


148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
# File 'lib/redmine/scm/adapters/git_adapter.rb', line 148

def lastrev(path, rev)
  return nil if path.nil?
  cmd_args = %w|log --no-color --encoding=UTF-8 --date=iso --pretty=fuller --no-merges -n 1|
  cmd_args << rev if rev
  cmd_args << "--" << path unless path.empty?
  lines = []
  scm_cmd(*cmd_args) { |io| lines = io.readlines }
  begin
      id = lines[0].split[1]
      author = lines[1].match('Author:\s+(.*)$')[1]
      time = Time.parse(lines[4].match('CommitDate:\s+(.*)$')[1])

      Revision.new({
        :identifier => id,
        :scmid => id,
        :author => author,
        :time => time,
        :message => nil,
        :paths => nil
        })
  rescue NoMethodError => e
      logger.error("The revision '#{path}' has a wrong format")
      return nil
  end
rescue ScmCommandAborted
  nil
end

#revisions(path, identifier_from, identifier_to, options = {}) ⇒ Object


176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
# File 'lib/redmine/scm/adapters/git_adapter.rb', line 176

def revisions(path, identifier_from, identifier_to, options={})
  revisions = Revisions.new
  cmd_args = %w|log --no-color --encoding=UTF-8 --raw --date=iso --pretty=fuller|
  cmd_args << "--reverse" if options[:reverse]
  cmd_args << "--all" if options[:all]
  cmd_args << "-n" << "#{options[:limit].to_i}" if options[:limit]
  from_to = ""
  from_to << "#{identifier_from}.." if identifier_from
  from_to << "#{identifier_to}" if identifier_to
  cmd_args << from_to if !from_to.empty?
  cmd_args << "--since='#{options[:since].strftime("%Y-%m-%d %H:%M:%S")}'" if options[:since]
  cmd_args << "--" << scm_iconv(@path_encoding, 'UTF-8', path) if path && !path.empty?

  scm_cmd *cmd_args do |io|
    files=[]
    changeset = {}
    parsing_descr = 0  #0: not parsing desc or files, 1: parsing desc, 2: parsing files

    io.each_line do |line|
      if line =~ /^commit ([0-9a-f]{40})$/
        key = "commit"
        value = $1
        if (parsing_descr == 1 || parsing_descr == 2)
          parsing_descr = 0
          revision = Revision.new({
            :identifier => changeset[:commit],
            :scmid => changeset[:commit],
            :author => changeset[:author],
            :time => Time.parse(changeset[:date]),
            :message => changeset[:description],
            :paths => files
          })
          if block_given?
            yield revision
          else
            revisions << revision
          end
          changeset = {}
          files = []
        end
        changeset[:commit] = $1
      elsif (parsing_descr == 0) && line =~ /^(\w+):\s*(.*)$/
        key = $1
        value = $2
        if key == "Author"
          changeset[:author] = value
        elsif key == "CommitDate"
          changeset[:date] = value
        end
      elsif (parsing_descr == 0) && line.chomp.to_s == ""
        parsing_descr = 1
        changeset[:description] = ""
      elsif (parsing_descr == 1 || parsing_descr == 2) \
          && line =~ /^:\d+\s+\d+\s+[0-9a-f.]+\s+[0-9a-f.]+\s+(\w)\t(.+)$/
        parsing_descr = 2
        fileaction    = $1
        filepath      = $2
        p = scm_iconv('UTF-8', @path_encoding, filepath)
        files << {:action => fileaction, :path => p}
      elsif (parsing_descr == 1 || parsing_descr == 2) \
          && line =~ /^:\d+\s+\d+\s+[0-9a-f.]+\s+[0-9a-f.]+\s+(\w)\d+\s+(\S+)\t(.+)$/
        parsing_descr = 2
        fileaction    = $1
        filepath      = $3
        p = scm_iconv('UTF-8', @path_encoding, filepath)
        files << {:action => fileaction, :path => p}
      elsif (parsing_descr == 1) && line.chomp.to_s == ""
        parsing_descr = 2
      elsif (parsing_descr == 1)
        changeset[:description] << line[4..-1]
      end
    end

    if changeset[:commit]
      revision = Revision.new({
        :identifier => changeset[:commit],
        :scmid => changeset[:commit],
        :author => changeset[:author],
        :time => Time.parse(changeset[:date]),
        :message => changeset[:description],
        :paths => files
      })

      if block_given?
        yield revision
      else
        revisions << revision
      end
    end
  end
  revisions
rescue ScmCommandAborted
  revisions
end

#tagsObject


90
91
92
93
94
95
96
97
98
# File 'lib/redmine/scm/adapters/git_adapter.rb', line 90

def tags
  return @tags if @tags
  cmd_args = %w|tag|
  scm_cmd(*cmd_args) do |io|
    @tags = io.readlines.sort!.map{|t| t.strip}
  end
rescue ScmCommandAborted
  nil
end