Class: Redmine::Scm::Adapters::MercurialAdapter

Inherits:
AbstractAdapter
  • Object
show all
Defined in:
lib/redmine/scm/adapters/mercurial_adapter.rb

Overview

Since:

  • 0.5.1

Defined Under Namespace

Classes: HgCommandAborted, HgCommandArgumentError, Revision

Constant Summary collapse

HG_BIN =

Mercurial executable name

Redmine::Configuration['scm_mercurial_command'] || "hg"
HELPERS_DIR = 
File.dirname(__FILE__) + "/mercurial"
HG_HELPER_EXT = 
"#{HELPERS_DIR}/redminehelper.py"
TEMPLATE_NAME = 
"hg-template"
TEMPLATE_EXTENSION = 
"tmpl"

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Utils::Shell

shell_quote, shell_quote_command

Constructor Details

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

Returns a new instance of MercurialAdapter

Since:

  • 1.2.0



78
79
80
81
 
# File 'lib/redmine/scm/adapters/mercurial_adapter.rb', line 78

def initialize(url, root_url=nil, =nil, password=nil, path_encoding=nil)
  super
  @path_encoding = path_encoding.blank? ? 'UTF-8' : path_encoding
end

Class Method Details

.client_available ⇒ Object

Since:

  • 1.2.0



51
52
53
 
# File 'lib/redmine/scm/adapters/mercurial_adapter.rb', line 51

def client_available
  client_version_above?([1, 2])
end

.client_command ⇒ Object

Since:

  • 1.2.0



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

def client_command
  @@bin    ||= HG_BIN
end

.client_version ⇒ Object

Since:

  • 0.8.0



47
48
49
 
# File 'lib/redmine/scm/adapters/mercurial_adapter.rb', line 47

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

.hgversion ⇒ Object

Since:

  • 0.8.0



55
56
57
58
59
60
61
62
63
 
# File 'lib/redmine/scm/adapters/mercurial_adapter.rb', line 55

def hgversion
  # The hg version is expressed either as a
  # release number (eg 0.9.5 or 1.0) or as a revision
  # id composed of 12 hexa characters.
  theversion = hgversion_from_command_line.dup.force_encoding('ASCII-8BIT')
  if m = theversion.match(%r{\A(.*?)((\d+\.)+\d+)})
    m[2].scan(%r{\d+}).collect(&:to_i)
  end
end

.hgversion_from_command_line ⇒ Object

Since:

  • 0.8.0



65
66
67
 
# File 'lib/redmine/scm/adapters/mercurial_adapter.rb', line 65

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

.sq_bin ⇒ Object

Since:

  • 1.2.0



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

def sq_bin
  @@sq_bin ||= shell_quote_command
end

.template_path ⇒ Object

Since:

  • 0.8.0



69
70
71
 
# File 'lib/redmine/scm/adapters/mercurial_adapter.rb', line 69

def template_path
  @@template_path ||= template_path_for(client_version)
end

.template_path_for(version) ⇒ Object

Since:

  • 0.8.0



73
74
75
 
# File 'lib/redmine/scm/adapters/mercurial_adapter.rb', line 73

def template_path_for(version)
  "#{HELPERS_DIR}/#{TEMPLATE_NAME}-1.0.#{TEMPLATE_EXTENSION}"
end

Instance Method Details

#annotate(path, identifier = nil) ⇒ Object

Since:

  • 0.6.1



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/redmine/scm/adapters/mercurial_adapter.rb', line 266

def annotate(path, identifier=nil)
  p = CGI.escape(scm_iconv(@path_encoding, 'UTF-8', path))
  blame = Annotate.new
  hg 'rhannotate', '-ncu', "-r#{CGI.escape(hgrev(identifier))}", '--', hgtarget(p) do |io|
    io.each_line do |line|
      line.force_encoding('ASCII-8BIT')
      next unless line =~ %r{^([^:]+)\s(\d+)\s([0-9a-f]+):\s(.*)$}
      r = Revision.new(:author => $1.strip, :revision => $2, :scmid => $3,
                       :identifier => $3)
      blame.add_line($4.rstrip, r)
    end
  end
  blame
rescue HgCommandAborted
  # means not found or cannot be annotated
  Annotate.new
end

#branches ⇒ Object

Since:

  • 1.2.0



110
111
112
113
114
115
116
117
118
119
 
# File 'lib/redmine/scm/adapters/mercurial_adapter.rb', line 110

def branches
  brs = []
  as_ary(summary['repository']['branch']).each do |e|
    br = Branch.new(e['name'])
    br.revision =  e['revision']
    br.scmid    =  e['node']
    brs << br
  end
  brs
end

#branchmap ⇒ Object

Returns map of => 'nodeid', …

Since:

  • 1.2.0



122
123
124
125
126
127
 
# File 'lib/redmine/scm/adapters/mercurial_adapter.rb', line 122

def branchmap
  alist = as_ary(summary['repository']['branch']).map do |e|
    e.values_at('name', 'node')
  end
  Hash[*alist.flatten]
end

#cat(path, identifier = nil) ⇒ Object 



256
257
258
259
260
261
262
263
264
 
# File 'lib/redmine/scm/adapters/mercurial_adapter.rb', line 256

def cat(path, identifier=nil)
  p = CGI.escape(scm_iconv(@path_encoding, 'UTF-8', path))
  hg 'rhcat', "-r#{CGI.escape(hgrev(identifier))}", '--', hgtarget(p) do |io|
    io.binmode
    io.read
  end
rescue HgCommandAborted
  nil  # means not found
end

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



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/redmine/scm/adapters/mercurial_adapter.rb', line 234

def diff(path, identifier_from, identifier_to=nil)
  hg_args = %w|rhdiff|
  if identifier_to
    hg_args << "-r#{hgrev(identifier_to)}" << "-r#{hgrev(identifier_from)}"
  else
    hg_args << "-c#{hgrev(identifier_from)}"
  end
  unless path.blank?
    p = scm_iconv(@path_encoding, 'UTF-8', path)
    hg_args << '--' << CGI.escape(hgtarget(p))
  end
  diff = []
  hg *hg_args do |io|
    io.each_line do |line|
      diff << line
    end
  end
  diff
rescue HgCommandAborted
  nil  # means not found
end

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

Iterates the revisions by using a template file that makes Mercurial produce a xml output.

Since:

  • 1.2.0



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
 
# File 'lib/redmine/scm/adapters/mercurial_adapter.rb', line 183

def each_revision(path=nil, identifier_from=nil, identifier_to=nil, options={})
  hg_args = ['log', '--debug', '-C', "--style=#{self.class.template_path}"]
  hg_args << "-r#{hgrev(identifier_from)}:#{hgrev(identifier_to)}"
  hg_args << "--limit=#{options[:limit]}" if options[:limit]
  hg_args << '--' << hgtarget(path) unless path.blank?
  log = hg(*hg_args) do |io|
    output = io.read.force_encoding('UTF-8')
    begin
      # Mercurial < 1.5 does not support footer template for '</log>'
      parse_xml("#{output}</log>")['log']
    rescue
    end
  end
  as_ary(log['logentry']).each do |le|
    cpalist = as_ary(le['paths']['path-copied']).map do |e|
      [e['__content__'], e['copyfrom-path']].map do |s|
        scm_iconv('UTF-8', @path_encoding, CGI.unescape(s))
      end
    end
    cpmap = Hash[*cpalist.flatten]
    paths = as_ary(le['paths']['path']).map do |e|
      p = scm_iconv('UTF-8', @path_encoding, CGI.unescape(e['__content__']) )
      {:action        => e['action'],
       :path          => with_leading_slash(p),
       :from_path     => (cpmap.member?(p) ? with_leading_slash(cpmap[p]) : nil),
       :from_revision => (cpmap.member?(p) ? le['node'] : nil)}
    end.sort_by { |e| e[:path] }
    parents_ary = []
    as_ary(le['parents']['parent']).map do |par|
      parents_ary << par['__content__'] if par['__content__'] != "0000000000000000000000000000000000000000"
    end
    yield Revision.new(:revision => le['revision'],
                       :scmid    => le['node'],
                       :author   => (le['author']['__content__'] rescue ''),
                       :time     => Time.parse(le['date']['__content__']),
                       :message  => le['msg']['__content__'],
                       :paths    => paths,
                       :parents  => parents_ary)
  end
  self
end

#entries(path = nil, identifier = nil, options = {}) ⇒ Object 



141
142
143
144
145
146
147
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
 
# File 'lib/redmine/scm/adapters/mercurial_adapter.rb', line 141

def entries(path=nil, identifier=nil, options={})
  p1 = scm_iconv(@path_encoding, 'UTF-8', path)
  manifest = hg('rhmanifest', "-r#{CGI.escape(hgrev(identifier))}",
                '--', CGI.escape(without_leading_slash(p1.to_s))) do |io|
    output = io.read.force_encoding('UTF-8')
    begin
      parse_xml(output)['rhmanifest']['repository']['manifest']
    rescue
    end
  end
  path_prefix = path.blank? ? '' : with_trailling_slash(path)

  entries = Entries.new
  as_ary(manifest['dir']).each do |e|
    n = scm_iconv('UTF-8', @path_encoding, CGI.unescape(e['name']))
    p = "#{path_prefix}#{n}"
    entries << Entry.new(:name => n, :path => p, :kind => 'dir')
  end

  as_ary(manifest['file']).each do |e|
    n = scm_iconv('UTF-8', @path_encoding, CGI.unescape(e['name']))
    p = "#{path_prefix}#{n}"
    lr = Revision.new(:revision => e['revision'], :scmid => e['node'],
                      :identifier => e['node'],
                      :time => Time.at(e['time'].to_i))
    entries << Entry.new(:name => n, :path => p, :kind => 'file',
                         :size => e['size'].to_i, :lastrev => lr)
  end

  entries
rescue HgCommandAborted
  nil  # means not found
end

#info ⇒ Object 



87
88
89
90
91
92
93
94
95
96
 
# File 'lib/redmine/scm/adapters/mercurial_adapter.rb', line 87

def info
  tip = summary['repository']['tip']
  Info.new(:root_url => CGI.unescape(summary['repository']['root']),
           :lastrev => Revision.new(:revision => tip['revision'],
                                    :scmid => tip['node']))
# rescue HgCommandAborted
rescue Exception => e
  logger.error "hg: error during getting info: #{e.message}"
  nil
end

#nodes_in_branch(branch, options = {}) ⇒ Object

Returns list of nodes in the specified branch

Since:

  • 1.2.0



226
227
228
229
230
231
232
 
# File 'lib/redmine/scm/adapters/mercurial_adapter.rb', line 226

def nodes_in_branch(branch, options={})
  hg_args = ['rhlog', '--template={node}\n', "--rhbranch=#{CGI.escape(branch)}"]
  hg_args << "--from=#{CGI.escape(branch)}"
  hg_args << '--to=0'
  hg_args << "--limit=#{options[:limit]}" if options[:limit]
  hg(*hg_args) { |io| io.readlines.map { |e| e.chomp } }
end

#path_encoding ⇒ Object

Since:

  • 1.2.0



83
84
85
 
# File 'lib/redmine/scm/adapters/mercurial_adapter.rb', line 83

def path_encoding
  @path_encoding
end

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



175
176
177
178
179
 
# File 'lib/redmine/scm/adapters/mercurial_adapter.rb', line 175

def revisions(path=nil, identifier_from=nil, identifier_to=nil, options={})
  revs = Revisions.new
  each_revision(path, identifier_from, identifier_to, options) { |e| revs << e }
  revs
end

#tagmap ⇒ Object

Returns map of => 'nodeid', …

Since:

  • 1.2.0



103
104
105
106
107
108
 
# File 'lib/redmine/scm/adapters/mercurial_adapter.rb', line 103

def tagmap
  alist = as_ary(summary['repository']['tag']).map do |e|
    e.values_at('name', 'node')
  end
  Hash[*alist.flatten]
end

#tags ⇒ Object

Since:

  • 1.2.0



98
99
100
 
# File 'lib/redmine/scm/adapters/mercurial_adapter.rb', line 98

def tags
  as_ary(summary['repository']['tag']).map { |e| e['name'] }
end