jro_apps/redmine Commit - r4869:c3e8fc5f1a2d

scm: mercurial: wrap revison, tag and branch with URL encoding for entries (#4455, #1981, #7246)....

Toshi MARUYAMA -

r4869:c3e8fc5f1a2d

parent child

Context file:

r4869:c3e8fc5f1a2d

Collapse all files

lib/redmine/scm/adapters/mercurial/redminehelper.py +1 -1

             # redminehelper: Redmine helper extension for Mercurial
             #
             # Copyright 2010 Alessio Franceschelli (alefranz.net)
             # Copyright 2010-2011 Yuya Nishihara <yuya@tcha.org>
             #
             # This software may be used and distributed according to the terms of the
             # GNU General Public License version 2 or any later version.
             """helper commands for Redmine to reduce the number of hg calls
             To test this extension, please try::
                 $ hg --config extensions.redminehelper=redminehelper.py rhsummary
             I/O encoding:
             :file path: urlencoded, raw string
             :tag name: utf-8
             :branch name: utf-8
             :node: 12-digits (short) hex string
             Output example of rhsummary::
                 <?xml version="1.0"?>
                 <rhsummary>
                   <repository root="/foo/bar">
                     <tip revision="1234" node="abcdef0123..."/>
                     <tag revision="123" node="34567abc..." name="1.1.1"/>
                     <branch .../>
                     ...
                   </repository>
                 </rhsummary>
             Output example of rhmanifest::
                 <?xml version="1.0"?>
                 <rhmanifest>
                   <repository root="/foo/bar">
                     <manifest revision="1234" path="lib">
                       <file name="diff.rb" revision="123" node="34567abc..." time="12345"
                              size="100"/>
                       ...
                       <dir name="redmine"/>
                       ...
                     </manifest>
                   </repository>
                 </rhmanifest>
             """
             import re, time, cgi, urllib
             from mercurial import cmdutil, commands, node, error
             _x = cgi.escape
             _u = lambda s: cgi.escape(urllib.quote(s))
             def _tip(ui, repo):
                 # see mercurial/commands.py:tip
                 def tiprev():
                     try:
                         return len(repo) - 1
                     except TypeError:  # Mercurial < 1.1
                         return repo.changelog.count() - 1
                 tipctx = repo.changectx(tiprev())
                 ui.write('<tip revision="%d" node="%s"/>\n'
                          % (tipctx.rev(), _x(node.short(tipctx.node()))))
             _SPECIAL_TAGS = ('tip',)
             def _tags(ui, repo):
                 # see mercurial/commands.py:tags
                 for t, n in reversed(repo.tagslist()):
                     if t in _SPECIAL_TAGS:
                         continue
                     try:
                         r = repo.changelog.rev(n)
                     except error.LookupError:
                         continue
                     ui.write('<tag revision="%d" node="%s" name="%s"/>\n'
                              % (r, _x(node.short(n)), _x(t)))
             def _branches(ui, repo):
                 # see mercurial/commands.py:branches
                 def iterbranches():
                     for t, n in repo.branchtags().iteritems():
                         yield t, n, repo.changelog.rev(n)
                 def branchheads(branch):
                     try:
                         return repo.branchheads(branch, closed=False)
                     except TypeError:  # Mercurial < 1.2
                         return repo.branchheads(branch)
                 for t, n, r in sorted(iterbranches(), key=lambda e: e[2], reverse=True):
                     if repo.lookup(r) in branchheads(t):
                         ui.write('<branch revision="%d" node="%s" name="%s"/>\n'
                                  % (r, _x(node.short(n)), _x(t)))
             def _manifest(ui, repo, path, rev):
                 ctx = repo.changectx(rev)
                 ui.write('<manifest revision="%d" path="%s">\n'
                          % (ctx.rev(), _u(path)))
                 known = set()
                 pathprefix = (path.rstrip('/') + '/').lstrip('/')
                 for f, n in sorted(ctx.manifest().iteritems(), key=lambda e: e[0]):
                     if not f.startswith(pathprefix):
                         continue
                     name = re.sub(r'/.*', '/', f[len(pathprefix):])
                     if name in known:
                         continue
                     known.add(name)
                     if name.endswith('/'):
                         ui.write('<dir name="%s"/>\n'
                                  % _x(urllib.quote(name[:-1])))
                     else:
                         fctx = repo.filectx(f, fileid=n)
                         tm, tzoffset = fctx.date()
                         ui.write('<file name="%s" revision="%d" node="%s" '
                                  'time="%d" size="%d"/>\n'
                                  % (_u(name), fctx.rev(), _x(node.short(fctx.node())),
                                     tm, fctx.size(), ))
                 ui.write('</manifest>\n')
             def rhannotate(ui, repo, *pats, **opts):
                 return commands.annotate(ui, repo, *map(urllib.unquote_plus, pats), **opts)
             def rhcat(ui, repo, file1, *pats, **opts):
                 return commands.cat(ui, repo, urllib.unquote_plus(file1), *map(urllib.unquote_plus, pats), **opts)
             def rhdiff(ui, repo, *pats, **opts):
                 """diff repository (or selected files)"""
                 change = opts.pop('change', None)
                 if change:  # add -c option for Mercurial<1.1
                     base = repo.changectx(change).parents()[0].rev()
                     opts['rev'] = [str(base), change]
                 opts['nodates'] = True
                 return commands.diff(ui, repo, *map(urllib.unquote_plus, pats), **opts)
             def rhmanifest(ui, repo, path='', **opts):
                 """output the sub-manifest of the specified directory"""
                 ui.write('<?xml version="1.0"?>\n')
                 ui.write('<rhmanifest>\n')
                 ui.write('<repository root="%s">\n' % _u(repo.root))
                 try:
-                    _manifest(ui, repo, urllib.unquote_plus(path), opts.get('rev'))
+                    _manifest(ui, repo, urllib.unquote_plus(path), urllib.unquote_plus(opts.get('rev')))
                 finally:
                     ui.write('</repository>\n')
                     ui.write('</rhmanifest>\n')
             def rhsummary(ui, repo, **opts):
                 """output the summary of the repository"""
                 ui.write('<?xml version="1.0"?>\n')
                 ui.write('<rhsummary>\n')
                 ui.write('<repository root="%s">\n' % _u(repo.root))
                 try:
                     _tip(ui, repo)
                     _tags(ui, repo)
                     _branches(ui, repo)
                     # TODO: bookmarks in core (Mercurial>=1.8)
                 finally:
                     ui.write('</repository>\n')
                     ui.write('</rhsummary>\n')
             # This extension should be compatible with Mercurial 0.9.5.
             # Note that Mercurial 0.9.5 doesn't have extensions.wrapfunction().
             cmdtable = {
                 'rhannotate': (rhannotate,
                      [('r', 'rev', '', 'revision'),
                       ('u', 'user', None, 'list the author (long with -v)'),
                       ('n', 'number', None, 'list the revision number (default)'),
                       ('c', 'changeset', None, 'list the changeset'),
                      ],
                      'hg rhannotate [-r REV] [-u] [-n] [-c] FILE...'),
                 'rhcat': (rhcat,
                            [('r', 'rev', '', 'revision')],
                            'hg rhcat ([-r REV] ...) FILE...'),
                 'rhdiff': (rhdiff,
                            [('r', 'rev', [], 'revision'),
                             ('c', 'change', '', 'change made by revision')],
                            'hg rhdiff ([-c REV] | [-r REV] ...) [FILE]...'),
                 'rhmanifest': (rhmanifest,
                                [('r', 'rev', '', 'show the specified revision')],
                                'hg rhmanifest [-r REV] [PATH]'),
                 'rhsummary': (rhsummary, [], 'hg rhsummary'),
             }

lib/redmine/scm/adapters/mercurial_adapter.rb +1 -1

             # redMine - project management software
             # Copyright (C) 2006-2007  Jean-Philippe Lang
             #
             # This program is free software; you can redistribute it and/or
             # modify it under the terms of the GNU General Public License
             # as published by the Free Software Foundation; either version 2
             # of the License, or (at your option) any later version.
             #
             # This program is distributed in the hope that it will be useful,
             # but WITHOUT ANY WARRANTY; without even the implied warranty of
             # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
             # GNU General Public License for more details.
             #
             # You should have received a copy of the GNU General Public License
             # along with this program; if not, write to the Free Software
             # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
             require 'redmine/scm/adapters/abstract_adapter'
             require 'cgi'
             module Redmine
               module Scm
                 module Adapters
                   class MercurialAdapter < AbstractAdapter
                     # Mercurial executable name
                     HG_BIN = 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"
                     # raised if hg command exited with error, e.g. unknown revision.
                     class HgCommandAborted < CommandFailed; end
                     class << self
                       def client_command
                         @@bin    ||= HG_BIN
                       end
                       def sq_bin
                         @@sq_bin ||= shell_quote(HG_BIN)
                       end
                       def client_version
                         @@client_version ||= (hgversion || [])
                       end
                       def client_available
                         !client_version.empty?
                       end
                       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
                         if theversion.respond_to?(:force_encoding)
                           theversion.force_encoding('ASCII-8BIT')
                         end
                         if m = theversion.match(%r{\A(.*?)((\d+\.)+\d+)})
                           m[2].scan(%r{\d+}).collect(&:to_i)
                         end
                       end
                       def hgversion_from_command_line
                         shellout("#{sq_bin} --version") { |io| io.read }.to_s
                       end
                       def template_path
                         @@template_path ||= template_path_for(client_version)
                       end
                       def template_path_for(version)
                         if ((version <=> [0,9,5]) > 0) || version.empty?
                           ver = "1.0"
                         else
                           ver = "0.9.5"
                         end
                         "#{HELPERS_DIR}/#{TEMPLATE_NAME}-#{ver}.#{TEMPLATE_EXTENSION}"
                       end
                     end
                     def initialize(url, root_url=nil, login=nil, password=nil, path_encoding=nil)
                       super
                       @path_encoding = path_encoding || 'UTF-8'
                     end
                     def info
                       tip = summary['repository']['tip']
                       Info.new(:root_url => CGI.unescape(summary['repository']['root']),
                                :lastrev => Revision.new(:revision => tip['revision'],
                                                         :scmid => tip['node']))
                     end
                     def tags
                       as_ary(summary['repository']['tag']).map { |e| e['name'] }
                     end
                     # Returns map of {'tag' => 'nodeid', ...}
                     def tagmap
                       alist = as_ary(summary['repository']['tag']).map do |e|
                         e.values_at('name', 'node')
                       end
                       Hash[*alist.flatten]
                     end
                     def branches
                       as_ary(summary['repository']['branch']).map { |e| e['name'] }
                     end
                     # Returns map of {'branch' => 'nodeid', ...}
                     def branchmap
                       alist = as_ary(summary['repository']['branch']).map do |e|
                         e.values_at('name', 'node')
                       end
                       Hash[*alist.flatten]
                     end
                     def summary
                       return @summary if @summary
                       hg 'rhsummary' do |io|
                         begin
                           @summary = ActiveSupport::XmlMini.parse(io.read)['rhsummary']
                         rescue
                         end
                       end
                     end
                     private :summary
                     def entries(path=nil, identifier=nil)
                       p1 = scm_iconv(@path_encoding, 'UTF-8', path)
-                      manifest = hg('rhmanifest', '-r', hgrev(identifier),
+                      manifest = hg('rhmanifest', '-r', CGI.escape(hgrev(identifier)),
                                     CGI.escape(without_leading_slash(p1.to_s))) do |io|
                         begin
                           ActiveSupport::XmlMini.parse(io.read)['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
                     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
                     # Iterates the revisions by using a template file that
                     # makes Mercurial produce a xml output.
                     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|
                         begin
                           # Mercurial < 1.5 does not support footer template for '</log>'
                           ActiveSupport::XmlMini.parse("#{io.read}</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 { |s| CGI.unescape(s) }
                         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['revision'] : nil)}
                         end.sort { |a, b| a[:path] <=> b[:path] }
                         yield Revision.new(:revision => le['revision'],
                                            :scmid => le['node'],
                                            :author => (le['author']['__content__'] rescue ''),
                                            :time => Time.parse(le['date']['__content__']).localtime,
                                            :message => le['msg']['__content__'],
                                            :paths => paths)
                       end
                       self
                     end
                     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
                     def cat(path, identifier=nil)
                       p = CGI.escape(scm_iconv(@path_encoding, 'UTF-8', path))
                       hg 'rhcat', '-r', hgrev(identifier), hgtarget(p) do |io|
                         io.binmode
                         io.read
                       end
                     rescue HgCommandAborted
                       nil  # means not found
                     end
                     def annotate(path, identifier=nil)
                       p = CGI.escape(scm_iconv(@path_encoding, 'UTF-8', path))
                       blame = Annotate.new
                       hg 'rhannotate', '-ncu', '-r', hgrev(identifier), hgtarget(p) do |io|
                         io.each_line do |line|
                           line.force_encoding('ASCII-8BIT') if line.respond_to?(:force_encoding)
                           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
                       nil  # means not found or cannot be annotated
                     end
                     class Revision < Redmine::Scm::Adapters::Revision
                       # Returns the readable identifier
                       def format_identifier
                         "#{revision}:#{scmid}"
                       end
                     end
                     # Runs 'hg' command with the given args
                     def hg(*args, &block)
                       repo_path = root_url || url
                       full_args = [HG_BIN, '-R', repo_path, '--encoding', 'utf-8']
                       full_args << '--config' << "extensions.redminehelper=#{HG_HELPER_EXT}"
                       full_args << '--config' << 'diff.git=false'
                       full_args += args
                       ret = shellout(full_args.map { |e| shell_quote e.to_s }.join(' '), &block)
                       if $? && $?.exitstatus != 0
                         raise HgCommandAborted, "hg exited with non-zero status: #{$?.exitstatus}"
                       end
                       ret
                     end
                     private :hg
                     # Returns correct revision identifier
                     def hgrev(identifier, sq=false)
                       rev = identifier.blank? ? 'tip' : identifier.to_s
                       rev = shell_quote(rev) if sq
                       rev
                     end
                     private :hgrev
                     def hgtarget(path)
                       path ||= ''
                       root_url + '/' + without_leading_slash(path)
                     end
                     private :hgtarget
                     def as_ary(o)
                       return [] unless o
                       o.is_a?(Array) ? o : Array[o]
                     end
                     private :as_ary
                   end
                 end
               end
             end

General Comments 0

Write
Preview

You need to be logged in to leave comments. Login now

No TODOs yet

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages