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

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

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 inherited from AbstractAdapter

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

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.



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

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 



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

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

.client_command ⇒ Object 



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

def client_command
  @@bin    ||= HG_BIN
end

.client_version ⇒ Object 



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

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

.hgversion ⇒ Object 



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

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.b
  if m = theversion.match(%r{\A(.*?)((\d+\.)+\d+)})
    m[2].scan(%r{\d+}).collect(&:to_i)
  end
end

.hgversion_from_command_line ⇒ Object 



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

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

.sq_bin ⇒ Object 



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

def sq_bin
  @@sq_bin ||= shell_quote_command
end

.template_path ⇒ Object 



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

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

.template_path_for(version) ⇒ Object 



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

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

Instance Method Details

#annotate(path, identifier = nil) ⇒ Object 



281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/redmine/scm/adapters/mercurial_adapter.rb', line 281

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|
      next unless line.b =~ %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 



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

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

#branchmap ⇒ Object

Returns map of => ‘nodeid’, …



124
125
126
127
128
129
130
 
# File 'lib/redmine/scm/adapters/mercurial_adapter.rb', line 124

def branchmap
  map = {}
  branches.each do |b|
    map[b.to_s] = b.scmid
  end
  map
end

#cat(path, identifier = nil) ⇒ Object 



271
272
273
274
275
276
277
278
279
 
# File 'lib/redmine/scm/adapters/mercurial_adapter.rb', line 271

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 



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/mercurial_adapter.rb', line 249

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.



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

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
      # do nothing
    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
    paths.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   =>
                         CGI.unescape(
                           begin
                             le['author']['__content__']
                           rescue
                             ''
                           end
                         ),
                       :time     => Time.parse(le['date']['__content__']),
                       :message  => CGI.unescape(le['msg']['__content__']),
                       :paths    => paths,
                       :parents  => parents_ary)
  end
  self
end

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



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
174
175
176
177
178
179
 
# File 'lib/redmine/scm/adapters/mercurial_adapter.rb', line 146

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
      # do nothing
    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 



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

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 => 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



241
242
243
244
245
246
247
 
# File 'lib/redmine/scm/adapters/mercurial_adapter.rb', line 241

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 



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

def path_encoding
  @path_encoding
end

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



181
182
183
184
185
 
# File 'lib/redmine/scm/adapters/mercurial_adapter.rb', line 181

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’, …



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

def tagmap
  map = {}
  as_ary(summary['repository']['tag']).each do |e|
    map[CGI.unescape(e['name'])] = e['node']
  end
  map
end

#tags ⇒ Object 



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

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

#valid_name?(name) ⇒ Boolean

Returns:

  • (Boolean) 


299
300
301
302
303
304
305
306
 
# File 'lib/redmine/scm/adapters/mercurial_adapter.rb', line 299

def valid_name?(name)
  return false unless name.nil? || name.is_a?(String)

  # Mercurials names don't need to be checked further as its CLI
  # interface is restrictive enough to reject any invalid names on its
  # own.
  true
end