convert: when converting from Perforce use original local encoding by default

On Windows Perforce command line client uses default system locale to encode
output. Using 'latin_1' causes locale-specific characters to be replaced with
question marks. With this patch we will use default locale by default whilst
allowing to specify it explicity with 'convert.p4.encoding' config option.

This is a potentially breaking change for any scripts relying on output treated
as in 'latin_1' encoding.

Also because hgext.convert.convcmd overwrites detected default system locale
with UTF-8 we had to introduce an import cycle in hgext.convert.p4 to retrieve
originally detected encoding from hgext.convert.convcmd.

hgext/convert/__init__.py

@@ -1,444 +1,447 b''
 # convert.py Foreign SCM converter
 #
 # Copyright 2005-2007 Matt Mackall <[e-mail]>
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2 or any later version.
 
 '''import revisions from foreign VCS repositories into Mercurial'''
 
 import convcmd
 import cvsps
 import subversion
 from mercurial import cmdutil, templatekw
 from mercurial.i18n import _
 
 cmdtable = {}
 command = cmdutil.command(cmdtable)
 # Note for extension authors: ONLY specify testedwith = 'internal' for
 # extensions which SHIP WITH MERCURIAL. Non-mainline extensions should
 # be specifying the version(s) of Mercurial they are tested with, or
 # leave the attribute unspecified.
 testedwith = 'internal'
 
 # Commands definition was moved elsewhere to ease demandload job.
 
 @command('convert',
     [('', 'authors', '',
       _('username mapping filename (DEPRECATED, use --authormap instead)'),
       _('FILE')),
     ('s', 'source-type', '', _('source repository type'), _('TYPE')),
     ('d', 'dest-type', '', _('destination repository type'), _('TYPE')),
     ('r', 'rev', [], _('import up to source revision REV'), _('REV')),
     ('A', 'authormap', '', _('remap usernames using this file'), _('FILE')),
     ('', 'filemap', '', _('remap file names using contents of file'),
      _('FILE')),
     ('', 'full', None,
      _('apply filemap changes by converting all files again')),
     ('', 'splicemap', '', _('splice synthesized history into place'),
      _('FILE')),
     ('', 'branchmap', '', _('change branch names while converting'),
      _('FILE')),
     ('', 'branchsort', None, _('try to sort changesets by branches')),
     ('', 'datesort', None, _('try to sort changesets by date')),
     ('', 'sourcesort', None, _('preserve source changesets order')),
     ('', 'closesort', None, _('try to reorder closed revisions'))],
    _('hg convert [OPTION]... SOURCE [DEST [REVMAP]]'),
    norepo=True)
 def convert(ui, src, dest=None, revmapfile=None, **opts):
     """convert a foreign SCM repository to a Mercurial one.
 
     Accepted source formats [identifiers]:
 
     - Mercurial [hg]
     - CVS [cvs]
     - Darcs [darcs]
     - git [git]
     - Subversion [svn]
     - Monotone [mtn]
     - GNU Arch [gnuarch]
     - Bazaar [bzr]
     - Perforce [p4]
 
     Accepted destination formats [identifiers]:
 
     - Mercurial [hg]
     - Subversion [svn] (history on branches is not preserved)
 
     If no revision is given, all revisions will be converted.
     Otherwise, convert will only import up to the named revision
     (given in a format understood by the source).
 
     If no destination directory name is specified, it defaults to the
     basename of the source with ``-hg`` appended. If the destination
     repository doesn't exist, it will be created.
 
     By default, all sources except Mercurial will use --branchsort.
     Mercurial uses --sourcesort to preserve original revision numbers
     order. Sort modes have the following effects:
 
     --branchsort  convert from parent to child revision when possible,
                   which means branches are usually converted one after
                   the other. It generates more compact repositories.
 
     --datesort    sort revisions by date. Converted repositories have
                   good-looking changelogs but are often an order of
                   magnitude larger than the same ones generated by
                   --branchsort.
 
     --sourcesort  try to preserve source revisions order, only
                   supported by Mercurial sources.
 
     --closesort   try to move closed revisions as close as possible
                   to parent branches, only supported by Mercurial
                   sources.
 
     If ``REVMAP`` isn't given, it will be put in a default location
     (``<dest>/.hg/shamap`` by default). The ``REVMAP`` is a simple
     text file that maps each source commit ID to the destination ID
     for that revision, like so::
 
       <source ID> <destination ID>
 
     If the file doesn't exist, it's automatically created. It's
     updated on each commit copied, so :hg:`convert` can be interrupted
     and can be run repeatedly to copy new commits.
 
     The authormap is a simple text file that maps each source commit
     author to a destination commit author. It is handy for source SCMs
     that use unix logins to identify authors (e.g.: CVS). One line per
     author mapping and the line format is::
 
       source author = destination author
 
     Empty lines and lines starting with a ``#`` are ignored.
 
     The filemap is a file that allows filtering and remapping of files
     and directories. Each line can contain one of the following
     directives::
 
       include path/to/file-or-dir
 
       exclude path/to/file-or-dir
 
       rename path/to/source path/to/destination
 
     Comment lines start with ``#``. A specified path matches if it
     equals the full relative name of a file or one of its parent
     directories. The ``include`` or ``exclude`` directive with the
     longest matching path applies, so line order does not matter.
 
     The ``include`` directive causes a file, or all files under a
     directory, to be included in the destination repository. The default
     if there are no ``include`` statements is to include everything.
     If there are any ``include`` statements, nothing else is included.
     The ``exclude`` directive causes files or directories to
     be omitted. The ``rename`` directive renames a file or directory if
     it is converted. To rename from a subdirectory into the root of
     the repository, use ``.`` as the path to rename to.
 
     ``--full`` will make sure the converted changesets contain exactly
     the right files with the right content. It will make a full
     conversion of all files, not just the ones that have
     changed. Files that already are correct will not be changed. This
     can be used to apply filemap changes when converting
     incrementally. This is currently only supported for Mercurial and
     Subversion.
 
     The splicemap is a file that allows insertion of synthetic
     history, letting you specify the parents of a revision. This is
     useful if you want to e.g. give a Subversion merge two parents, or
     graft two disconnected series of history together. Each entry
     contains a key, followed by a space, followed by one or two
     comma-separated values::
 
       key parent1, parent2
 
     The key is the revision ID in the source
     revision control system whose parents should be modified (same
     format as a key in .hg/shamap). The values are the revision IDs
     (in either the source or destination revision control system) that
     should be used as the new parents for that node. For example, if
     you have merged "release-1.0" into "trunk", then you should
     specify the revision on "trunk" as the first parent and the one on
     the "release-1.0" branch as the second.
 
     The branchmap is a file that allows you to rename a branch when it is
     being brought in from whatever external repository. When used in
     conjunction with a splicemap, it allows for a powerful combination
     to help fix even the most badly mismanaged repositories and turn them
     into nicely structured Mercurial repositories. The branchmap contains
     lines of the form::
 
       original_branch_name new_branch_name
 
     where "original_branch_name" is the name of the branch in the
     source repository, and "new_branch_name" is the name of the branch
     is the destination repository. No whitespace is allowed in the
     branch names. This can be used to (for instance) move code in one
     repository from "default" to a named branch.
 
     Mercurial Source
     ################
 
     The Mercurial source recognizes the following configuration
     options, which you can set on the command line with ``--config``:
 
     :convert.hg.ignoreerrors: ignore integrity errors when reading.
         Use it to fix Mercurial repositories with missing revlogs, by
         converting from and to Mercurial. Default is False.
 
     :convert.hg.saverev: store original revision ID in changeset
         (forces target IDs to change). It takes a boolean argument and
         defaults to False.
 
     :convert.hg.startrev: specify the initial Mercurial revision.
         The default is 0.
 
     :convert.hg.revs: revset specifying the source revisions to convert.
 
     CVS Source
     ##########
 
     CVS source will use a sandbox (i.e. a checked-out copy) from CVS
     to indicate the starting point of what will be converted. Direct
     access to the repository files is not needed, unless of course the
     repository is ``:local:``. The conversion uses the top level
     directory in the sandbox to find the CVS repository, and then uses
     CVS rlog commands to find files to convert. This means that unless
     a filemap is given, all files under the starting directory will be
     converted, and that any directory reorganization in the CVS
     sandbox is ignored.
 
     The following options can be used with ``--config``:
 
     :convert.cvsps.cache: Set to False to disable remote log caching,
         for testing and debugging purposes. Default is True.
 
     :convert.cvsps.fuzz: Specify the maximum time (in seconds) that is
         allowed between commits with identical user and log message in
         a single changeset. When very large files were checked in as
         part of a changeset then the default may not be long enough.
         The default is 60.
 
     :convert.cvsps.mergeto: Specify a regular expression to which
         commit log messages are matched. If a match occurs, then the
         conversion process will insert a dummy revision merging the
         branch on which this log message occurs to the branch
         indicated in the regex. Default is ``{{mergetobranch
         ([-\\w]+)}}``
 
     :convert.cvsps.mergefrom: Specify a regular expression to which
         commit log messages are matched. If a match occurs, then the
         conversion process will add the most recent revision on the
         branch indicated in the regex as the second parent of the
         changeset. Default is ``{{mergefrombranch ([-\\w]+)}}``
 
     :convert.localtimezone: use local time (as determined by the TZ
         environment variable) for changeset date/times. The default
         is False (use UTC).
 
     :hooks.cvslog: Specify a Python function to be called at the end of
         gathering the CVS log. The function is passed a list with the
         log entries, and can modify the entries in-place, or add or
         delete them.
 
     :hooks.cvschangesets: Specify a Python function to be called after
         the changesets are calculated from the CVS log. The
         function is passed a list with the changeset entries, and can
         modify the changesets in-place, or add or delete them.
 
     An additional "debugcvsps" Mercurial command allows the builtin
     changeset merging code to be run without doing a conversion. Its
     parameters and output are similar to that of cvsps 2.1. Please see
     the command help for more details.
 
     Subversion Source
     #################
 
     Subversion source detects classical trunk/branches/tags layouts.
     By default, the supplied ``svn://repo/path/`` source URL is
     converted as a single branch. If ``svn://repo/path/trunk`` exists
     it replaces the default branch. If ``svn://repo/path/branches``
     exists, its subdirectories are listed as possible branches. If
     ``svn://repo/path/tags`` exists, it is looked for tags referencing
     converted branches. Default ``trunk``, ``branches`` and ``tags``
     values can be overridden with following options. Set them to paths
     relative to the source URL, or leave them blank to disable auto
     detection.
 
     The following options can be set with ``--config``:
 
     :convert.svn.branches: specify the directory containing branches.
         The default is ``branches``.
 
     :convert.svn.tags: specify the directory containing tags. The
         default is ``tags``.
 
     :convert.svn.trunk: specify the name of the trunk branch. The
         default is ``trunk``.
 
     :convert.localtimezone: use local time (as determined by the TZ
         environment variable) for changeset date/times. The default
         is False (use UTC).
 
     Source history can be retrieved starting at a specific revision,
     instead of being integrally converted. Only single branch
     conversions are supported.
 
     :convert.svn.startrev: specify start Subversion revision number.
         The default is 0.
 
     Git Source
     ##########
 
     The Git importer converts commits from all reachable branches (refs
     in refs/heads) and remotes (refs in refs/remotes) to Mercurial.
     Branches are converted to bookmarks with the same name, with the
     leading 'refs/heads' stripped. Git submodules are converted to Git
     subrepos in Mercurial.
 
     The following options can be set with ``--config``:
 
     :convert.git.similarity: specify how similar files modified in a
         commit must be to be imported as renames or copies, as a
         percentage between ``0`` (disabled) and ``100`` (files must be
         identical). For example, ``90`` means that a delete/add pair will
         be imported as a rename if more than 90% of the file hasn't
         changed. The default is ``50``.
 
     :convert.git.findcopiesharder: while detecting copies, look at all
         files in the working copy instead of just changed ones. This
         is very expensive for large projects, and is only effective when
         ``convert.git.similarity`` is greater than 0. The default is False.
 
     :convert.git.remoteprefix: remote refs are converted as bookmarks with
         ``convert.git.remoteprefix`` as a prefix followed by a /. The default
         is 'remote'.
 
     Perforce Source
     ###############
 
     The Perforce (P4) importer can be given a p4 depot path or a
     client specification as source. It will convert all files in the
     source to a flat Mercurial repository, ignoring labels, branches
     and integrations. Note that when a depot path is given you then
     usually should specify a target directory, because otherwise the
     target may be named ``...-hg``.
 
-    It is possible to limit the amount of source history to be
-    converted by specifying an initial Perforce revision:
+    The following options can be set with ``--config``:
+
+    :convert.p4.encoding: specify the encoding to use when decoding standard
+        output of the Perforce command line tool. The default is default system
+        encoding.
 
     :convert.p4.startrev: specify initial Perforce revision (a
         Perforce changelist number).
 
     Mercurial Destination
     #####################
 
     The Mercurial destination will recognize Mercurial subrepositories in the
     destination directory, and update the .hgsubstate file automatically if the
     destination subrepositories contain the <dest>/<sub>/.hg/shamap file.
     Converting a repository with subrepositories requires converting a single
     repository at a time, from the bottom up.
 
     .. container:: verbose
 
        An example showing how to convert a repository with subrepositories::
 
          # so convert knows the type when it sees a non empty destination
          $ hg init converted
 
          $ hg convert orig/sub1 converted/sub1
          $ hg convert orig/sub2 converted/sub2
          $ hg convert orig converted
 
     The following options are supported:
 
     :convert.hg.clonebranches: dispatch source branches in separate
         clones. The default is False.
 
     :convert.hg.tagsbranch: branch name for tag revisions, defaults to
         ``default``.
 
     :convert.hg.usebranchnames: preserve branch names. The default is
         True.
 
     :convert.hg.sourcename: records the given string as a 'convert_source' extra
         value on each commit made in the target repository. The default is None.
 
     All Destinations
     ################
 
     All destination types accept the following options:
 
     :convert.skiptags: does not convert tags from the source repo to the target
         repo. The default is False.
     """
     return convcmd.convert(ui, src, dest, revmapfile, **opts)
 
 @command('debugsvnlog', [], 'hg debugsvnlog', norepo=True)
 def debugsvnlog(ui, **opts):
     return subversion.debugsvnlog(ui, **opts)
 
 @command('debugcvsps',
     [
     # Main options shared with cvsps-2.1
     ('b', 'branches', [], _('only return changes on specified branches')),
     ('p', 'prefix', '', _('prefix to remove from file names')),
     ('r', 'revisions', [],
      _('only return changes after or between specified tags')),
     ('u', 'update-cache', None, _("update cvs log cache")),
     ('x', 'new-cache', None, _("create new cvs log cache")),
     ('z', 'fuzz', 60, _('set commit time fuzz in seconds')),
     ('', 'root', '', _('specify cvsroot')),
     # Options specific to builtin cvsps
     ('', 'parents', '', _('show parent changesets')),
     ('', 'ancestors', '', _('show current changeset in ancestor branches')),
     # Options that are ignored for compatibility with cvsps-2.1
     ('A', 'cvs-direct', None, _('ignored for compatibility')),
     ],
     _('hg debugcvsps [OPTION]... [PATH]...'),
     norepo=True)
 def debugcvsps(ui, *args, **opts):
     '''create changeset information from CVS
 
     This command is intended as a debugging tool for the CVS to
     Mercurial converter, and can be used as a direct replacement for
     cvsps.
 
     Hg debugcvsps reads the CVS rlog for current directory (or any
     named directory) in the CVS repository, and converts the log to a
     series of changesets based on matching commit log entries and
     dates.'''
     return cvsps.debugcvsps(ui, *args, **opts)
 
 def kwconverted(ctx, name):
     rev = ctx.extra().get('convert_revision', '')
     if rev.startswith('svn:'):
         if name == 'svnrev':
             return str(subversion.revsplit(rev)[2])
         elif name == 'svnpath':
             return subversion.revsplit(rev)[1]
         elif name == 'svnuuid':
             return subversion.revsplit(rev)[0]
     return rev
 
 def kwsvnrev(repo, ctx, **args):
     """:svnrev: String. Converted subversion revision number."""
     return kwconverted(ctx, 'svnrev')
 
 def kwsvnpath(repo, ctx, **args):
     """:svnpath: String. Converted subversion revision project path."""
     return kwconverted(ctx, 'svnpath')
 
 def kwsvnuuid(repo, ctx, **args):
     """:svnuuid: String. Converted subversion revision repository identifier."""
     return kwconverted(ctx, 'svnuuid')
 
 def extsetup(ui):
     templatekw.keywords['svnrev'] = kwsvnrev
     templatekw.keywords['svnpath'] = kwsvnpath
     templatekw.keywords['svnuuid'] = kwsvnuuid
 
 # tell hggettext to extract docstrings from these functions:
 i18nfunctions = [kwsvnrev, kwsvnpath, kwsvnuuid]

hgext/convert/p4.py

@@ -1,286 +1,290 b''
 # Perforce source for convert extension.
 #
 # Copyright 2009, Frank Kingswood <[e-mail]>
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2 or any later version.
 
 from mercurial import util
 from mercurial.i18n import _
 
 from common import commit, converter_source, checktool, NoRepo
 import marshal
 import re
 
 def loaditer(f):
     "Yield the dictionary objects generated by p4"
     try:
         while True:
             d = marshal.load(f)
             if not d:
                 break
             yield d
     except EOFError:
         pass
 
 def decodefilename(filename):
     """Perforce escapes special characters @, #, *, or %
     with %40, %23, %2A, or %25 respectively
 
     >>> decodefilename('portable-net45%252Bnetcore45%252Bwp8%252BMonoAndroid')
     'portable-net45%2Bnetcore45%2Bwp8%2BMonoAndroid'
     >>> decodefilename('//Depot/Directory/%2525/%2523/%23%40.%2A')
     '//Depot/Directory/%25/%23/#@.*'
     """
     replacements = [('%2A', '*'), ('%23', '#'), ('%40', '@'), ('%25', '%')]
     for k, v in replacements:
         filename = filename.replace(k, v)
     return filename
 
 class p4_source(converter_source):
     def __init__(self, ui, path, revs=None):
+        # avoid import cycle
+        import convcmd
+
         super(p4_source, self).__init__(ui, path, revs=revs)
 
         if "/" in path and not path.startswith('//'):
             raise NoRepo(_('%s does not look like a P4 repository') % path)
 
         checktool('p4', abort=False)
 
         self.p4changes = {}
         self.heads = {}
         self.changeset = {}
         self.files = {}
         self.copies = {}
         self.tags = {}
         self.lastbranch = {}
         self.parent = {}
-        self.encoding = "latin_1"
+        self.encoding = self.ui.config('convert', 'p4.encoding',
+                                       default=convcmd.orig_encoding)
         self.depotname = {}           # mapping from local name to depot name
         self.localname = {} # mapping from depot name to local name
         self.re_type = re.compile(
             "([a-z]+)?(text|binary|symlink|apple|resource|unicode|utf\d+)"
             "(\+\w+)?$")
         self.re_keywords = re.compile(
             r"\$(Id|Header|Date|DateTime|Change|File|Revision|Author)"
             r":[^$\n]*\$")
         self.re_keywords_old = re.compile("\$(Id|Header):[^$\n]*\$")
 
         if revs and len(revs) > 1:
             raise util.Abort(_("p4 source does not support specifying "
                                "multiple revisions"))
         self._parse(ui, path)
 
     def _parse_view(self, path):
         "Read changes affecting the path"
         cmd = 'p4 -G changes -s submitted %s' % util.shellquote(path)
         stdout = util.popen(cmd, mode='rb')
         for d in loaditer(stdout):
             c = d.get("change", None)
             if c:
                 self.p4changes[c] = True
 
     def _parse(self, ui, path):
         "Prepare list of P4 filenames and revisions to import"
         ui.status(_('reading p4 views\n'))
 
         # read client spec or view
         if "/" in path:
             self._parse_view(path)
             if path.startswith("//") and path.endswith("/..."):
                 views = {path[:-3]:""}
             else:
                 views = {"//": ""}
         else:
             cmd = 'p4 -G client -o %s' % util.shellquote(path)
             clientspec = marshal.load(util.popen(cmd, mode='rb'))
 
             views = {}
             for client in clientspec:
                 if client.startswith("View"):
                     sview, cview = clientspec[client].split()
                     self._parse_view(sview)
                     if sview.endswith("...") and cview.endswith("..."):
                         sview = sview[:-3]
                         cview = cview[:-3]
                     cview = cview[2:]
                     cview = cview[cview.find("/") + 1:]
                     views[sview] = cview
 
         # list of changes that affect our source files
         self.p4changes = self.p4changes.keys()
         self.p4changes.sort(key=int)
 
         # list with depot pathnames, longest first
         vieworder = views.keys()
         vieworder.sort(key=len, reverse=True)
 
         # handle revision limiting
         startrev = self.ui.config('convert', 'p4.startrev', default=0)
         self.p4changes = [x for x in self.p4changes
                           if ((not startrev or int(x) >= int(startrev)) and
                               (not self.revs or int(x) <= int(self.revs[0])))]
 
         # now read the full changelists to get the list of file revisions
         ui.status(_('collecting p4 changelists\n'))
         lastid = None
         for change in self.p4changes:
             cmd = "p4 -G describe -s %s" % change
             stdout = util.popen(cmd, mode='rb')
             d = marshal.load(stdout)
             desc = self.recode(d.get("desc", ""))
             shortdesc = desc.split("\n", 1)[0]
             t = '%s %s' % (d["change"], repr(shortdesc)[1:-1])
             ui.status(util.ellipsis(t, 80) + '\n')
 
             if lastid:
                 parents = [lastid]
             else:
                 parents = []
 
             date = (int(d["time"]), 0)     # timezone not set
             c = commit(author=self.recode(d["user"]),
                        date=util.datestr(date, '%Y-%m-%d %H:%M:%S %1%2'),
                        parents=parents, desc=desc, branch=None,
                        extra={"p4": change})
 
             files = []
             copies = {}
             copiedfiles = []
             i = 0
             while ("depotFile%d" % i) in d and ("rev%d" % i) in d:
                 oldname = d["depotFile%d" % i]
                 filename = None
                 for v in vieworder:
                     if oldname.lower().startswith(v.lower()):
                         filename = decodefilename(views[v] + oldname[len(v):])
                         break
                 if filename:
                     files.append((filename, d["rev%d" % i]))
                     self.depotname[filename] = oldname
                     if (d.get("action%d" % i) == "move/add"):
                         copiedfiles.append(filename)
                     self.localname[oldname] = filename
                 i += 1
 
             # Collect information about copied files
             for filename in copiedfiles:
                 oldname = self.depotname[filename]
 
                 flcmd = 'p4 -G filelog %s' \
                       % util.shellquote(oldname)
                 flstdout = util.popen(flcmd, mode='rb')
 
                 copiedfilename = None
                 for d in loaditer(flstdout):
                     copiedoldname = None
 
                     i = 0
                     while ("change%d" % i) in d:
                         if (d["change%d" % i] == change and
                             d["action%d" % i] == "move/add"):
                             j = 0
                             while ("file%d,%d" % (i, j)) in d:
                                 if d["how%d,%d" % (i, j)] == "moved from":
                                     copiedoldname = d["file%d,%d" % (i, j)]
                                     break
                                 j += 1
                         i += 1
 
                     if copiedoldname and copiedoldname in self.localname:
                         copiedfilename = self.localname[copiedoldname]
                         break
 
                 if copiedfilename:
                     copies[filename] = copiedfilename
                 else:
                     ui.warn(_("cannot find source for copied file: %s@%s\n")
                             % (filename, change))
 
             self.changeset[change] = c
             self.files[change] = files
             self.copies[change] = copies
             lastid = change
 
         if lastid:
             self.heads = [lastid]
 
     def getheads(self):
         return self.heads
 
     def getfile(self, name, rev):
         cmd = 'p4 -G print %s' \
             % util.shellquote("%s#%s" % (self.depotname[name], rev))
 
         lasterror = None
         while True:
             stdout = util.popen(cmd, mode='rb')
 
             mode = None
             contents = []
             keywords = None
 
             for d in loaditer(stdout):
                 code = d["code"]
                 data = d.get("data")
 
                 if code == "error":
                     # if this is the first time error happened
                     # re-attempt getting the file
                     if not lasterror:
                         lasterror = IOError(d["generic"], data)
                         # this will exit inner-most for-loop
                         break
                     else:
                         raise lasterror
 
                 elif code == "stat":
                     action = d.get("action")
                     if action in ["purge", "delete", "move/delete"]:
                         return None, None
                     p4type = self.re_type.match(d["type"])
                     if p4type:
                         mode = ""
                         flags = ((p4type.group(1) or "")
                                + (p4type.group(3) or ""))
                         if "x" in flags:
                             mode = "x"
                         if p4type.group(2) == "symlink":
                             mode = "l"
                         if "ko" in flags:
                             keywords = self.re_keywords_old
                         elif "k" in flags:
                             keywords = self.re_keywords
 
                 elif code == "text" or code == "binary":
                     contents.append(data)
 
                 lasterror = None
 
             if not lasterror:
                 break
 
         if mode is None:
             return None, None
 
         contents = ''.join(contents)
 
         if keywords:
             contents = keywords.sub("$\\1$", contents)
         if mode == "l" and contents.endswith("\n"):
             contents = contents[:-1]
 
         return contents, mode
 
     def getchanges(self, rev, full):
         if full:
             raise util.Abort(_("convert from p4 do not support --full"))
         return self.files[rev], self.copies[rev], set()
 
     def getcommit(self, rev):
         return self.changeset[rev]
 
     def gettags(self):
         return self.tags
 
     def getchangedfiles(self, rev, i):
         return sorted([x[0] for x in self.files[rev]])

tests/test-convert.t

@@ -1,529 +1,532 b''
   $ cat >> $HGRCPATH <<EOF
   > [extensions]
   > convert=
   > [convert]
   > hg.saverev=False
   > EOF
   $ hg help convert
   hg convert [OPTION]... SOURCE [DEST [REVMAP]]
   
   convert a foreign SCM repository to a Mercurial one.
   
       Accepted source formats [identifiers]:
   
       - Mercurial [hg]
       - CVS [cvs]
       - Darcs [darcs]
       - git [git]
       - Subversion [svn]
       - Monotone [mtn]
       - GNU Arch [gnuarch]
       - Bazaar [bzr]
       - Perforce [p4]
   
       Accepted destination formats [identifiers]:
   
       - Mercurial [hg]
       - Subversion [svn] (history on branches is not preserved)
   
       If no revision is given, all revisions will be converted. Otherwise,
       convert will only import up to the named revision (given in a format
       understood by the source).
   
       If no destination directory name is specified, it defaults to the basename
       of the source with "-hg" appended. If the destination repository doesn't
       exist, it will be created.
   
       By default, all sources except Mercurial will use --branchsort. Mercurial
       uses --sourcesort to preserve original revision numbers order. Sort modes
       have the following effects:
   
       --branchsort  convert from parent to child revision when possible, which
                     means branches are usually converted one after the other.
                     It generates more compact repositories.
       --datesort    sort revisions by date. Converted repositories have good-
                     looking changelogs but are often an order of magnitude
                     larger than the same ones generated by --branchsort.
       --sourcesort  try to preserve source revisions order, only supported by
                     Mercurial sources.
       --closesort   try to move closed revisions as close as possible to parent
                     branches, only supported by Mercurial sources.
   
       If "REVMAP" isn't given, it will be put in a default location
       ("<dest>/.hg/shamap" by default). The "REVMAP" is a simple text file that
       maps each source commit ID to the destination ID for that revision, like
       so:
   
         <source ID> <destination ID>
   
       If the file doesn't exist, it's automatically created. It's updated on
       each commit copied, so "hg convert" can be interrupted and can be run
       repeatedly to copy new commits.
   
       The authormap is a simple text file that maps each source commit author to
       a destination commit author. It is handy for source SCMs that use unix
       logins to identify authors (e.g.: CVS). One line per author mapping and
       the line format is:
   
         source author = destination author
   
       Empty lines and lines starting with a "#" are ignored.
   
       The filemap is a file that allows filtering and remapping of files and
       directories. Each line can contain one of the following directives:
   
         include path/to/file-or-dir
   
         exclude path/to/file-or-dir
   
         rename path/to/source path/to/destination
   
       Comment lines start with "#". A specified path matches if it equals the
       full relative name of a file or one of its parent directories. The
       "include" or "exclude" directive with the longest matching path applies,
       so line order does not matter.
   
       The "include" directive causes a file, or all files under a directory, to
       be included in the destination repository. The default if there are no
       "include" statements is to include everything. If there are any "include"
       statements, nothing else is included. The "exclude" directive causes files
       or directories to be omitted. The "rename" directive renames a file or
       directory if it is converted. To rename from a subdirectory into the root
       of the repository, use "." as the path to rename to.
   
       "--full" will make sure the converted changesets contain exactly the right
       files with the right content. It will make a full conversion of all files,
       not just the ones that have changed. Files that already are correct will
       not be changed. This can be used to apply filemap changes when converting
       incrementally. This is currently only supported for Mercurial and
       Subversion.
   
       The splicemap is a file that allows insertion of synthetic history,
       letting you specify the parents of a revision. This is useful if you want
       to e.g. give a Subversion merge two parents, or graft two disconnected
       series of history together. Each entry contains a key, followed by a
       space, followed by one or two comma-separated values:
   
         key parent1, parent2
   
       The key is the revision ID in the source revision control system whose
       parents should be modified (same format as a key in .hg/shamap). The
       values are the revision IDs (in either the source or destination revision
       control system) that should be used as the new parents for that node. For
       example, if you have merged "release-1.0" into "trunk", then you should
       specify the revision on "trunk" as the first parent and the one on the
       "release-1.0" branch as the second.
   
       The branchmap is a file that allows you to rename a branch when it is
       being brought in from whatever external repository. When used in
       conjunction with a splicemap, it allows for a powerful combination to help
       fix even the most badly mismanaged repositories and turn them into nicely
       structured Mercurial repositories. The branchmap contains lines of the
       form:
   
         original_branch_name new_branch_name
   
       where "original_branch_name" is the name of the branch in the source
       repository, and "new_branch_name" is the name of the branch is the
       destination repository. No whitespace is allowed in the branch names. This
       can be used to (for instance) move code in one repository from "default"
       to a named branch.
   
       Mercurial Source
       ################
   
       The Mercurial source recognizes the following configuration options, which
       you can set on the command line with "--config":
   
       convert.hg.ignoreerrors
                     ignore integrity errors when reading. Use it to fix
                     Mercurial repositories with missing revlogs, by converting
                     from and to Mercurial. Default is False.
       convert.hg.saverev
                     store original revision ID in changeset (forces target IDs
                     to change). It takes a boolean argument and defaults to
                     False.
       convert.hg.startrev
                     specify the initial Mercurial revision. The default is 0.
       convert.hg.revs
                     revset specifying the source revisions to convert.
   
       CVS Source
       ##########
   
       CVS source will use a sandbox (i.e. a checked-out copy) from CVS to
       indicate the starting point of what will be converted. Direct access to
       the repository files is not needed, unless of course the repository is
       ":local:". The conversion uses the top level directory in the sandbox to
       find the CVS repository, and then uses CVS rlog commands to find files to
       convert. This means that unless a filemap is given, all files under the
       starting directory will be converted, and that any directory
       reorganization in the CVS sandbox is ignored.
   
       The following options can be used with "--config":
   
       convert.cvsps.cache
                     Set to False to disable remote log caching, for testing and
                     debugging purposes. Default is True.
       convert.cvsps.fuzz
                     Specify the maximum time (in seconds) that is allowed
                     between commits with identical user and log message in a
                     single changeset. When very large files were checked in as
                     part of a changeset then the default may not be long enough.
                     The default is 60.
       convert.cvsps.mergeto
                     Specify a regular expression to which commit log messages
                     are matched. If a match occurs, then the conversion process
                     will insert a dummy revision merging the branch on which
                     this log message occurs to the branch indicated in the
                     regex. Default is "{{mergetobranch ([-\w]+)}}"
       convert.cvsps.mergefrom
                     Specify a regular expression to which commit log messages
                     are matched. If a match occurs, then the conversion process
                     will add the most recent revision on the branch indicated in
                     the regex as the second parent of the changeset. Default is
                     "{{mergefrombranch ([-\w]+)}}"
       convert.localtimezone
                     use local time (as determined by the TZ environment
                     variable) for changeset date/times. The default is False
                     (use UTC).
       hooks.cvslog  Specify a Python function to be called at the end of
                     gathering the CVS log. The function is passed a list with
                     the log entries, and can modify the entries in-place, or add
                     or delete them.
       hooks.cvschangesets
                     Specify a Python function to be called after the changesets
                     are calculated from the CVS log. The function is passed a
                     list with the changeset entries, and can modify the
                     changesets in-place, or add or delete them.
   
       An additional "debugcvsps" Mercurial command allows the builtin changeset
       merging code to be run without doing a conversion. Its parameters and
       output are similar to that of cvsps 2.1. Please see the command help for
       more details.
   
       Subversion Source
       #################
   
       Subversion source detects classical trunk/branches/tags layouts. By
       default, the supplied "svn://repo/path/" source URL is converted as a
       single branch. If "svn://repo/path/trunk" exists it replaces the default
       branch. If "svn://repo/path/branches" exists, its subdirectories are
       listed as possible branches. If "svn://repo/path/tags" exists, it is
       looked for tags referencing converted branches. Default "trunk",
       "branches" and "tags" values can be overridden with following options. Set
       them to paths relative to the source URL, or leave them blank to disable
       auto detection.
   
       The following options can be set with "--config":
   
       convert.svn.branches
                     specify the directory containing branches. The default is
                     "branches".
       convert.svn.tags
                     specify the directory containing tags. The default is
                     "tags".
       convert.svn.trunk
                     specify the name of the trunk branch. The default is
                     "trunk".
       convert.localtimezone
                     use local time (as determined by the TZ environment
                     variable) for changeset date/times. The default is False
                     (use UTC).
   
       Source history can be retrieved starting at a specific revision, instead
       of being integrally converted. Only single branch conversions are
       supported.
   
       convert.svn.startrev
                     specify start Subversion revision number. The default is 0.
   
       Git Source
       ##########
   
       The Git importer converts commits from all reachable branches (refs in
       refs/heads) and remotes (refs in refs/remotes) to Mercurial. Branches are
       converted to bookmarks with the same name, with the leading 'refs/heads'
       stripped. Git submodules are converted to Git subrepos in Mercurial.
   
       The following options can be set with "--config":
   
       convert.git.similarity
                     specify how similar files modified in a commit must be to be
                     imported as renames or copies, as a percentage between "0"
                     (disabled) and "100" (files must be identical). For example,
                     "90" means that a delete/add pair will be imported as a
                     rename if more than 90% of the file hasn't changed. The
                     default is "50".
       convert.git.findcopiesharder
                     while detecting copies, look at all files in the working
                     copy instead of just changed ones. This is very expensive
                     for large projects, and is only effective when
                     "convert.git.similarity" is greater than 0. The default is
                     False.
       convert.git.remoteprefix
                     remote refs are converted as bookmarks with
                     "convert.git.remoteprefix" as a prefix followed by a /. The
                     default is 'remote'.
   
       Perforce Source
       ###############
   
       The Perforce (P4) importer can be given a p4 depot path or a client
       specification as source. It will convert all files in the source to a flat
       Mercurial repository, ignoring labels, branches and integrations. Note
       that when a depot path is given you then usually should specify a target
       directory, because otherwise the target may be named "...-hg".
   
-      It is possible to limit the amount of source history to be converted by
-      specifying an initial Perforce revision:
+      The following options can be set with "--config":
   
+      convert.p4.encoding
+                    specify the encoding to use when decoding standard output of
+                    the Perforce command line tool. The default is default
+                    system encoding.
       convert.p4.startrev
                     specify initial Perforce revision (a Perforce changelist
                     number).
   
       Mercurial Destination
       #####################
   
       The Mercurial destination will recognize Mercurial subrepositories in the
       destination directory, and update the .hgsubstate file automatically if
       the destination subrepositories contain the <dest>/<sub>/.hg/shamap file.
       Converting a repository with subrepositories requires converting a single
       repository at a time, from the bottom up.
   
       The following options are supported:
   
       convert.hg.clonebranches
                     dispatch source branches in separate clones. The default is
                     False.
       convert.hg.tagsbranch
                     branch name for tag revisions, defaults to "default".
       convert.hg.usebranchnames
                     preserve branch names. The default is True.
       convert.hg.sourcename
                     records the given string as a 'convert_source' extra value
                     on each commit made in the target repository. The default is
                     None.
   
       All Destinations
       ################
   
       All destination types accept the following options:
   
       convert.skiptags
                     does not convert tags from the source repo to the target
                     repo. The default is False.
   
   options ([+] can be repeated):
   
    -s --source-type TYPE source repository type
    -d --dest-type TYPE   destination repository type
    -r --rev REV [+]      import up to source revision REV
    -A --authormap FILE   remap usernames using this file
       --filemap FILE     remap file names using contents of file
       --full             apply filemap changes by converting all files again
       --splicemap FILE   splice synthesized history into place
       --branchmap FILE   change branch names while converting
       --branchsort       try to sort changesets by branches
       --datesort         try to sort changesets by date
       --sourcesort       preserve source changesets order
       --closesort        try to reorder closed revisions
   
   (some details hidden, use --verbose to show complete help)
   $ hg init a
   $ cd a
   $ echo a > a
   $ hg ci -d'0 0' -Ama
   adding a
   $ hg cp a b
   $ hg ci -d'1 0' -mb
   $ hg rm a
   $ hg ci -d'2 0' -mc
   $ hg mv b a
   $ hg ci -d'3 0' -md
   $ echo a >> a
   $ hg ci -d'4 0' -me
   $ cd ..
   $ hg convert a 2>&1 | grep -v 'subversion python bindings could not be loaded'
   assuming destination a-hg
   initializing destination a-hg repository
   scanning source...
   sorting...
   converting...
   4 a
   3 b
   2 c
   1 d
   0 e
   $ hg --cwd a-hg pull ../a
   pulling from ../a
   searching for changes
   no changes found
 
 conversion to existing file should fail
 
   $ touch bogusfile
   $ hg convert a bogusfile
   initializing destination bogusfile repository
   abort: cannot create new bundle repository
   [255]
 
 #if unix-permissions no-root
 
 conversion to dir without permissions should fail
 
   $ mkdir bogusdir
   $ chmod 000 bogusdir
 
   $ hg convert a bogusdir
   abort: Permission denied: 'bogusdir'
   [255]
 
 user permissions should succeed
 
   $ chmod 700 bogusdir
   $ hg convert a bogusdir
   initializing destination bogusdir repository
   scanning source...
   sorting...
   converting...
   4 a
   3 b
   2 c
   1 d
   0 e
 
 #endif
 
 test pre and post conversion actions
 
   $ echo 'include b' > filemap
   $ hg convert --debug --filemap filemap a partialb | \
   >     grep 'run hg'
   run hg source pre-conversion action
   run hg sink pre-conversion action
   run hg sink post-conversion action
   run hg source post-conversion action
 
 converting empty dir should fail "nicely
 
   $ mkdir emptydir
 
 override $PATH to ensure p4 not visible; use $PYTHON in case we're
 running from a devel copy, not a temp installation
 
   $ PATH="$BINDIR" $PYTHON "$BINDIR"/hg convert emptydir
   assuming destination emptydir-hg
   initializing destination emptydir-hg repository
   emptydir does not look like a CVS checkout
   emptydir does not look like a Git repository
   emptydir does not look like a Subversion repository
   emptydir is not a local Mercurial repository
   emptydir does not look like a darcs repository
   emptydir does not look like a monotone repository
   emptydir does not look like a GNU Arch repository
   emptydir does not look like a Bazaar repository
   cannot find required "p4" tool
   abort: emptydir: missing or unsupported repository
   [255]
 
 convert with imaginary source type
 
   $ hg convert --source-type foo a a-foo
   initializing destination a-foo repository
   abort: foo: invalid source repository type
   [255]
 
 convert with imaginary sink type
 
   $ hg convert --dest-type foo a a-foo
   abort: foo: invalid destination repository type
   [255]
 
 testing: convert must not produce duplicate entries in fncache
 
   $ hg convert a b
   initializing destination b repository
   scanning source...
   sorting...
   converting...
   4 a
   3 b
   2 c
   1 d
   0 e
 
 contents of fncache file:
 
   $ cat b/.hg/store/fncache | sort
   data/a.i
   data/b.i
 
 test bogus URL
 
   $ hg convert -q bzr+ssh://[e-mail]/baz baz
   abort: bzr+ssh://[e-mail]/baz: missing or unsupported repository
   [255]
 
 test revset converted() lookup
 
   $ hg --config convert.hg.saverev=True convert a c
   initializing destination c repository
   scanning source...
   sorting...
   converting...
   4 a
   3 b
   2 c
   1 d
   0 e
   $ echo f > c/f
   $ hg -R c ci -d'0 0' -Amf
   adding f
   created new head
   $ hg -R c log -r "converted(09d945a62ce6)"
   changeset:   1:98c3dd46a874
   user:        test
   date:        Thu Jan 01 00:00:01 1970 +0000
   summary:     b
   
   $ hg -R c log -r "converted()"
   changeset:   0:31ed57b2037c
   user:        test
   date:        Thu Jan 01 00:00:00 1970 +0000
   summary:     a
   
   changeset:   1:98c3dd46a874
   user:        test
   date:        Thu Jan 01 00:00:01 1970 +0000
   summary:     b
   
   changeset:   2:3b9ca06ef716
   user:        test
   date:        Thu Jan 01 00:00:02 1970 +0000
   summary:     c
   
   changeset:   3:4e0debd37cf2
   user:        test
   date:        Thu Jan 01 00:00:03 1970 +0000
   summary:     d
   
   changeset:   4:9de3bc9349c5
   user:        test
   date:        Thu Jan 01 00:00:04 1970 +0000
   summary:     e
   
 
 test specifying a sourcename
   $ echo g > a/g
   $ hg -R a ci -d'0 0' -Amg
   adding g
   $ hg --config convert.hg.sourcename=mysource --config convert.hg.saverev=True convert a c
   scanning source...
   sorting...
   converting...
   0 g
   $ hg -R c log -r tip --template '{extras % "{extra}\n"}'
   branch=default
   convert_revision=a3bc6100aa8ec03e00aaf271f1f50046fb432072
   convert_source=mysource