py3: replace `pycompat.xrange` by `range`

hgext/absorb.py

@@ -1,1165 +1,1165 b''
 # absorb.py
 #
 # Copyright 2016 Facebook, Inc.
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2 or any later version.
 
 """apply working directory changes to changesets (EXPERIMENTAL)
 
 The absorb extension provides a command to use annotate information to
 amend modified chunks into the corresponding non-public changesets.
 
 ::
 
     [absorb]
     # only check 50 recent non-public changesets at most
     max-stack-size = 50
     # whether to add noise to new commits to avoid obsolescence cycle
     add-noise = 1
     # make `amend --correlated` a shortcut to the main command
     amend-flag = correlated
 
     [color]
     absorb.description = yellow
     absorb.node = blue bold
     absorb.path = bold
 """
 
 # TODO:
 #  * Rename config items to [commands] namespace
 #  * Converge getdraftstack() with other code in core
 #  * move many attributes on fixupstate to be private
 
 
 import collections
 
 from mercurial.i18n import _
 from mercurial.node import (
     hex,
     short,
 )
 from mercurial import (
     cmdutil,
     commands,
     context,
     crecord,
     error,
     linelog,
     mdiff,
     obsolete,
     patch,
     phases,
     pycompat,
     registrar,
     rewriteutil,
     scmutil,
     util,
 )
 from mercurial.utils import stringutil
 
 # Note for extension authors: ONLY specify testedwith = 'ships-with-hg-core' 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 = b'ships-with-hg-core'
 
 cmdtable = {}
 command = registrar.command(cmdtable)
 
 configtable = {}
 configitem = registrar.configitem(configtable)
 
 configitem(b'absorb', b'add-noise', default=True)
 configitem(b'absorb', b'amend-flag', default=None)
 configitem(b'absorb', b'max-stack-size', default=50)
 
 colortable = {
     b'absorb.description': b'yellow',
     b'absorb.node': b'blue bold',
     b'absorb.path': b'bold',
 }
 
 defaultdict = collections.defaultdict
 
 
 class nullui:
     """blank ui object doing nothing"""
 
     debugflag = False
     verbose = False
     quiet = True
 
     def __getitem__(name):
         def nullfunc(*args, **kwds):
             return
 
         return nullfunc
 
 
 class emptyfilecontext:
     """minimal filecontext representing an empty file"""
 
     def __init__(self, repo):
         self._repo = repo
 
     def data(self):
         return b''
 
     def node(self):
         return self._repo.nullid
 
 
 def uniq(lst):
     """list -> list. remove duplicated items without changing the order"""
     seen = set()
     result = []
     for x in lst:
         if x not in seen:
             seen.add(x)
             result.append(x)
     return result
 
 
 def getdraftstack(headctx, limit=None):
     """(ctx, int?) -> [ctx]. get a linear stack of non-public changesets.
 
     changesets are sorted in topo order, oldest first.
     return at most limit items, if limit is a positive number.
 
     merges are considered as non-draft as well. i.e. every commit
     returned has and only has 1 parent.
     """
     ctx = headctx
     result = []
     while ctx.phase() != phases.public:
         if limit and len(result) >= limit:
             break
         parents = ctx.parents()
         if len(parents) != 1:
             break
         result.append(ctx)
         ctx = parents[0]
     result.reverse()
     return result
 
 
 def getfilestack(stack, path, seenfctxs=None):
     """([ctx], str, set) -> [fctx], {ctx: fctx}
 
     stack is a list of contexts, from old to new. usually they are what
     "getdraftstack" returns.
 
     follows renames, but not copies.
 
     seenfctxs is a set of filecontexts that will be considered "immutable".
     they are usually what this function returned in earlier calls, useful
     to avoid issues that a file was "moved" to multiple places and was then
     modified differently, like: "a" was copied to "b", "a" was also copied to
     "c" and then "a" was deleted, then both "b" and "c" were "moved" from "a"
     and we enforce only one of them to be able to affect "a"'s content.
 
     return an empty list and an empty dict, if the specified path does not
     exist in stack[-1] (the top of the stack).
 
     otherwise, return a list of de-duplicated filecontexts, and the map to
     convert ctx in the stack to fctx, for possible mutable fctxs. the first item
     of the list would be outside the stack and should be considered immutable.
     the remaining items are within the stack.
 
     for example, given the following changelog and corresponding filelog
     revisions:
 
       changelog: 3----4----5----6----7
       filelog:   x    0----1----1----2 (x: no such file yet)
 
     - if stack = [5, 6, 7], returns ([0, 1, 2], {5: 1, 6: 1, 7: 2})
     - if stack = [3, 4, 5], returns ([e, 0, 1], {4: 0, 5: 1}), where "e" is a
       dummy empty filecontext.
     - if stack = [2], returns ([], {})
     - if stack = [7], returns ([1, 2], {7: 2})
     - if stack = [6, 7], returns ([1, 2], {6: 1, 7: 2}), although {6: 1} can be
       removed, since 1 is immutable.
     """
     if seenfctxs is None:
         seenfctxs = set()
     assert stack
 
     if path not in stack[-1]:
         return [], {}
 
     fctxs = []
     fctxmap = {}
 
     pctx = stack[0].p1()  # the public (immutable) ctx we stop at
     for ctx in reversed(stack):
         if path not in ctx:  # the file is added in the next commit
             pctx = ctx
             break
         fctx = ctx[path]
         fctxs.append(fctx)
         if fctx in seenfctxs:  # treat fctx as the immutable one
             pctx = None  # do not add another immutable fctx
             break
         fctxmap[ctx] = fctx  # only for mutable fctxs
         copy = fctx.copysource()
         if copy:
             path = copy  # follow rename
             if path in ctx:  # but do not follow copy
                 pctx = ctx.p1()
                 break
 
     if pctx is not None:  # need an extra immutable fctx
         if path in pctx:
             fctxs.append(pctx[path])
         else:
             fctxs.append(emptyfilecontext(pctx.repo()))
 
     fctxs.reverse()
     # note: we rely on a property of hg: filerev is not reused for linear
     # history. i.e. it's impossible to have:
     #   changelog:  4----5----6 (linear, no merges)
     #   filelog:    1----2----1
     #                         ^ reuse filerev (impossible)
     # because parents are part of the hash. if that's not true, we need to
     # remove uniq and find a different way to identify fctxs.
     return uniq(fctxs), fctxmap
 
 
 class overlaystore(patch.filestore):
     """read-only, hybrid store based on a dict and ctx.
     memworkingcopy: {path: content}, overrides file contents.
     """
 
     def __init__(self, basectx, memworkingcopy):
         self.basectx = basectx
         self.memworkingcopy = memworkingcopy
 
     def getfile(self, path):
         """comply with mercurial.patch.filestore.getfile"""
         if path not in self.basectx:
             return None, None, None
         fctx = self.basectx[path]
         if path in self.memworkingcopy:
             content = self.memworkingcopy[path]
         else:
             content = fctx.data()
         mode = (fctx.islink(), fctx.isexec())
         copy = fctx.copysource()
         return content, mode, copy
 
 
 def overlaycontext(memworkingcopy, ctx, parents=None, extra=None, desc=None):
     """({path: content}, ctx, (p1node, p2node)?, {}?) -> memctx
     memworkingcopy overrides file contents.
     """
     # parents must contain 2 items: (node1, node2)
     if parents is None:
         parents = ctx.repo().changelog.parents(ctx.node())
     if extra is None:
         extra = ctx.extra()
     if desc is None:
         desc = ctx.description()
     date = ctx.date()
     user = ctx.user()
     files = set(ctx.files()).union(memworkingcopy)
     store = overlaystore(ctx, memworkingcopy)
     return context.memctx(
         repo=ctx.repo(),
         parents=parents,
         text=desc,
         files=files,
         filectxfn=store,
         user=user,
         date=date,
         branch=None,
         extra=extra,
     )
 
 
 class filefixupstate:
     """state needed to apply fixups to a single file
 
     internally, it keeps file contents of several revisions and a linelog.
 
     the linelog uses odd revision numbers for original contents (fctxs passed
     to __init__), and even revision numbers for fixups, like:
 
         linelog rev 1: self.fctxs[0] (from an immutable "public" changeset)
         linelog rev 2: fixups made to self.fctxs[0]
         linelog rev 3: self.fctxs[1] (a child of fctxs[0])
         linelog rev 4: fixups made to self.fctxs[1]
         ...
 
     a typical use is like:
 
         1. call diffwith, to calculate self.fixups
         2. (optionally), present self.fixups to the user, or change it
         3. call apply, to apply changes
         4. read results from "finalcontents", or call getfinalcontent
     """
 
     def __init__(self, fctxs, path, ui=None, opts=None):
         """([fctx], ui or None) -> None
 
         fctxs should be linear, and sorted by topo order - oldest first.
         fctxs[0] will be considered as "immutable" and will not be changed.
         """
         self.fctxs = fctxs
         self.path = path
         self.ui = ui or nullui()
         self.opts = opts or {}
 
         # following fields are built from fctxs. they exist for perf reason
         self.contents = [f.data() for f in fctxs]
         self.contentlines = pycompat.maplist(mdiff.splitnewlines, self.contents)
         self.linelog = self._buildlinelog()
         if self.ui.debugflag:
             assert self._checkoutlinelog() == self.contents
 
         # following fields will be filled later
         self.chunkstats = [0, 0]  # [adopted, total : int]
         self.targetlines = []  # [str]
         self.fixups = []  # [(linelog rev, a1, a2, b1, b2)]
         self.finalcontents = []  # [str]
         self.ctxaffected = set()
 
     def diffwith(self, targetfctx, fm=None):
         """calculate fixups needed by examining the differences between
         self.fctxs[-1] and targetfctx, chunk by chunk.
 
         targetfctx is the target state we move towards. we may or may not be
         able to get there because not all modified chunks can be amended into
         a non-public fctx unambiguously.
 
         call this only once, before apply().
 
         update self.fixups, self.chunkstats, and self.targetlines.
         """
         a = self.contents[-1]
         alines = self.contentlines[-1]
         b = targetfctx.data()
         blines = mdiff.splitnewlines(b)
         self.targetlines = blines
 
         self.linelog.annotate(self.linelog.maxrev)
         annotated = self.linelog.annotateresult  # [(linelog rev, linenum)]
         assert len(annotated) == len(alines)
         # add a dummy end line to make insertion at the end easier
         if annotated:
             dummyendline = (annotated[-1][0], annotated[-1][1] + 1)
             annotated.append(dummyendline)
 
         # analyse diff blocks
         for chunk in self._alldiffchunks(a, b, alines, blines):
             newfixups = self._analysediffchunk(chunk, annotated)
             self.chunkstats[0] += bool(newfixups)  # 1 or 0
             self.chunkstats[1] += 1
             self.fixups += newfixups
             if fm is not None:
                 self._showchanges(fm, alines, blines, chunk, newfixups)
 
     def apply(self):
         """apply self.fixups. update self.linelog, self.finalcontents.
 
         call this only once, before getfinalcontent(), after diffwith().
         """
         # the following is unnecessary, as it's done by "diffwith":
         #   self.linelog.annotate(self.linelog.maxrev)
         for rev, a1, a2, b1, b2 in reversed(self.fixups):
             blines = self.targetlines[b1:b2]
             if self.ui.debugflag:
                 idx = (max(rev - 1, 0)) // 2
                 self.ui.write(
                     _(b'%s: chunk %d:%d -> %d lines\n')
                     % (short(self.fctxs[idx].node()), a1, a2, len(blines))
                 )
             self.linelog.replacelines(rev, a1, a2, b1, b2)
         if self.opts.get(b'edit_lines', False):
             self.finalcontents = self._checkoutlinelogwithedits()
         else:
             self.finalcontents = self._checkoutlinelog()
 
     def getfinalcontent(self, fctx):
         """(fctx) -> str. get modified file content for a given filecontext"""
         idx = self.fctxs.index(fctx)
         return self.finalcontents[idx]
 
     def _analysediffchunk(self, chunk, annotated):
         """analyse a different chunk and return new fixups found
 
         return [] if no lines from the chunk can be safely applied.
 
         the chunk (or lines) cannot be safely applied, if, for example:
           - the modified (deleted) lines belong to a public changeset
             (self.fctxs[0])
           - the chunk is a pure insertion and the adjacent lines (at most 2
             lines) belong to different non-public changesets, or do not belong
             to any non-public changesets.
           - the chunk is modifying lines from different changesets.
             in this case, if the number of lines deleted equals to the number
             of lines added, assume it's a simple 1:1 map (could be wrong).
             otherwise, give up.
           - the chunk is modifying lines from a single non-public changeset,
             but other revisions touch the area as well. i.e. the lines are
             not continuous as seen from the linelog.
         """
         a1, a2, b1, b2 = chunk
         # find involved indexes from annotate result
         involved = annotated[a1:a2]
         if not involved and annotated:  # a1 == a2 and a is not empty
             # pure insertion, check nearby lines. ignore lines belong
             # to the public (first) changeset (i.e. annotated[i][0] == 1)
             nearbylinenums = {a2, max(0, a1 - 1)}
             involved = [
                 annotated[i] for i in nearbylinenums if annotated[i][0] != 1
             ]
         involvedrevs = list({r for r, l in involved})
         newfixups = []
         if len(involvedrevs) == 1 and self._iscontinuous(a1, a2 - 1, True):
             # chunk belongs to a single revision
             rev = involvedrevs[0]
             if rev > 1:
                 fixuprev = rev + 1
                 newfixups.append((fixuprev, a1, a2, b1, b2))
         elif a2 - a1 == b2 - b1 or b1 == b2:
             # 1:1 line mapping, or chunk was deleted
-            for i in pycompat.xrange(a1, a2):
+            for i in range(a1, a2):
                 rev, linenum = annotated[i]
                 if rev > 1:
                     if b1 == b2:  # deletion, simply remove that single line
                         nb1 = nb2 = 0
                     else:  # 1:1 line mapping, change the corresponding rev
                         nb1 = b1 + i - a1
                         nb2 = nb1 + 1
                     fixuprev = rev + 1
                     newfixups.append((fixuprev, i, i + 1, nb1, nb2))
         return self._optimizefixups(newfixups)
 
     @staticmethod
     def _alldiffchunks(a, b, alines, blines):
         """like mdiff.allblocks, but only care about differences"""
         blocks = mdiff.allblocks(a, b, lines1=alines, lines2=blines)
         for chunk, btype in blocks:
             if btype != b'!':
                 continue
             yield chunk
 
     def _buildlinelog(self):
         """calculate the initial linelog based on self.content{,line}s.
         this is similar to running a partial "annotate".
         """
         llog = linelog.linelog()
         a, alines = b'', []
-        for i in pycompat.xrange(len(self.contents)):
+        for i in range(len(self.contents)):
             b, blines = self.contents[i], self.contentlines[i]
             llrev = i * 2 + 1
             chunks = self._alldiffchunks(a, b, alines, blines)
             for a1, a2, b1, b2 in reversed(list(chunks)):
                 llog.replacelines(llrev, a1, a2, b1, b2)
             a, alines = b, blines
         return llog
 
     def _checkoutlinelog(self):
         """() -> [str]. check out file contents from linelog"""
         contents = []
-        for i in pycompat.xrange(len(self.contents)):
+        for i in range(len(self.contents)):
             rev = (i + 1) * 2
             self.linelog.annotate(rev)
             content = b''.join(map(self._getline, self.linelog.annotateresult))
             contents.append(content)
         return contents
 
     def _checkoutlinelogwithedits(self):
         """() -> [str]. prompt all lines for edit"""
         alllines = self.linelog.getalllines()
         # header
         editortext = (
             _(
                 b'HG: editing %s\nHG: "y" means the line to the right '
                 b'exists in the changeset to the top\nHG:\n'
             )
             % self.fctxs[-1].path()
         )
         # [(idx, fctx)]. hide the dummy emptyfilecontext
         visiblefctxs = [
             (i, f)
             for i, f in enumerate(self.fctxs)
             if not isinstance(f, emptyfilecontext)
         ]
         for i, (j, f) in enumerate(visiblefctxs):
             editortext += _(b'HG: %s/%s %s %s\n') % (
                 b'|' * i,
                 b'-' * (len(visiblefctxs) - i + 1),
                 short(f.node()),
                 f.description().split(b'\n', 1)[0],
             )
         editortext += _(b'HG: %s\n') % (b'|' * len(visiblefctxs))
         # figure out the lifetime of a line, this is relatively inefficient,
         # but probably fine
         lineset = defaultdict(lambda: set())  # {(llrev, linenum): {llrev}}
         for i, f in visiblefctxs:
             self.linelog.annotate((i + 1) * 2)
             for l in self.linelog.annotateresult:
                 lineset[l].add(i)
         # append lines
         for l in alllines:
             editortext += b'    %s : %s' % (
                 b''.join(
                     [
                         (b'y' if i in lineset[l] else b' ')
                         for i, _f in visiblefctxs
                     ]
                 ),
                 self._getline(l),
             )
         # run editor
         editedtext = self.ui.edit(editortext, b'', action=b'absorb')
         if not editedtext:
             raise error.InputError(_(b'empty editor text'))
         # parse edited result
         contents = [b''] * len(self.fctxs)
         leftpadpos = 4
         colonpos = leftpadpos + len(visiblefctxs) + 1
         for l in mdiff.splitnewlines(editedtext):
             if l.startswith(b'HG:'):
                 continue
             if l[colonpos - 1 : colonpos + 2] != b' : ':
                 raise error.InputError(_(b'malformed line: %s') % l)
             linecontent = l[colonpos + 2 :]
             for i, ch in enumerate(
                 pycompat.bytestr(l[leftpadpos : colonpos - 1])
             ):
                 if ch == b'y':
                     contents[visiblefctxs[i][0]] += linecontent
         # chunkstats is hard to calculate if anything changes, therefore
         # set them to just a simple value (1, 1).
         if editedtext != editortext:
             self.chunkstats = [1, 1]
         return contents
 
     def _getline(self, lineinfo):
         """((rev, linenum)) -> str. convert rev+line number to line content"""
         rev, linenum = lineinfo
         if rev & 1:  # odd: original line taken from fctxs
             return self.contentlines[rev // 2][linenum]
         else:  # even: fixup line from targetfctx
             return self.targetlines[linenum]
 
     def _iscontinuous(self, a1, a2, closedinterval=False):
         """(a1, a2 : int) -> bool
 
         check if these lines are continuous. i.e. no other insertions or
         deletions (from other revisions) among these lines.
 
         closedinterval decides whether a2 should be included or not. i.e. is
         it [a1, a2), or [a1, a2] ?
         """
         if a1 >= a2:
             return True
         llog = self.linelog
         offset1 = llog.getoffset(a1)
         offset2 = llog.getoffset(a2) + int(closedinterval)
         linesinbetween = llog.getalllines(offset1, offset2)
         return len(linesinbetween) == a2 - a1 + int(closedinterval)
 
     def _optimizefixups(self, fixups):
         """[(rev, a1, a2, b1, b2)] -> [(rev, a1, a2, b1, b2)].
         merge adjacent fixups to make them less fragmented.
         """
         result = []
         pcurrentchunk = [[-1, -1, -1, -1, -1]]
 
         def pushchunk():
             if pcurrentchunk[0][0] != -1:
                 result.append(tuple(pcurrentchunk[0]))
 
         for i, chunk in enumerate(fixups):
             rev, a1, a2, b1, b2 = chunk
             lastrev = pcurrentchunk[0][0]
             lasta2 = pcurrentchunk[0][2]
             lastb2 = pcurrentchunk[0][4]
             if (
                 a1 == lasta2
                 and b1 == lastb2
                 and rev == lastrev
                 and self._iscontinuous(max(a1 - 1, 0), a1)
             ):
                 # merge into currentchunk
                 pcurrentchunk[0][2] = a2
                 pcurrentchunk[0][4] = b2
             else:
                 pushchunk()
                 pcurrentchunk[0] = list(chunk)
         pushchunk()
         return result
 
     def _showchanges(self, fm, alines, blines, chunk, fixups):
         def trim(line):
             if line.endswith(b'\n'):
                 line = line[:-1]
             return line
 
         # this is not optimized for perf but _showchanges only gets executed
         # with an extra command-line flag.
         a1, a2, b1, b2 = chunk
         aidxs, bidxs = [0] * (a2 - a1), [0] * (b2 - b1)
         for idx, fa1, fa2, fb1, fb2 in fixups:
-            for i in pycompat.xrange(fa1, fa2):
+            for i in range(fa1, fa2):
                 aidxs[i - a1] = (max(idx, 1) - 1) // 2
-            for i in pycompat.xrange(fb1, fb2):
+            for i in range(fb1, fb2):
                 bidxs[i - b1] = (max(idx, 1) - 1) // 2
 
         fm.startitem()
         fm.write(
             b'hunk',
             b'        %s\n',
             b'@@ -%d,%d +%d,%d @@' % (a1, a2 - a1, b1, b2 - b1),
             label=b'diff.hunk',
         )
         fm.data(path=self.path, linetype=b'hunk')
 
         def writeline(idx, diffchar, line, linetype, linelabel):
             fm.startitem()
             node = b''
             if idx:
                 ctx = self.fctxs[idx]
                 fm.context(fctx=ctx)
                 node = ctx.hex()
                 self.ctxaffected.add(ctx.changectx())
             fm.write(b'node', b'%-7.7s ', node, label=b'absorb.node')
             fm.write(
                 b'diffchar ' + linetype,
                 b'%s%s\n',
                 diffchar,
                 line,
                 label=linelabel,
             )
             fm.data(path=self.path, linetype=linetype)
 
-        for i in pycompat.xrange(a1, a2):
+        for i in range(a1, a2):
             writeline(
                 aidxs[i - a1],
                 b'-',
                 trim(alines[i]),
                 b'deleted',
                 b'diff.deleted',
             )
-        for i in pycompat.xrange(b1, b2):
+        for i in range(b1, b2):
             writeline(
                 bidxs[i - b1],
                 b'+',
                 trim(blines[i]),
                 b'inserted',
                 b'diff.inserted',
             )
 
 
 class fixupstate:
     """state needed to run absorb
 
     internally, it keeps paths and filefixupstates.
 
     a typical use is like filefixupstates:
 
         1. call diffwith, to calculate fixups
         2. (optionally), present fixups to the user, or edit fixups
         3. call apply, to apply changes to memory
         4. call commit, to commit changes to hg database
     """
 
     def __init__(self, stack, ui=None, opts=None):
         """([ctx], ui or None) -> None
 
         stack: should be linear, and sorted by topo order - oldest first.
         all commits in stack are considered mutable.
         """
         assert stack
         self.ui = ui or nullui()
         self.opts = opts or {}
         self.stack = stack
         self.repo = stack[-1].repo().unfiltered()
 
         # following fields will be filled later
         self.paths = []  # [str]
         self.status = None  # ctx.status output
         self.fctxmap = {}  # {path: {ctx: fctx}}
         self.fixupmap = {}  # {path: filefixupstate}
         self.replacemap = {}  # {oldnode: newnode or None}
         self.finalnode = None  # head after all fixups
         self.ctxaffected = set()  # ctx that will be absorbed into
 
     def diffwith(self, targetctx, match=None, fm=None):
         """diff and prepare fixups. update self.fixupmap, self.paths"""
         # only care about modified files
         self.status = self.stack[-1].status(targetctx, match)
         self.paths = []
         # but if --edit-lines is used, the user may want to edit files
         # even if they are not modified
         editopt = self.opts.get(b'edit_lines')
         if not self.status.modified and editopt and match:
             interestingpaths = match.files()
         else:
             interestingpaths = self.status.modified
         # prepare the filefixupstate
         seenfctxs = set()
         # sorting is necessary to eliminate ambiguity for the "double move"
         # case: "hg cp A B; hg cp A C; hg rm A", then only "B" can affect "A".
         for path in sorted(interestingpaths):
             self.ui.debug(b'calculating fixups for %s\n' % path)
             targetfctx = targetctx[path]
             fctxs, ctx2fctx = getfilestack(self.stack, path, seenfctxs)
             # ignore symbolic links or binary, or unchanged files
             if any(
                 f.islink() or stringutil.binary(f.data())
                 for f in [targetfctx] + fctxs
                 if not isinstance(f, emptyfilecontext)
             ):
                 continue
             if targetfctx.data() == fctxs[-1].data() and not editopt:
                 continue
             seenfctxs.update(fctxs[1:])
             self.fctxmap[path] = ctx2fctx
             fstate = filefixupstate(fctxs, path, ui=self.ui, opts=self.opts)
             if fm is not None:
                 fm.startitem()
                 fm.plain(b'showing changes for ')
                 fm.write(b'path', b'%s\n', path, label=b'absorb.path')
                 fm.data(linetype=b'path')
             fstate.diffwith(targetfctx, fm)
             self.fixupmap[path] = fstate
             self.paths.append(path)
             self.ctxaffected.update(fstate.ctxaffected)
 
     def apply(self):
         """apply fixups to individual filefixupstates"""
         for path, state in self.fixupmap.items():
             if self.ui.debugflag:
                 self.ui.write(_(b'applying fixups to %s\n') % path)
             state.apply()
 
     @property
     def chunkstats(self):
         """-> {path: chunkstats}. collect chunkstats from filefixupstates"""
         return {path: state.chunkstats for path, state in self.fixupmap.items()}
 
     def commit(self):
         """commit changes. update self.finalnode, self.replacemap"""
         with self.repo.transaction(b'absorb') as tr:
             self._commitstack()
             self._movebookmarks(tr)
             if self.repo[b'.'].node() in self.replacemap:
                 self._moveworkingdirectoryparent()
             self._cleanupoldcommits()
         return self.finalnode
 
     def printchunkstats(self):
         """print things like '1 of 2 chunk(s) applied'"""
         ui = self.ui
         chunkstats = self.chunkstats
         if ui.verbose:
             # chunkstats for each file
             for path, stat in chunkstats.items():
                 if stat[0]:
                     ui.write(
                         _(b'%s: %d of %d chunk(s) applied\n')
                         % (path, stat[0], stat[1])
                     )
         elif not ui.quiet:
             # a summary for all files
             stats = chunkstats.values()
             applied, total = (sum(s[i] for s in stats) for i in (0, 1))
             ui.write(_(b'%d of %d chunk(s) applied\n') % (applied, total))
 
     def _commitstack(self):
         """make new commits. update self.finalnode, self.replacemap.
         it is splitted from "commit" to avoid too much indentation.
         """
         # last node (20-char) committed by us
         lastcommitted = None
         # p1 which overrides the parent of the next commit, "None" means use
         # the original parent unchanged
         nextp1 = None
         for ctx in self.stack:
             memworkingcopy = self._getnewfilecontents(ctx)
             if not memworkingcopy and not lastcommitted:
                 # nothing changed, nothing commited
                 nextp1 = ctx
                 continue
             willbecomenoop = ctx.files() and self._willbecomenoop(
                 memworkingcopy, ctx, nextp1
             )
             if self.skip_empty_successor and willbecomenoop:
                 # changeset is no longer necessary
                 self.replacemap[ctx.node()] = None
                 msg = _(b'became empty and was dropped')
             else:
                 # changeset needs re-commit
                 nodestr = self._commitsingle(memworkingcopy, ctx, p1=nextp1)
                 lastcommitted = self.repo[nodestr]
                 nextp1 = lastcommitted
                 self.replacemap[ctx.node()] = lastcommitted.node()
                 if memworkingcopy:
                     if willbecomenoop:
                         msg = _(b'%d file(s) changed, became empty as %s')
                     else:
                         msg = _(b'%d file(s) changed, became %s')
                     msg = msg % (
                         len(memworkingcopy),
                         self._ctx2str(lastcommitted),
                     )
                 else:
                     msg = _(b'became %s') % self._ctx2str(lastcommitted)
             if self.ui.verbose and msg:
                 self.ui.write(_(b'%s: %s\n') % (self._ctx2str(ctx), msg))
         self.finalnode = lastcommitted and lastcommitted.node()
 
     def _ctx2str(self, ctx):
         if self.ui.debugflag:
             return b'%d:%s' % (ctx.rev(), ctx.hex())
         else:
             return b'%d:%s' % (ctx.rev(), short(ctx.node()))
 
     def _getnewfilecontents(self, ctx):
         """(ctx) -> {path: str}
 
         fetch file contents from filefixupstates.
         return the working copy overrides - files different from ctx.
         """
         result = {}
         for path in self.paths:
             ctx2fctx = self.fctxmap[path]  # {ctx: fctx}
             if ctx not in ctx2fctx:
                 continue
             fctx = ctx2fctx[ctx]
             content = fctx.data()
             newcontent = self.fixupmap[path].getfinalcontent(fctx)
             if content != newcontent:
                 result[fctx.path()] = newcontent
         return result
 
     def _movebookmarks(self, tr):
         repo = self.repo
         needupdate = [
             (name, self.replacemap[hsh])
             for name, hsh in repo._bookmarks.items()
             if hsh in self.replacemap
         ]
         changes = []
         for name, hsh in needupdate:
             if hsh:
                 changes.append((name, hsh))
                 if self.ui.verbose:
                     self.ui.write(
                         _(b'moving bookmark %s to %s\n') % (name, hex(hsh))
                     )
             else:
                 changes.append((name, None))
                 if self.ui.verbose:
                     self.ui.write(_(b'deleting bookmark %s\n') % name)
         repo._bookmarks.applychanges(repo, tr, changes)
 
     def _moveworkingdirectoryparent(self):
         if not self.finalnode:
             # Find the latest not-{obsoleted,stripped} parent.
             revs = self.repo.revs(b'max(::. - %ln)', self.replacemap.keys())
             ctx = self.repo[revs.first()]
             self.finalnode = ctx.node()
         else:
             ctx = self.repo[self.finalnode]
 
         dirstate = self.repo.dirstate
         # dirstate.rebuild invalidates fsmonitorstate, causing "hg status" to
         # be slow. in absorb's case, no need to invalidate fsmonitorstate.
         noop = lambda: 0
         restore = noop
         if util.safehasattr(dirstate, '_fsmonitorstate'):
             bak = dirstate._fsmonitorstate.invalidate
 
             def restore():
                 dirstate._fsmonitorstate.invalidate = bak
 
             dirstate._fsmonitorstate.invalidate = noop
         try:
             with dirstate.parentchange():
                 dirstate.rebuild(ctx.node(), ctx.manifest(), self.paths)
         finally:
             restore()
 
     @staticmethod
     def _willbecomenoop(memworkingcopy, ctx, pctx=None):
         """({path: content}, ctx, ctx) -> bool. test if a commit will be noop
 
         if it will become an empty commit (does not change anything, after the
         memworkingcopy overrides), return True. otherwise return False.
         """
         if not pctx:
             parents = ctx.parents()
             if len(parents) != 1:
                 return False
             pctx = parents[0]
         if ctx.branch() != pctx.branch():
             return False
         if ctx.extra().get(b'close'):
             return False
         # ctx changes more files (not a subset of memworkingcopy)
         if not set(ctx.files()).issubset(set(memworkingcopy)):
             return False
         for path, content in memworkingcopy.items():
             if path not in pctx or path not in ctx:
                 return False
             fctx = ctx[path]
             pfctx = pctx[path]
             if pfctx.flags() != fctx.flags():
                 return False
             if pfctx.data() != content:
                 return False
         return True
 
     def _commitsingle(self, memworkingcopy, ctx, p1=None):
         """(ctx, {path: content}, node) -> node. make a single commit
 
         the commit is a clone from ctx, with a (optionally) different p1, and
         different file contents replaced by memworkingcopy.
         """
         parents = p1 and (p1, self.repo.nullid)
         extra = ctx.extra()
         if self._useobsolete and self.ui.configbool(b'absorb', b'add-noise'):
             extra[b'absorb_source'] = ctx.hex()
 
         desc = rewriteutil.update_hash_refs(
             ctx.repo(),
             ctx.description(),
             {
                 oldnode: [newnode]
                 for oldnode, newnode in self.replacemap.items()
             },
         )
         mctx = overlaycontext(
             memworkingcopy, ctx, parents, extra=extra, desc=desc
         )
         return mctx.commit()
 
     @util.propertycache
     def _useobsolete(self):
         """() -> bool"""
         return obsolete.isenabled(self.repo, obsolete.createmarkersopt)
 
     def _cleanupoldcommits(self):
         replacements = {
             k: ([v] if v is not None else [])
             for k, v in self.replacemap.items()
         }
         if replacements:
             scmutil.cleanupnodes(
                 self.repo, replacements, operation=b'absorb', fixphase=True
             )
 
     @util.propertycache
     def skip_empty_successor(self):
         return rewriteutil.skip_empty_successor(self.ui, b'absorb')
 
 
 def _parsechunk(hunk):
     """(crecord.uihunk or patch.recordhunk) -> (path, (a1, a2, [bline]))"""
     if type(hunk) not in (crecord.uihunk, patch.recordhunk):
         return None, None
     path = hunk.header.filename()
     a1 = hunk.fromline + len(hunk.before) - 1
     # remove before and after context
     hunk.before = hunk.after = []
     buf = util.stringio()
     hunk.write(buf)
     patchlines = mdiff.splitnewlines(buf.getvalue())
     # hunk.prettystr() will update hunk.removed
     a2 = a1 + hunk.removed
     blines = [l[1:] for l in patchlines[1:] if not l.startswith(b'-')]
     return path, (a1, a2, blines)
 
 
 def overlaydiffcontext(ctx, chunks):
     """(ctx, [crecord.uihunk]) -> memctx
 
     return a memctx with some [1] patches (chunks) applied to ctx.
     [1]: modifications are handled. renames, mode changes, etc. are ignored.
     """
     # sadly the applying-patch logic is hardly reusable, and messy:
     # 1. the core logic "_applydiff" is too heavy - it writes .rej files, it
     #    needs a file stream of a patch and will re-parse it, while we have
     #    structured hunk objects at hand.
     # 2. a lot of different implementations about "chunk" (patch.hunk,
     #    patch.recordhunk, crecord.uihunk)
     # as we only care about applying changes to modified files, no mode
     # change, no binary diff, and no renames, it's probably okay to
     # re-invent the logic using much simpler code here.
     memworkingcopy = {}  # {path: content}
     patchmap = defaultdict(lambda: [])  # {path: [(a1, a2, [bline])]}
     for path, info in map(_parsechunk, chunks):
         if not path or not info:
             continue
         patchmap[path].append(info)
     for path, patches in patchmap.items():
         if path not in ctx or not patches:
             continue
         patches.sort(reverse=True)
         lines = mdiff.splitnewlines(ctx[path].data())
         for a1, a2, blines in patches:
             lines[a1:a2] = blines
         memworkingcopy[path] = b''.join(lines)
     return overlaycontext(memworkingcopy, ctx)
 
 
 def absorb(ui, repo, stack=None, targetctx=None, pats=None, opts=None):
     """pick fixup chunks from targetctx, apply them to stack.
 
     if targetctx is None, the working copy context will be used.
     if stack is None, the current draft stack will be used.
     return fixupstate.
     """
     if stack is None:
         limit = ui.configint(b'absorb', b'max-stack-size')
         headctx = repo[b'.']
         if len(headctx.parents()) > 1:
             raise error.InputError(_(b'cannot absorb into a merge'))
         stack = getdraftstack(headctx, limit)
         if limit and len(stack) >= limit:
             ui.warn(
                 _(
                     b'absorb: only the recent %d changesets will '
                     b'be analysed\n'
                 )
                 % limit
             )
     if not stack:
         raise error.InputError(_(b'no mutable changeset to change'))
     if targetctx is None:  # default to working copy
         targetctx = repo[None]
     if pats is None:
         pats = ()
     if opts is None:
         opts = {}
     state = fixupstate(stack, ui=ui, opts=opts)
     matcher = scmutil.match(targetctx, pats, opts)
     if opts.get(b'interactive'):
         diff = patch.diff(repo, stack[-1].node(), targetctx.node(), matcher)
         origchunks = patch.parsepatch(diff)
         chunks = cmdutil.recordfilter(ui, origchunks, matcher)[0]
         targetctx = overlaydiffcontext(stack[-1], chunks)
     if opts.get(b'edit_lines'):
         # If we're going to open the editor, don't ask the user to confirm
         # first
         opts[b'apply_changes'] = True
     fm = None
     if opts.get(b'print_changes') or not opts.get(b'apply_changes'):
         fm = ui.formatter(b'absorb', opts)
     state.diffwith(targetctx, matcher, fm)
     if fm is not None:
         fm.startitem()
         fm.write(
             b"count", b"\n%d changesets affected\n", len(state.ctxaffected)
         )
         fm.data(linetype=b'summary')
         for ctx in reversed(stack):
             if ctx not in state.ctxaffected:
                 continue
             fm.startitem()
             fm.context(ctx=ctx)
             fm.data(linetype=b'changeset')
             fm.write(b'node', b'%-7.7s ', ctx.hex(), label=b'absorb.node')
             descfirstline = stringutil.firstline(ctx.description())
             fm.write(
                 b'descfirstline',
                 b'%s\n',
                 descfirstline,
                 label=b'absorb.description',
             )
         fm.end()
     if not opts.get(b'dry_run'):
         if (
             not opts.get(b'apply_changes')
             and state.ctxaffected
             and ui.promptchoice(
                 b"apply changes (y/N)? $$ &Yes $$ &No", default=1
             )
         ):
             raise error.CanceledError(_(b'absorb cancelled\n'))
 
         state.apply()
         if state.commit():
             state.printchunkstats()
         elif not ui.quiet:
             ui.write(_(b'nothing applied\n'))
     return state
 
 
 @command(
     b'absorb',
     [
         (
             b'a',
             b'apply-changes',
             None,
             _(b'apply changes without prompting for confirmation'),
         ),
         (
             b'p',
             b'print-changes',
             None,
             _(b'always print which changesets are modified by which changes'),
         ),
         (
             b'i',
             b'interactive',
             None,
             _(b'interactively select which chunks to apply'),
         ),
         (
             b'e',
             b'edit-lines',
             None,
             _(
                 b'edit what lines belong to which changesets before commit '
                 b'(EXPERIMENTAL)'
             ),
         ),
     ]
     + commands.dryrunopts
     + commands.templateopts
     + commands.walkopts,
     _(b'hg absorb [OPTION] [FILE]...'),
     helpcategory=command.CATEGORY_COMMITTING,
     helpbasic=True,
 )
 def absorbcmd(ui, repo, *pats, **opts):
     """incorporate corrections into the stack of draft changesets
 
     absorb analyzes each change in your working directory and attempts to
     amend the changed lines into the changesets in your stack that first
     introduced those lines.
 
     If absorb cannot find an unambiguous changeset to amend for a change,
     that change will be left in the working directory, untouched. They can be
     observed by :hg:`status` or :hg:`diff` afterwards. In other words,
     absorb does not write to the working directory.
 
     Changesets outside the revset `::. and not public() and not merge()` will
     not be changed.
 
     Changesets that become empty after applying the changes will be deleted.
 
     By default, absorb will show what it plans to do and prompt for
     confirmation.  If you are confident that the changes will be absorbed
     to the correct place, run :hg:`absorb -a` to apply the changes
     immediately.
 
     Returns 0 on success, 1 if all chunks were ignored and nothing amended.
     """
     opts = pycompat.byteskwargs(opts)
 
     with repo.wlock(), repo.lock():
         if not opts[b'dry_run']:
             cmdutil.checkunfinished(repo)
 
         state = absorb(ui, repo, pats=pats, opts=opts)
         if sum(s[0] for s in state.chunkstats.values()) == 0:
             return 1

hgext/acl.py

@@ -1,489 +1,488 b''
 # acl.py - changeset access control for mercurial
 #
 # Copyright 2006 Vadim Gelfer <[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.
 
 '''hooks for controlling repository access
 
 This hook makes it possible to allow or deny write access to given
 branches and paths of a repository when receiving incoming changesets
 via pretxnchangegroup and pretxncommit.
 
 The authorization is matched based on the local user name on the
 system where the hook runs, and not the committer of the original
 changeset (since the latter is merely informative).
 
 The acl hook is best used along with a restricted shell like hgsh,
 preventing authenticating users from doing anything other than pushing
 or pulling. The hook is not safe to use if users have interactive
 shell access, as they can then disable the hook. Nor is it safe if
 remote users share an account, because then there is no way to
 distinguish them.
 
 The order in which access checks are performed is:
 
 1) Deny  list for branches (section ``acl.deny.branches``)
 2) Allow list for branches (section ``acl.allow.branches``)
 3) Deny  list for paths    (section ``acl.deny``)
 4) Allow list for paths    (section ``acl.allow``)
 
 The allow and deny sections take key-value pairs.
 
 Branch-based Access Control
 ---------------------------
 
 Use the ``acl.deny.branches`` and ``acl.allow.branches`` sections to
 have branch-based access control. Keys in these sections can be
 either:
 
 - a branch name, or
 - an asterisk, to match any branch;
 
 The corresponding values can be either:
 
 - a comma-separated list containing users and groups, or
 - an asterisk, to match anyone;
 
 You can add the "!" prefix to a user or group name to invert the sense
 of the match.
 
 Path-based Access Control
 -------------------------
 
 Use the ``acl.deny`` and ``acl.allow`` sections to have path-based
 access control. Keys in these sections accept a subtree pattern (with
 a glob syntax by default). The corresponding values follow the same
 syntax as the other sections above.
 
 Bookmark-based Access Control
 -----------------------------
 Use the ``acl.deny.bookmarks`` and ``acl.allow.bookmarks`` sections to
 have bookmark-based access control. Keys in these sections can be
 either:
 
 - a bookmark name, or
 - an asterisk, to match any bookmark;
 
 The corresponding values can be either:
 
 - a comma-separated list containing users and groups, or
 - an asterisk, to match anyone;
 
 You can add the "!" prefix to a user or group name to invert the sense
 of the match.
 
 Note: for interactions between clients and servers using Mercurial 3.6+
 a rejection will generally reject the entire push, for interactions
 involving older clients, the commit transactions will already be accepted,
 and only the bookmark movement will be rejected.
 
 Groups
 ------
 
 Group names must be prefixed with an ``@`` symbol. Specifying a group
 name has the same effect as specifying all the users in that group.
 
 You can define group members in the ``acl.groups`` section.
 If a group name is not defined there, and Mercurial is running under
 a Unix-like system, the list of users will be taken from the OS.
 Otherwise, an exception will be raised.
 
 Example Configuration
 ---------------------
 
 ::
 
   [hooks]
 
   # Use this if you want to check access restrictions at commit time
   pretxncommit.acl = python:hgext.acl.hook
 
   # Use this if you want to check access restrictions for pull, push,
   # bundle and serve.
   pretxnchangegroup.acl = python:hgext.acl.hook
 
   [acl]
   # Allow or deny access for incoming changes only if their source is
   # listed here, let them pass otherwise. Source is "serve" for all
   # remote access (http or ssh), "push", "pull" or "bundle" when the
   # related commands are run locally.
   # Default: serve
   sources = serve
 
   [acl.deny.branches]
 
   # Everyone is denied to the frozen branch:
   frozen-branch = *
 
   # A bad user is denied on all branches:
   * = bad-user
 
   [acl.allow.branches]
 
   # A few users are allowed on branch-a:
   branch-a = user-1, user-2, user-3
 
   # Only one user is allowed on branch-b:
   branch-b = user-1
 
   # The super user is allowed on any branch:
   * = super-user
 
   # Everyone is allowed on branch-for-tests:
   branch-for-tests = *
 
   [acl.deny]
   # This list is checked first. If a match is found, acl.allow is not
   # checked. All users are granted access if acl.deny is not present.
   # Format for both lists: glob pattern = user, ..., @group, ...
 
   # To match everyone, use an asterisk for the user:
   # my/glob/pattern = *
 
   # user6 will not have write access to any file:
   ** = user6
 
   # Group "hg-denied" will not have write access to any file:
   ** = @hg-denied
 
   # Nobody will be able to change "DONT-TOUCH-THIS.txt", despite
   # everyone being able to change all other files. See below.
   src/main/resources/DONT-TOUCH-THIS.txt = *
 
   [acl.allow]
   # if acl.allow is not present, all users are allowed by default
   # empty acl.allow = no users allowed
 
   # User "doc_writer" has write access to any file under the "docs"
   # folder:
   docs/** = doc_writer
 
   # User "jack" and group "designers" have write access to any file
   # under the "images" folder:
   images/** = jack, @designers
 
   # Everyone (except for "user6" and "@hg-denied" - see acl.deny above)
   # will have write access to any file under the "resources" folder
   # (except for 1 file. See acl.deny):
   src/main/resources/** = *
 
   .hgtags = release_engineer
 
 Examples using the "!" prefix
 .............................
 
 Suppose there's a branch that only a given user (or group) should be able to
 push to, and you don't want to restrict access to any other branch that may
 be created.
 
 The "!" prefix allows you to prevent anyone except a given user or group to
 push changesets in a given branch or path.
 
 In the examples below, we will:
 1) Deny access to branch "ring" to anyone but user "gollum"
 2) Deny access to branch "lake" to anyone but members of the group "hobbit"
 3) Deny access to a file to anyone but user "gollum"
 
 ::
 
   [acl.allow.branches]
   # Empty
 
   [acl.deny.branches]
 
   # 1) only 'gollum' can commit to branch 'ring';
   # 'gollum' and anyone else can still commit to any other branch.
   ring = !gollum
 
   # 2) only members of the group 'hobbit' can commit to branch 'lake';
   # 'hobbit' members and anyone else can still commit to any other branch.
   lake = !@hobbit
 
   # You can also deny access based on file paths:
 
   [acl.allow]
   # Empty
 
   [acl.deny]
   # 3) only 'gollum' can change the file below;
   # 'gollum' and anyone else can still change any other file.
   /misty/mountains/cave/ring = !gollum
 
 '''
 
 
 from mercurial.i18n import _
 from mercurial import (
     error,
     extensions,
     match,
-    pycompat,
     registrar,
     util,
 )
 from mercurial.utils import procutil
 
 urlreq = util.urlreq
 
 # Note for extension authors: ONLY specify testedwith = 'ships-with-hg-core' 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 = b'ships-with-hg-core'
 
 configtable = {}
 configitem = registrar.configitem(configtable)
 
 # deprecated config: acl.config
 configitem(
     b'acl',
     b'config',
     default=None,
 )
 configitem(
     b'acl.groups',
     b'.*',
     default=None,
     generic=True,
 )
 configitem(
     b'acl.deny.branches',
     b'.*',
     default=None,
     generic=True,
 )
 configitem(
     b'acl.allow.branches',
     b'.*',
     default=None,
     generic=True,
 )
 configitem(
     b'acl.deny',
     b'.*',
     default=None,
     generic=True,
 )
 configitem(
     b'acl.allow',
     b'.*',
     default=None,
     generic=True,
 )
 configitem(
     b'acl',
     b'sources',
     default=lambda: [b'serve'],
 )
 
 
 def _getusers(ui, group):
 
     # First, try to use group definition from section [acl.groups]
     hgrcusers = ui.configlist(b'acl.groups', group)
     if hgrcusers:
         return hgrcusers
 
     ui.debug(b'acl: "%s" not defined in [acl.groups]\n' % group)
     # If no users found in group definition, get users from OS-level group
     try:
         return util.groupmembers(group)
     except KeyError:
         raise error.Abort(_(b"group '%s' is undefined") % group)
 
 
 def _usermatch(ui, user, usersorgroups):
 
     if usersorgroups == b'*':
         return True
 
     for ug in usersorgroups.replace(b',', b' ').split():
 
         if ug.startswith(b'!'):
             # Test for excluded user or group. Format:
             # if ug is a user  name: !username
             # if ug is a group name: !@groupname
             ug = ug[1:]
             if (
                 not ug.startswith(b'@')
                 and user != ug
                 or ug.startswith(b'@')
                 and user not in _getusers(ui, ug[1:])
             ):
                 return True
 
         # Test for user or group. Format:
         # if ug is a user  name: username
         # if ug is a group name: @groupname
         elif (
             user == ug or ug.startswith(b'@') and user in _getusers(ui, ug[1:])
         ):
             return True
 
     return False
 
 
 def buildmatch(ui, repo, user, key):
     '''return tuple of (match function, list enabled).'''
     if not ui.has_section(key):
         ui.debug(b'acl: %s not enabled\n' % key)
         return None
 
     pats = [
         pat for pat, users in ui.configitems(key) if _usermatch(ui, user, users)
     ]
     ui.debug(
         b'acl: %s enabled, %d entries for user %s\n' % (key, len(pats), user)
     )
 
     # Branch-based ACL
     if not repo:
         if pats:
             # If there's an asterisk (meaning "any branch"), always return True;
             # Otherwise, test if b is in pats
             if b'*' in pats:
                 return util.always
             return lambda b: b in pats
         return util.never
 
     # Path-based ACL
     if pats:
         return match.match(repo.root, b'', pats)
     return util.never
 
 
 def ensureenabled(ui):
     """make sure the extension is enabled when used as hook
 
     When acl is used through hooks, the extension is never formally loaded and
     enabled. This has some side effect, for example the config declaration is
     never loaded. This function ensure the extension is enabled when running
     hooks.
     """
     if b'acl' in ui._knownconfig:
         return
     ui.setconfig(b'extensions', b'acl', b'', source=b'internal')
     extensions.loadall(ui, [b'acl'])
 
 
 def hook(ui, repo, hooktype, node=None, source=None, **kwargs):
 
     ensureenabled(ui)
 
     if hooktype not in [b'pretxnchangegroup', b'pretxncommit', b'prepushkey']:
         raise error.Abort(
             _(
                 b'config error - hook type "%s" cannot stop '
                 b'incoming changesets, commits, nor bookmarks'
             )
             % hooktype
         )
     if hooktype == b'pretxnchangegroup' and source not in ui.configlist(
         b'acl', b'sources'
     ):
         ui.debug(b'acl: changes have source "%s" - skipping\n' % source)
         return
 
     user = None
     if source == b'serve' and 'url' in kwargs:
         url = kwargs['url'].split(b':')
         if url[0] == b'remote' and url[1].startswith(b'http'):
             user = urlreq.unquote(url[3])
 
     if user is None:
         user = procutil.getuser()
 
     ui.debug(b'acl: checking access for user "%s"\n' % user)
 
     if hooktype == b'prepushkey':
         _pkhook(ui, repo, hooktype, node, source, user, **kwargs)
     else:
         _txnhook(ui, repo, hooktype, node, source, user, **kwargs)
 
 
 def _pkhook(ui, repo, hooktype, node, source, user, **kwargs):
     if kwargs['namespace'] == b'bookmarks':
         bookmark = kwargs['key']
         ctx = kwargs['new']
         allowbookmarks = buildmatch(ui, None, user, b'acl.allow.bookmarks')
         denybookmarks = buildmatch(ui, None, user, b'acl.deny.bookmarks')
 
         if denybookmarks and denybookmarks(bookmark):
             raise error.Abort(
                 _(
                     b'acl: user "%s" denied on bookmark "%s"'
                     b' (changeset "%s")'
                 )
                 % (user, bookmark, ctx)
             )
         if allowbookmarks and not allowbookmarks(bookmark):
             raise error.Abort(
                 _(
                     b'acl: user "%s" not allowed on bookmark "%s"'
                     b' (changeset "%s")'
                 )
                 % (user, bookmark, ctx)
             )
         ui.debug(
             b'acl: bookmark access granted: "%s" on bookmark "%s"\n'
             % (ctx, bookmark)
         )
 
 
 def _txnhook(ui, repo, hooktype, node, source, user, **kwargs):
     # deprecated config: acl.config
     cfg = ui.config(b'acl', b'config')
     if cfg:
         ui.readconfig(
             cfg,
             sections=[
                 b'acl.groups',
                 b'acl.allow.branches',
                 b'acl.deny.branches',
                 b'acl.allow',
                 b'acl.deny',
             ],
         )
 
     allowbranches = buildmatch(ui, None, user, b'acl.allow.branches')
     denybranches = buildmatch(ui, None, user, b'acl.deny.branches')
     allow = buildmatch(ui, repo, user, b'acl.allow')
     deny = buildmatch(ui, repo, user, b'acl.deny')
 
-    for rev in pycompat.xrange(repo[node].rev(), len(repo)):
+    for rev in range(repo[node].rev(), len(repo)):
         ctx = repo[rev]
         branch = ctx.branch()
         if denybranches and denybranches(branch):
             raise error.Abort(
                 _(b'acl: user "%s" denied on branch "%s" (changeset "%s")')
                 % (user, branch, ctx)
             )
         if allowbranches and not allowbranches(branch):
             raise error.Abort(
                 _(
                     b'acl: user "%s" not allowed on branch "%s"'
                     b' (changeset "%s")'
                 )
                 % (user, branch, ctx)
             )
         ui.debug(
             b'acl: branch access granted: "%s" on branch "%s"\n' % (ctx, branch)
         )
 
         for f in ctx.files():
             if deny and deny(f):
                 raise error.Abort(
                     _(b'acl: user "%s" denied on "%s" (changeset "%s")')
                     % (user, f, ctx)
                 )
             if allow and not allow(f):
                 raise error.Abort(
                     _(
                         b'acl: user "%s" not allowed on "%s"'
                         b' (changeset "%s")'
                     )
                     % (user, f, ctx)
                 )
         ui.debug(b'acl: path access granted: "%s"\n' % ctx)

hgext/beautifygraph.py

@@ -1,108 +1,107 b''
 # -*- coding: UTF-8 -*-
 # beautifygraph.py - improve graph output by using Unicode characters
 #
 # Copyright 2018 John Stiles <[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.
 
 '''beautify log -G output by using Unicode characters (EXPERIMENTAL)
 
    A terminal with UTF-8 support and monospace narrow text are required.
 '''
 
 
 from mercurial.i18n import _
 from mercurial import (
     encoding,
     extensions,
     graphmod,
-    pycompat,
     templatekw,
 )
 
 # Note for extension authors: ONLY specify testedwith = 'ships-with-hg-core' 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 = b'ships-with-hg-core'
 
 
 def prettyedge(before, edge, after):
     if edge == b'~':
         return b'\xE2\x95\xA7'  # U+2567 ╧
     if edge == b'/':
         return b'\xE2\x95\xB1'  # U+2571 ╱
     if edge == b'-':
         return b'\xE2\x94\x80'  # U+2500 ─
     if edge == b'|':
         return b'\xE2\x94\x82'  # U+2502 │
     if edge == b':':
         return b'\xE2\x94\x86'  # U+2506 ┆
     if edge == b'\\':
         return b'\xE2\x95\xB2'  # U+2572 ╲
     if edge == b'+':
         if before == b' ' and not after == b' ':
             return b'\xE2\x94\x9C'  # U+251C ├
         if after == b' ' and not before == b' ':
             return b'\xE2\x94\xA4'  # U+2524 ┤
         return b'\xE2\x94\xBC'  # U+253C ┼
     return edge
 
 
 def convertedges(line):
     line = b' %s ' % line
     pretty = []
-    for idx in pycompat.xrange(len(line) - 2):
+    for idx in range(len(line) - 2):
         pretty.append(
             prettyedge(
                 line[idx : idx + 1],
                 line[idx + 1 : idx + 2],
                 line[idx + 2 : idx + 3],
             )
         )
     return b''.join(pretty)
 
 
 def getprettygraphnode(orig, *args, **kwargs):
     node = orig(*args, **kwargs)
     if node == b'o':
         return b'\xE2\x97\x8B'  # U+25CB ○
     if node == b'@':
         return b'\xE2\x97\x89'  # U+25C9 ◉
     if node == b'%':
         return b'\xE2\x97\x8D'  # U+25CE ◎
     if node == b'*':
         return b'\xE2\x88\x97'  # U+2217 ∗
     if node == b'x':
         return b'\xE2\x97\x8C'  # U+25CC ◌
     if node == b'_':
         return b'\xE2\x95\xA4'  # U+2564 ╤
     return node
 
 
 def outputprettygraph(orig, ui, graph, *args, **kwargs):
     (edges, text) = zip(*graph)
     graph = zip([convertedges(e) for e in edges], text)
     return orig(ui, graph, *args, **kwargs)
 
 
 def extsetup(ui):
     if ui.plain(b'graph'):
         return
 
     if encoding.encoding != b'UTF-8':
         ui.warn(_(b'beautifygraph: unsupported encoding, UTF-8 required\n'))
         return
 
     if 'A' in encoding._wide:
         ui.warn(
             _(
                 b'beautifygraph: unsupported terminal settings, '
                 b'monospace narrow text required\n'
             )
         )
         return
 
     extensions.wrapfunction(graphmod, b'outputgraph', outputprettygraph)
     extensions.wrapfunction(templatekw, b'getgraphnode', getprettygraphnode)

hgext/convert/cvsps.py

@@ -1,1068 +1,1068 b''
 # Mercurial built-in replacement for cvsps.
 #
 # Copyright 2008, 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.
 
 import functools
 import os
 import pickle
 import re
 
 from mercurial.i18n import _
 from mercurial.pycompat import open
 from mercurial import (
     encoding,
     error,
     hook,
     pycompat,
     util,
 )
 from mercurial.utils import (
     dateutil,
     procutil,
     stringutil,
 )
 
 
 class logentry:
     """Class logentry has the following attributes:
     .author    - author name as CVS knows it
     .branch    - name of branch this revision is on
     .branches  - revision tuple of branches starting at this revision
     .comment   - commit message
     .commitid  - CVS commitid or None
     .date      - the commit date as a (time, tz) tuple
     .dead      - true if file revision is dead
     .file      - Name of file
     .lines     - a tuple (+lines, -lines) or None
     .parent    - Previous revision of this entry
     .rcs       - name of file as returned from CVS
     .revision  - revision number as tuple
     .tags      - list of tags on the file
     .synthetic - is this a synthetic "file ... added on ..." revision?
     .mergepoint - the branch that has been merged from (if present in
                   rlog output) or None
     .branchpoints - the branches that start at the current entry or empty
     """
 
     def __init__(self, **entries):
         self.synthetic = False
         self.__dict__.update(entries)
 
     def __repr__(self):
         items = ("%s=%r" % (k, self.__dict__[k]) for k in sorted(self.__dict__))
         return "%s(%s)" % (type(self).__name__, ", ".join(items))
 
 
 class logerror(Exception):
     pass
 
 
 def getrepopath(cvspath):
     """Return the repository path from a CVS path.
 
     >>> getrepopath(b'/foo/bar')
     '/foo/bar'
     >>> getrepopath(b'c:/foo/bar')
     '/foo/bar'
     >>> getrepopath(b':pserver:10/foo/bar')
     '/foo/bar'
     >>> getrepopath(b':pserver:10c:/foo/bar')
     '/foo/bar'
     >>> getrepopath(b':pserver:/foo/bar')
     '/foo/bar'
     >>> getrepopath(b':pserver:c:/foo/bar')
     '/foo/bar'
     >>> getrepopath(b':pserver:[e-mail]:/foo/bar')
     '/foo/bar'
     >>> getrepopath(b':pserver:[e-mail]:c:/foo/bar')
     '/foo/bar'
     >>> getrepopath(b'user@server/path/to/repository')
     '/path/to/repository'
     """
     # According to CVS manual, CVS paths are expressed like:
     # [:method:][[user][:password]@]hostname[:[port]]/path/to/repository
     #
     # CVSpath is splitted into parts and then position of the first occurrence
     # of the '/' char after the '@' is located. The solution is the rest of the
     # string after that '/' sign including it
 
     parts = cvspath.split(b':')
     atposition = parts[-1].find(b'@')
     start = 0
 
     if atposition != -1:
         start = atposition
 
     repopath = parts[-1][parts[-1].find(b'/', start) :]
     return repopath
 
 
 def createlog(ui, directory=None, root=b"", rlog=True, cache=None):
     '''Collect the CVS rlog'''
 
     # Because we store many duplicate commit log messages, reusing strings
     # saves a lot of memory and pickle storage space.
     _scache = {}
 
     def scache(s):
         """return a shared version of a string"""
         return _scache.setdefault(s, s)
 
     ui.status(_(b'collecting CVS rlog\n'))
 
     log = []  # list of logentry objects containing the CVS state
 
     # patterns to match in CVS (r)log output, by state of use
     re_00 = re.compile(b'RCS file: (.+)$')
     re_01 = re.compile(b'cvs \\[r?log aborted\\]: (.+)$')
     re_02 = re.compile(b'cvs (r?log|server): (.+)\n$')
     re_03 = re.compile(
         b"(Cannot access.+CVSROOT)|(can't create temporary directory.+)$"
     )
     re_10 = re.compile(b'Working file: (.+)$')
     re_20 = re.compile(b'symbolic names:')
     re_30 = re.compile(b'\t(.+): ([\\d.]+)$')
     re_31 = re.compile(b'----------------------------$')
     re_32 = re.compile(
         b'======================================='
         b'======================================$'
     )
     re_50 = re.compile(br'revision ([\d.]+)(\s+locked by:\s+.+;)?$')
     re_60 = re.compile(
         br'date:\s+(.+);\s+author:\s+(.+);\s+state:\s+(.+?);'
         br'(\s+lines:\s+(\+\d+)?\s+(-\d+)?;)?'
         br'(\s+commitid:\s+([^;]+);)?'
         br'(.*mergepoint:\s+([^;]+);)?'
     )
     re_70 = re.compile(b'branches: (.+);$')
 
     file_added_re = re.compile(br'file [^/]+ was (initially )?added on branch')
 
     prefix = b''  # leading path to strip of what we get from CVS
 
     if directory is None:
         # Current working directory
 
         # Get the real directory in the repository
         try:
             with open(os.path.join(b'CVS', b'Repository'), b'rb') as f:
                 prefix = f.read().strip()
             directory = prefix
             if prefix == b".":
                 prefix = b""
         except IOError:
             raise logerror(_(b'not a CVS sandbox'))
 
         if prefix and not prefix.endswith(pycompat.ossep):
             prefix += pycompat.ossep
 
         # Use the Root file in the sandbox, if it exists
         try:
             root = open(os.path.join(b'CVS', b'Root'), b'rb').read().strip()
         except IOError:
             pass
 
     if not root:
         root = encoding.environ.get(b'CVSROOT', b'')
 
     # read log cache if one exists
     oldlog = []
     date = None
 
     if cache:
         cachedir = os.path.expanduser(b'~/.hg.cvsps')
         if not os.path.exists(cachedir):
             os.mkdir(cachedir)
 
         # The cvsps cache pickle needs a uniquified name, based on the
         # repository location. The address may have all sort of nasties
         # in it, slashes, colons and such. So here we take just the
         # alphanumeric characters, concatenated in a way that does not
         # mix up the various components, so that
         #    :pserver:user@server:/path
         # and
         #    /pserver/user/server/path
         # are mapped to different cache file names.
         cachefile = root.split(b":") + [directory, b"cache"]
         cachefile = [b'-'.join(re.findall(br'\w+', s)) for s in cachefile if s]
         cachefile = os.path.join(
             cachedir, b'.'.join([s for s in cachefile if s])
         )
 
     if cache == b'update':
         try:
             ui.note(_(b'reading cvs log cache %s\n') % cachefile)
             oldlog = pickle.load(open(cachefile, b'rb'))
             for e in oldlog:
                 if not (
                     util.safehasattr(e, b'branchpoints')
                     and util.safehasattr(e, b'commitid')
                     and util.safehasattr(e, b'mergepoint')
                 ):
                     ui.status(_(b'ignoring old cache\n'))
                     oldlog = []
                     break
 
             ui.note(_(b'cache has %d log entries\n') % len(oldlog))
         except Exception as e:
             ui.note(_(b'error reading cache: %r\n') % e)
 
         if oldlog:
             date = oldlog[-1].date  # last commit date as a (time,tz) tuple
             date = dateutil.datestr(date, b'%Y/%m/%d %H:%M:%S %1%2')
 
     # build the CVS commandline
     cmd = [b'cvs', b'-q']
     if root:
         cmd.append(b'-d%s' % root)
         p = util.normpath(getrepopath(root))
         if not p.endswith(b'/'):
             p += b'/'
         if prefix:
             # looks like normpath replaces "" by "."
             prefix = p + util.normpath(prefix)
         else:
             prefix = p
     cmd.append([b'log', b'rlog'][rlog])
     if date:
         # no space between option and date string
         cmd.append(b'-d>%s' % date)
     cmd.append(directory)
 
     # state machine begins here
     tags = {}  # dictionary of revisions on current file with their tags
     branchmap = {}  # mapping between branch names and revision numbers
     rcsmap = {}
     state = 0
     store = False  # set when a new record can be appended
 
     cmd = [procutil.shellquote(arg) for arg in cmd]
     ui.note(_(b"running %s\n") % (b' '.join(cmd)))
     ui.debug(b"prefix=%r directory=%r root=%r\n" % (prefix, directory, root))
 
     pfp = procutil.popen(b' '.join(cmd), b'rb')
     peek = util.fromnativeeol(pfp.readline())
     while True:
         line = peek
         if line == b'':
             break
         peek = util.fromnativeeol(pfp.readline())
         if line.endswith(b'\n'):
             line = line[:-1]
         # ui.debug('state=%d line=%r\n' % (state, line))
 
         if state == 0:
             # initial state, consume input until we see 'RCS file'
             match = re_00.match(line)
             if match:
                 rcs = match.group(1)
                 tags = {}
                 if rlog:
                     filename = util.normpath(rcs[:-2])
                     if filename.startswith(prefix):
                         filename = filename[len(prefix) :]
                     if filename.startswith(b'/'):
                         filename = filename[1:]
                     if filename.startswith(b'Attic/'):
                         filename = filename[6:]
                     else:
                         filename = filename.replace(b'/Attic/', b'/')
                     state = 2
                     continue
                 state = 1
                 continue
             match = re_01.match(line)
             if match:
                 raise logerror(match.group(1))
             match = re_02.match(line)
             if match:
                 raise logerror(match.group(2))
             if re_03.match(line):
                 raise logerror(line)
 
         elif state == 1:
             # expect 'Working file' (only when using log instead of rlog)
             match = re_10.match(line)
             assert match, _(b'RCS file must be followed by working file')
             filename = util.normpath(match.group(1))
             state = 2
 
         elif state == 2:
             # expect 'symbolic names'
             if re_20.match(line):
                 branchmap = {}
                 state = 3
 
         elif state == 3:
             # read the symbolic names and store as tags
             match = re_30.match(line)
             if match:
                 rev = [int(x) for x in match.group(2).split(b'.')]
 
                 # Convert magic branch number to an odd-numbered one
                 revn = len(rev)
                 if revn > 3 and (revn % 2) == 0 and rev[-2] == 0:
                     rev = rev[:-2] + rev[-1:]
                 rev = tuple(rev)
 
                 if rev not in tags:
                     tags[rev] = []
                 tags[rev].append(match.group(1))
                 branchmap[match.group(1)] = match.group(2)
 
             elif re_31.match(line):
                 state = 5
             elif re_32.match(line):
                 state = 0
 
         elif state == 4:
             # expecting '------' separator before first revision
             if re_31.match(line):
                 state = 5
             else:
                 assert not re_32.match(line), _(
                     b'must have at least some revisions'
                 )
 
         elif state == 5:
             # expecting revision number and possibly (ignored) lock indication
             # we create the logentry here from values stored in states 0 to 4,
             # as this state is re-entered for subsequent revisions of a file.
             match = re_50.match(line)
             assert match, _(b'expected revision number')
             e = logentry(
                 rcs=scache(rcs),
                 file=scache(filename),
                 revision=tuple([int(x) for x in match.group(1).split(b'.')]),
                 branches=[],
                 parent=None,
                 commitid=None,
                 mergepoint=None,
                 branchpoints=set(),
             )
 
             state = 6
 
         elif state == 6:
             # expecting date, author, state, lines changed
             match = re_60.match(line)
             assert match, _(b'revision must be followed by date line')
             d = match.group(1)
             if d[2] == b'/':
                 # Y2K
                 d = b'19' + d
 
             if len(d.split()) != 3:
                 # cvs log dates always in GMT
                 d = d + b' UTC'
             e.date = dateutil.parsedate(
                 d,
                 [
                     b'%y/%m/%d %H:%M:%S',
                     b'%Y/%m/%d %H:%M:%S',
                     b'%Y-%m-%d %H:%M:%S',
                 ],
             )
             e.author = scache(match.group(2))
             e.dead = match.group(3).lower() == b'dead'
 
             if match.group(5):
                 if match.group(6):
                     e.lines = (int(match.group(5)), int(match.group(6)))
                 else:
                     e.lines = (int(match.group(5)), 0)
             elif match.group(6):
                 e.lines = (0, int(match.group(6)))
             else:
                 e.lines = None
 
             if match.group(7):  # cvs 1.12 commitid
                 e.commitid = match.group(8)
 
             if match.group(9):  # cvsnt mergepoint
                 myrev = match.group(10).split(b'.')
                 if len(myrev) == 2:  # head
                     e.mergepoint = b'HEAD'
                 else:
                     myrev = b'.'.join(myrev[:-2] + [b'0', myrev[-2]])
                     branches = [b for b in branchmap if branchmap[b] == myrev]
                     assert len(branches) == 1, (
                         b'unknown branch: %s' % e.mergepoint
                     )
                     e.mergepoint = branches[0]
 
             e.comment = []
             state = 7
 
         elif state == 7:
             # read the revision numbers of branches that start at this revision
             # or store the commit log message otherwise
             m = re_70.match(line)
             if m:
                 e.branches = [
                     tuple([int(y) for y in x.strip().split(b'.')])
                     for x in m.group(1).split(b';')
                 ]
                 state = 8
             elif re_31.match(line) and re_50.match(peek):
                 state = 5
                 store = True
             elif re_32.match(line):
                 state = 0
                 store = True
             else:
                 e.comment.append(line)
 
         elif state == 8:
             # store commit log message
             if re_31.match(line):
                 cpeek = peek
                 if cpeek.endswith(b'\n'):
                     cpeek = cpeek[:-1]
                 if re_50.match(cpeek):
                     state = 5
                     store = True
                 else:
                     e.comment.append(line)
             elif re_32.match(line):
                 state = 0
                 store = True
             else:
                 e.comment.append(line)
 
         # When a file is added on a branch B1, CVS creates a synthetic
         # dead trunk revision 1.1 so that the branch has a root.
         # Likewise, if you merge such a file to a later branch B2 (one
         # that already existed when the file was added on B1), CVS
         # creates a synthetic dead revision 1.1.x.1 on B2.  Don't drop
         # these revisions now, but mark them synthetic so
         # createchangeset() can take care of them.
         if (
             store
             and e.dead
             and e.revision[-1] == 1
             and len(e.comment) == 1  # 1.1 or 1.1.x.1
             and file_added_re.match(e.comment[0])
         ):
             ui.debug(
                 b'found synthetic revision in %s: %r\n' % (e.rcs, e.comment[0])
             )
             e.synthetic = True
 
         if store:
             # clean up the results and save in the log.
             store = False
             e.tags = sorted([scache(x) for x in tags.get(e.revision, [])])
             e.comment = scache(b'\n'.join(e.comment))
 
             revn = len(e.revision)
             if revn > 3 and (revn % 2) == 0:
                 e.branch = tags.get(e.revision[:-1], [None])[0]
             else:
                 e.branch = None
 
             # find the branches starting from this revision
             branchpoints = set()
             for branch, revision in branchmap.items():
                 revparts = tuple([int(i) for i in revision.split(b'.')])
                 if len(revparts) < 2:  # bad tags
                     continue
                 if revparts[-2] == 0 and revparts[-1] % 2 == 0:
                     # normal branch
                     if revparts[:-2] == e.revision:
                         branchpoints.add(branch)
                 elif revparts == (1, 1, 1):  # vendor branch
                     if revparts in e.branches:
                         branchpoints.add(branch)
             e.branchpoints = branchpoints
 
             log.append(e)
 
             rcsmap[e.rcs.replace(b'/Attic/', b'/')] = e.rcs
 
             if len(log) % 100 == 0:
                 ui.status(
                     stringutil.ellipsis(b'%d %s' % (len(log), e.file), 80)
                     + b'\n'
                 )
 
     log.sort(key=lambda x: (x.rcs, x.revision))
 
     # find parent revisions of individual files
     versions = {}
     for e in sorted(oldlog, key=lambda x: (x.rcs, x.revision)):
         rcs = e.rcs.replace(b'/Attic/', b'/')
         if rcs in rcsmap:
             e.rcs = rcsmap[rcs]
         branch = e.revision[:-1]
         versions[(e.rcs, branch)] = e.revision
 
     for e in log:
         branch = e.revision[:-1]
         p = versions.get((e.rcs, branch), None)
         if p is None:
             p = e.revision[:-2]
         e.parent = p
         versions[(e.rcs, branch)] = e.revision
 
     # update the log cache
     if cache:
         if log:
             # join up the old and new logs
             log.sort(key=lambda x: x.date)
 
             if oldlog and oldlog[-1].date >= log[0].date:
                 raise logerror(
                     _(
                         b'log cache overlaps with new log entries,'
                         b' re-run without cache.'
                     )
                 )
 
             log = oldlog + log
 
             # write the new cachefile
             ui.note(_(b'writing cvs log cache %s\n') % cachefile)
             pickle.dump(log, open(cachefile, b'wb'))
         else:
             log = oldlog
 
     ui.status(_(b'%d log entries\n') % len(log))
 
     encodings = ui.configlist(b'convert', b'cvsps.logencoding')
     if encodings:
 
         def revstr(r):
             # this is needed, because logentry.revision is a tuple of "int"
             # (e.g. (1, 2) for "1.2")
             return b'.'.join(pycompat.maplist(pycompat.bytestr, r))
 
         for entry in log:
             comment = entry.comment
             for e in encodings:
                 try:
                     entry.comment = comment.decode(pycompat.sysstr(e)).encode(
                         'utf-8'
                     )
                     if ui.debugflag:
                         ui.debug(
                             b"transcoding by %s: %s of %s\n"
                             % (e, revstr(entry.revision), entry.file)
                         )
                     break
                 except UnicodeDecodeError:
                     pass  # try next encoding
                 except LookupError as inst:  # unknown encoding, maybe
                     raise error.Abort(
                         pycompat.bytestr(inst),
                         hint=_(
                             b'check convert.cvsps.logencoding configuration'
                         ),
                     )
             else:
                 raise error.Abort(
                     _(
                         b"no encoding can transcode"
                         b" CVS log message for %s of %s"
                     )
                     % (revstr(entry.revision), entry.file),
                     hint=_(b'check convert.cvsps.logencoding configuration'),
                 )
 
     hook.hook(ui, None, b"cvslog", True, log=log)
 
     return log
 
 
 class changeset:
     """Class changeset has the following attributes:
     .id        - integer identifying this changeset (list index)
     .author    - author name as CVS knows it
     .branch    - name of branch this changeset is on, or None
     .comment   - commit message
     .commitid  - CVS commitid or None
     .date      - the commit date as a (time,tz) tuple
     .entries   - list of logentry objects in this changeset
     .parents   - list of one or two parent changesets
     .tags      - list of tags on this changeset
     .synthetic - from synthetic revision "file ... added on branch ..."
     .mergepoint- the branch that has been merged from or None
     .branchpoints- the branches that start at the current entry or empty
     """
 
     def __init__(self, **entries):
         self.id = None
         self.synthetic = False
         self.__dict__.update(entries)
 
     def __repr__(self):
         items = (
             b"%s=%r" % (k, self.__dict__[k]) for k in sorted(self.__dict__)
         )
         return b"%s(%s)" % (type(self).__name__, b", ".join(items))
 
 
 def createchangeset(ui, log, fuzz=60, mergefrom=None, mergeto=None):
     '''Convert log into changesets.'''
 
     ui.status(_(b'creating changesets\n'))
 
     # try to order commitids by date
     mindate = {}
     for e in log:
         if e.commitid:
             if e.commitid not in mindate:
                 mindate[e.commitid] = e.date
             else:
                 mindate[e.commitid] = min(e.date, mindate[e.commitid])
 
     # Merge changesets
     log.sort(
         key=lambda x: (
             mindate.get(x.commitid, (-1, 0)),
             x.commitid or b'',
             x.comment,
             x.author,
             x.branch or b'',
             x.date,
             x.branchpoints,
         )
     )
 
     changesets = []
     files = set()
     c = None
     for i, e in enumerate(log):
 
         # Check if log entry belongs to the current changeset or not.
 
         # Since CVS is file-centric, two different file revisions with
         # different branchpoints should be treated as belonging to two
         # different changesets (and the ordering is important and not
         # honoured by cvsps at this point).
         #
         # Consider the following case:
         # foo 1.1 branchpoints: [MYBRANCH]
         # bar 1.1 branchpoints: [MYBRANCH, MYBRANCH2]
         #
         # Here foo is part only of MYBRANCH, but not MYBRANCH2, e.g. a
         # later version of foo may be in MYBRANCH2, so foo should be the
         # first changeset and bar the next and MYBRANCH and MYBRANCH2
         # should both start off of the bar changeset. No provisions are
         # made to ensure that this is, in fact, what happens.
         if not (
             c
             and e.branchpoints == c.branchpoints
             and (  # cvs commitids
                 (e.commitid is not None and e.commitid == c.commitid)
                 or (  # no commitids, use fuzzy commit detection
                     (e.commitid is None or c.commitid is None)
                     and e.comment == c.comment
                     and e.author == c.author
                     and e.branch == c.branch
                     and (
                         (c.date[0] + c.date[1])
                         <= (e.date[0] + e.date[1])
                         <= (c.date[0] + c.date[1]) + fuzz
                     )
                     and e.file not in files
                 )
             )
         ):
             c = changeset(
                 comment=e.comment,
                 author=e.author,
                 branch=e.branch,
                 date=e.date,
                 entries=[],
                 mergepoint=e.mergepoint,
                 branchpoints=e.branchpoints,
                 commitid=e.commitid,
             )
             changesets.append(c)
 
             files = set()
             if len(changesets) % 100 == 0:
                 t = b'%d %s' % (len(changesets), repr(e.comment)[1:-1])
                 ui.status(stringutil.ellipsis(t, 80) + b'\n')
 
         c.entries.append(e)
         files.add(e.file)
         c.date = e.date  # changeset date is date of latest commit in it
 
     # Mark synthetic changesets
 
     for c in changesets:
         # Synthetic revisions always get their own changeset, because
         # the log message includes the filename.  E.g. if you add file3
         # and file4 on a branch, you get four log entries and three
         # changesets:
         #   "File file3 was added on branch ..." (synthetic, 1 entry)
         #   "File file4 was added on branch ..." (synthetic, 1 entry)
         #   "Add file3 and file4 to fix ..."     (real, 2 entries)
         # Hence the check for 1 entry here.
         c.synthetic = len(c.entries) == 1 and c.entries[0].synthetic
 
     # Sort files in each changeset
 
     def entitycompare(l, r):
         """Mimic cvsps sorting order"""
         l = l.file.split(b'/')
         r = r.file.split(b'/')
         nl = len(l)
         nr = len(r)
         n = min(nl, nr)
         for i in range(n):
             if i + 1 == nl and nl < nr:
                 return -1
             elif i + 1 == nr and nl > nr:
                 return +1
             elif l[i] < r[i]:
                 return -1
             elif l[i] > r[i]:
                 return +1
         return 0
 
     for c in changesets:
         c.entries.sort(key=functools.cmp_to_key(entitycompare))
 
     # Sort changesets by date
 
     odd = set()
 
     def cscmp(l, r):
         d = sum(l.date) - sum(r.date)
         if d:
             return d
 
         # detect vendor branches and initial commits on a branch
         le = {}
         for e in l.entries:
             le[e.rcs] = e.revision
         re = {}
         for e in r.entries:
             re[e.rcs] = e.revision
 
         d = 0
         for e in l.entries:
             if re.get(e.rcs, None) == e.parent:
                 assert not d
                 d = 1
                 break
 
         for e in r.entries:
             if le.get(e.rcs, None) == e.parent:
                 if d:
                     odd.add((l, r))
                 d = -1
                 break
         # By this point, the changesets are sufficiently compared that
         # we don't really care about ordering. However, this leaves
         # some race conditions in the tests, so we compare on the
         # number of files modified, the files contained in each
         # changeset, and the branchpoints in the change to ensure test
         # output remains stable.
 
         # recommended replacement for cmp from
         # https://docs.python.org/3.0/whatsnew/3.0.html
         c = lambda x, y: (x > y) - (x < y)
         # Sort bigger changes first.
         if not d:
             d = c(len(l.entries), len(r.entries))
         # Try sorting by filename in the change.
         if not d:
             d = c([e.file for e in l.entries], [e.file for e in r.entries])
         # Try and put changes without a branch point before ones with
         # a branch point.
         if not d:
             d = c(len(l.branchpoints), len(r.branchpoints))
         return d
 
     changesets.sort(key=functools.cmp_to_key(cscmp))
 
     # Collect tags
 
     globaltags = {}
     for c in changesets:
         for e in c.entries:
             for tag in e.tags:
                 # remember which is the latest changeset to have this tag
                 globaltags[tag] = c
 
     for c in changesets:
         tags = set()
         for e in c.entries:
             tags.update(e.tags)
         # remember tags only if this is the latest changeset to have it
         c.tags = sorted(tag for tag in tags if globaltags[tag] is c)
 
     # Find parent changesets, handle {{mergetobranch BRANCHNAME}}
     # by inserting dummy changesets with two parents, and handle
     # {{mergefrombranch BRANCHNAME}} by setting two parents.
 
     if mergeto is None:
         mergeto = br'{{mergetobranch ([-\w]+)}}'
     if mergeto:
         mergeto = re.compile(mergeto)
 
     if mergefrom is None:
         mergefrom = br'{{mergefrombranch ([-\w]+)}}'
     if mergefrom:
         mergefrom = re.compile(mergefrom)
 
     versions = {}  # changeset index where we saw any particular file version
     branches = {}  # changeset index where we saw a branch
     n = len(changesets)
     i = 0
     while i < n:
         c = changesets[i]
 
         for f in c.entries:
             versions[(f.rcs, f.revision)] = i
 
         p = None
         if c.branch in branches:
             p = branches[c.branch]
         else:
             # first changeset on a new branch
             # the parent is a changeset with the branch in its
             # branchpoints such that it is the latest possible
             # commit without any intervening, unrelated commits.
 
-            for candidate in pycompat.xrange(i):
+            for candidate in range(i):
                 if c.branch not in changesets[candidate].branchpoints:
                     if p is not None:
                         break
                     continue
                 p = candidate
 
         c.parents = []
         if p is not None:
             p = changesets[p]
 
             # Ensure no changeset has a synthetic changeset as a parent.
             while p.synthetic:
                 assert len(p.parents) <= 1, _(
                     b'synthetic changeset cannot have multiple parents'
                 )
                 if p.parents:
                     p = p.parents[0]
                 else:
                     p = None
                     break
 
             if p is not None:
                 c.parents.append(p)
 
         if c.mergepoint:
             if c.mergepoint == b'HEAD':
                 c.mergepoint = None
             c.parents.append(changesets[branches[c.mergepoint]])
 
         if mergefrom:
             m = mergefrom.search(c.comment)
             if m:
                 m = m.group(1)
                 if m == b'HEAD':
                     m = None
                 try:
                     candidate = changesets[branches[m]]
                 except KeyError:
                     ui.warn(
                         _(
                             b"warning: CVS commit message references "
                             b"non-existent branch %r:\n%s\n"
                         )
                         % (pycompat.bytestr(m), c.comment)
                     )
                 if m in branches and c.branch != m and not candidate.synthetic:
                     c.parents.append(candidate)
 
         if mergeto:
             m = mergeto.search(c.comment)
             if m:
                 if m.groups():
                     m = m.group(1)
                     if m == b'HEAD':
                         m = None
                 else:
                     m = None  # if no group found then merge to HEAD
                 if m in branches and c.branch != m:
                     # insert empty changeset for merge
                     cc = changeset(
                         author=c.author,
                         branch=m,
                         date=c.date,
                         comment=b'convert-repo: CVS merge from branch %s'
                         % c.branch,
                         entries=[],
                         tags=[],
                         parents=[changesets[branches[m]], c],
                     )
                     changesets.insert(i + 1, cc)
                     branches[m] = i + 1
 
                     # adjust our loop counters now we have inserted a new entry
                     n += 1
                     i += 2
                     continue
 
         branches[c.branch] = i
         i += 1
 
     # Drop synthetic changesets (safe now that we have ensured no other
     # changesets can have them as parents).
     i = 0
     while i < len(changesets):
         if changesets[i].synthetic:
             del changesets[i]
         else:
             i += 1
 
     # Number changesets
 
     for i, c in enumerate(changesets):
         c.id = i + 1
 
     if odd:
         for l, r in odd:
             if l.id is not None and r.id is not None:
                 ui.warn(
                     _(b'changeset %d is both before and after %d\n')
                     % (l.id, r.id)
                 )
 
     ui.status(_(b'%d changeset entries\n') % len(changesets))
 
     hook.hook(ui, None, b"cvschangesets", True, changesets=changesets)
 
     return changesets
 
 
 def debugcvsps(ui, *args, **opts):
     """Read CVS rlog for current directory or named path in
     repository, and convert the log to changesets based on matching
     commit log entries and dates.
     """
     opts = pycompat.byteskwargs(opts)
     if opts[b"new_cache"]:
         cache = b"write"
     elif opts[b"update_cache"]:
         cache = b"update"
     else:
         cache = None
 
     revisions = opts[b"revisions"]
 
     try:
         if args:
             log = []
             for d in args:
                 log += createlog(ui, d, root=opts[b"root"], cache=cache)
         else:
             log = createlog(ui, root=opts[b"root"], cache=cache)
     except logerror as e:
         ui.write(b"%r\n" % e)
         return
 
     changesets = createchangeset(ui, log, opts[b"fuzz"])
     del log
 
     # Print changesets (optionally filtered)
 
     off = len(revisions)
     branches = {}  # latest version number in each branch
     ancestors = {}  # parent branch
     for cs in changesets:
 
         if opts[b"ancestors"]:
             if cs.branch not in branches and cs.parents and cs.parents[0].id:
                 ancestors[cs.branch] = (
                     changesets[cs.parents[0].id - 1].branch,
                     cs.parents[0].id,
                 )
             branches[cs.branch] = cs.id
 
         # limit by branches
         if (
             opts[b"branches"]
             and (cs.branch or b'HEAD') not in opts[b"branches"]
         ):
             continue
 
         if not off:
             # Note: trailing spaces on several lines here are needed to have
             #       bug-for-bug compatibility with cvsps.
             ui.write(b'---------------------\n')
             ui.write((b'PatchSet %d \n' % cs.id))
             ui.write(
                 (
                     b'Date: %s\n'
                     % dateutil.datestr(cs.date, b'%Y/%m/%d %H:%M:%S %1%2')
                 )
             )
             ui.write((b'Author: %s\n' % cs.author))
             ui.write((b'Branch: %s\n' % (cs.branch or b'HEAD')))
             ui.write(
                 (
                     b'Tag%s: %s \n'
                     % (
                         [b'', b's'][len(cs.tags) > 1],
                         b','.join(cs.tags) or b'(none)',
                     )
                 )
             )
             if cs.branchpoints:
                 ui.writenoi18n(
                     b'Branchpoints: %s \n' % b', '.join(sorted(cs.branchpoints))
                 )
             if opts[b"parents"] and cs.parents:
                 if len(cs.parents) > 1:
                     ui.write(
                         (
                             b'Parents: %s\n'
                             % (b','.join([(b"%d" % p.id) for p in cs.parents]))
                         )
                     )
                 else:
                     ui.write((b'Parent: %d\n' % cs.parents[0].id))
 
             if opts[b"ancestors"]:
                 b = cs.branch
                 r = []
                 while b:
                     b, c = ancestors[b]
                     r.append(b'%s:%d:%d' % (b or b"HEAD", c, branches[b]))
                 if r:
                     ui.write((b'Ancestors: %s\n' % (b','.join(r))))
 
             ui.writenoi18n(b'Log:\n')
             ui.write(b'%s\n\n' % cs.comment)
             ui.writenoi18n(b'Members: \n')
             for f in cs.entries:
                 fn = f.file
                 if fn.startswith(opts[b"prefix"]):
                     fn = fn[len(opts[b"prefix"]) :]
                 ui.write(
                     b'\t%s:%s->%s%s \n'
                     % (
                         fn,
                         b'.'.join([b"%d" % x for x in f.parent]) or b'INITIAL',
                         b'.'.join([(b"%d" % x) for x in f.revision]),
                         [b'', b'(DEAD)'][f.dead],
                     )
                 )
             ui.write(b'\n')
 
         # have we seen the start tag?
         if revisions and off:
             if revisions[0] == (b"%d" % cs.id) or revisions[0] in cs.tags:
                 off = False
 
         # see if we reached the end tag
         if len(revisions) > 1 and not off:
             if revisions[1] == (b"%d" % cs.id) or revisions[1] in cs.tags:
                 break

hgext/eol.py

@@ -1,479 +1,479 b''
 """automatically manage newlines in repository files
 
 This extension allows you to manage the type of line endings (CRLF or
 LF) that are used in the repository and in the local working
 directory. That way you can get CRLF line endings on Windows and LF on
 Unix/Mac, thereby letting everybody use their OS native line endings.
 
 The extension reads its configuration from a versioned ``.hgeol``
 configuration file found in the root of the working directory. The
 ``.hgeol`` file use the same syntax as all other Mercurial
 configuration files. It uses two sections, ``[patterns]`` and
 ``[repository]``.
 
 The ``[patterns]`` section specifies how line endings should be
 converted between the working directory and the repository. The format is
 specified by a file pattern. The first match is used, so put more
 specific patterns first. The available line endings are ``LF``,
 ``CRLF``, and ``BIN``.
 
 Files with the declared format of ``CRLF`` or ``LF`` are always
 checked out and stored in the repository in that format and files
 declared to be binary (``BIN``) are left unchanged. Additionally,
 ``native`` is an alias for checking out in the platform's default line
 ending: ``LF`` on Unix (including Mac OS X) and ``CRLF`` on
 Windows. Note that ``BIN`` (do nothing to line endings) is Mercurial's
 default behavior; it is only needed if you need to override a later,
 more general pattern.
 
 The optional ``[repository]`` section specifies the line endings to
 use for files stored in the repository. It has a single setting,
 ``native``, which determines the storage line endings for files
 declared as ``native`` in the ``[patterns]`` section. It can be set to
 ``LF`` or ``CRLF``. The default is ``LF``. For example, this means
 that on Windows, files configured as ``native`` (``CRLF`` by default)
 will be converted to ``LF`` when stored in the repository. Files
 declared as ``LF``, ``CRLF``, or ``BIN`` in the ``[patterns]`` section
 are always stored as-is in the repository.
 
 Example versioned ``.hgeol`` file::
 
   [patterns]
   **.py = native
   **.vcproj = CRLF
   **.txt = native
   Makefile = LF
   **.jpg = BIN
 
   [repository]
   native = LF
 
 .. note::
 
    The rules will first apply when files are touched in the working
    directory, e.g. by updating to null and back to tip to touch all files.
 
 The extension uses an optional ``[eol]`` section read from both the
 normal Mercurial configuration files and the ``.hgeol`` file, with the
 latter overriding the former. You can use that section to control the
 overall behavior. There are three settings:
 
 - ``eol.native`` (default ``os.linesep``) can be set to ``LF`` or
   ``CRLF`` to override the default interpretation of ``native`` for
   checkout. This can be used with :hg:`archive` on Unix, say, to
   generate an archive where files have line endings for Windows.
 
 - ``eol.only-consistent`` (default True) can be set to False to make
   the extension convert files with inconsistent EOLs. Inconsistent
   means that there is both ``CRLF`` and ``LF`` present in the file.
   Such files are normally not touched under the assumption that they
   have mixed EOLs on purpose.
 
 - ``eol.fix-trailing-newline`` (default False) can be set to True to
   ensure that converted files end with a EOL character (either ``\\n``
   or ``\\r\\n`` as per the configured patterns).
 
 The extension provides ``cleverencode:`` and ``cleverdecode:`` filters
 like the deprecated win32text extension does. This means that you can
 disable win32text and enable eol and your filters will still work. You
 only need to these filters until you have prepared a ``.hgeol`` file.
 
 The ``win32text.forbid*`` hooks provided by the win32text extension
 have been unified into a single hook named ``eol.checkheadshook``. The
 hook will lookup the expected line endings from the ``.hgeol`` file,
 which means you must migrate to a ``.hgeol`` file first before using
 the hook. ``eol.checkheadshook`` only checks heads, intermediate
 invalid revisions will be pushed. To forbid them completely, use the
 ``eol.checkallhook`` hook. These hooks are best used as
 ``pretxnchangegroup`` hooks.
 
 See :hg:`help patterns` for more information about the glob patterns
 used.
 """
 
 
 import os
 import re
 from mercurial.i18n import _
 from mercurial import (
     config,
     error as errormod,
     extensions,
     match,
     pycompat,
     registrar,
     scmutil,
     util,
 )
 from mercurial.utils import stringutil
 
 # Note for extension authors: ONLY specify testedwith = 'ships-with-hg-core' 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 = b'ships-with-hg-core'
 
 configtable = {}
 configitem = registrar.configitem(configtable)
 
 configitem(
     b'eol',
     b'fix-trailing-newline',
     default=False,
 )
 configitem(
     b'eol',
     b'native',
     default=pycompat.oslinesep,
 )
 configitem(
     b'eol',
     b'only-consistent',
     default=True,
 )
 
 # Matches a lone LF, i.e., one that is not part of CRLF.
 singlelf = re.compile(b'(^|[^\r])\n')
 
 
 def inconsistenteol(data):
     return b'\r\n' in data and singlelf.search(data)
 
 
 def tolf(s, params, ui, **kwargs):
     """Filter to convert to LF EOLs."""
     if stringutil.binary(s):
         return s
     if ui.configbool(b'eol', b'only-consistent') and inconsistenteol(s):
         return s
     if (
         ui.configbool(b'eol', b'fix-trailing-newline')
         and s
         and not s.endswith(b'\n')
     ):
         s = s + b'\n'
     return util.tolf(s)
 
 
 def tocrlf(s, params, ui, **kwargs):
     """Filter to convert to CRLF EOLs."""
     if stringutil.binary(s):
         return s
     if ui.configbool(b'eol', b'only-consistent') and inconsistenteol(s):
         return s
     if (
         ui.configbool(b'eol', b'fix-trailing-newline')
         and s
         and not s.endswith(b'\n')
     ):
         s = s + b'\n'
     return util.tocrlf(s)
 
 
 def isbinary(s, params, ui, **kwargs):
     """Filter to do nothing with the file."""
     return s
 
 
 filters = {
     b'to-lf': tolf,
     b'to-crlf': tocrlf,
     b'is-binary': isbinary,
     # The following provide backwards compatibility with win32text
     b'cleverencode:': tolf,
     b'cleverdecode:': tocrlf,
 }
 
 
 class eolfile:
     def __init__(self, ui, root, data):
         self._decode = {
             b'LF': b'to-lf',
             b'CRLF': b'to-crlf',
             b'BIN': b'is-binary',
         }
         self._encode = {
             b'LF': b'to-lf',
             b'CRLF': b'to-crlf',
             b'BIN': b'is-binary',
         }
 
         self.cfg = config.config()
         # Our files should not be touched. The pattern must be
         # inserted first override a '** = native' pattern.
         self.cfg.set(b'patterns', b'.hg*', b'BIN', b'eol')
         # We can then parse the user's patterns.
         self.cfg.parse(b'.hgeol', data)
 
         isrepolf = self.cfg.get(b'repository', b'native') != b'CRLF'
         self._encode[b'NATIVE'] = isrepolf and b'to-lf' or b'to-crlf'
         iswdlf = ui.config(b'eol', b'native') in (b'LF', b'\n')
         self._decode[b'NATIVE'] = iswdlf and b'to-lf' or b'to-crlf'
 
         include = []
         exclude = []
         self.patterns = []
         for pattern, style in self.cfg.items(b'patterns'):
             key = style.upper()
             if key == b'BIN':
                 exclude.append(pattern)
             else:
                 include.append(pattern)
             m = match.match(root, b'', [pattern])
             self.patterns.append((pattern, key, m))
         # This will match the files for which we need to care
         # about inconsistent newlines.
         self.match = match.match(root, b'', [], include, exclude)
 
     def copytoui(self, ui):
         newpatterns = {pattern for pattern, key, m in self.patterns}
         for section in (b'decode', b'encode'):
             for oldpattern, _filter in ui.configitems(section):
                 if oldpattern not in newpatterns:
                     if ui.configsource(section, oldpattern) == b'eol':
                         ui.setconfig(section, oldpattern, b'!', b'eol')
         for pattern, key, m in self.patterns:
             try:
                 ui.setconfig(b'decode', pattern, self._decode[key], b'eol')
                 ui.setconfig(b'encode', pattern, self._encode[key], b'eol')
             except KeyError:
                 ui.warn(
                     _(b"ignoring unknown EOL style '%s' from %s\n")
                     % (key, self.cfg.source(b'patterns', pattern))
                 )
         # eol.only-consistent can be specified in ~/.hgrc or .hgeol
         for k, v in self.cfg.items(b'eol'):
             ui.setconfig(b'eol', k, v, b'eol')
 
     def checkrev(self, repo, ctx, files):
         failed = []
         for f in files or ctx.files():
             if f not in ctx:
                 continue
             for pattern, key, m in self.patterns:
                 if not m(f):
                     continue
                 target = self._encode[key]
                 data = ctx[f].data()
                 if (
                     target == b"to-lf"
                     and b"\r\n" in data
                     or target == b"to-crlf"
                     and singlelf.search(data)
                 ):
                     failed.append((f, target, bytes(ctx)))
                 break
         return failed
 
 
 def parseeol(ui, repo, nodes):
     try:
         for node in nodes:
             try:
                 if node is None:
                     # Cannot use workingctx.data() since it would load
                     # and cache the filters before we configure them.
                     data = repo.wvfs(b'.hgeol').read()
                 else:
                     data = repo[node][b'.hgeol'].data()
                 return eolfile(ui, repo.root, data)
             except (IOError, LookupError):
                 pass
     except errormod.ConfigError as inst:
         ui.warn(
             _(
                 b"warning: ignoring .hgeol file due to parse error "
                 b"at %s: %s\n"
             )
             % (inst.location, inst.message)
         )
     return None
 
 
 def ensureenabled(ui):
     """make sure the extension is enabled when used as hook
 
     When eol is used through hooks, the extension is never formally loaded and
     enabled. This has some side effect, for example the config declaration is
     never loaded. This function ensure the extension is enabled when running
     hooks.
     """
     if b'eol' in ui._knownconfig:
         return
     ui.setconfig(b'extensions', b'eol', b'', source=b'internal')
     extensions.loadall(ui, [b'eol'])
 
 
 def _checkhook(ui, repo, node, headsonly):
     # Get revisions to check and touched files at the same time
     ensureenabled(ui)
     files = set()
     revs = set()
-    for rev in pycompat.xrange(repo[node].rev(), len(repo)):
+    for rev in range(repo[node].rev(), len(repo)):
         revs.add(rev)
         if headsonly:
             ctx = repo[rev]
             files.update(ctx.files())
             for pctx in ctx.parents():
                 revs.discard(pctx.rev())
     failed = []
     for rev in revs:
         ctx = repo[rev]
         eol = parseeol(ui, repo, [ctx.node()])
         if eol:
             failed.extend(eol.checkrev(repo, ctx, files))
 
     if failed:
         eols = {b'to-lf': b'CRLF', b'to-crlf': b'LF'}
         msgs = []
         for f, target, node in sorted(failed):
             msgs.append(
                 _(b"  %s in %s should not have %s line endings")
                 % (f, node, eols[target])
             )
         raise errormod.Abort(
             _(b"end-of-line check failed:\n") + b"\n".join(msgs)
         )
 
 
 def checkallhook(ui, repo, node, hooktype, **kwargs):
     """verify that files have expected EOLs"""
     _checkhook(ui, repo, node, False)
 
 
 def checkheadshook(ui, repo, node, hooktype, **kwargs):
     """verify that files have expected EOLs"""
     _checkhook(ui, repo, node, True)
 
 
 # "checkheadshook" used to be called "hook"
 hook = checkheadshook
 
 
 def preupdate(ui, repo, hooktype, parent1, parent2):
     p1node = scmutil.resolvehexnodeidprefix(repo, parent1)
     repo.loadeol([p1node])
     return False
 
 
 def uisetup(ui):
     ui.setconfig(b'hooks', b'preupdate.eol', preupdate, b'eol')
 
 
 def extsetup(ui):
     try:
         extensions.find(b'win32text')
         ui.warn(
             _(
                 b"the eol extension is incompatible with the "
                 b"win32text extension\n"
             )
         )
     except KeyError:
         pass
 
 
 def reposetup(ui, repo):
     uisetup(repo.ui)
 
     if not repo.local():
         return
     for name, fn in filters.items():
         repo.adddatafilter(name, fn)
 
     ui.setconfig(b'patch', b'eol', b'auto', b'eol')
 
     class eolrepo(repo.__class__):
         def loadeol(self, nodes):
             eol = parseeol(self.ui, self, nodes)
             if eol is None:
                 return None
             eol.copytoui(self.ui)
             return eol.match
 
         def _hgcleardirstate(self):
             self._eolmatch = self.loadeol([None])
             if not self._eolmatch:
                 self._eolmatch = util.never
                 return
 
             oldeol = None
             try:
                 cachemtime = os.path.getmtime(self.vfs.join(b"eol.cache"))
             except OSError:
                 cachemtime = 0
             else:
                 olddata = self.vfs.read(b"eol.cache")
                 if olddata:
                     oldeol = eolfile(self.ui, self.root, olddata)
 
             try:
                 eolmtime = os.path.getmtime(self.wjoin(b".hgeol"))
             except OSError:
                 eolmtime = 0
 
             if eolmtime >= cachemtime and eolmtime > 0:
                 self.ui.debug(b"eol: detected change in .hgeol\n")
 
                 hgeoldata = self.wvfs.read(b'.hgeol')
                 neweol = eolfile(self.ui, self.root, hgeoldata)
 
                 wlock = None
                 try:
                     wlock = self.wlock()
                     for f in self.dirstate:
                         if not self.dirstate.get_entry(f).maybe_clean:
                             continue
                         if oldeol is not None:
                             if not oldeol.match(f) and not neweol.match(f):
                                 continue
                             oldkey = None
                             for pattern, key, m in oldeol.patterns:
                                 if m(f):
                                     oldkey = key
                                     break
                             newkey = None
                             for pattern, key, m in neweol.patterns:
                                 if m(f):
                                     newkey = key
                                     break
                             if oldkey == newkey:
                                 continue
                         # all normal files need to be looked at again since
                         # the new .hgeol file specify a different filter
                         self.dirstate.set_possibly_dirty(f)
                     # Write the cache to update mtime and cache .hgeol
                     with self.vfs(b"eol.cache", b"w") as f:
                         f.write(hgeoldata)
                 except errormod.LockUnavailable:
                     # If we cannot lock the repository and clear the
                     # dirstate, then a commit might not see all files
                     # as modified. But if we cannot lock the
                     # repository, then we can also not make a commit,
                     # so ignore the error.
                     pass
                 finally:
                     if wlock is not None:
                         wlock.release()
 
         def commitctx(self, ctx, error=False, origctx=None):
             for f in sorted(ctx.added() + ctx.modified()):
                 if not self._eolmatch(f):
                     continue
                 fctx = ctx[f]
                 if fctx is None:
                     continue
                 data = fctx.data()
                 if stringutil.binary(data):
                     # We should not abort here, since the user should
                     # be able to say "** = native" to automatically
                     # have all non-binary files taken care of.
                     continue
                 if inconsistenteol(data):
                     raise errormod.Abort(
                         _(b"inconsistent newline style in %s\n") % f
                     )
             return super(eolrepo, self).commitctx(ctx, error, origctx)
 
     repo.__class__ = eolrepo
     repo._hgcleardirstate()

hgext/fastannotate/context.py

@@ -1,858 +1,858 b''
 # Copyright 2016-present Facebook. All Rights Reserved.
 #
 # context: context needed to annotate a file
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2 or any later version.
 
 
 import collections
 import contextlib
 import os
 
 from mercurial.i18n import _
 from mercurial.pycompat import (
     getattr,
     open,
     setattr,
 )
 from mercurial.node import (
     bin,
     hex,
     short,
 )
 from mercurial import (
     error,
     linelog as linelogmod,
     lock as lockmod,
     mdiff,
     pycompat,
     scmutil,
     util,
 )
 from mercurial.utils import (
     hashutil,
     stringutil,
 )
 
 from . import (
     error as faerror,
     revmap as revmapmod,
 )
 
 # given path, get filelog, cached
 @util.lrucachefunc
 def _getflog(repo, path):
     return repo.file(path)
 
 
 # extracted from mercurial.context.basefilectx.annotate
 def _parents(f, follow=True):
     # Cut _descendantrev here to mitigate the penalty of lazy linkrev
     # adjustment. Otherwise, p._adjustlinkrev() would walk changelog
     # from the topmost introrev (= srcrev) down to p.linkrev() if it
     # isn't an ancestor of the srcrev.
     f._changeid
     pl = f.parents()
 
     # Don't return renamed parents if we aren't following.
     if not follow:
         pl = [p for p in pl if p.path() == f.path()]
 
     # renamed filectx won't have a filelog yet, so set it
     # from the cache to save time
     for p in pl:
         if not '_filelog' in p.__dict__:
             p._filelog = _getflog(f._repo, p.path())
 
     return pl
 
 
 # extracted from mercurial.context.basefilectx.annotate. slightly modified
 # so it takes a fctx instead of a pair of text and fctx.
 def _decorate(fctx):
     text = fctx.data()
     linecount = text.count(b'\n')
     if text and not text.endswith(b'\n'):
         linecount += 1
-    return ([(fctx, i) for i in pycompat.xrange(linecount)], text)
+    return ([(fctx, i) for i in range(linecount)], text)
 
 
 # extracted from mercurial.context.basefilectx.annotate. slightly modified
 # so it takes an extra "blocks" parameter calculated elsewhere, instead of
 # calculating diff here.
 def _pair(parent, child, blocks):
     for (a1, a2, b1, b2), t in blocks:
         # Changed blocks ('!') or blocks made only of blank lines ('~')
         # belong to the child.
         if t == b'=':
             child[0][b1:b2] = parent[0][a1:a2]
     return child
 
 
 # like scmutil.revsingle, but with lru cache, so their states (like manifests)
 # could be reused
 _revsingle = util.lrucachefunc(scmutil.revsingle)
 
 
 def resolvefctx(repo, rev, path, resolverev=False, adjustctx=None):
     """(repo, str, str) -> fctx
 
     get the filectx object from repo, rev, path, in an efficient way.
 
     if resolverev is True, "rev" is a revision specified by the revset
     language, otherwise "rev" is a nodeid, or a revision number that can
     be consumed by repo.__getitem__.
 
     if adjustctx is not None, the returned fctx will point to a changeset
     that introduces the change (last modified the file). if adjustctx
     is 'linkrev', trust the linkrev and do not adjust it. this is noticeably
     faster for big repos but is incorrect for some cases.
     """
     if resolverev and not isinstance(rev, int) and rev is not None:
         ctx = _revsingle(repo, rev)
     else:
         ctx = repo[rev]
 
     # If we don't need to adjust the linkrev, create the filectx using the
     # changectx instead of using ctx[path]. This means it already has the
     # changectx information, so blame -u will be able to look directly at the
     # commitctx object instead of having to resolve it by going through the
     # manifest. In a lazy-manifest world this can prevent us from downloading a
     # lot of data.
     if adjustctx is None:
         # ctx.rev() is None means it's the working copy, which is a special
         # case.
         if ctx.rev() is None:
             fctx = ctx[path]
         else:
             fctx = repo.filectx(path, changeid=ctx.rev())
     else:
         fctx = ctx[path]
         if adjustctx == b'linkrev':
             introrev = fctx.linkrev()
         else:
             introrev = fctx.introrev()
         if introrev != ctx.rev():
             fctx._changeid = introrev
             fctx._changectx = repo[introrev]
     return fctx
 
 
 # like mercurial.store.encodedir, but use linelog suffixes: .m, .l, .lock
 def encodedir(path):
     return (
         path.replace(b'.hg/', b'.hg.hg/')
         .replace(b'.l/', b'.l.hg/')
         .replace(b'.m/', b'.m.hg/')
         .replace(b'.lock/', b'.lock.hg/')
     )
 
 
 def hashdiffopts(diffopts):
     diffoptstr = stringutil.pprint(
         sorted((k, getattr(diffopts, k)) for k in mdiff.diffopts.defaults)
     )
     return hex(hashutil.sha1(diffoptstr).digest())[:6]
 
 
 _defaultdiffopthash = hashdiffopts(mdiff.defaultopts)
 
 
 class annotateopts:
     """like mercurial.mdiff.diffopts, but is for annotate
 
     followrename: follow renames, like "hg annotate -f"
     followmerge: follow p2 of a merge changeset, otherwise p2 is ignored
     """
 
     defaults = {
         b'diffopts': None,
         b'followrename': True,
         b'followmerge': True,
     }
 
     def __init__(self, **opts):
         opts = pycompat.byteskwargs(opts)
         for k, v in self.defaults.items():
             setattr(self, k, opts.get(k, v))
 
     @util.propertycache
     def shortstr(self):
         """represent opts in a short string, suitable for a directory name"""
         result = b''
         if not self.followrename:
             result += b'r0'
         if not self.followmerge:
             result += b'm0'
         if self.diffopts is not None:
             assert isinstance(self.diffopts, mdiff.diffopts)
             diffopthash = hashdiffopts(self.diffopts)
             if diffopthash != _defaultdiffopthash:
                 result += b'i' + diffopthash
         return result or b'default'
 
 
 defaultopts = annotateopts()
 
 
 class _annotatecontext:
     """do not use this class directly as it does not use lock to protect
     writes. use "with annotatecontext(...)" instead.
     """
 
     def __init__(self, repo, path, linelogpath, revmappath, opts):
         self.repo = repo
         self.ui = repo.ui
         self.path = path
         self.opts = opts
         self.linelogpath = linelogpath
         self.revmappath = revmappath
         self._linelog = None
         self._revmap = None
         self._node2path = {}  # {str: str}
 
     @property
     def linelog(self):
         if self._linelog is None:
             if os.path.exists(self.linelogpath):
                 with open(self.linelogpath, b'rb') as f:
                     try:
                         self._linelog = linelogmod.linelog.fromdata(f.read())
                     except linelogmod.LineLogError:
                         self._linelog = linelogmod.linelog()
             else:
                 self._linelog = linelogmod.linelog()
         return self._linelog
 
     @property
     def revmap(self):
         if self._revmap is None:
             self._revmap = revmapmod.revmap(self.revmappath)
         return self._revmap
 
     def close(self):
         if self._revmap is not None:
             self._revmap.flush()
             self._revmap = None
         if self._linelog is not None:
             with open(self.linelogpath, b'wb') as f:
                 f.write(self._linelog.encode())
             self._linelog = None
 
     __del__ = close
 
     def rebuild(self):
         """delete linelog and revmap, useful for rebuilding"""
         self.close()
         self._node2path.clear()
         _unlinkpaths([self.revmappath, self.linelogpath])
 
     @property
     def lastnode(self):
         """return last node in revmap, or None if revmap is empty"""
         if self._revmap is None:
             # fast path, read revmap without loading its full content
             return revmapmod.getlastnode(self.revmappath)
         else:
             return self._revmap.rev2hsh(self._revmap.maxrev)
 
     def isuptodate(self, master, strict=True):
         """return True if the revmap / linelog is up-to-date, or the file
         does not exist in the master revision. False otherwise.
 
         it tries to be fast and could return false negatives, because of the
         use of linkrev instead of introrev.
 
         useful for both server and client to decide whether to update
         fastannotate cache or not.
 
         if strict is True, even if fctx exists in the revmap, but is not the
         last node, isuptodate will return False. it's good for performance - no
         expensive check was done.
 
         if strict is False, if fctx exists in the revmap, this function may
         return True. this is useful for the client to skip downloading the
         cache if the client's master is behind the server's.
         """
         lastnode = self.lastnode
         try:
             f = self._resolvefctx(master, resolverev=True)
             # choose linkrev instead of introrev as the check is meant to be
             # *fast*.
             linknode = self.repo.changelog.node(f.linkrev())
             if not strict and lastnode and linknode != lastnode:
                 # check if f.node() is in the revmap. note: this loads the
                 # revmap and can be slow.
                 return self.revmap.hsh2rev(linknode) is not None
             # avoid resolving old manifest, or slow adjustlinkrev to be fast,
             # false negatives are acceptable in this case.
             return linknode == lastnode
         except LookupError:
             # master does not have the file, or the revmap is ahead
             return True
 
     def annotate(self, rev, master=None, showpath=False, showlines=False):
         """incrementally update the cache so it includes revisions in the main
         branch till 'master'. and run annotate on 'rev', which may or may not be
         included in the main branch.
 
         if master is None, do not update linelog.
 
         the first value returned is the annotate result, it is [(node, linenum)]
         by default. [(node, linenum, path)] if showpath is True.
 
         if showlines is True, a second value will be returned, it is a list of
         corresponding line contents.
         """
 
         # the fast path test requires commit hash, convert rev number to hash,
         # so it may hit the fast path. note: in the "fctx" mode, the "annotate"
         # command could give us a revision number even if the user passes a
         # commit hash.
         if isinstance(rev, int):
             rev = hex(self.repo.changelog.node(rev))
 
         # fast path: if rev is in the main branch already
         directly, revfctx = self.canannotatedirectly(rev)
         if directly:
             if self.ui.debugflag:
                 self.ui.debug(
                     b'fastannotate: %s: using fast path '
                     b'(resolved fctx: %s)\n'
                     % (
                         self.path,
                         stringutil.pprint(util.safehasattr(revfctx, b'node')),
                     )
                 )
             return self.annotatedirectly(revfctx, showpath, showlines)
 
         # resolve master
         masterfctx = None
         if master:
             try:
                 masterfctx = self._resolvefctx(
                     master, resolverev=True, adjustctx=True
                 )
             except LookupError:  # master does not have the file
                 pass
             else:
                 if masterfctx in self.revmap:  # no need to update linelog
                     masterfctx = None
 
         #                  ... - @ <- rev (can be an arbitrary changeset,
         #                 /                not necessarily a descendant
         #      master -> o                 of master)
         #                |
         #     a merge -> o         'o': new changesets in the main branch
         #                |\        '#': revisions in the main branch that
         #                o *            exist in linelog / revmap
         #                | .       '*': changesets in side branches, or
         # last master -> # .            descendants of master
         #                | .
         #                # *       joint: '#', and is a parent of a '*'
         #                |/
         #     a joint -> # ^^^^ --- side branches
         #                |
         #                ^ --- main branch (in linelog)
 
         # these DFSes are similar to the traditional annotate algorithm.
         # we cannot really reuse the code for perf reason.
 
         # 1st DFS calculates merges, joint points, and needed.
         # "needed" is a simple reference counting dict to free items in
         # "hist", reducing its memory usage otherwise could be huge.
         initvisit = [revfctx]
         if masterfctx:
             if masterfctx.rev() is None:
                 raise error.Abort(
                     _(b'cannot update linelog to wdir()'),
                     hint=_(b'set fastannotate.mainbranch'),
                 )
             initvisit.append(masterfctx)
         visit = initvisit[:]
         pcache = {}
         needed = {revfctx: 1}
         hist = {}  # {fctx: ([(llrev or fctx, linenum)], text)}
         while visit:
             f = visit.pop()
             if f in pcache or f in hist:
                 continue
             if f in self.revmap:  # in the old main branch, it's a joint
                 llrev = self.revmap.hsh2rev(f.node())
                 self.linelog.annotate(llrev)
                 result = self.linelog.annotateresult
                 hist[f] = (result, f.data())
                 continue
             pl = self._parentfunc(f)
             pcache[f] = pl
             for p in pl:
                 needed[p] = needed.get(p, 0) + 1
                 if p not in pcache:
                     visit.append(p)
 
         # 2nd (simple) DFS calculates new changesets in the main branch
         # ('o' nodes in # the above graph), so we know when to update linelog.
         newmainbranch = set()
         f = masterfctx
         while f and f not in self.revmap:
             newmainbranch.add(f)
             pl = pcache[f]
             if pl:
                 f = pl[0]
             else:
                 f = None
                 break
 
         # f, if present, is the position where the last build stopped at, and
         # should be the "master" last time. check to see if we can continue
         # building the linelog incrementally. (we cannot if diverged)
         if masterfctx is not None:
             self._checklastmasterhead(f)
 
         if self.ui.debugflag:
             if newmainbranch:
                 self.ui.debug(
                     b'fastannotate: %s: %d new changesets in the main'
                     b' branch\n' % (self.path, len(newmainbranch))
                 )
             elif not hist:  # no joints, no updates
                 self.ui.debug(
                     b'fastannotate: %s: linelog cannot help in '
                     b'annotating this revision\n' % self.path
                 )
 
         # prepare annotateresult so we can update linelog incrementally
         self.linelog.annotate(self.linelog.maxrev)
 
         # 3rd DFS does the actual annotate
         visit = initvisit[:]
         progress = self.ui.makeprogress(
             b'building cache', total=len(newmainbranch)
         )
         while visit:
             f = visit[-1]
             if f in hist:
                 visit.pop()
                 continue
 
             ready = True
             pl = pcache[f]
             for p in pl:
                 if p not in hist:
                     ready = False
                     visit.append(p)
             if not ready:
                 continue
 
             visit.pop()
             blocks = None  # mdiff blocks, used for appending linelog
             ismainbranch = f in newmainbranch
             # curr is the same as the traditional annotate algorithm,
             # if we only care about linear history (do not follow merge),
             # then curr is not actually used.
             assert f not in hist
             curr = _decorate(f)
             for i, p in enumerate(pl):
                 bs = list(self._diffblocks(hist[p][1], curr[1]))
                 if i == 0 and ismainbranch:
                     blocks = bs
                 curr = _pair(hist[p], curr, bs)
                 if needed[p] == 1:
                     del hist[p]
                     del needed[p]
                 else:
                     needed[p] -= 1
 
             hist[f] = curr
             del pcache[f]
 
             if ismainbranch:  # need to write to linelog
                 progress.increment()
                 bannotated = None
                 if len(pl) == 2 and self.opts.followmerge:  # merge
                     bannotated = curr[0]
                 if blocks is None:  # no parents, add an empty one
                     blocks = list(self._diffblocks(b'', curr[1]))
                 self._appendrev(f, blocks, bannotated)
             elif showpath:  # not append linelog, but we need to record path
                 self._node2path[f.node()] = f.path()
 
         progress.complete()
 
         result = [
             ((self.revmap.rev2hsh(fr) if isinstance(fr, int) else fr.node()), l)
             for fr, l in hist[revfctx][0]
         ]  # [(node, linenumber)]
         return self._refineannotateresult(result, revfctx, showpath, showlines)
 
     def canannotatedirectly(self, rev):
         """(str) -> bool, fctx or node.
         return (True, f) if we can annotate without updating the linelog, pass
         f to annotatedirectly.
         return (False, f) if we need extra calculation. f is the fctx resolved
         from rev.
         """
         result = True
         f = None
         if not isinstance(rev, int) and rev is not None:
             hsh = {20: bytes, 40: bin}.get(len(rev), lambda x: None)(rev)
             if hsh is not None and (hsh, self.path) in self.revmap:
                 f = hsh
         if f is None:
             adjustctx = b'linkrev' if self._perfhack else True
             f = self._resolvefctx(rev, adjustctx=adjustctx, resolverev=True)
             result = f in self.revmap
             if not result and self._perfhack:
                 # redo the resolution without perfhack - as we are going to
                 # do write operations, we need a correct fctx.
                 f = self._resolvefctx(rev, adjustctx=True, resolverev=True)
         return result, f
 
     def annotatealllines(self, rev, showpath=False, showlines=False):
         """(rev : str) -> [(node : str, linenum : int, path : str)]
 
         the result has the same format with annotate, but include all (including
         deleted) lines up to rev. call this after calling annotate(rev, ...) for
         better performance and accuracy.
         """
         revfctx = self._resolvefctx(rev, resolverev=True, adjustctx=True)
 
         # find a chain from rev to anything in the mainbranch
         if revfctx not in self.revmap:
             chain = [revfctx]
             a = b''
             while True:
                 f = chain[-1]
                 pl = self._parentfunc(f)
                 if not pl:
                     break
                 if pl[0] in self.revmap:
                     a = pl[0].data()
                     break
                 chain.append(pl[0])
 
             # both self.linelog and self.revmap is backed by filesystem. now
             # we want to modify them but do not want to write changes back to
             # files. so we create in-memory objects and copy them. it's like
             # a "fork".
             linelog = linelogmod.linelog()
             linelog.copyfrom(self.linelog)
             linelog.annotate(linelog.maxrev)
             revmap = revmapmod.revmap()
             revmap.copyfrom(self.revmap)
 
             for f in reversed(chain):
                 b = f.data()
                 blocks = list(self._diffblocks(a, b))
                 self._doappendrev(linelog, revmap, f, blocks)
                 a = b
         else:
             # fastpath: use existing linelog, revmap as we don't write to them
             linelog = self.linelog
             revmap = self.revmap
 
         lines = linelog.getalllines()
         hsh = revfctx.node()
         llrev = revmap.hsh2rev(hsh)
         result = [(revmap.rev2hsh(r), l) for r, l in lines if r <= llrev]
         # cannot use _refineannotateresult since we need custom logic for
         # resolving line contents
         if showpath:
             result = self._addpathtoresult(result, revmap)
         if showlines:
             linecontents = self._resolvelines(result, revmap, linelog)
             result = (result, linecontents)
         return result
 
     def _resolvelines(self, annotateresult, revmap, linelog):
         """(annotateresult) -> [line]. designed for annotatealllines.
         this is probably the most inefficient code in the whole fastannotate
         directory. but we have made a decision that the linelog does not
         store line contents. so getting them requires random accesses to
         the revlog data, since they can be many, it can be very slow.
         """
         # [llrev]
         revs = [revmap.hsh2rev(l[0]) for l in annotateresult]
         result = [None] * len(annotateresult)
         # {(rev, linenum): [lineindex]}
         key2idxs = collections.defaultdict(list)
-        for i in pycompat.xrange(len(result)):
+        for i in range(len(result)):
             key2idxs[(revs[i], annotateresult[i][1])].append(i)
         while key2idxs:
             # find an unresolved line and its linelog rev to annotate
             hsh = None
             try:
                 for (rev, _linenum), idxs in key2idxs.items():
                     if revmap.rev2flag(rev) & revmapmod.sidebranchflag:
                         continue
                     hsh = annotateresult[idxs[0]][0]
                     break
             except StopIteration:  # no more unresolved lines
                 return result
             if hsh is None:
                 # the remaining key2idxs are not in main branch, resolving them
                 # using the hard way...
                 revlines = {}
                 for (rev, linenum), idxs in key2idxs.items():
                     if rev not in revlines:
                         hsh = annotateresult[idxs[0]][0]
                         if self.ui.debugflag:
                             self.ui.debug(
                                 b'fastannotate: reading %s line #%d '
                                 b'to resolve lines %r\n'
                                 % (short(hsh), linenum, idxs)
                             )
                         fctx = self._resolvefctx(hsh, revmap.rev2path(rev))
                         lines = mdiff.splitnewlines(fctx.data())
                         revlines[rev] = lines
                     for idx in idxs:
                         result[idx] = revlines[rev][linenum]
                 assert all(x is not None for x in result)
                 return result
 
             # run the annotate and the lines should match to the file content
             self.ui.debug(
                 b'fastannotate: annotate %s to resolve lines\n' % short(hsh)
             )
             linelog.annotate(rev)
             fctx = self._resolvefctx(hsh, revmap.rev2path(rev))
             annotated = linelog.annotateresult
             lines = mdiff.splitnewlines(fctx.data())
             if len(lines) != len(annotated):
                 raise faerror.CorruptedFileError(b'unexpected annotated lines')
             # resolve lines from the annotate result
             for i, line in enumerate(lines):
                 k = annotated[i]
                 if k in key2idxs:
                     for idx in key2idxs[k]:
                         result[idx] = line
                     del key2idxs[k]
         return result
 
     def annotatedirectly(self, f, showpath, showlines):
         """like annotate, but when we know that f is in linelog.
         f can be either a 20-char str (node) or a fctx. this is for perf - in
         the best case, the user provides a node and we don't need to read the
         filelog or construct any filecontext.
         """
         if isinstance(f, bytes):
             hsh = f
         else:
             hsh = f.node()
         llrev = self.revmap.hsh2rev(hsh)
         if not llrev:
             raise faerror.CorruptedFileError(b'%s is not in revmap' % hex(hsh))
         if (self.revmap.rev2flag(llrev) & revmapmod.sidebranchflag) != 0:
             raise faerror.CorruptedFileError(
                 b'%s is not in revmap mainbranch' % hex(hsh)
             )
         self.linelog.annotate(llrev)
         result = [
             (self.revmap.rev2hsh(r), l) for r, l in self.linelog.annotateresult
         ]
         return self._refineannotateresult(result, f, showpath, showlines)
 
     def _refineannotateresult(self, result, f, showpath, showlines):
         """add the missing path or line contents, they can be expensive.
         f could be either node or fctx.
         """
         if showpath:
             result = self._addpathtoresult(result)
         if showlines:
             if isinstance(f, bytes):  # f: node or fctx
                 llrev = self.revmap.hsh2rev(f)
                 fctx = self._resolvefctx(f, self.revmap.rev2path(llrev))
             else:
                 fctx = f
             lines = mdiff.splitnewlines(fctx.data())
             if len(lines) != len(result):  # linelog is probably corrupted
                 raise faerror.CorruptedFileError()
             result = (result, lines)
         return result
 
     def _appendrev(self, fctx, blocks, bannotated=None):
         self._doappendrev(self.linelog, self.revmap, fctx, blocks, bannotated)
 
     def _diffblocks(self, a, b):
         return mdiff.allblocks(a, b, self.opts.diffopts)
 
     @staticmethod
     def _doappendrev(linelog, revmap, fctx, blocks, bannotated=None):
         """append a revision to linelog and revmap"""
 
         def getllrev(f):
             """(fctx) -> int"""
             # f should not be a linelog revision
             if isinstance(f, int):
                 raise error.ProgrammingError(b'f should not be an int')
             # f is a fctx, allocate linelog rev on demand
             hsh = f.node()
             rev = revmap.hsh2rev(hsh)
             if rev is None:
                 rev = revmap.append(hsh, sidebranch=True, path=f.path())
             return rev
 
         # append sidebranch revisions to revmap
         siderevs = []
         siderevmap = {}  # node: int
         if bannotated is not None:
             for (a1, a2, b1, b2), op in blocks:
                 if op != b'=':
                     # f could be either linelong rev, or fctx.
                     siderevs += [
                         f
                         for f, l in bannotated[b1:b2]
                         if not isinstance(f, int)
                     ]
         siderevs = set(siderevs)
         if fctx in siderevs:  # mainnode must be appended seperately
             siderevs.remove(fctx)
         for f in siderevs:
             siderevmap[f] = getllrev(f)
 
         # the changeset in the main branch, could be a merge
         llrev = revmap.append(fctx.node(), path=fctx.path())
         siderevmap[fctx] = llrev
 
         for (a1, a2, b1, b2), op in reversed(blocks):
             if op == b'=':
                 continue
             if bannotated is None:
                 linelog.replacelines(llrev, a1, a2, b1, b2)
             else:
                 blines = [
                     ((r if isinstance(r, int) else siderevmap[r]), l)
                     for r, l in bannotated[b1:b2]
                 ]
                 linelog.replacelines_vec(llrev, a1, a2, blines)
 
     def _addpathtoresult(self, annotateresult, revmap=None):
         """(revmap, [(node, linenum)]) -> [(node, linenum, path)]"""
         if revmap is None:
             revmap = self.revmap
 
         def _getpath(nodeid):
             path = self._node2path.get(nodeid)
             if path is None:
                 path = revmap.rev2path(revmap.hsh2rev(nodeid))
                 self._node2path[nodeid] = path
             return path
 
         return [(n, l, _getpath(n)) for n, l in annotateresult]
 
     def _checklastmasterhead(self, fctx):
         """check if fctx is the master's head last time, raise if not"""
         if fctx is None:
             llrev = 0
         else:
             llrev = self.revmap.hsh2rev(fctx.node())
             if not llrev:
                 raise faerror.CannotReuseError()
         if self.linelog.maxrev != llrev:
             raise faerror.CannotReuseError()
 
     @util.propertycache
     def _parentfunc(self):
         """-> (fctx) -> [fctx]"""
         followrename = self.opts.followrename
         followmerge = self.opts.followmerge
 
         def parents(f):
             pl = _parents(f, follow=followrename)
             if not followmerge:
                 pl = pl[:1]
             return pl
 
         return parents
 
     @util.propertycache
     def _perfhack(self):
         return self.ui.configbool(b'fastannotate', b'perfhack')
 
     def _resolvefctx(self, rev, path=None, **kwds):
         return resolvefctx(self.repo, rev, (path or self.path), **kwds)
 
 
 def _unlinkpaths(paths):
     """silent, best-effort unlink"""
     for path in paths:
         try:
             util.unlink(path)
         except OSError:
             pass
 
 
 class pathhelper:
     """helper for getting paths for lockfile, linelog and revmap"""
 
     def __init__(self, repo, path, opts=defaultopts):
         # different options use different directories
         self._vfspath = os.path.join(
             b'fastannotate', opts.shortstr, encodedir(path)
         )
         self._repo = repo
 
     @property
     def dirname(self):
         return os.path.dirname(self._repo.vfs.join(self._vfspath))
 
     @property
     def linelogpath(self):
         return self._repo.vfs.join(self._vfspath + b'.l')
 
     def lock(self):
         return lockmod.lock(self._repo.vfs, self._vfspath + b'.lock')
 
     @property
     def revmappath(self):
         return self._repo.vfs.join(self._vfspath + b'.m')
 
 
 @contextlib.contextmanager
 def annotatecontext(repo, path, opts=defaultopts, rebuild=False):
     """context needed to perform (fast) annotate on a file
 
     an annotatecontext of a single file consists of two structures: the
     linelog and the revmap. this function takes care of locking. only 1
     process is allowed to write that file's linelog and revmap at a time.
 
     when something goes wrong, this function will assume the linelog and the
     revmap are in a bad state, and remove them from disk.
 
     use this function in the following way:
 
         with annotatecontext(...) as actx:
             actx. ....
     """
     helper = pathhelper(repo, path, opts)
     util.makedirs(helper.dirname)
     revmappath = helper.revmappath
     linelogpath = helper.linelogpath
     actx = None
     try:
         with helper.lock():
             actx = _annotatecontext(repo, path, linelogpath, revmappath, opts)
             if rebuild:
                 actx.rebuild()
             yield actx
     except Exception:
         if actx is not None:
             actx.rebuild()
         repo.ui.debug(b'fastannotate: %s: cache broken and deleted\n' % path)
         raise
     finally:
         if actx is not None:
             actx.close()
 
 
 def fctxannotatecontext(fctx, follow=True, diffopts=None, rebuild=False):
     """like annotatecontext but get the context from a fctx. convenient when
     used in fctx.annotate
     """
     repo = fctx._repo
     path = fctx._path
     if repo.ui.configbool(b'fastannotate', b'forcefollow', True):
         follow = True
     aopts = annotateopts(diffopts=diffopts, followrename=follow)
     return annotatecontext(repo, path, aopts, rebuild)

hgext/fastannotate/formatter.py

@@ -1,176 +1,176 b''
 # Copyright 2016-present Facebook. All Rights Reserved.
 #
 # format: defines the format used to output annotate result
 #
 # 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.node import (
     hex,
     short,
 )
 from mercurial import (
     encoding,
     pycompat,
     templatefilters,
     util,
 )
 from mercurial.utils import dateutil
 
 # imitating mercurial.commands.annotate, not using the vanilla formatter since
 # the data structures are a bit different, and we have some fast paths.
 class defaultformatter:
     """the default formatter that does leftpad and support some common flags"""
 
     def __init__(self, ui, repo, opts):
         self.ui = ui
         self.opts = opts
 
         if ui.quiet:
             datefunc = dateutil.shortdate
         else:
             datefunc = dateutil.datestr
         datefunc = util.cachefunc(datefunc)
         getctx = util.cachefunc(lambda x: repo[x[0]])
         hexfunc = self._hexfunc
 
         # special handling working copy "changeset" and "rev" functions
         if self.opts.get(b'rev') == b'wdir()':
             orig = hexfunc
             hexfunc = lambda x: None if x is None else orig(x)
             wnode = hexfunc(repo[b'.'].node()) + b'+'
             wrev = b'%d' % repo[b'.'].rev()
             wrevpad = b''
             if not opts.get(b'changeset'):  # only show + if changeset is hidden
                 wrev += b'+'
                 wrevpad = b' '
             revenc = lambda x: wrev if x is None else (b'%d' % x) + wrevpad
 
             def csetenc(x):
                 if x is None:
                     return wnode
                 return pycompat.bytestr(x) + b' '
 
         else:
             revenc = csetenc = pycompat.bytestr
 
         # opt name, separator, raw value (for json/plain), encoder (for plain)
         opmap = [
             (b'user', b' ', lambda x: getctx(x).user(), ui.shortuser),
             (b'number', b' ', lambda x: getctx(x).rev(), revenc),
             (b'changeset', b' ', lambda x: hexfunc(x[0]), csetenc),
             (b'date', b' ', lambda x: getctx(x).date(), datefunc),
             (b'file', b' ', lambda x: x[2], pycompat.bytestr),
             (b'line_number', b':', lambda x: x[1] + 1, pycompat.bytestr),
         ]
         fieldnamemap = {b'number': b'rev', b'changeset': b'node'}
         funcmap = [
             (get, sep, fieldnamemap.get(op, op), enc)
             for op, sep, get, enc in opmap
             if opts.get(op)
         ]
         # no separator for first column
         funcmap[0] = list(funcmap[0])
         funcmap[0][1] = b''
         self.funcmap = funcmap
 
     def write(self, annotatedresult, lines=None, existinglines=None):
         """(annotateresult, [str], set([rev, linenum])) -> None. write output.
         annotateresult can be [(node, linenum, path)], or [(node, linenum)]
         """
         pieces = []  # [[str]]
         maxwidths = []  # [int]
 
         # calculate padding
         for f, sep, name, enc in self.funcmap:
             l = [enc(f(x)) for x in annotatedresult]
             pieces.append(l)
             if name in [b'node', b'date']:  # node and date has fixed size
                 l = l[:1]
             widths = pycompat.maplist(encoding.colwidth, set(l))
             maxwidth = max(widths) if widths else 0
             maxwidths.append(maxwidth)
 
         # buffered output
         result = b''
-        for i in pycompat.xrange(len(annotatedresult)):
+        for i in range(len(annotatedresult)):
             for j, p in enumerate(pieces):
                 sep = self.funcmap[j][1]
                 padding = b' ' * (maxwidths[j] - len(p[i]))
                 result += sep + padding + p[i]
             if lines:
                 if existinglines is None:
                     result += b': ' + lines[i]
                 else:  # extra formatting showing whether a line exists
                     key = (annotatedresult[i][0], annotatedresult[i][1])
                     if key in existinglines:
                         result += b':  ' + lines[i]
                     else:
                         result += b': ' + self.ui.label(
                             b'-' + lines[i], b'diff.deleted'
                         )
 
             if result[-1:] != b'\n':
                 result += b'\n'
 
         self.ui.write(result)
 
     @util.propertycache
     def _hexfunc(self):
         if self.ui.debugflag or self.opts.get(b'long_hash'):
             return hex
         else:
             return short
 
     def end(self):
         pass
 
 
 class jsonformatter(defaultformatter):
     def __init__(self, ui, repo, opts):
         super(jsonformatter, self).__init__(ui, repo, opts)
         self.ui.write(b'[')
         self.needcomma = False
 
     def write(self, annotatedresult, lines=None, existinglines=None):
         if annotatedresult:
             self._writecomma()
 
         pieces = [
             (name, pycompat.maplist(f, annotatedresult))
             for f, sep, name, enc in self.funcmap
         ]
         if lines is not None:
             pieces.append((b'line', lines))
         pieces.sort()
 
         seps = [b','] * len(pieces[:-1]) + [b'']
 
         result = b''
         lasti = len(annotatedresult) - 1
-        for i in pycompat.xrange(len(annotatedresult)):
+        for i in range(len(annotatedresult)):
             result += b'\n {\n'
             for j, p in enumerate(pieces):
                 k, vs = p
                 result += b'  "%s": %s%s\n' % (
                     k,
                     templatefilters.json(vs[i], paranoid=False),
                     seps[j],
                 )
             result += b' }%s' % (b'' if i == lasti else b',')
         if lasti >= 0:
             self.needcomma = True
 
         self.ui.write(result)
 
     def _writecomma(self):
         if self.needcomma:
             self.ui.write(b',')
             self.needcomma = False
 
     @util.propertycache
     def _hexfunc(self):
         return hex
 
     def end(self):
         self.ui.write(b'\n]\n')

hgext/fastannotate/revmap.py

@@ -1,262 +1,259 b''
 # Copyright 2016-present Facebook. All Rights Reserved.
 #
 # revmap: trivial hg hash - linelog rev bidirectional map
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2 or any later version.
 
 
 import bisect
 import io
 import os
 import struct
 
 from mercurial.node import hex
 from mercurial.pycompat import open
 from mercurial import (
     error as hgerror,
-    pycompat,
 )
 from . import error
 
 # the revmap file format is straightforward:
 #
 #    8 bytes: header
 #    1 byte : flag for linelog revision 1
 #    ? bytes: (optional) '\0'-terminated path string
 #             only exists if (flag & renameflag) != 0
 #   20 bytes: hg hash for linelog revision 1
 #    1 byte : flag for linelog revision 2
 #    ? bytes: (optional) '\0'-terminated path string
 #   20 bytes: hg hash for linelog revision 2
 #   ....
 #
 # the implementation is kinda stupid: __init__ loads the whole revmap.
 # no laziness. benchmark shows loading 10000 revisions is about 0.015
 # seconds, which looks enough for our use-case. if this implementation
 # becomes a bottleneck, we can change it to lazily read the file
 # from the end.
 
 # whether the changeset is in the side branch. i.e. not in the linear main
 # branch but only got referenced by lines in merge changesets.
 sidebranchflag = 1
 
 # whether the changeset changes the file path (ie. is a rename)
 renameflag = 2
 
 # len(mercurial.node.nullid)
 _hshlen = 20
 
 
 class revmap:
     """trivial hg bin hash - linelog rev bidirectional map
 
     also stores a flag (uint8) for each revision, and track renames.
     """
 
     HEADER = b'REVMAP1\0'
 
     def __init__(self, path=None):
         """create or load the revmap, optionally associate to a file
 
         if path is None, the revmap is entirely in-memory. the caller is
         responsible for locking. concurrent writes to a same file is unsafe.
         the caller needs to make sure one file is associated to at most one
         revmap object at a time."""
         self.path = path
         self._rev2hsh = [None]
         self._rev2flag = [None]
         self._hsh2rev = {}
         # since rename does not happen frequently, do not store path for every
         # revision. self._renamerevs can be used for bisecting.
         self._renamerevs = [0]
         self._renamepaths = [b'']
         self._lastmaxrev = -1
         if path:
             if os.path.exists(path):
                 self._load()
             else:
                 # write the header so "append" can do incremental updates
                 self.flush()
 
     def copyfrom(self, rhs):
         """copy the map data from another revmap. do not affect self.path"""
         self._rev2hsh = rhs._rev2hsh[:]
         self._rev2flag = rhs._rev2flag[:]
         self._hsh2rev = rhs._hsh2rev.copy()
         self._renamerevs = rhs._renamerevs[:]
         self._renamepaths = rhs._renamepaths[:]
         self._lastmaxrev = -1
 
     @property
     def maxrev(self):
         """return max linelog revision number"""
         return len(self._rev2hsh) - 1
 
     def append(self, hsh, sidebranch=False, path=None, flush=False):
         """add a binary hg hash and return the mapped linelog revision.
         if flush is True, incrementally update the file.
         """
         if hsh in self._hsh2rev:
             raise error.CorruptedFileError(
                 b'%r is in revmap already' % hex(hsh)
             )
         if len(hsh) != _hshlen:
             raise hgerror.ProgrammingError(
                 b'hsh must be %d-char long' % _hshlen
             )
         idx = len(self._rev2hsh)
         flag = 0
         if sidebranch:
             flag |= sidebranchflag
         if path is not None and path != self._renamepaths[-1]:
             flag |= renameflag
             self._renamerevs.append(idx)
             self._renamepaths.append(path)
         self._rev2hsh.append(hsh)
         self._rev2flag.append(flag)
         self._hsh2rev[hsh] = idx
         if flush:
             self.flush()
         return idx
 
     def rev2hsh(self, rev):
         """convert linelog revision to hg hash. return None if not found."""
         if rev > self.maxrev or rev < 0:
             return None
         return self._rev2hsh[rev]
 
     def rev2flag(self, rev):
         """get the flag (uint8) for a given linelog revision.
         return None if revision does not exist.
         """
         if rev > self.maxrev or rev < 0:
             return None
         return self._rev2flag[rev]
 
     def rev2path(self, rev):
         """get the path for a given linelog revision.
         return None if revision does not exist.
         """
         if rev > self.maxrev or rev < 0:
             return None
         idx = bisect.bisect_right(self._renamerevs, rev) - 1
         return self._renamepaths[idx]
 
     def hsh2rev(self, hsh):
         """convert hg hash to linelog revision. return None if not found."""
         return self._hsh2rev.get(hsh)
 
     def clear(self, flush=False):
         """make the map empty. if flush is True, write to disk"""
         # rev 0 is reserved, real rev starts from 1
         self._rev2hsh = [None]
         self._rev2flag = [None]
         self._hsh2rev = {}
         self._rev2path = [b'']
         self._lastmaxrev = -1
         if flush:
             self.flush()
 
     def flush(self):
         """write the state down to the file"""
         if not self.path:
             return
         if self._lastmaxrev == -1:  # write the entire file
             with open(self.path, b'wb') as f:
                 f.write(self.HEADER)
-                for i in pycompat.xrange(1, len(self._rev2hsh)):
+                for i in range(1, len(self._rev2hsh)):
                     self._writerev(i, f)
         else:  # append incrementally
             with open(self.path, b'ab') as f:
-                for i in pycompat.xrange(
-                    self._lastmaxrev + 1, len(self._rev2hsh)
-                ):
+                for i in range(self._lastmaxrev + 1, len(self._rev2hsh)):
                     self._writerev(i, f)
         self._lastmaxrev = self.maxrev
 
     def _load(self):
         """load state from file"""
         if not self.path:
             return
         # use local variables in a loop. CPython uses LOAD_FAST for them,
         # which is faster than both LOAD_CONST and LOAD_GLOBAL.
         flaglen = 1
         hshlen = _hshlen
         with open(self.path, b'rb') as f:
             if f.read(len(self.HEADER)) != self.HEADER:
                 raise error.CorruptedFileError()
             self.clear(flush=False)
             while True:
                 buf = f.read(flaglen)
                 if not buf:
                     break
                 flag = ord(buf)
                 rev = len(self._rev2hsh)
                 if flag & renameflag:
                     path = self._readcstr(f)
                     self._renamerevs.append(rev)
                     self._renamepaths.append(path)
                 hsh = f.read(hshlen)
                 if len(hsh) != hshlen:
                     raise error.CorruptedFileError()
                 self._hsh2rev[hsh] = rev
                 self._rev2flag.append(flag)
                 self._rev2hsh.append(hsh)
         self._lastmaxrev = self.maxrev
 
     def _writerev(self, rev, f):
         """append a revision data to file"""
         flag = self._rev2flag[rev]
         hsh = self._rev2hsh[rev]
         f.write(struct.pack(b'B', flag))
         if flag & renameflag:
             path = self.rev2path(rev)
             if path is None:
                 raise error.CorruptedFileError(b'cannot find path for %s' % rev)
             f.write(path + b'\0')
         f.write(hsh)
 
     @staticmethod
     def _readcstr(f):
         """read a C-language-like '\0'-terminated string"""
         buf = b''
         while True:
             ch = f.read(1)
             if not ch:  # unexpected eof
                 raise error.CorruptedFileError()
             if ch == b'\0':
                 break
             buf += ch
         return buf
 
     def __contains__(self, f):
         """(fctx or (node, path)) -> bool.
         test if (node, path) is in the map, and is not in a side branch.
         f can be either a tuple of (node, path), or a fctx.
         """
         if isinstance(f, tuple):  # f: (node, path)
             hsh, path = f
         else:  # f: fctx
             hsh, path = f.node(), f.path()
         rev = self.hsh2rev(hsh)
         if rev is None:
             return False
         if path is not None and path != self.rev2path(rev):
             return False
         return (self.rev2flag(rev) & sidebranchflag) == 0
 
 
 def getlastnode(path):
     """return the last hash in a revmap, without loading its full content.
     this is equivalent to `m = revmap(path); m.rev2hsh(m.maxrev)`, but faster.
     """
     hsh = None
     try:
         with open(path, b'rb') as f:
             f.seek(-_hshlen, io.SEEK_END)
             if f.tell() > len(revmap.HEADER):
                 hsh = f.read(_hshlen)
     except IOError:
         pass
     return hsh

hgext/git/gitlog.py

@@ -1,547 +1,547 b''
 from mercurial.i18n import _
 
 from mercurial.node import (
     bin,
     hex,
     nullrev,
     sha1nodeconstants,
 )
 from mercurial import (
     ancestor,
     changelog as hgchangelog,
     dagop,
     encoding,
     error,
     manifest,
     pycompat,
 )
 from mercurial.interfaces import (
     repository,
     util as interfaceutil,
 )
 from mercurial.utils import stringutil
 from . import (
     gitutil,
     index,
     manifest as gitmanifest,
 )
 
 pygit2 = gitutil.get_pygit2()
 
 
 class baselog:  # revlog.revlog):
     """Common implementations between changelog and manifestlog."""
 
     def __init__(self, gr, db):
         self.gitrepo = gr
         self._db = db
 
     def __len__(self):
         return int(
             self._db.execute('SELECT COUNT(*) FROM changelog').fetchone()[0]
         )
 
     def rev(self, n):
         if n == sha1nodeconstants.nullid:
             return -1
         t = self._db.execute(
             'SELECT rev FROM changelog WHERE node = ?', (gitutil.togitnode(n),)
         ).fetchone()
         if t is None:
             raise error.LookupError(n, b'00changelog.i', _(b'no node %d'))
         return t[0]
 
     def node(self, r):
         if r == nullrev:
             return sha1nodeconstants.nullid
         t = self._db.execute(
             'SELECT node FROM changelog WHERE rev = ?', (r,)
         ).fetchone()
         if t is None:
             raise error.LookupError(r, b'00changelog.i', _(b'no node'))
         return bin(t[0])
 
     def hasnode(self, n):
         t = self._db.execute(
             'SELECT node FROM changelog WHERE node = ?',
             (pycompat.sysstr(n),),
         ).fetchone()
         return t is not None
 
 
 class baselogindex:
     def __init__(self, log):
         self._log = log
 
     def has_node(self, n):
         return self._log.rev(n) != -1
 
     def __len__(self):
         return len(self._log)
 
     def __getitem__(self, idx):
         p1rev, p2rev = self._log.parentrevs(idx)
         # TODO: it's messy that the index leaks so far out of the
         # storage layer that we have to implement things like reading
         # this raw tuple, which exposes revlog internals.
         return (
             # Pretend offset is just the index, since we don't really care.
             idx,
             # Same with lengths
             idx,  # length
             idx,  # rawsize
             -1,  # delta base
             idx,  # linkrev TODO is this right?
             p1rev,
             p2rev,
             self._log.node(idx),
         )
 
 
 # TODO: an interface for the changelog type?
 class changelog(baselog):
     # TODO: this appears to be an enumerated type, and should probably
     # be part of the public changelog interface
     _copiesstorage = b'extra'
 
     def __contains__(self, rev):
         try:
             self.node(rev)
             return True
         except error.LookupError:
             return False
 
     def __iter__(self):
-        return iter(pycompat.xrange(len(self)))
+        return iter(range(len(self)))
 
     @property
     def filteredrevs(self):
         # TODO: we should probably add a refs/hg/ namespace for hidden
         # heads etc, but that's an idea for later.
         return set()
 
     @property
     def index(self):
         return baselogindex(self)
 
     @property
     def nodemap(self):
         r = {
             bin(v[0]): v[1]
             for v in self._db.execute('SELECT node, rev FROM changelog')
         }
         r[sha1nodeconstants.nullid] = nullrev
         return r
 
     def tip(self):
         t = self._db.execute(
             'SELECT node FROM changelog ORDER BY rev DESC LIMIT 1'
         ).fetchone()
         if t:
             return bin(t[0])
         return sha1nodeconstants.nullid
 
     def revs(self, start=0, stop=None):
         if stop is None:
             stop = self.tiprev()
         t = self._db.execute(
             'SELECT rev FROM changelog '
             'WHERE rev >= ? AND rev <= ? '
             'ORDER BY REV ASC',
             (start, stop),
         )
         return (int(r[0]) for r in t)
 
     def tiprev(self):
         t = self._db.execute(
             'SELECT rev FROM changelog ' 'ORDER BY REV DESC ' 'LIMIT 1'
         ).fetchone()
 
         if t is not None:
             return t[0]
         return -1
 
     def _partialmatch(self, id):
         if sha1nodeconstants.wdirhex.startswith(id):
             raise error.WdirUnsupported
         candidates = [
             bin(x[0])
             for x in self._db.execute(
                 'SELECT node FROM changelog WHERE node LIKE ?',
                 (pycompat.sysstr(id + b'%'),),
             )
         ]
         if sha1nodeconstants.nullhex.startswith(id):
             candidates.append(sha1nodeconstants.nullid)
         if len(candidates) > 1:
             raise error.AmbiguousPrefixLookupError(
                 id, b'00changelog.i', _(b'ambiguous identifier')
             )
         if candidates:
             return candidates[0]
         return None
 
     def flags(self, rev):
         return 0
 
     def shortest(self, node, minlength=1):
         nodehex = hex(node)
-        for attempt in pycompat.xrange(minlength, len(nodehex) + 1):
+        for attempt in range(minlength, len(nodehex) + 1):
             candidate = nodehex[:attempt]
             matches = int(
                 self._db.execute(
                     'SELECT COUNT(*) FROM changelog WHERE node LIKE ?',
                     (pycompat.sysstr(candidate + b'%'),),
                 ).fetchone()[0]
             )
             if matches == 1:
                 return candidate
         return nodehex
 
     def headrevs(self, revs=None):
         realheads = [
             int(x[0])
             for x in self._db.execute(
                 'SELECT rev FROM changelog '
                 'INNER JOIN heads ON changelog.node = heads.node'
             )
         ]
         if revs:
             return sorted([r for r in revs if r in realheads])
         return sorted(realheads)
 
     def changelogrevision(self, nodeorrev):
         # Ensure we have a node id
         if isinstance(nodeorrev, int):
             n = self.node(nodeorrev)
         else:
             n = nodeorrev
         extra = {b'branch': b'default'}
         # handle looking up nullid
         if n == sha1nodeconstants.nullid:
             return hgchangelog._changelogrevision(
                 extra=extra, manifest=sha1nodeconstants.nullid
             )
         hn = gitutil.togitnode(n)
         # We've got a real commit!
         files = [
             r[0]
             for r in self._db.execute(
                 'SELECT filename FROM changedfiles '
                 'WHERE node = ? and filenode != ?',
                 (hn, gitutil.nullgit),
             )
         ]
         filesremoved = [
             r[0]
             for r in self._db.execute(
                 'SELECT filename FROM changedfiles '
                 'WHERE node = ? and filenode = ?',
                 (hn, gitutil.nullgit),
             )
         ]
         c = self.gitrepo[hn]
         return hgchangelog._changelogrevision(
             manifest=n,  # pretend manifest the same as the commit node
             user=b'%s <%s>'
             % (c.author.name.encode('utf8'), c.author.email.encode('utf8')),
             date=(c.author.time, -c.author.offset * 60),
             files=files,
             # TODO filesadded in the index
             filesremoved=filesremoved,
             description=c.message.encode('utf8'),
             # TODO do we want to handle extra? how?
             extra=extra,
         )
 
     def ancestors(self, revs, stoprev=0, inclusive=False):
         revs = list(revs)
         tip = self.rev(self.tip())
         for r in revs:
             if r > tip:
                 raise IndexError(b'Invalid rev %r' % r)
         return ancestor.lazyancestors(
             self.parentrevs, revs, stoprev=stoprev, inclusive=inclusive
         )
 
     # Cleanup opportunity: this is *identical* to the revlog.py version
     def descendants(self, revs):
         return dagop.descendantrevs(revs, self.revs, self.parentrevs)
 
     def incrementalmissingrevs(self, common=None):
         """Return an object that can be used to incrementally compute the
         revision numbers of the ancestors of arbitrary sets that are not
         ancestors of common. This is an ancestor.incrementalmissingancestors
         object.
 
         'common' is a list of revision numbers. If common is not supplied, uses
         nullrev.
         """
         if common is None:
             common = [nullrev]
 
         return ancestor.incrementalmissingancestors(self.parentrevs, common)
 
     def findmissing(self, common=None, heads=None):
         """Return the ancestors of heads that are not ancestors of common.
 
         More specifically, return a list of nodes N such that every N
         satisfies the following constraints:
 
           1. N is an ancestor of some node in 'heads'
           2. N is not an ancestor of any node in 'common'
 
         The list is sorted by revision number, meaning it is
         topologically sorted.
 
         'heads' and 'common' are both lists of node IDs.  If heads is
         not supplied, uses all of the revlog's heads.  If common is not
         supplied, uses nullid."""
         if common is None:
             common = [sha1nodeconstants.nullid]
         if heads is None:
             heads = self.heads()
 
         common = [self.rev(n) for n in common]
         heads = [self.rev(n) for n in heads]
 
         inc = self.incrementalmissingrevs(common=common)
         return [self.node(r) for r in inc.missingancestors(heads)]
 
     def children(self, node):
         """find the children of a given node"""
         c = []
         p = self.rev(node)
         for r in self.revs(start=p + 1):
             prevs = [pr for pr in self.parentrevs(r) if pr != nullrev]
             if prevs:
                 for pr in prevs:
                     if pr == p:
                         c.append(self.node(r))
             elif p == nullrev:
                 c.append(self.node(r))
         return c
 
     def reachableroots(self, minroot, heads, roots, includepath=False):
         return dagop._reachablerootspure(
             self.parentrevs, minroot, roots, heads, includepath
         )
 
     # Cleanup opportunity: this is *identical* to the revlog.py version
     def isancestor(self, a, b):
         a, b = self.rev(a), self.rev(b)
         return self.isancestorrev(a, b)
 
     # Cleanup opportunity: this is *identical* to the revlog.py version
     def isancestorrev(self, a, b):
         if a == nullrev:
             return True
         elif a == b:
             return True
         elif a > b:
             return False
         return bool(self.reachableroots(a, [b], [a], includepath=False))
 
     def parentrevs(self, rev):
         n = self.node(rev)
         hn = gitutil.togitnode(n)
         if hn != gitutil.nullgit:
             c = self.gitrepo[hn]
         else:
             return nullrev, nullrev
         p1 = p2 = nullrev
         if c.parents:
             p1 = self.rev(c.parents[0].id.raw)
             if len(c.parents) > 2:
                 raise error.Abort(b'TODO octopus merge handling')
             if len(c.parents) == 2:
                 p2 = self.rev(c.parents[1].id.raw)
         return p1, p2
 
     # Private method is used at least by the tags code.
     _uncheckedparentrevs = parentrevs
 
     def commonancestorsheads(self, a, b):
         # TODO the revlog verson of this has a C path, so we probably
         # need to optimize this...
         a, b = self.rev(a), self.rev(b)
         return [
             self.node(n)
             for n in ancestor.commonancestorsheads(self.parentrevs, a, b)
         ]
 
     def branchinfo(self, rev):
         """Git doesn't do named branches, so just put everything on default."""
         return b'default', False
 
     def delayupdate(self, tr):
         # TODO: I think we can elide this because we're just dropping
         # an object in the git repo?
         pass
 
     def add(
         self,
         manifest,
         files,
         desc,
         transaction,
         p1,
         p2,
         user,
         date=None,
         extra=None,
         p1copies=None,
         p2copies=None,
         filesadded=None,
         filesremoved=None,
     ):
         parents = []
         hp1, hp2 = gitutil.togitnode(p1), gitutil.togitnode(p2)
         if p1 != sha1nodeconstants.nullid:
             parents.append(hp1)
         if p2 and p2 != sha1nodeconstants.nullid:
             parents.append(hp2)
         assert date is not None
         timestamp, tz = date
         sig = pygit2.Signature(
             encoding.unifromlocal(stringutil.person(user)),
             encoding.unifromlocal(stringutil.email(user)),
             int(timestamp),
             -int(tz // 60),
         )
         oid = self.gitrepo.create_commit(
             None, sig, sig, desc, gitutil.togitnode(manifest), parents
         )
         # Set up an internal reference to force the commit into the
         # changelog. Hypothetically, we could even use this refs/hg/
         # namespace to allow for anonymous heads on git repos, which
         # would be neat.
         self.gitrepo.references.create(
             'refs/hg/internal/latest-commit', oid, force=True
         )
         # Reindex now to pick up changes. We omit the progress
         # and log callbacks because this will be very quick.
         index._index_repo(self.gitrepo, self._db)
         return oid.raw
 
 
 class manifestlog(baselog):
     nodeconstants = sha1nodeconstants
 
     def __getitem__(self, node):
         return self.get(b'', node)
 
     def get(self, relpath, node):
         if node == sha1nodeconstants.nullid:
             # TODO: this should almost certainly be a memgittreemanifestctx
             return manifest.memtreemanifestctx(self, relpath)
         commit = self.gitrepo[gitutil.togitnode(node)]
         t = commit.tree
         if relpath:
             parts = relpath.split(b'/')
             for p in parts:
                 te = t[p]
                 t = self.gitrepo[te.id]
         return gitmanifest.gittreemanifestctx(self.gitrepo, t)
 
 
 @interfaceutil.implementer(repository.ifilestorage)
 class filelog(baselog):
     def __init__(self, gr, db, path):
         super(filelog, self).__init__(gr, db)
         assert isinstance(path, bytes)
         self.path = path
         self.nullid = sha1nodeconstants.nullid
 
     def read(self, node):
         if node == sha1nodeconstants.nullid:
             return b''
         return self.gitrepo[gitutil.togitnode(node)].data
 
     def lookup(self, node):
         if len(node) not in (20, 40):
             node = int(node)
         if isinstance(node, int):
             assert False, b'todo revnums for nodes'
         if len(node) == 40:
             node = bin(node)
         hnode = gitutil.togitnode(node)
         if hnode in self.gitrepo:
             return node
         raise error.LookupError(self.path, node, _(b'no match found'))
 
     def cmp(self, node, text):
         """Returns True if text is different than content at `node`."""
         return self.read(node) != text
 
     def add(self, text, meta, transaction, link, p1=None, p2=None):
         assert not meta  # Should we even try to handle this?
         return self.gitrepo.create_blob(text).raw
 
     def __iter__(self):
         for clrev in self._db.execute(
             '''
 SELECT rev FROM changelog
 INNER JOIN changedfiles ON changelog.node = changedfiles.node
 WHERE changedfiles.filename = ? AND changedfiles.filenode != ?
         ''',
             (pycompat.fsdecode(self.path), gitutil.nullgit),
         ):
             yield clrev[0]
 
     def linkrev(self, fr):
         return fr
 
     def rev(self, node):
         row = self._db.execute(
             '''
 SELECT rev FROM changelog
 INNER JOIN changedfiles ON changelog.node = changedfiles.node
 WHERE changedfiles.filename = ? AND changedfiles.filenode = ?''',
             (pycompat.fsdecode(self.path), gitutil.togitnode(node)),
         ).fetchone()
         if row is None:
             raise error.LookupError(self.path, node, _(b'no such node'))
         return int(row[0])
 
     def node(self, rev):
         maybe = self._db.execute(
             '''SELECT filenode FROM changedfiles
 INNER JOIN changelog ON changelog.node = changedfiles.node
 WHERE changelog.rev = ? AND filename = ?
 ''',
             (rev, pycompat.fsdecode(self.path)),
         ).fetchone()
         if maybe is None:
             raise IndexError('gitlog %r out of range %d' % (self.path, rev))
         return bin(maybe[0])
 
     def parents(self, node):
         gn = gitutil.togitnode(node)
         gp = pycompat.fsdecode(self.path)
         ps = []
         for p in self._db.execute(
             '''SELECT p1filenode, p2filenode FROM changedfiles
 WHERE filenode = ? AND filename = ?
 ''',
             (gn, gp),
         ).fetchone():
             if p is None:
                 commit = self._db.execute(
                     "SELECT node FROM changedfiles "
                     "WHERE filenode = ? AND filename = ?",
                     (gn, gp),
                 ).fetchone()[0]
                 # This filelog is missing some data. Build the
                 # filelog, then recurse (which will always find data).
                 if pycompat.ispy3:
                     commit = commit.decode('ascii')
                 index.fill_in_filelog(self.gitrepo, self._db, commit, gp, gn)
                 return self.parents(node)
             else:
                 ps.append(bin(p))
         return ps
 
     def renamed(self, node):
         # TODO: renames/copies
         return False

hgext/hgk.py

@@ -1,385 +1,385 b''
 # Minimal support for git commands on an hg repository
 #
 # Copyright 2005, 2006 Chris Mason <[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.
 
 '''browse the repository in a graphical way
 
 The hgk extension allows browsing the history of a repository in a
 graphical way. It requires Tcl/Tk version 8.4 or later. (Tcl/Tk is not
 distributed with Mercurial.)
 
 hgk consists of two parts: a Tcl script that does the displaying and
 querying of information, and an extension to Mercurial named hgk.py,
 which provides hooks for hgk to get information. hgk can be found in
 the contrib directory, and the extension is shipped in the hgext
 repository, and needs to be enabled.
 
 The :hg:`view` command will launch the hgk Tcl script. For this command
 to work, hgk must be in your search path. Alternately, you can specify
 the path to hgk in your configuration file::
 
   [hgk]
   path = /location/of/hgk
 
 hgk can make use of the extdiff extension to visualize revisions.
 Assuming you had already configured extdiff vdiff command, just add::
 
   [hgk]
   vdiff=vdiff
 
 Revisions context menu will now display additional entries to fire
 vdiff on hovered and selected revisions.
 '''
 
 
 import os
 
 from mercurial.i18n import _
 from mercurial.node import (
     nullrev,
     short,
 )
 from mercurial import (
     commands,
     obsolete,
     patch,
     pycompat,
     registrar,
     scmutil,
 )
 
 cmdtable = {}
 command = registrar.command(cmdtable)
 # Note for extension authors: ONLY specify testedwith = 'ships-with-hg-core' 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 = b'ships-with-hg-core'
 
 configtable = {}
 configitem = registrar.configitem(configtable)
 
 configitem(
     b'hgk',
     b'path',
     default=b'hgk',
 )
 
 
 @command(
     b'debug-diff-tree',
     [
         (b'p', b'patch', None, _(b'generate patch')),
         (b'r', b'recursive', None, _(b'recursive')),
         (b'P', b'pretty', None, _(b'pretty')),
         (b's', b'stdin', None, _(b'stdin')),
         (b'C', b'copy', None, _(b'detect copies')),
         (b'S', b'search', b"", _(b'search')),
     ],
     b'[OPTION]... NODE1 NODE2 [FILE]...',
     inferrepo=True,
 )
 def difftree(ui, repo, node1=None, node2=None, *files, **opts):
     """diff trees from two commits"""
 
     def __difftree(repo, node1, node2, files=None):
         assert node2 is not None
         if files is None:
             files = []
         mmap = repo[node1].manifest()
         mmap2 = repo[node2].manifest()
         m = scmutil.match(repo[node1], files)
         st = repo.status(node1, node2, m)
         empty = short(repo.nullid)
 
         for f in st.modified:
             # TODO get file permissions
             ui.writenoi18n(
                 b":100664 100664 %s %s M\t%s\t%s\n"
                 % (short(mmap[f]), short(mmap2[f]), f, f)
             )
         for f in st.added:
             ui.writenoi18n(
                 b":000000 100664 %s %s N\t%s\t%s\n"
                 % (empty, short(mmap2[f]), f, f)
             )
         for f in st.removed:
             ui.writenoi18n(
                 b":100664 000000 %s %s D\t%s\t%s\n"
                 % (short(mmap[f]), empty, f, f)
             )
 
     ##
 
     while True:
         if opts['stdin']:
             line = ui.fin.readline()
             if not line:
                 break
             line = line.rstrip(pycompat.oslinesep).split(b' ')
             node1 = line[0]
             if len(line) > 1:
                 node2 = line[1]
             else:
                 node2 = None
         node1 = repo.lookup(node1)
         if node2:
             node2 = repo.lookup(node2)
         else:
             node2 = node1
             node1 = repo.changelog.parents(node1)[0]
         if opts['patch']:
             if opts['pretty']:
                 catcommit(ui, repo, node2, b"")
             m = scmutil.match(repo[node1], files)
             diffopts = patch.difffeatureopts(ui)
             diffopts.git = True
             chunks = patch.diff(repo, node1, node2, match=m, opts=diffopts)
             for chunk in chunks:
                 ui.write(chunk)
         else:
             __difftree(repo, node1, node2, files=files)
         if not opts['stdin']:
             break
 
 
 def catcommit(ui, repo, n, prefix, ctx=None):
     nlprefix = b'\n' + prefix
     if ctx is None:
         ctx = repo[n]
     # use ctx.node() instead ??
     ui.write((b"tree %s\n" % short(ctx.changeset()[0])))
     for p in ctx.parents():
         ui.write((b"parent %s\n" % p))
 
     date = ctx.date()
     description = ctx.description().replace(b"\0", b"")
     ui.write((b"author %s %d %d\n" % (ctx.user(), int(date[0]), date[1])))
 
     if b'committer' in ctx.extra():
         ui.write((b"committer %s\n" % ctx.extra()[b'committer']))
 
     ui.write((b"revision %d\n" % ctx.rev()))
     ui.write((b"branch %s\n" % ctx.branch()))
     if obsolete.isenabled(repo, obsolete.createmarkersopt):
         if ctx.obsolete():
             ui.writenoi18n(b"obsolete\n")
     ui.write((b"phase %s\n\n" % ctx.phasestr()))
 
     if prefix != b"":
         ui.write(
             b"%s%s\n" % (prefix, description.replace(b'\n', nlprefix).strip())
         )
     else:
         ui.write(description + b"\n")
     if prefix:
         ui.write(b'\0')
 
 
 @command(b'debug-merge-base', [], _(b'REV REV'))
 def base(ui, repo, node1, node2):
     """output common ancestor information"""
     node1 = repo.lookup(node1)
     node2 = repo.lookup(node2)
     n = repo.changelog.ancestor(node1, node2)
     ui.write(short(n) + b"\n")
 
 
 @command(
     b'debug-cat-file',
     [(b's', b'stdin', None, _(b'stdin'))],
     _(b'[OPTION]... TYPE FILE'),
     inferrepo=True,
 )
 def catfile(ui, repo, type=None, r=None, **opts):
     """cat a specific revision"""
     # in stdin mode, every line except the commit is prefixed with two
     # spaces.  This way the our caller can find the commit without magic
     # strings
     #
     prefix = b""
     if opts['stdin']:
         line = ui.fin.readline()
         if not line:
             return
         (type, r) = line.rstrip(pycompat.oslinesep).split(b' ')
         prefix = b"    "
     else:
         if not type or not r:
             ui.warn(_(b"cat-file: type or revision not supplied\n"))
             commands.help_(ui, b'cat-file')
 
     while r:
         if type != b"commit":
             ui.warn(_(b"aborting hg cat-file only understands commits\n"))
             return 1
         n = repo.lookup(r)
         catcommit(ui, repo, n, prefix)
         if opts['stdin']:
             line = ui.fin.readline()
             if not line:
                 break
             (type, r) = line.rstrip(pycompat.oslinesep).split(b' ')
         else:
             break
 
 
 # git rev-tree is a confusing thing.  You can supply a number of
 # commit sha1s on the command line, and it walks the commit history
 # telling you which commits are reachable from the supplied ones via
 # a bitmask based on arg position.
 # you can specify a commit to stop at by starting the sha1 with ^
 def revtree(ui, args, repo, full=b"tree", maxnr=0, parents=False):
     def chlogwalk():
         count = len(repo)
         i = count
         l = [0] * 100
         chunk = 100
         while True:
             if chunk > i:
                 chunk = i
                 i = 0
             else:
                 i -= chunk
 
-            for x in pycompat.xrange(chunk):
+            for x in range(chunk):
                 if i + x >= count:
                     l[chunk - x :] = [0] * (chunk - x)
                     break
                 if full is not None:
                     if (i + x) in repo:
                         l[x] = repo[i + x]
                         l[x].changeset()  # force reading
                 else:
                     if (i + x) in repo:
                         l[x] = 1
-            for x in pycompat.xrange(chunk - 1, -1, -1):
+            for x in range(chunk - 1, -1, -1):
                 if l[x] != 0:
                     yield (i + x, full is not None and l[x] or None)
             if i == 0:
                 break
 
     # calculate and return the reachability bitmask for sha
     def is_reachable(ar, reachable, sha):
         if len(ar) == 0:
             return 1
         mask = 0
-        for i in pycompat.xrange(len(ar)):
+        for i in range(len(ar)):
             if sha in reachable[i]:
                 mask |= 1 << i
 
         return mask
 
     reachable = []
     stop_sha1 = []
     want_sha1 = []
     count = 0
 
     # figure out which commits they are asking for and which ones they
     # want us to stop on
     for i, arg in enumerate(args):
         if arg.startswith(b'^'):
             s = repo.lookup(arg[1:])
             stop_sha1.append(s)
             want_sha1.append(s)
         elif arg != b'HEAD':
             want_sha1.append(repo.lookup(arg))
 
     # calculate the graph for the supplied commits
     for i, n in enumerate(want_sha1):
         reachable.append(set())
         visit = [n]
         reachable[i].add(n)
         while visit:
             n = visit.pop(0)
             if n in stop_sha1:
                 continue
             for p in repo.changelog.parents(n):
                 if p not in reachable[i]:
                     reachable[i].add(p)
                     visit.append(p)
                 if p in stop_sha1:
                     continue
 
     # walk the repository looking for commits that are in our
     # reachability graph
     for i, ctx in chlogwalk():
         if i not in repo:
             continue
         n = repo.changelog.node(i)
         mask = is_reachable(want_sha1, reachable, n)
         if mask:
             parentstr = b""
             if parents:
                 pp = repo.changelog.parents(n)
                 if pp[0] != repo.nullid:
                     parentstr += b" " + short(pp[0])
                 if pp[1] != repo.nullid:
                     parentstr += b" " + short(pp[1])
             if not full:
                 ui.write(b"%s%s\n" % (short(n), parentstr))
             elif full == b"commit":
                 ui.write(b"%s%s\n" % (short(n), parentstr))
                 catcommit(ui, repo, n, b'    ', ctx)
             else:
                 (p1, p2) = repo.changelog.parents(n)
                 (h, h1, h2) = map(short, (n, p1, p2))
                 (i1, i2) = map(repo.changelog.rev, (p1, p2))
 
                 date = ctx.date()[0]
                 ui.write(b"%s %s:%s" % (date, h, mask))
                 mask = is_reachable(want_sha1, reachable, p1)
                 if i1 != nullrev and mask > 0:
                     ui.write(b"%s:%s " % (h1, mask)),
                 mask = is_reachable(want_sha1, reachable, p2)
                 if i2 != nullrev and mask > 0:
                     ui.write(b"%s:%s " % (h2, mask))
                 ui.write(b"\n")
             if maxnr and count >= maxnr:
                 break
             count += 1
 
 
 # git rev-list tries to order things by date, and has the ability to stop
 # at a given commit without walking the whole repo.  TODO add the stop
 # parameter
 @command(
     b'debug-rev-list',
     [
         (b'H', b'header', None, _(b'header')),
         (b't', b'topo-order', None, _(b'topo-order')),
         (b'p', b'parents', None, _(b'parents')),
         (b'n', b'max-count', 0, _(b'max-count')),
     ],
     b'[OPTION]... REV...',
 )
 def revlist(ui, repo, *revs, **opts):
     """print revisions"""
     if opts['header']:
         full = b"commit"
     else:
         full = None
     copy = [x for x in revs]
     revtree(ui, copy, repo, full, opts['max_count'], opts[r'parents'])
 
 
 @command(
     b'view',
     [(b'l', b'limit', b'', _(b'limit number of changes displayed'), _(b'NUM'))],
     _(b'[-l LIMIT] [REVRANGE]'),
     helpcategory=command.CATEGORY_CHANGE_NAVIGATION,
 )
 def view(ui, repo, *etc, **opts):
     """start interactive history viewer"""
     opts = pycompat.byteskwargs(opts)
     os.chdir(repo.root)
     optstr = b' '.join([b'--%s %s' % (k, v) for k, v in opts.items() if v])
     if repo.filtername is None:
         optstr += b'--hidden'
 
     cmd = ui.config(b"hgk", b"path") + b" %s %s" % (optstr, b" ".join(etc))
     ui.debug(b"running %s\n" % cmd)
     ui.system(cmd, blockedtag=b'hgk_view')

hgext/histedit.py

@@ -1,2683 +1,2683 b''
 # histedit.py - interactive history editing for mercurial
 #
 # Copyright 2009 Augie Fackler <[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.
 """interactive history editing
 
 With this extension installed, Mercurial gains one new command: histedit. Usage
 is as follows, assuming the following history::
 
  @  3[tip]   7c2fd3b9020c   2009-04-27 18:04 -0500   durin42
  |    Add delta
  |
  o  2   030b686bedc4   2009-04-27 18:04 -0500   durin42
  |    Add gamma
  |
  o  1   c561b4e977df   2009-04-27 18:04 -0500   durin42
  |    Add beta
  |
  o  0   d8d2fcd0e319   2009-04-27 18:04 -0500   durin42
       Add alpha
 
 If you were to run ``hg histedit c561b4e977df``, you would see the following
 file open in your editor::
 
  pick c561b4e977df Add beta
  pick 030b686bedc4 Add gamma
  pick 7c2fd3b9020c Add delta
 
  # Edit history between c561b4e977df and 7c2fd3b9020c
  #
  # Commits are listed from least to most recent
  #
  # Commands:
  #  p, pick = use commit
  #  e, edit = use commit, but allow edits before making new commit
  #  f, fold = use commit, but combine it with the one above
  #  r, roll = like fold, but discard this commit's description and date
  #  d, drop = remove commit from history
  #  m, mess = edit commit message without changing commit content
  #  b, base = checkout changeset and apply further changesets from there
  #
 
 In this file, lines beginning with ``#`` are ignored. You must specify a rule
 for each revision in your history. For example, if you had meant to add gamma
 before beta, and then wanted to add delta in the same revision as beta, you
 would reorganize the file to look like this::
 
  pick 030b686bedc4 Add gamma
  pick c561b4e977df Add beta
  fold 7c2fd3b9020c Add delta
 
  # Edit history between c561b4e977df and 7c2fd3b9020c
  #
  # Commits are listed from least to most recent
  #
  # Commands:
  #  p, pick = use commit
  #  e, edit = use commit, but allow edits before making new commit
  #  f, fold = use commit, but combine it with the one above
  #  r, roll = like fold, but discard this commit's description and date
  #  d, drop = remove commit from history
  #  m, mess = edit commit message without changing commit content
  #  b, base = checkout changeset and apply further changesets from there
  #
 
 At which point you close the editor and ``histedit`` starts working. When you
 specify a ``fold`` operation, ``histedit`` will open an editor when it folds
 those revisions together, offering you a chance to clean up the commit message::
 
  Add beta
  ***
  Add delta
 
 Edit the commit message to your liking, then close the editor. The date used
 for the commit will be the later of the two commits' dates. For this example,
 let's assume that the commit message was changed to ``Add beta and delta.``
 After histedit has run and had a chance to remove any old or temporary
 revisions it needed, the history looks like this::
 
  @  2[tip]   989b4d060121   2009-04-27 18:04 -0500   durin42
  |    Add beta and delta.
  |
  o  1   081603921c3f   2009-04-27 18:04 -0500   durin42
  |    Add gamma
  |
  o  0   d8d2fcd0e319   2009-04-27 18:04 -0500   durin42
       Add alpha
 
 Note that ``histedit`` does *not* remove any revisions (even its own temporary
 ones) until after it has completed all the editing operations, so it will
 probably perform several strip operations when it's done. For the above example,
 it had to run strip twice. Strip can be slow depending on a variety of factors,
 so you might need to be a little patient. You can choose to keep the original
 revisions by passing the ``--keep`` flag.
 
 The ``edit`` operation will drop you back to a command prompt,
 allowing you to edit files freely, or even use ``hg record`` to commit
 some changes as a separate commit. When you're done, any remaining
 uncommitted changes will be committed as well. When done, run ``hg
 histedit --continue`` to finish this step. If there are uncommitted
 changes, you'll be prompted for a new commit message, but the default
 commit message will be the original message for the ``edit`` ed
 revision, and the date of the original commit will be preserved.
 
 The ``message`` operation will give you a chance to revise a commit
 message without changing the contents. It's a shortcut for doing
 ``edit`` immediately followed by `hg histedit --continue``.
 
 If ``histedit`` encounters a conflict when moving a revision (while
 handling ``pick`` or ``fold``), it'll stop in a similar manner to
 ``edit`` with the difference that it won't prompt you for a commit
 message when done. If you decide at this point that you don't like how
 much work it will be to rearrange history, or that you made a mistake,
 you can use ``hg histedit --abort`` to abandon the new changes you
 have made and return to the state before you attempted to edit your
 history.
 
 If we clone the histedit-ed example repository above and add four more
 changes, such that we have the following history::
 
    @  6[tip]   038383181893   2009-04-27 18:04 -0500   stefan
    |    Add theta
    |
    o  5   140988835471   2009-04-27 18:04 -0500   stefan
    |    Add eta
    |
    o  4   122930637314   2009-04-27 18:04 -0500   stefan
    |    Add zeta
    |
    o  3   836302820282   2009-04-27 18:04 -0500   stefan
    |    Add epsilon
    |
    o  2   989b4d060121   2009-04-27 18:04 -0500   durin42
    |    Add beta and delta.
    |
    o  1   081603921c3f   2009-04-27 18:04 -0500   durin42
    |    Add gamma
    |
    o  0   d8d2fcd0e319   2009-04-27 18:04 -0500   durin42
         Add alpha
 
 If you run ``hg histedit --outgoing`` on the clone then it is the same
 as running ``hg histedit 836302820282``. If you need plan to push to a
 repository that Mercurial does not detect to be related to the source
 repo, you can add a ``--force`` option.
 
 Config
 ------
 
 Histedit rule lines are truncated to 80 characters by default. You
 can customize this behavior by setting a different length in your
 configuration file::
 
   [histedit]
   linelen = 120      # truncate rule lines at 120 characters
 
 The summary of a change can be customized as well::
 
   [histedit]
   summary-template = '{rev} {bookmarks} {desc|firstline}'
 
 The customized summary should be kept short enough that rule lines
 will fit in the configured line length. See above if that requires
 customization.
 
 ``hg histedit`` attempts to automatically choose an appropriate base
 revision to use. To change which base revision is used, define a
 revset in your configuration file::
 
   [histedit]
   defaultrev = only(.) & draft()
 
 By default each edited revision needs to be present in histedit commands.
 To remove revision you need to use ``drop`` operation. You can configure
 the drop to be implicit for missing commits by adding::
 
   [histedit]
   dropmissing = True
 
 By default, histedit will close the transaction after each action. For
 performance purposes, you can configure histedit to use a single transaction
 across the entire histedit. WARNING: This setting introduces a significant risk
 of losing the work you've done in a histedit if the histedit aborts
 unexpectedly::
 
   [histedit]
   singletransaction = True
 
 """
 
 
 # chistedit dependencies that are not available everywhere
 try:
     import fcntl
     import termios
 except ImportError:
     fcntl = None
     termios = None
 
 import binascii
 import functools
 import os
 import pickle
 import struct
 
 from mercurial.i18n import _
 from mercurial.pycompat import (
     getattr,
     open,
 )
 from mercurial.node import (
     bin,
     hex,
     short,
 )
 from mercurial import (
     bundle2,
     cmdutil,
     context,
     copies,
     destutil,
     discovery,
     encoding,
     error,
     exchange,
     extensions,
     hg,
     logcmdutil,
     merge as mergemod,
     mergestate as mergestatemod,
     mergeutil,
     obsolete,
     pycompat,
     registrar,
     repair,
     rewriteutil,
     scmutil,
     state as statemod,
     util,
 )
 from mercurial.utils import (
     dateutil,
     stringutil,
     urlutil,
 )
 
 cmdtable = {}
 command = registrar.command(cmdtable)
 
 configtable = {}
 configitem = registrar.configitem(configtable)
 configitem(
     b'experimental',
     b'histedit.autoverb',
     default=False,
 )
 configitem(
     b'histedit',
     b'defaultrev',
     default=None,
 )
 configitem(
     b'histedit',
     b'dropmissing',
     default=False,
 )
 configitem(
     b'histedit',
     b'linelen',
     default=80,
 )
 configitem(
     b'histedit',
     b'singletransaction',
     default=False,
 )
 configitem(
     b'ui',
     b'interface.histedit',
     default=None,
 )
 configitem(b'histedit', b'summary-template', default=b'{rev} {desc|firstline}')
 # TODO: Teach the text-based histedit interface to respect this config option
 # before we make it non-experimental.
 configitem(
     b'histedit', b'later-commits-first', default=False, experimental=True
 )
 
 # Note for extension authors: ONLY specify testedwith = 'ships-with-hg-core' 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 = b'ships-with-hg-core'
 
 actiontable = {}
 primaryactions = set()
 secondaryactions = set()
 tertiaryactions = set()
 internalactions = set()
 
 
 def geteditcomment(ui, first, last):
     """construct the editor comment
     The comment includes::
      - an intro
      - sorted primary commands
      - sorted short commands
      - sorted long commands
      - additional hints
 
     Commands are only included once.
     """
     intro = _(
         b"""Edit history between %s and %s
 
 Commits are listed from least to most recent
 
 You can reorder changesets by reordering the lines
 
 Commands:
 """
     )
     actions = []
 
     def addverb(v):
         a = actiontable[v]
         lines = a.message.split(b"\n")
         if len(a.verbs):
             v = b', '.join(sorted(a.verbs, key=lambda v: len(v)))
         actions.append(b" %s = %s" % (v, lines[0]))
         actions.extend([b'  %s'] * (len(lines) - 1))
 
     for v in (
         sorted(primaryactions)
         + sorted(secondaryactions)
         + sorted(tertiaryactions)
     ):
         addverb(v)
     actions.append(b'')
 
     hints = []
     if ui.configbool(b'histedit', b'dropmissing'):
         hints.append(
             b"Deleting a changeset from the list "
             b"will DISCARD it from the edited history!"
         )
 
     lines = (intro % (first, last)).split(b'\n') + actions + hints
 
     return b''.join([b'# %s\n' % l if l else b'#\n' for l in lines])
 
 
 class histeditstate:
     def __init__(self, repo):
         self.repo = repo
         self.actions = None
         self.keep = None
         self.topmost = None
         self.parentctxnode = None
         self.lock = None
         self.wlock = None
         self.backupfile = None
         self.stateobj = statemod.cmdstate(repo, b'histedit-state')
         self.replacements = []
 
     def read(self):
         """Load histedit state from disk and set fields appropriately."""
         if not self.stateobj.exists():
             cmdutil.wrongtooltocontinue(self.repo, _(b'histedit'))
 
         data = self._read()
 
         self.parentctxnode = data[b'parentctxnode']
         actions = parserules(data[b'rules'], self)
         self.actions = actions
         self.keep = data[b'keep']
         self.topmost = data[b'topmost']
         self.replacements = data[b'replacements']
         self.backupfile = data[b'backupfile']
 
     def _read(self):
         fp = self.repo.vfs.read(b'histedit-state')
         if fp.startswith(b'v1\n'):
             data = self._load()
             parentctxnode, rules, keep, topmost, replacements, backupfile = data
         else:
             data = pickle.loads(fp)
             parentctxnode, rules, keep, topmost, replacements = data
             backupfile = None
         rules = b"\n".join([b"%s %s" % (verb, rest) for [verb, rest] in rules])
 
         return {
             b'parentctxnode': parentctxnode,
             b"rules": rules,
             b"keep": keep,
             b"topmost": topmost,
             b"replacements": replacements,
             b"backupfile": backupfile,
         }
 
     def write(self, tr=None):
         if tr:
             tr.addfilegenerator(
                 b'histedit-state',
                 (b'histedit-state',),
                 self._write,
                 location=b'plain',
             )
         else:
             with self.repo.vfs(b"histedit-state", b"w") as f:
                 self._write(f)
 
     def _write(self, fp):
         fp.write(b'v1\n')
         fp.write(b'%s\n' % hex(self.parentctxnode))
         fp.write(b'%s\n' % hex(self.topmost))
         fp.write(b'%s\n' % (b'True' if self.keep else b'False'))
         fp.write(b'%d\n' % len(self.actions))
         for action in self.actions:
             fp.write(b'%s\n' % action.tostate())
         fp.write(b'%d\n' % len(self.replacements))
         for replacement in self.replacements:
             fp.write(
                 b'%s%s\n'
                 % (
                     hex(replacement[0]),
                     b''.join(hex(r) for r in replacement[1]),
                 )
             )
         backupfile = self.backupfile
         if not backupfile:
             backupfile = b''
         fp.write(b'%s\n' % backupfile)
 
     def _load(self):
         fp = self.repo.vfs(b'histedit-state', b'r')
         lines = [l[:-1] for l in fp.readlines()]
 
         index = 0
         lines[index]  # version number
         index += 1
 
         parentctxnode = bin(lines[index])
         index += 1
 
         topmost = bin(lines[index])
         index += 1
 
         keep = lines[index] == b'True'
         index += 1
 
         # Rules
         rules = []
         rulelen = int(lines[index])
         index += 1
-        for i in pycompat.xrange(rulelen):
+        for i in range(rulelen):
             ruleaction = lines[index]
             index += 1
             rule = lines[index]
             index += 1
             rules.append((ruleaction, rule))
 
         # Replacements
         replacements = []
         replacementlen = int(lines[index])
         index += 1
-        for i in pycompat.xrange(replacementlen):
+        for i in range(replacementlen):
             replacement = lines[index]
             original = bin(replacement[:40])
             succ = [
                 bin(replacement[i : i + 40])
                 for i in range(40, len(replacement), 40)
             ]
             replacements.append((original, succ))
             index += 1
 
         backupfile = lines[index]
         index += 1
 
         fp.close()
 
         return parentctxnode, rules, keep, topmost, replacements, backupfile
 
     def clear(self):
         if self.inprogress():
             self.repo.vfs.unlink(b'histedit-state')
 
     def inprogress(self):
         return self.repo.vfs.exists(b'histedit-state')
 
 
 class histeditaction:
     def __init__(self, state, node):
         self.state = state
         self.repo = state.repo
         self.node = node
 
     @classmethod
     def fromrule(cls, state, rule):
         """Parses the given rule, returning an instance of the histeditaction."""
         ruleid = rule.strip().split(b' ', 1)[0]
         # ruleid can be anything from rev numbers, hashes, "bookmarks" etc
         # Check for validation of rule ids and get the rulehash
         try:
             rev = bin(ruleid)
         except binascii.Error:
             try:
                 _ctx = scmutil.revsingle(state.repo, ruleid)
                 rulehash = _ctx.hex()
                 rev = bin(rulehash)
             except error.RepoLookupError:
                 raise error.ParseError(_(b"invalid changeset %s") % ruleid)
         return cls(state, rev)
 
     def verify(self, prev, expected, seen):
         """Verifies semantic correctness of the rule"""
         repo = self.repo
         ha = hex(self.node)
         self.node = scmutil.resolvehexnodeidprefix(repo, ha)
         if self.node is None:
             raise error.ParseError(_(b'unknown changeset %s listed') % ha[:12])
         self._verifynodeconstraints(prev, expected, seen)
 
     def _verifynodeconstraints(self, prev, expected, seen):
         # by default command need a node in the edited list
         if self.node not in expected:
             raise error.ParseError(
                 _(b'%s "%s" changeset was not a candidate')
                 % (self.verb, short(self.node)),
                 hint=_(b'only use listed changesets'),
             )
         # and only one command per node
         if self.node in seen:
             raise error.ParseError(
                 _(b'duplicated command for changeset %s') % short(self.node)
             )
 
     def torule(self):
         """build a histedit rule line for an action
 
         by default lines are in the form:
         <hash> <rev> <summary>
         """
         ctx = self.repo[self.node]
         ui = self.repo.ui
         # We don't want color codes in the commit message template, so
         # disable the label() template function while we render it.
         with ui.configoverride(
             {(b'templatealias', b'label(l,x)'): b"x"}, b'histedit'
         ):
             summary = cmdutil.rendertemplate(
                 ctx, ui.config(b'histedit', b'summary-template')
             )
         line = b'%s %s %s' % (self.verb, ctx, stringutil.firstline(summary))
         # trim to 75 columns by default so it's not stupidly wide in my editor
         # (the 5 more are left for verb)
         maxlen = self.repo.ui.configint(b'histedit', b'linelen')
         maxlen = max(maxlen, 22)  # avoid truncating hash
         return stringutil.ellipsis(line, maxlen)
 
     def tostate(self):
         """Print an action in format used by histedit state files
         (the first line is a verb, the remainder is the second)
         """
         return b"%s\n%s" % (self.verb, hex(self.node))
 
     def run(self):
         """Runs the action. The default behavior is simply apply the action's
         rulectx onto the current parentctx."""
         self.applychange()
         self.continuedirty()
         return self.continueclean()
 
     def applychange(self):
         """Applies the changes from this action's rulectx onto the current
         parentctx, but does not commit them."""
         repo = self.repo
         rulectx = repo[self.node]
         with repo.ui.silent():
             hg.update(repo, self.state.parentctxnode, quietempty=True)
         stats = applychanges(repo.ui, repo, rulectx, {})
         repo.dirstate.setbranch(rulectx.branch())
         if stats.unresolvedcount:
             raise error.InterventionRequired(
                 _(b'Fix up the change (%s %s)') % (self.verb, short(self.node)),
                 hint=_(b'hg histedit --continue to resume'),
             )
 
     def continuedirty(self):
         """Continues the action when changes have been applied to the working
         copy. The default behavior is to commit the dirty changes."""
         repo = self.repo
         rulectx = repo[self.node]
 
         editor = self.commiteditor()
         commit = commitfuncfor(repo, rulectx)
         if repo.ui.configbool(b'rewrite', b'update-timestamp'):
             date = dateutil.makedate()
         else:
             date = rulectx.date()
         commit(
             text=rulectx.description(),
             user=rulectx.user(),
             date=date,
             extra=rulectx.extra(),
             editor=editor,
         )
 
     def commiteditor(self):
         """The editor to be used to edit the commit message."""
         return False
 
     def continueclean(self):
         """Continues the action when the working copy is clean. The default
         behavior is to accept the current commit as the new version of the
         rulectx."""
         ctx = self.repo[b'.']
         if ctx.node() == self.state.parentctxnode:
             self.repo.ui.warn(
                 _(b'%s: skipping changeset (no changes)\n') % short(self.node)
             )
             return ctx, [(self.node, tuple())]
         if ctx.node() == self.node:
             # Nothing changed
             return ctx, []
         return ctx, [(self.node, (ctx.node(),))]
 
 
 def commitfuncfor(repo, src):
     """Build a commit function for the replacement of <src>
 
     This function ensure we apply the same treatment to all changesets.
 
     - Add a 'histedit_source' entry in extra.
 
     Note that fold has its own separated logic because its handling is a bit
     different and not easily factored out of the fold method.
     """
     phasemin = src.phase()
 
     def commitfunc(**kwargs):
         overrides = {(b'phases', b'new-commit'): phasemin}
         with repo.ui.configoverride(overrides, b'histedit'):
             extra = kwargs.get('extra', {}).copy()
             extra[b'histedit_source'] = src.hex()
             kwargs['extra'] = extra
             return repo.commit(**kwargs)
 
     return commitfunc
 
 
 def applychanges(ui, repo, ctx, opts):
     """Merge changeset from ctx (only) in the current working directory"""
     if ctx.p1().node() == repo.dirstate.p1():
         # edits are "in place" we do not need to make any merge,
         # just applies changes on parent for editing
         with ui.silent():
             cmdutil.revert(ui, repo, ctx, all=True)
             stats = mergemod.updateresult(0, 0, 0, 0)
     else:
         try:
             # ui.forcemerge is an internal variable, do not document
             repo.ui.setconfig(
                 b'ui', b'forcemerge', opts.get(b'tool', b''), b'histedit'
             )
             stats = mergemod.graft(
                 repo,
                 ctx,
                 labels=[
                     b'already edited',
                     b'current change',
                     b'parent of current change',
                 ],
             )
         finally:
             repo.ui.setconfig(b'ui', b'forcemerge', b'', b'histedit')
     return stats
 
 
 def collapse(repo, firstctx, lastctx, commitopts, skipprompt=False):
     """collapse the set of revisions from first to last as new one.
 
     Expected commit options are:
         - message
         - date
         - username
     Commit message is edited in all cases.
 
     This function works in memory."""
     ctxs = list(repo.set(b'%d::%d', firstctx.rev(), lastctx.rev()))
     if not ctxs:
         return None
     for c in ctxs:
         if not c.mutable():
             raise error.ParseError(
                 _(b"cannot fold into public change %s") % short(c.node())
             )
     base = firstctx.p1()
 
     # commit a new version of the old changeset, including the update
     # collect all files which might be affected
     files = set()
     for ctx in ctxs:
         files.update(ctx.files())
 
     # Recompute copies (avoid recording a -> b -> a)
     copied = copies.pathcopies(base, lastctx)
 
     # prune files which were reverted by the updates
     files = [f for f in files if not cmdutil.samefile(f, lastctx, base)]
     # commit version of these files as defined by head
     headmf = lastctx.manifest()
 
     def filectxfn(repo, ctx, path):
         if path in headmf:
             fctx = lastctx[path]
             flags = fctx.flags()
             mctx = context.memfilectx(
                 repo,
                 ctx,
                 fctx.path(),
                 fctx.data(),
                 islink=b'l' in flags,
                 isexec=b'x' in flags,
                 copysource=copied.get(path),
             )
             return mctx
         return None
 
     if commitopts.get(b'message'):
         message = commitopts[b'message']
     else:
         message = firstctx.description()
     user = commitopts.get(b'user')
     date = commitopts.get(b'date')
     extra = commitopts.get(b'extra')
 
     parents = (firstctx.p1().node(), firstctx.p2().node())
     editor = None
     if not skipprompt:
         editor = cmdutil.getcommiteditor(edit=True, editform=b'histedit.fold')
     new = context.memctx(
         repo,
         parents=parents,
         text=message,
         files=files,
         filectxfn=filectxfn,
         user=user,
         date=date,
         extra=extra,
         editor=editor,
     )
     return repo.commitctx(new)
 
 
 def _isdirtywc(repo):
     return repo[None].dirty(missing=True)
 
 
 def abortdirty():
     raise error.StateError(
         _(b'working copy has pending changes'),
         hint=_(
             b'amend, commit, or revert them and run histedit '
             b'--continue, or abort with histedit --abort'
         ),
     )
 
 
 def action(verbs, message, priority=False, internal=False):
     def wrap(cls):
         assert not priority or not internal
         verb = verbs[0]
         if priority:
             primaryactions.add(verb)
         elif internal:
             internalactions.add(verb)
         elif len(verbs) > 1:
             secondaryactions.add(verb)
         else:
             tertiaryactions.add(verb)
 
         cls.verb = verb
         cls.verbs = verbs
         cls.message = message
         for verb in verbs:
             actiontable[verb] = cls
         return cls
 
     return wrap
 
 
 @action([b'pick', b'p'], _(b'use commit'), priority=True)
 class pick(histeditaction):
     def run(self):
         rulectx = self.repo[self.node]
         if rulectx.p1().node() == self.state.parentctxnode:
             self.repo.ui.debug(b'node %s unchanged\n' % short(self.node))
             return rulectx, []
 
         return super(pick, self).run()
 
 
 @action(
     [b'edit', b'e'],
     _(b'use commit, but allow edits before making new commit'),
     priority=True,
 )
 class edit(histeditaction):
     def run(self):
         repo = self.repo
         rulectx = repo[self.node]
         hg.update(repo, self.state.parentctxnode, quietempty=True)
         applychanges(repo.ui, repo, rulectx, {})
         hint = _(b'to edit %s, `hg histedit --continue` after making changes')
         raise error.InterventionRequired(
             _(b'Editing (%s), commit as needed now to split the change')
             % short(self.node),
             hint=hint % short(self.node),
         )
 
     def commiteditor(self):
         return cmdutil.getcommiteditor(edit=True, editform=b'histedit.edit')
 
 
 @action([b'fold', b'f'], _(b'use commit, but combine it with the one above'))
 class fold(histeditaction):
     def verify(self, prev, expected, seen):
         """Verifies semantic correctness of the fold rule"""
         super(fold, self).verify(prev, expected, seen)
         repo = self.repo
         if not prev:
             c = repo[self.node].p1()
         elif not prev.verb in (b'pick', b'base'):
             return
         else:
             c = repo[prev.node]
         if not c.mutable():
             raise error.ParseError(
                 _(b"cannot fold into public change %s") % short(c.node())
             )
 
     def continuedirty(self):
         repo = self.repo
         rulectx = repo[self.node]
 
         commit = commitfuncfor(repo, rulectx)
         commit(
             text=b'fold-temp-revision %s' % short(self.node),
             user=rulectx.user(),
             date=rulectx.date(),
             extra=rulectx.extra(),
         )
 
     def continueclean(self):
         repo = self.repo
         ctx = repo[b'.']
         rulectx = repo[self.node]
         parentctxnode = self.state.parentctxnode
         if ctx.node() == parentctxnode:
             repo.ui.warn(_(b'%s: empty changeset\n') % short(self.node))
             return ctx, [(self.node, (parentctxnode,))]
 
         parentctx = repo[parentctxnode]
         newcommits = {
             c.node()
             for c in repo.set(b'(%d::. - %d)', parentctx.rev(), parentctx.rev())
         }
         if not newcommits:
             repo.ui.warn(
                 _(
                     b'%s: cannot fold - working copy is not a '
                     b'descendant of previous commit %s\n'
                 )
                 % (short(self.node), short(parentctxnode))
             )
             return ctx, [(self.node, (ctx.node(),))]
 
         middlecommits = newcommits.copy()
         middlecommits.discard(ctx.node())
 
         return self.finishfold(
             repo.ui, repo, parentctx, rulectx, ctx.node(), middlecommits
         )
 
     def skipprompt(self):
         """Returns true if the rule should skip the message editor.
 
         For example, 'fold' wants to show an editor, but 'rollup'
         doesn't want to.
         """
         return False
 
     def mergedescs(self):
         """Returns true if the rule should merge messages of multiple changes.
 
         This exists mainly so that 'rollup' rules can be a subclass of
         'fold'.
         """
         return True
 
     def firstdate(self):
         """Returns true if the rule should preserve the date of the first
         change.
 
         This exists mainly so that 'rollup' rules can be a subclass of
         'fold'.
         """
         return False
 
     def finishfold(self, ui, repo, ctx, oldctx, newnode, internalchanges):
         mergemod.update(ctx.p1())
         ### prepare new commit data
         commitopts = {}
         commitopts[b'user'] = ctx.user()
         # commit message
         if not self.mergedescs():
             newmessage = ctx.description()
         else:
             newmessage = (
                 b'\n***\n'.join(
                     [ctx.description()]
                     + [repo[r].description() for r in internalchanges]
                     + [oldctx.description()]
                 )
                 + b'\n'
             )
         commitopts[b'message'] = newmessage
         # date
         if self.firstdate():
             commitopts[b'date'] = ctx.date()
         else:
             commitopts[b'date'] = max(ctx.date(), oldctx.date())
         # if date is to be updated to current
         if ui.configbool(b'rewrite', b'update-timestamp'):
             commitopts[b'date'] = dateutil.makedate()
 
         extra = ctx.extra().copy()
         # histedit_source
         # note: ctx is likely a temporary commit but that the best we can do
         #       here. This is sufficient to solve issue3681 anyway.
         extra[b'histedit_source'] = b'%s,%s' % (ctx.hex(), oldctx.hex())
         commitopts[b'extra'] = extra
         phasemin = max(ctx.phase(), oldctx.phase())
         overrides = {(b'phases', b'new-commit'): phasemin}
         with repo.ui.configoverride(overrides, b'histedit'):
             n = collapse(
                 repo,
                 ctx,
                 repo[newnode],
                 commitopts,
                 skipprompt=self.skipprompt(),
             )
         if n is None:
             return ctx, []
         mergemod.update(repo[n])
         replacements = [
             (oldctx.node(), (newnode,)),
             (ctx.node(), (n,)),
             (newnode, (n,)),
         ]
         for ich in internalchanges:
             replacements.append((ich, (n,)))
         return repo[n], replacements
 
 
 @action(
     [b'base', b'b'],
     _(b'checkout changeset and apply further changesets from there'),
 )
 class base(histeditaction):
     def run(self):
         if self.repo[b'.'].node() != self.node:
             mergemod.clean_update(self.repo[self.node])
         return self.continueclean()
 
     def continuedirty(self):
         abortdirty()
 
     def continueclean(self):
         basectx = self.repo[b'.']
         return basectx, []
 
     def _verifynodeconstraints(self, prev, expected, seen):
         # base can only be use with a node not in the edited set
         if self.node in expected:
             msg = _(b'%s "%s" changeset was an edited list candidate')
             raise error.ParseError(
                 msg % (self.verb, short(self.node)),
                 hint=_(b'base must only use unlisted changesets'),
             )
 
 
 @action(
     [b'_multifold'],
     _(
         """fold subclass used for when multiple folds happen in a row
 
     We only want to fire the editor for the folded message once when
     (say) four changes are folded down into a single change. This is
     similar to rollup, but we should preserve both messages so that
     when the last fold operation runs we can show the user all the
     commit messages in their editor.
     """
     ),
     internal=True,
 )
 class _multifold(fold):
     def skipprompt(self):
         return True
 
 
 @action(
     [b"roll", b"r"],
     _(b"like fold, but discard this commit's description and date"),
 )
 class rollup(fold):
     def mergedescs(self):
         return False
 
     def skipprompt(self):
         return True
 
     def firstdate(self):
         return True
 
 
 @action([b"drop", b"d"], _(b'remove commit from history'))
 class drop(histeditaction):
     def run(self):
         parentctx = self.repo[self.state.parentctxnode]
         return parentctx, [(self.node, tuple())]
 
 
 @action(
     [b"mess", b"m"],
     _(b'edit commit message without changing commit content'),
     priority=True,
 )
 class message(histeditaction):
     def commiteditor(self):
         return cmdutil.getcommiteditor(edit=True, editform=b'histedit.mess')
 
 
 def findoutgoing(ui, repo, remote=None, force=False, opts=None):
     """utility function to find the first outgoing changeset
 
     Used by initialization code"""
     if opts is None:
         opts = {}
     path = urlutil.get_unique_push_path(b'histedit', repo, ui, remote)
     dest = path.pushloc or path.loc
 
     ui.status(_(b'comparing with %s\n') % urlutil.hidepassword(dest))
 
     revs, checkout = hg.addbranchrevs(repo, repo, (path.branch, []), None)
     other = hg.peer(repo, opts, dest)
 
     if revs:
         revs = [repo.lookup(rev) for rev in revs]
 
     outgoing = discovery.findcommonoutgoing(repo, other, revs, force=force)
     if not outgoing.missing:
         raise error.StateError(_(b'no outgoing ancestors'))
     roots = list(repo.revs(b"roots(%ln)", outgoing.missing))
     if len(roots) > 1:
         msg = _(b'there are ambiguous outgoing revisions')
         hint = _(b"see 'hg help histedit' for more detail")
         raise error.StateError(msg, hint=hint)
     return repo[roots[0]].node()
 
 
 # Curses Support
 try:
     import curses
 except ImportError:
     curses = None
 
 KEY_LIST = [b'pick', b'edit', b'fold', b'drop', b'mess', b'roll']
 ACTION_LABELS = {
     b'fold': b'^fold',
     b'roll': b'^roll',
 }
 
 COLOR_HELP, COLOR_SELECTED, COLOR_OK, COLOR_WARN, COLOR_CURRENT = 1, 2, 3, 4, 5
 COLOR_DIFF_ADD_LINE, COLOR_DIFF_DEL_LINE, COLOR_DIFF_OFFSET = 6, 7, 8
 COLOR_ROLL, COLOR_ROLL_CURRENT, COLOR_ROLL_SELECTED = 9, 10, 11
 
 E_QUIT, E_HISTEDIT = 1, 2
 E_PAGEDOWN, E_PAGEUP, E_LINEUP, E_LINEDOWN, E_RESIZE = 3, 4, 5, 6, 7
 MODE_INIT, MODE_PATCH, MODE_RULES, MODE_HELP = 0, 1, 2, 3
 
 KEYTABLE = {
     b'global': {
         b'h': b'next-action',
         b'KEY_RIGHT': b'next-action',
         b'l': b'prev-action',
         b'KEY_LEFT': b'prev-action',
         b'q': b'quit',
         b'c': b'histedit',
         b'C': b'histedit',
         b'v': b'showpatch',
         b'?': b'help',
     },
     MODE_RULES: {
         b'd': b'action-drop',
         b'e': b'action-edit',
         b'f': b'action-fold',
         b'm': b'action-mess',
         b'p': b'action-pick',
         b'r': b'action-roll',
         b' ': b'select',
         b'j': b'down',
         b'k': b'up',
         b'KEY_DOWN': b'down',
         b'KEY_UP': b'up',
         b'J': b'move-down',
         b'K': b'move-up',
         b'KEY_NPAGE': b'move-down',
         b'KEY_PPAGE': b'move-up',
         b'0': b'goto',  # Used for 0..9
     },
     MODE_PATCH: {
         b' ': b'page-down',
         b'KEY_NPAGE': b'page-down',
         b'KEY_PPAGE': b'page-up',
         b'j': b'line-down',
         b'k': b'line-up',
         b'KEY_DOWN': b'line-down',
         b'KEY_UP': b'line-up',
         b'J': b'down',
         b'K': b'up',
     },
     MODE_HELP: {},
 }
 
 
 def screen_size():
     return struct.unpack(b'hh', fcntl.ioctl(1, termios.TIOCGWINSZ, b'    '))
 
 
 class histeditrule:
     def __init__(self, ui, ctx, pos, action=b'pick'):
         self.ui = ui
         self.ctx = ctx
         self.action = action
         self.origpos = pos
         self.pos = pos
         self.conflicts = []
 
     def __bytes__(self):
         # Example display of several histeditrules:
         #
         #  #10 pick   316392:06a16c25c053   add option to skip tests
         #  #11 ^roll  316393:71313c964cc5   <RED>oops a fixup commit</RED>
         #  #12 pick   316394:ab31f3973b0d   include mfbt for mozilla-config.h
         #  #13 ^fold  316395:14ce5803f4c3   fix warnings
         #
         # The carets point to the changeset being folded into ("roll this
         # changeset into the changeset above").
         return b'%s%s' % (self.prefix, self.desc)
 
     __str__ = encoding.strmethod(__bytes__)
 
     @property
     def prefix(self):
         # Some actions ('fold' and 'roll') combine a patch with a
         # previous one. Add a marker showing which patch they apply
         # to.
         action = ACTION_LABELS.get(self.action, self.action)
 
         h = self.ctx.hex()[0:12]
         r = self.ctx.rev()
 
         return b"#%s %s %d:%s   " % (
             (b'%d' % self.origpos).ljust(2),
             action.ljust(6),
             r,
             h,
         )
 
     @util.propertycache
     def desc(self):
         summary = cmdutil.rendertemplate(
             self.ctx, self.ui.config(b'histedit', b'summary-template')
         )
         if summary:
             return summary
         # This is split off from the prefix property so that we can
         # separately make the description for 'roll' red (since it
         # will get discarded).
         return stringutil.firstline(self.ctx.description())
 
     def checkconflicts(self, other):
         if other.pos > self.pos and other.origpos <= self.origpos:
             if set(other.ctx.files()) & set(self.ctx.files()) != set():
                 self.conflicts.append(other)
                 return self.conflicts
 
         if other in self.conflicts:
             self.conflicts.remove(other)
         return self.conflicts
 
 
 def makecommands(rules):
     """Returns a list of commands consumable by histedit --commands based on
     our list of rules"""
     commands = []
     for rules in rules:
         commands.append(b'%s %s\n' % (rules.action, rules.ctx))
     return commands
 
 
 def addln(win, y, x, line, color=None):
     """Add a line to the given window left padding but 100% filled with
     whitespace characters, so that the color appears on the whole line"""
     maxy, maxx = win.getmaxyx()
     length = maxx - 1 - x
     line = bytes(line).ljust(length)[:length]
     if y < 0:
         y = maxy + y
     if x < 0:
         x = maxx + x
     if color:
         win.addstr(y, x, line, color)
     else:
         win.addstr(y, x, line)
 
 
 def _trunc_head(line, n):
     if len(line) <= n:
         return line
     return b'> ' + line[-(n - 2) :]
 
 
 def _trunc_tail(line, n):
     if len(line) <= n:
         return line
     return line[: n - 2] + b' >'
 
 
 class _chistedit_state:
     def __init__(
         self,
         repo,
         rules,
         stdscr,
     ):
         self.repo = repo
         self.rules = rules
         self.stdscr = stdscr
         self.later_on_top = repo.ui.configbool(
             b'histedit', b'later-commits-first'
         )
         # The current item in display order, initialized to point to the top
         # of the screen.
         self.pos = 0
         self.selected = None
         self.mode = (MODE_INIT, MODE_INIT)
         self.page_height = None
         self.modes = {
             MODE_RULES: {
                 b'line_offset': 0,
             },
             MODE_PATCH: {
                 b'line_offset': 0,
             },
         }
 
     def render_commit(self, win):
         """Renders the commit window that shows the log of the current selected
         commit"""
         rule = self.rules[self.display_pos_to_rule_pos(self.pos)]
 
         ctx = rule.ctx
         win.box()
 
         maxy, maxx = win.getmaxyx()
         length = maxx - 3
 
         line = b"changeset: %d:%s" % (ctx.rev(), ctx.hex()[:12])
         win.addstr(1, 1, line[:length])
 
         line = b"user:      %s" % ctx.user()
         win.addstr(2, 1, line[:length])
 
         bms = self.repo.nodebookmarks(ctx.node())
         line = b"bookmark:  %s" % b' '.join(bms)
         win.addstr(3, 1, line[:length])
 
         line = b"summary:   %s" % stringutil.firstline(ctx.description())
         win.addstr(4, 1, line[:length])
 
         line = b"files:     "
         win.addstr(5, 1, line)
         fnx = 1 + len(line)
         fnmaxx = length - fnx + 1
         y = 5
         fnmaxn = maxy - (1 + y) - 1
         files = ctx.files()
         for i, line1 in enumerate(files):
             if len(files) > fnmaxn and i == fnmaxn - 1:
                 win.addstr(y, fnx, _trunc_tail(b','.join(files[i:]), fnmaxx))
                 y = y + 1
                 break
             win.addstr(y, fnx, _trunc_head(line1, fnmaxx))
             y = y + 1
 
         conflicts = rule.conflicts
         if len(conflicts) > 0:
             conflictstr = b','.join(map(lambda r: r.ctx.hex()[:12], conflicts))
             conflictstr = b"changed files overlap with %s" % conflictstr
         else:
             conflictstr = b'no overlap'
 
         win.addstr(y, 1, conflictstr[:length])
         win.noutrefresh()
 
     def helplines(self):
         if self.mode[0] == MODE_PATCH:
             help = b"""\
 ?: help, k/up: line up, j/down: line down, v: stop viewing patch
 pgup: prev page, space/pgdn: next page, c: commit, q: abort
 """
         else:
             help = b"""\
 ?: help, k/up: move up, j/down: move down, space: select, v: view patch
 d: drop, e: edit, f: fold, m: mess, p: pick, r: roll
 pgup/K: move patch up, pgdn/J: move patch down, c: commit, q: abort
 """
             if self.later_on_top:
                 help += b"Newer commits are shown above older commits.\n"
             else:
                 help += b"Older commits are shown above newer commits.\n"
         return help.splitlines()
 
     def render_help(self, win):
         maxy, maxx = win.getmaxyx()
         for y, line in enumerate(self.helplines()):
             if y >= maxy:
                 break
             addln(win, y, 0, line, curses.color_pair(COLOR_HELP))
         win.noutrefresh()
 
     def layout(self):
         maxy, maxx = self.stdscr.getmaxyx()
         helplen = len(self.helplines())
         mainlen = maxy - helplen - 12
         if mainlen < 1:
             raise error.Abort(
                 _(b"terminal dimensions %d by %d too small for curses histedit")
                 % (maxy, maxx),
                 hint=_(
                     b"enlarge your terminal or use --config ui.interface=text"
                 ),
             )
         return {
             b'commit': (12, maxx),
             b'help': (helplen, maxx),
             b'main': (mainlen, maxx),
         }
 
     def display_pos_to_rule_pos(self, display_pos):
         """Converts a position in display order to rule order.
 
         The `display_pos` is the order from the top in display order, not
         considering which items are currently visible on the screen. Thus,
         `display_pos=0` is the item at the top (possibly after scrolling to
         the top)
         """
         if self.later_on_top:
             return len(self.rules) - 1 - display_pos
         else:
             return display_pos
 
     def render_rules(self, rulesscr):
         start = self.modes[MODE_RULES][b'line_offset']
 
         conflicts = [r.ctx for r in self.rules if r.conflicts]
         if len(conflicts) > 0:
             line = b"potential conflict in %s" % b','.join(
                 map(pycompat.bytestr, conflicts)
             )
             addln(rulesscr, -1, 0, line, curses.color_pair(COLOR_WARN))
 
         for display_pos in range(start, len(self.rules)):
             y = display_pos - start
             if y < 0 or y >= self.page_height:
                 continue
             rule_pos = self.display_pos_to_rule_pos(display_pos)
             rule = self.rules[rule_pos]
             if len(rule.conflicts) > 0:
                 rulesscr.addstr(y, 0, b" ", curses.color_pair(COLOR_WARN))
             else:
                 rulesscr.addstr(y, 0, b" ", curses.COLOR_BLACK)
 
             if display_pos == self.selected:
                 rollcolor = COLOR_ROLL_SELECTED
                 addln(rulesscr, y, 2, rule, curses.color_pair(COLOR_SELECTED))
             elif display_pos == self.pos:
                 rollcolor = COLOR_ROLL_CURRENT
                 addln(
                     rulesscr,
                     y,
                     2,
                     rule,
                     curses.color_pair(COLOR_CURRENT) | curses.A_BOLD,
                 )
             else:
                 rollcolor = COLOR_ROLL
                 addln(rulesscr, y, 2, rule)
 
             if rule.action == b'roll':
                 rulesscr.addstr(
                     y,
                     2 + len(rule.prefix),
                     rule.desc,
                     curses.color_pair(rollcolor),
                 )
 
         rulesscr.noutrefresh()
 
     def render_string(self, win, output, diffcolors=False):
         maxy, maxx = win.getmaxyx()
         length = min(maxy - 1, len(output))
         for y in range(0, length):
             line = output[y]
             if diffcolors:
                 if line and line[0] == b'+':
                     win.addstr(
                         y, 0, line, curses.color_pair(COLOR_DIFF_ADD_LINE)
                     )
                 elif line and line[0] == b'-':
                     win.addstr(
                         y, 0, line, curses.color_pair(COLOR_DIFF_DEL_LINE)
                     )
                 elif line.startswith(b'@@ '):
                     win.addstr(y, 0, line, curses.color_pair(COLOR_DIFF_OFFSET))
                 else:
                     win.addstr(y, 0, line)
             else:
                 win.addstr(y, 0, line)
         win.noutrefresh()
 
     def render_patch(self, win):
         start = self.modes[MODE_PATCH][b'line_offset']
         content = self.modes[MODE_PATCH][b'patchcontents']
         self.render_string(win, content[start:], diffcolors=True)
 
     def event(self, ch):
         """Change state based on the current character input
 
         This takes the current state and based on the current character input from
         the user we change the state.
         """
         oldpos = self.pos
 
         if ch in (curses.KEY_RESIZE, b"KEY_RESIZE"):
             return E_RESIZE
 
         lookup_ch = ch
         if ch is not None and b'0' <= ch <= b'9':
             lookup_ch = b'0'
 
         curmode, prevmode = self.mode
         action = KEYTABLE[curmode].get(
             lookup_ch, KEYTABLE[b'global'].get(lookup_ch)
         )
         if action is None:
             return
         if action in (b'down', b'move-down'):
             newpos = min(oldpos + 1, len(self.rules) - 1)
             self.move_cursor(oldpos, newpos)
             if self.selected is not None or action == b'move-down':
                 self.swap(oldpos, newpos)
         elif action in (b'up', b'move-up'):
             newpos = max(0, oldpos - 1)
             self.move_cursor(oldpos, newpos)
             if self.selected is not None or action == b'move-up':
                 self.swap(oldpos, newpos)
         elif action == b'next-action':
             self.cycle_action(oldpos, next=True)
         elif action == b'prev-action':
             self.cycle_action(oldpos, next=False)
         elif action == b'select':
             self.selected = oldpos if self.selected is None else None
             self.make_selection(self.selected)
         elif action == b'goto' and int(ch) < len(self.rules) <= 10:
             newrule = next((r for r in self.rules if r.origpos == int(ch)))
             self.move_cursor(oldpos, newrule.pos)
             if self.selected is not None:
                 self.swap(oldpos, newrule.pos)
         elif action.startswith(b'action-'):
             self.change_action(oldpos, action[7:])
         elif action == b'showpatch':
             self.change_mode(MODE_PATCH if curmode != MODE_PATCH else prevmode)
         elif action == b'help':
             self.change_mode(MODE_HELP if curmode != MODE_HELP else prevmode)
         elif action == b'quit':
             return E_QUIT
         elif action == b'histedit':
             return E_HISTEDIT
         elif action == b'page-down':
             return E_PAGEDOWN
         elif action == b'page-up':
             return E_PAGEUP
         elif action == b'line-down':
             return E_LINEDOWN
         elif action == b'line-up':
             return E_LINEUP
 
     def patch_contents(self):
         repo = self.repo
         rule = self.rules[self.display_pos_to_rule_pos(self.pos)]
         displayer = logcmdutil.changesetdisplayer(
             repo.ui,
             repo,
             {b"patch": True, b"template": b"status"},
             buffered=True,
         )
         overrides = {(b'ui', b'verbose'): True}
         with repo.ui.configoverride(overrides, source=b'histedit'):
             displayer.show(rule.ctx)
             displayer.close()
         return displayer.hunk[rule.ctx.rev()].splitlines()
 
     def move_cursor(self, oldpos, newpos):
         """Change the rule/changeset that the cursor is pointing to, regardless of
         current mode (you can switch between patches from the view patch window)."""
         self.pos = newpos
 
         mode, _ = self.mode
         if mode == MODE_RULES:
             # Scroll through the list by updating the view for MODE_RULES, so that
             # even if we are not currently viewing the rules, switching back will
             # result in the cursor's rule being visible.
             modestate = self.modes[MODE_RULES]
             if newpos < modestate[b'line_offset']:
                 modestate[b'line_offset'] = newpos
             elif newpos > modestate[b'line_offset'] + self.page_height - 1:
                 modestate[b'line_offset'] = newpos - self.page_height + 1
 
         # Reset the patch view region to the top of the new patch.
         self.modes[MODE_PATCH][b'line_offset'] = 0
 
     def change_mode(self, mode):
         curmode, _ = self.mode
         self.mode = (mode, curmode)
         if mode == MODE_PATCH:
             self.modes[MODE_PATCH][b'patchcontents'] = self.patch_contents()
 
     def make_selection(self, pos):
         self.selected = pos
 
     def swap(self, oldpos, newpos):
         """Swap two positions and calculate necessary conflicts in
         O(|newpos-oldpos|) time"""
         old_rule_pos = self.display_pos_to_rule_pos(oldpos)
         new_rule_pos = self.display_pos_to_rule_pos(newpos)
 
         rules = self.rules
         assert 0 <= old_rule_pos < len(rules) and 0 <= new_rule_pos < len(rules)
 
         rules[old_rule_pos], rules[new_rule_pos] = (
             rules[new_rule_pos],
             rules[old_rule_pos],
         )
 
         # TODO: swap should not know about histeditrule's internals
         rules[new_rule_pos].pos = new_rule_pos
         rules[old_rule_pos].pos = old_rule_pos
 
         start = min(old_rule_pos, new_rule_pos)
         end = max(old_rule_pos, new_rule_pos)
-        for r in pycompat.xrange(start, end + 1):
+        for r in range(start, end + 1):
             rules[new_rule_pos].checkconflicts(rules[r])
             rules[old_rule_pos].checkconflicts(rules[r])
 
         if self.selected:
             self.make_selection(newpos)
 
     def change_action(self, pos, action):
         """Change the action state on the given position to the new action"""
         assert 0 <= pos < len(self.rules)
         self.rules[pos].action = action
 
     def cycle_action(self, pos, next=False):
         """Changes the action state the next or the previous action from
         the action list"""
         assert 0 <= pos < len(self.rules)
         current = self.rules[pos].action
 
         assert current in KEY_LIST
 
         index = KEY_LIST.index(current)
         if next:
             index += 1
         else:
             index -= 1
         self.change_action(pos, KEY_LIST[index % len(KEY_LIST)])
 
     def change_view(self, delta, unit):
         """Change the region of whatever is being viewed (a patch or the list of
         changesets). 'delta' is an amount (+/- 1) and 'unit' is 'page' or 'line'."""
         mode, _ = self.mode
         if mode != MODE_PATCH:
             return
         mode_state = self.modes[mode]
         num_lines = len(mode_state[b'patchcontents'])
         page_height = self.page_height
         unit = page_height if unit == b'page' else 1
         num_pages = 1 + (num_lines - 1) // page_height
         max_offset = (num_pages - 1) * page_height
         newline = mode_state[b'line_offset'] + delta * unit
         mode_state[b'line_offset'] = max(0, min(max_offset, newline))
 
 
 def _chisteditmain(repo, rules, stdscr):
     try:
         curses.use_default_colors()
     except curses.error:
         pass
 
     # initialize color pattern
     curses.init_pair(COLOR_HELP, curses.COLOR_WHITE, curses.COLOR_BLUE)
     curses.init_pair(COLOR_SELECTED, curses.COLOR_BLACK, curses.COLOR_WHITE)
     curses.init_pair(COLOR_WARN, curses.COLOR_BLACK, curses.COLOR_YELLOW)
     curses.init_pair(COLOR_OK, curses.COLOR_BLACK, curses.COLOR_GREEN)
     curses.init_pair(COLOR_CURRENT, curses.COLOR_WHITE, curses.COLOR_MAGENTA)
     curses.init_pair(COLOR_DIFF_ADD_LINE, curses.COLOR_GREEN, -1)
     curses.init_pair(COLOR_DIFF_DEL_LINE, curses.COLOR_RED, -1)
     curses.init_pair(COLOR_DIFF_OFFSET, curses.COLOR_MAGENTA, -1)
     curses.init_pair(COLOR_ROLL, curses.COLOR_RED, -1)
     curses.init_pair(
         COLOR_ROLL_CURRENT, curses.COLOR_BLACK, curses.COLOR_MAGENTA
     )
     curses.init_pair(COLOR_ROLL_SELECTED, curses.COLOR_RED, curses.COLOR_WHITE)
 
     # don't display the cursor
     try:
         curses.curs_set(0)
     except curses.error:
         pass
 
     def drawvertwin(size, y, x):
         win = curses.newwin(size[0], size[1], y, x)
         y += size[0]
         return win, y, x
 
     state = _chistedit_state(repo, rules, stdscr)
 
     # eventloop
     ch = None
     stdscr.clear()
     stdscr.refresh()
     while True:
         oldmode, unused = state.mode
         if oldmode == MODE_INIT:
             state.change_mode(MODE_RULES)
         e = state.event(ch)
 
         if e == E_QUIT:
             return False
         if e == E_HISTEDIT:
             return state.rules
         else:
             if e == E_RESIZE:
                 size = screen_size()
                 if size != stdscr.getmaxyx():
                     curses.resizeterm(*size)
 
             sizes = state.layout()
             curmode, unused = state.mode
             if curmode != oldmode:
                 state.page_height = sizes[b'main'][0]
                 # Adjust the view to fit the current screen size.
                 state.move_cursor(state.pos, state.pos)
 
             # Pack the windows against the top, each pane spread across the
             # full width of the screen.
             y, x = (0, 0)
             helpwin, y, x = drawvertwin(sizes[b'help'], y, x)
             mainwin, y, x = drawvertwin(sizes[b'main'], y, x)
             commitwin, y, x = drawvertwin(sizes[b'commit'], y, x)
 
             if e in (E_PAGEDOWN, E_PAGEUP, E_LINEDOWN, E_LINEUP):
                 if e == E_PAGEDOWN:
                     state.change_view(+1, b'page')
                 elif e == E_PAGEUP:
                     state.change_view(-1, b'page')
                 elif e == E_LINEDOWN:
                     state.change_view(+1, b'line')
                 elif e == E_LINEUP:
                     state.change_view(-1, b'line')
 
             # start rendering
             commitwin.erase()
             helpwin.erase()
             mainwin.erase()
             if curmode == MODE_PATCH:
                 state.render_patch(mainwin)
             elif curmode == MODE_HELP:
                 state.render_string(mainwin, __doc__.strip().splitlines())
             else:
                 state.render_rules(mainwin)
                 state.render_commit(commitwin)
             state.render_help(helpwin)
             curses.doupdate()
             # done rendering
             ch = encoding.strtolocal(stdscr.getkey())
 
 
 def _chistedit(ui, repo, freeargs, opts):
     """interactively edit changeset history via a curses interface
 
     Provides a ncurses interface to histedit. Press ? in chistedit mode
     to see an extensive help. Requires python-curses to be installed."""
 
     if curses is None:
         raise error.Abort(_(b"Python curses library required"))
 
     # disable color
     ui._colormode = None
 
     try:
         keep = opts.get(b'keep')
         revs = opts.get(b'rev', [])[:]
         cmdutil.checkunfinished(repo)
         cmdutil.bailifchanged(repo)
 
         revs.extend(freeargs)
         if not revs:
             defaultrev = destutil.desthistedit(ui, repo)
             if defaultrev is not None:
                 revs.append(defaultrev)
         if len(revs) != 1:
             raise error.InputError(
                 _(b'histedit requires exactly one ancestor revision')
             )
 
         rr = list(repo.set(b'roots(%ld)', logcmdutil.revrange(repo, revs)))
         if len(rr) != 1:
             raise error.InputError(
                 _(
                     b'The specified revisions must have '
                     b'exactly one common root'
                 )
             )
         root = rr[0].node()
 
         topmost = repo.dirstate.p1()
         revs = between(repo, root, topmost, keep)
         if not revs:
             raise error.InputError(
                 _(b'%s is not an ancestor of working directory') % short(root)
             )
 
         rules = []
         for i, r in enumerate(revs):
             rules.append(histeditrule(ui, repo[r], i))
         with util.with_lc_ctype():
             rc = curses.wrapper(functools.partial(_chisteditmain, repo, rules))
         curses.echo()
         curses.endwin()
         if rc is False:
             ui.write(_(b"histedit aborted\n"))
             return 0
         if type(rc) is list:
             ui.status(_(b"performing changes\n"))
             rules = makecommands(rc)
             with repo.vfs(b'chistedit', b'w+') as fp:
                 for r in rules:
                     fp.write(r)
                 opts[b'commands'] = fp.name
             return _texthistedit(ui, repo, freeargs, opts)
     except KeyboardInterrupt:
         pass
     return -1
 
 
 @command(
     b'histedit',
     [
         (
             b'',
             b'commands',
             b'',
             _(b'read history edits from the specified file'),
             _(b'FILE'),
         ),
         (b'c', b'continue', False, _(b'continue an edit already in progress')),
         (b'', b'edit-plan', False, _(b'edit remaining actions list')),
         (
             b'k',
             b'keep',
             False,
             _(b"don't strip old nodes after edit is complete"),
         ),
         (b'', b'abort', False, _(b'abort an edit in progress')),
         (b'o', b'outgoing', False, _(b'changesets not found in destination')),
         (
             b'f',
             b'force',
             False,
             _(b'force outgoing even for unrelated repositories'),
         ),
         (b'r', b'rev', [], _(b'first revision to be edited'), _(b'REV')),
     ]
     + cmdutil.formatteropts,
     _(b"[OPTIONS] ([ANCESTOR] | --outgoing [URL])"),
     helpcategory=command.CATEGORY_CHANGE_MANAGEMENT,
 )
 def histedit(ui, repo, *freeargs, **opts):
     """interactively edit changeset history
 
     This command lets you edit a linear series of changesets (up to
     and including the working directory, which should be clean).
     You can:
 
     - `pick` to [re]order a changeset
 
     - `drop` to omit changeset
 
     - `mess` to reword the changeset commit message
 
     - `fold` to combine it with the preceding changeset (using the later date)
 
     - `roll` like fold, but discarding this commit's description and date
 
     - `edit` to edit this changeset (preserving date)
 
     - `base` to checkout changeset and apply further changesets from there
 
     There are a number of ways to select the root changeset:
 
     - Specify ANCESTOR directly
 
     - Use --outgoing -- it will be the first linear changeset not
       included in destination. (See :hg:`help config.paths.default-push`)
 
     - Otherwise, the value from the "histedit.defaultrev" config option
       is used as a revset to select the base revision when ANCESTOR is not
       specified. The first revision returned by the revset is used. By
       default, this selects the editable history that is unique to the
       ancestry of the working directory.
 
     .. container:: verbose
 
        If you use --outgoing, this command will abort if there are ambiguous
        outgoing revisions. For example, if there are multiple branches
        containing outgoing revisions.
 
        Use "min(outgoing() and ::.)" or similar revset specification
        instead of --outgoing to specify edit target revision exactly in
        such ambiguous situation. See :hg:`help revsets` for detail about
        selecting revisions.
 
     .. container:: verbose
 
        Examples:
 
          - A number of changes have been made.
            Revision 3 is no longer needed.
 
            Start history editing from revision 3::
 
              hg histedit -r 3
 
            An editor opens, containing the list of revisions,
            with specific actions specified::
 
              pick 5339bf82f0ca 3 Zworgle the foobar
              pick 8ef592ce7cc4 4 Bedazzle the zerlog
              pick 0a9639fcda9d 5 Morgify the cromulancy
 
            Additional information about the possible actions
            to take appears below the list of revisions.
 
            To remove revision 3 from the history,
            its action (at the beginning of the relevant line)
            is changed to 'drop'::
 
              drop 5339bf82f0ca 3 Zworgle the foobar
              pick 8ef592ce7cc4 4 Bedazzle the zerlog
              pick 0a9639fcda9d 5 Morgify the cromulancy
 
          - A number of changes have been made.
            Revision 2 and 4 need to be swapped.
 
            Start history editing from revision 2::
 
              hg histedit -r 2
 
            An editor opens, containing the list of revisions,
            with specific actions specified::
 
              pick 252a1af424ad 2 Blorb a morgwazzle
              pick 5339bf82f0ca 3 Zworgle the foobar
              pick 8ef592ce7cc4 4 Bedazzle the zerlog
 
            To swap revision 2 and 4, its lines are swapped
            in the editor::
 
              pick 8ef592ce7cc4 4 Bedazzle the zerlog
              pick 5339bf82f0ca 3 Zworgle the foobar
              pick 252a1af424ad 2 Blorb a morgwazzle
 
     Returns 0 on success, 1 if user intervention is required (not only
     for intentional "edit" command, but also for resolving unexpected
     conflicts).
     """
     opts = pycompat.byteskwargs(opts)
 
     # kludge: _chistedit only works for starting an edit, not aborting
     # or continuing, so fall back to regular _texthistedit for those
     # operations.
     if ui.interface(b'histedit') == b'curses' and _getgoal(opts) == goalnew:
         return _chistedit(ui, repo, freeargs, opts)
     return _texthistedit(ui, repo, freeargs, opts)
 
 
 def _texthistedit(ui, repo, freeargs, opts):
     state = histeditstate(repo)
     with repo.wlock() as wlock, repo.lock() as lock:
         state.wlock = wlock
         state.lock = lock
         _histedit(ui, repo, state, freeargs, opts)
 
 
 goalcontinue = b'continue'
 goalabort = b'abort'
 goaleditplan = b'edit-plan'
 goalnew = b'new'
 
 
 def _getgoal(opts):
     if opts.get(b'continue'):
         return goalcontinue
     if opts.get(b'abort'):
         return goalabort
     if opts.get(b'edit_plan'):
         return goaleditplan
     return goalnew
 
 
 def _readfile(ui, path):
     if path == b'-':
         with ui.timeblockedsection(b'histedit'):
             return ui.fin.read()
     else:
         with open(path, b'rb') as f:
             return f.read()
 
 
 def _validateargs(ui, repo, freeargs, opts, goal, rules, revs):
     # TODO only abort if we try to histedit mq patches, not just
     # blanket if mq patches are applied somewhere
     mq = getattr(repo, 'mq', None)
     if mq and mq.applied:
         raise error.StateError(_(b'source has mq patches applied'))
 
     # basic argument incompatibility processing
     outg = opts.get(b'outgoing')
     editplan = opts.get(b'edit_plan')
     abort = opts.get(b'abort')
     force = opts.get(b'force')
     if force and not outg:
         raise error.InputError(_(b'--force only allowed with --outgoing'))
     if goal == b'continue':
         if any((outg, abort, revs, freeargs, rules, editplan)):
             raise error.InputError(_(b'no arguments allowed with --continue'))
     elif goal == b'abort':
         if any((outg, revs, freeargs, rules, editplan)):
             raise error.InputError(_(b'no arguments allowed with --abort'))
     elif goal == b'edit-plan':
         if any((outg, revs, freeargs)):
             raise error.InputError(
                 _(b'only --commands argument allowed with --edit-plan')
             )
     else:
         if outg:
             if revs:
                 raise error.InputError(
                     _(b'no revisions allowed with --outgoing')
                 )
             if len(freeargs) > 1:
                 raise error.InputError(
                     _(b'only one repo argument allowed with --outgoing')
                 )
         else:
             revs.extend(freeargs)
             if len(revs) == 0:
                 defaultrev = destutil.desthistedit(ui, repo)
                 if defaultrev is not None:
                     revs.append(defaultrev)
 
             if len(revs) != 1:
                 raise error.InputError(
                     _(b'histedit requires exactly one ancestor revision')
                 )
 
 
 def _histedit(ui, repo, state, freeargs, opts):
     fm = ui.formatter(b'histedit', opts)
     fm.startitem()
     goal = _getgoal(opts)
     revs = opts.get(b'rev', [])
     nobackup = not ui.configbool(b'rewrite', b'backup-bundle')
     rules = opts.get(b'commands', b'')
     state.keep = opts.get(b'keep', False)
 
     _validateargs(ui, repo, freeargs, opts, goal, rules, revs)
 
     hastags = False
     if revs:
         revs = logcmdutil.revrange(repo, revs)
         ctxs = [repo[rev] for rev in revs]
         for ctx in ctxs:
             tags = [tag for tag in ctx.tags() if tag != b'tip']
             if not hastags:
                 hastags = len(tags)
     if hastags:
         if ui.promptchoice(
             _(
                 b'warning: tags associated with the given'
                 b' changeset will be lost after histedit.\n'
                 b'do you want to continue (yN)? $$ &Yes $$ &No'
             ),
             default=1,
         ):
             raise error.CanceledError(_(b'histedit cancelled\n'))
     # rebuild state
     if goal == goalcontinue:
         state.read()
         state = bootstrapcontinue(ui, state, opts)
     elif goal == goaleditplan:
         _edithisteditplan(ui, repo, state, rules)
         return
     elif goal == goalabort:
         _aborthistedit(ui, repo, state, nobackup=nobackup)
         return
     else:
         # goal == goalnew
         _newhistedit(ui, repo, state, revs, freeargs, opts)
 
     _continuehistedit(ui, repo, state)
     _finishhistedit(ui, repo, state, fm)
     fm.end()
 
 
 def _continuehistedit(ui, repo, state):
     """This function runs after either:
     - bootstrapcontinue (if the goal is 'continue')
     - _newhistedit (if the goal is 'new')
     """
     # preprocess rules so that we can hide inner folds from the user
     # and only show one editor
     actions = state.actions[:]
     for idx, (action, nextact) in enumerate(zip(actions, actions[1:] + [None])):
         if action.verb == b'fold' and nextact and nextact.verb == b'fold':
             state.actions[idx].__class__ = _multifold
 
     # Force an initial state file write, so the user can run --abort/continue
     # even if there's an exception before the first transaction serialize.
     state.write()
 
     tr = None
     # Don't use singletransaction by default since it rolls the entire
     # transaction back if an unexpected exception happens (like a
     # pretxncommit hook throws, or the user aborts the commit msg editor).
     if ui.configbool(b"histedit", b"singletransaction"):
         # Don't use a 'with' for the transaction, since actions may close
         # and reopen a transaction. For example, if the action executes an
         # external process it may choose to commit the transaction first.
         tr = repo.transaction(b'histedit')
     progress = ui.makeprogress(
         _(b"editing"), unit=_(b'changes'), total=len(state.actions)
     )
     with progress, util.acceptintervention(tr):
         while state.actions:
             state.write(tr=tr)
             actobj = state.actions[0]
             progress.increment(item=actobj.torule())
             ui.debug(
                 b'histedit: processing %s %s\n' % (actobj.verb, actobj.torule())
             )
             parentctx, replacement_ = actobj.run()
             state.parentctxnode = parentctx.node()
             state.replacements.extend(replacement_)
             state.actions.pop(0)
 
     state.write()
 
 
 def _finishhistedit(ui, repo, state, fm):
     """This action runs when histedit is finishing its session"""
     mergemod.update(repo[state.parentctxnode])
 
     mapping, tmpnodes, created, ntm = processreplacement(state)
     if mapping:
         for prec, succs in mapping.items():
             if not succs:
                 ui.debug(b'histedit: %s is dropped\n' % short(prec))
             else:
                 ui.debug(
                     b'histedit: %s is replaced by %s\n'
                     % (short(prec), short(succs[0]))
                 )
                 if len(succs) > 1:
                     m = b'histedit:                            %s'
                     for n in succs[1:]:
                         ui.debug(m % short(n))
 
     if not state.keep:
         if mapping:
             movetopmostbookmarks(repo, state.topmost, ntm)
             # TODO update mq state
     else:
         mapping = {}
 
     for n in tmpnodes:
         if n in repo:
             mapping[n] = ()
 
     # remove entries about unknown nodes
     has_node = repo.unfiltered().changelog.index.has_node
     mapping = {
         k: v
         for k, v in mapping.items()
         if has_node(k) and all(has_node(n) for n in v)
     }
     scmutil.cleanupnodes(repo, mapping, b'histedit')
     hf = fm.hexfunc
     fl = fm.formatlist
     fd = fm.formatdict
     nodechanges = fd(
         {
             hf(oldn): fl([hf(n) for n in newn], name=b'node')
             for oldn, newn in mapping.items()
         },
         key=b"oldnode",
         value=b"newnodes",
     )
     fm.data(nodechanges=nodechanges)
 
     state.clear()
     if os.path.exists(repo.sjoin(b'undo')):
         os.unlink(repo.sjoin(b'undo'))
     if repo.vfs.exists(b'histedit-last-edit.txt'):
         repo.vfs.unlink(b'histedit-last-edit.txt')
 
 
 def _aborthistedit(ui, repo, state, nobackup=False):
     try:
         state.read()
         __, leafs, tmpnodes, __ = processreplacement(state)
         ui.debug(b'restore wc to old parent %s\n' % short(state.topmost))
 
         # Recover our old commits if necessary
         if not state.topmost in repo and state.backupfile:
             backupfile = repo.vfs.join(state.backupfile)
             f = hg.openpath(ui, backupfile)
             gen = exchange.readbundle(ui, f, backupfile)
             with repo.transaction(b'histedit.abort') as tr:
                 bundle2.applybundle(
                     repo,
                     gen,
                     tr,
                     source=b'histedit',
                     url=b'bundle:' + backupfile,
                 )
 
             os.remove(backupfile)
 
         # check whether we should update away
         if repo.unfiltered().revs(
             b'parents() and (%n  or %ln::)',
             state.parentctxnode,
             leafs | tmpnodes,
         ):
             hg.clean(repo, state.topmost, show_stats=True, quietempty=True)
         cleanupnode(ui, repo, tmpnodes, nobackup=nobackup)
         cleanupnode(ui, repo, leafs, nobackup=nobackup)
     except Exception:
         if state.inprogress():
             ui.warn(
                 _(
                     b'warning: encountered an exception during histedit '
                     b'--abort; the repository may not have been completely '
                     b'cleaned up\n'
                 )
             )
         raise
     finally:
         state.clear()
 
 
 def hgaborthistedit(ui, repo):
     state = histeditstate(repo)
     nobackup = not ui.configbool(b'rewrite', b'backup-bundle')
     with repo.wlock() as wlock, repo.lock() as lock:
         state.wlock = wlock
         state.lock = lock
         _aborthistedit(ui, repo, state, nobackup=nobackup)
 
 
 def _edithisteditplan(ui, repo, state, rules):
     state.read()
     if not rules:
         comment = geteditcomment(
             ui, short(state.parentctxnode), short(state.topmost)
         )
         rules = ruleeditor(repo, ui, state.actions, comment)
     else:
         rules = _readfile(ui, rules)
     actions = parserules(rules, state)
     ctxs = [repo[act.node] for act in state.actions if act.node]
     warnverifyactions(ui, repo, actions, state, ctxs)
     state.actions = actions
     state.write()
 
 
 def _newhistedit(ui, repo, state, revs, freeargs, opts):
     outg = opts.get(b'outgoing')
     rules = opts.get(b'commands', b'')
     force = opts.get(b'force')
 
     cmdutil.checkunfinished(repo)
     cmdutil.bailifchanged(repo)
 
     topmost = repo.dirstate.p1()
     if outg:
         if freeargs:
             remote = freeargs[0]
         else:
             remote = None
         root = findoutgoing(ui, repo, remote, force, opts)
     else:
         rr = list(repo.set(b'roots(%ld)', logcmdutil.revrange(repo, revs)))
         if len(rr) != 1:
             raise error.InputError(
                 _(
                     b'The specified revisions must have '
                     b'exactly one common root'
                 )
             )
         root = rr[0].node()
 
     revs = between(repo, root, topmost, state.keep)
     if not revs:
         raise error.InputError(
             _(b'%s is not an ancestor of working directory') % short(root)
         )
 
     ctxs = [repo[r] for r in revs]
 
     wctx = repo[None]
     # Please don't ask me why `ancestors` is this value. I figured it
     # out with print-debugging, not by actually understanding what the
     # merge code is doing. :(
     ancs = [repo[b'.']]
     # Sniff-test to make sure we won't collide with untracked files in
     # the working directory. If we don't do this, we can get a
     # collision after we've started histedit and backing out gets ugly
     # for everyone, especially the user.
     for c in [ctxs[0].p1()] + ctxs:
         try:
             mergemod.calculateupdates(
                 repo,
                 wctx,
                 c,
                 ancs,
                 # These parameters were determined by print-debugging
                 # what happens later on inside histedit.
                 branchmerge=False,
                 force=False,
                 acceptremote=False,
                 followcopies=False,
             )
         except error.Abort:
             raise error.StateError(
                 _(
                     b"untracked files in working directory conflict with files in %s"
                 )
                 % c
             )
 
     if not rules:
         comment = geteditcomment(ui, short(root), short(topmost))
         actions = [pick(state, r) for r in revs]
         rules = ruleeditor(repo, ui, actions, comment)
     else:
         rules = _readfile(ui, rules)
     actions = parserules(rules, state)
     warnverifyactions(ui, repo, actions, state, ctxs)
 
     parentctxnode = repo[root].p1().node()
 
     state.parentctxnode = parentctxnode
     state.actions = actions
     state.topmost = topmost
     state.replacements = []
 
     ui.log(
         b"histedit",
         b"%d actions to histedit\n",
         len(actions),
         histedit_num_actions=len(actions),
     )
 
     # Create a backup so we can always abort completely.
     backupfile = None
     if not obsolete.isenabled(repo, obsolete.createmarkersopt):
         backupfile = repair.backupbundle(
             repo, [parentctxnode], [topmost], root, b'histedit'
         )
     state.backupfile = backupfile
 
 
 def _getsummary(ctx):
     return stringutil.firstline(ctx.description())
 
 
 def bootstrapcontinue(ui, state, opts):
     repo = state.repo
 
     ms = mergestatemod.mergestate.read(repo)
     mergeutil.checkunresolved(ms)
 
     if state.actions:
         actobj = state.actions.pop(0)
 
         if _isdirtywc(repo):
             actobj.continuedirty()
             if _isdirtywc(repo):
                 abortdirty()
 
         parentctx, replacements = actobj.continueclean()
 
         state.parentctxnode = parentctx.node()
         state.replacements.extend(replacements)
 
     return state
 
 
 def between(repo, old, new, keep):
     """select and validate the set of revision to edit
 
     When keep is false, the specified set can't have children."""
     revs = repo.revs(b'%n::%n', old, new)
     if revs and not keep:
         rewriteutil.precheck(repo, revs, b'edit')
         if repo.revs(b'(%ld) and merge()', revs):
             raise error.StateError(
                 _(b'cannot edit history that contains merges')
             )
     return pycompat.maplist(repo.changelog.node, revs)
 
 
 def ruleeditor(repo, ui, actions, editcomment=b""):
     """open an editor to edit rules
 
     rules are in the format [ [act, ctx], ...] like in state.rules
     """
     if repo.ui.configbool(b"experimental", b"histedit.autoverb"):
         newact = util.sortdict()
         for act in actions:
             ctx = repo[act.node]
             summary = _getsummary(ctx)
             fword = summary.split(b' ', 1)[0].lower()
             added = False
 
             # if it doesn't end with the special character '!' just skip this
             if fword.endswith(b'!'):
                 fword = fword[:-1]
                 if fword in primaryactions | secondaryactions | tertiaryactions:
                     act.verb = fword
                     # get the target summary
                     tsum = summary[len(fword) + 1 :].lstrip()
                     # safe but slow: reverse iterate over the actions so we
                     # don't clash on two commits having the same summary
                     for na, l in reversed(list(newact.items())):
                         actx = repo[na.node]
                         asum = _getsummary(actx)
                         if asum == tsum:
                             added = True
                             l.append(act)
                             break
 
             if not added:
                 newact[act] = []
 
         # copy over and flatten the new list
         actions = []
         for na, l in newact.items():
             actions.append(na)
             actions += l
 
     rules = b'\n'.join([act.torule() for act in actions])
     rules += b'\n\n'
     rules += editcomment
     rules = ui.edit(
         rules,
         ui.username(),
         {b'prefix': b'histedit'},
         repopath=repo.path,
         action=b'histedit',
     )
 
     # Save edit rules in .hg/histedit-last-edit.txt in case
     # the user needs to ask for help after something
     # surprising happens.
     with repo.vfs(b'histedit-last-edit.txt', b'wb') as f:
         f.write(rules)
 
     return rules
 
 
 def parserules(rules, state):
     """Read the histedit rules string and return list of action objects"""
     rules = [
         l
         for l in (r.strip() for r in rules.splitlines())
         if l and not l.startswith(b'#')
     ]
     actions = []
     for r in rules:
         if b' ' not in r:
             raise error.ParseError(_(b'malformed line "%s"') % r)
         verb, rest = r.split(b' ', 1)
 
         if verb not in actiontable:
             raise error.ParseError(_(b'unknown action "%s"') % verb)
 
         action = actiontable[verb].fromrule(state, rest)
         actions.append(action)
     return actions
 
 
 def warnverifyactions(ui, repo, actions, state, ctxs):
     try:
         verifyactions(actions, state, ctxs)
     except error.ParseError:
         if repo.vfs.exists(b'histedit-last-edit.txt'):
             ui.warn(
                 _(
                     b'warning: histedit rules saved '
                     b'to: .hg/histedit-last-edit.txt\n'
                 )
             )
         raise
 
 
 def verifyactions(actions, state, ctxs):
     """Verify that there exists exactly one action per given changeset and
     other constraints.
 
     Will abort if there are to many or too few rules, a malformed rule,
     or a rule on a changeset outside of the user-given range.
     """
     expected = {c.node() for c in ctxs}
     seen = set()
     prev = None
 
     if actions and actions[0].verb in [b'roll', b'fold']:
         raise error.ParseError(
             _(b'first changeset cannot use verb "%s"') % actions[0].verb
         )
 
     for action in actions:
         action.verify(prev, expected, seen)
         prev = action
         if action.node is not None:
             seen.add(action.node)
     missing = sorted(expected - seen)  # sort to stabilize output
 
     if state.repo.ui.configbool(b'histedit', b'dropmissing'):
         if len(actions) == 0:
             raise error.ParseError(
                 _(b'no rules provided'),
                 hint=_(b'use strip extension to remove commits'),
             )
 
         drops = [drop(state, n) for n in missing]
         # put the in the beginning so they execute immediately and
         # don't show in the edit-plan in the future
         actions[:0] = drops
     elif missing:
         raise error.ParseError(
             _(b'missing rules for changeset %s') % short(missing[0]),
             hint=_(
                 b'use "drop %s" to discard, see also: '
                 b"'hg help -e histedit.config'"
             )
             % short(missing[0]),
         )
 
 
 def adjustreplacementsfrommarkers(repo, oldreplacements):
     """Adjust replacements from obsolescence markers
 
     Replacements structure is originally generated based on
     histedit's state and does not account for changes that are
     not recorded there. This function fixes that by adding
     data read from obsolescence markers"""
     if not obsolete.isenabled(repo, obsolete.createmarkersopt):
         return oldreplacements
 
     unfi = repo.unfiltered()
     get_rev = unfi.changelog.index.get_rev
     obsstore = repo.obsstore
     newreplacements = list(oldreplacements)
     oldsuccs = [r[1] for r in oldreplacements]
     # successors that have already been added to succstocheck once
     seensuccs = set().union(
         *oldsuccs
     )  # create a set from an iterable of tuples
     succstocheck = list(seensuccs)
     while succstocheck:
         n = succstocheck.pop()
         missing = get_rev(n) is None
         markers = obsstore.successors.get(n, ())
         if missing and not markers:
             # dead end, mark it as such
             newreplacements.append((n, ()))
         for marker in markers:
             nsuccs = marker[1]
             newreplacements.append((n, nsuccs))
             for nsucc in nsuccs:
                 if nsucc not in seensuccs:
                     seensuccs.add(nsucc)
                     succstocheck.append(nsucc)
 
     return newreplacements
 
 
 def processreplacement(state):
     """process the list of replacements to return
 
     1) the final mapping between original and created nodes
     2) the list of temporary node created by histedit
     3) the list of new commit created by histedit"""
     replacements = adjustreplacementsfrommarkers(state.repo, state.replacements)
     allsuccs = set()
     replaced = set()
     fullmapping = {}
     # initialize basic set
     # fullmapping records all operations recorded in replacement
     for rep in replacements:
         allsuccs.update(rep[1])
         replaced.add(rep[0])
         fullmapping.setdefault(rep[0], set()).update(rep[1])
     new = allsuccs - replaced
     tmpnodes = allsuccs & replaced
     # Reduce content fullmapping into direct relation between original nodes
     # and final node created during history edition
     # Dropped changeset are replaced by an empty list
     toproceed = set(fullmapping)
     final = {}
     while toproceed:
         for x in list(toproceed):
             succs = fullmapping[x]
             for s in list(succs):
                 if s in toproceed:
                     # non final node with unknown closure
                     # We can't process this now
                     break
                 elif s in final:
                     # non final node, replace with closure
                     succs.remove(s)
                     succs.update(final[s])
             else:
                 final[x] = succs
                 toproceed.remove(x)
     # remove tmpnodes from final mapping
     for n in tmpnodes:
         del final[n]
     # we expect all changes involved in final to exist in the repo
     # turn `final` into list (topologically sorted)
     get_rev = state.repo.changelog.index.get_rev
     for prec, succs in final.items():
         final[prec] = sorted(succs, key=get_rev)
 
     # computed topmost element (necessary for bookmark)
     if new:
         newtopmost = sorted(new, key=state.repo.changelog.rev)[-1]
     elif not final:
         # Nothing rewritten at all. we won't need `newtopmost`
         # It is the same as `oldtopmost` and `processreplacement` know it
         newtopmost = None
     else:
         # every body died. The newtopmost is the parent of the root.
         r = state.repo.changelog.rev
         newtopmost = state.repo[sorted(final, key=r)[0]].p1().node()
 
     return final, tmpnodes, new, newtopmost
 
 
 def movetopmostbookmarks(repo, oldtopmost, newtopmost):
     """Move bookmark from oldtopmost to newly created topmost
 
     This is arguably a feature and we may only want that for the active
     bookmark. But the behavior is kept compatible with the old version for now.
     """
     if not oldtopmost or not newtopmost:
         return
     oldbmarks = repo.nodebookmarks(oldtopmost)
     if oldbmarks:
         with repo.lock(), repo.transaction(b'histedit') as tr:
             marks = repo._bookmarks
             changes = []
             for name in oldbmarks:
                 changes.append((name, newtopmost))
             marks.applychanges(repo, tr, changes)
 
 
 def cleanupnode(ui, repo, nodes, nobackup=False):
     """strip a group of nodes from the repository
 
     The set of node to strip may contains unknown nodes."""
     with repo.lock():
         # do not let filtering get in the way of the cleanse
         # we should probably get rid of obsolescence marker created during the
         # histedit, but we currently do not have such information.
         repo = repo.unfiltered()
         # Find all nodes that need to be stripped
         # (we use %lr instead of %ln to silently ignore unknown items)
         has_node = repo.changelog.index.has_node
         nodes = sorted(n for n in nodes if has_node(n))
         roots = [c.node() for c in repo.set(b"roots(%ln)", nodes)]
         if roots:
             backup = not nobackup
             repair.strip(ui, repo, roots, backup=backup)
 
 
 def stripwrapper(orig, ui, repo, nodelist, *args, **kwargs):
     if isinstance(nodelist, bytes):
         nodelist = [nodelist]
     state = histeditstate(repo)
     if state.inprogress():
         state.read()
         histedit_nodes = {
             action.node for action in state.actions if action.node
         }
         common_nodes = histedit_nodes & set(nodelist)
         if common_nodes:
             raise error.Abort(
                 _(b"histedit in progress, can't strip %s")
                 % b', '.join(short(x) for x in common_nodes)
             )
     return orig(ui, repo, nodelist, *args, **kwargs)
 
 
 extensions.wrapfunction(repair, b'strip', stripwrapper)
 
 
 def summaryhook(ui, repo):
     state = histeditstate(repo)
     if not state.inprogress():
         return
     state.read()
     if state.actions:
         # i18n: column positioning for "hg summary"
         ui.write(
             _(b'hist:   %s (histedit --continue)\n')
             % (
                 ui.label(_(b'%d remaining'), b'histedit.remaining')
                 % len(state.actions)
             )
         )
 
 
 def extsetup(ui):
     cmdutil.summaryhooks.add(b'histedit', summaryhook)
     statemod.addunfinished(
         b'histedit',
         fname=b'histedit-state',
         allowcommit=True,
         continueflag=True,
         abortfunc=hgaborthistedit,
     )

hgext/mq.py

@@ -1,4314 +1,4310 b''
 # mq.py - patch queues for mercurial
 #
 # Copyright 2005, 2006 Chris Mason <[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.
 
 '''manage a stack of patches
 
 This extension lets you work with a stack of patches in a Mercurial
 repository. It manages two stacks of patches - all known patches, and
 applied patches (subset of known patches).
 
 Known patches are represented as patch files in the .hg/patches
 directory. Applied patches are both patch files and changesets.
 
 Common tasks (use :hg:`help COMMAND` for more details)::
 
   create new patch                          qnew
   import existing patch                     qimport
 
   print patch series                        qseries
   print applied patches                     qapplied
 
   add known patch to applied stack          qpush
   remove patch from applied stack           qpop
   refresh contents of top applied patch     qrefresh
 
 By default, mq will automatically use git patches when required to
 avoid losing file mode changes, copy records, binary files or empty
 files creations or deletions. This behavior can be configured with::
 
   [mq]
   git = auto/keep/yes/no
 
 If set to 'keep', mq will obey the [diff] section configuration while
 preserving existing git patches upon qrefresh. If set to 'yes' or
 'no', mq will override the [diff] section and always generate git or
 regular patches, possibly losing data in the second case.
 
 It may be desirable for mq changesets to be kept in the secret phase (see
 :hg:`help phases`), which can be enabled with the following setting::
 
   [mq]
   secret = True
 
 You will by default be managing a patch queue named "patches". You can
 create other, independent patch queues with the :hg:`qqueue` command.
 
 If the working directory contains uncommitted files, qpush, qpop and
 qgoto abort immediately. If -f/--force is used, the changes are
 discarded. Setting::
 
   [mq]
   keepchanges = True
 
 make them behave as if --keep-changes were passed, and non-conflicting
 local changes will be tolerated and preserved. If incompatible options
 such as -f/--force or --exact are passed, this setting is ignored.
 
 This extension used to provide a strip command. This command now lives
 in the strip extension.
 '''
 
 
 import errno
 import os
 import re
 import shutil
 import sys
 from mercurial.i18n import _
 from mercurial.node import (
     bin,
     hex,
     nullrev,
     short,
 )
 from mercurial.pycompat import (
     delattr,
     getattr,
     open,
 )
 from mercurial import (
     cmdutil,
     commands,
     dirstateguard,
     encoding,
     error,
     extensions,
     hg,
     localrepo,
     lock as lockmod,
     logcmdutil,
     patch as patchmod,
     phases,
     pycompat,
     registrar,
     revsetlang,
     scmutil,
     smartset,
     strip,
     subrepoutil,
     util,
     vfs as vfsmod,
 )
 from mercurial.utils import (
     dateutil,
     stringutil,
     urlutil,
 )
 
 release = lockmod.release
 seriesopts = [(b's', b'summary', None, _(b'print first line of patch header'))]
 
 cmdtable = {}
 command = registrar.command(cmdtable)
 # Note for extension authors: ONLY specify testedwith = 'ships-with-hg-core' 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 = b'ships-with-hg-core'
 
 configtable = {}
 configitem = registrar.configitem(configtable)
 
 configitem(
     b'mq',
     b'git',
     default=b'auto',
 )
 configitem(
     b'mq',
     b'keepchanges',
     default=False,
 )
 configitem(
     b'mq',
     b'plain',
     default=False,
 )
 configitem(
     b'mq',
     b'secret',
     default=False,
 )
 
 # force load strip extension formerly included in mq and import some utility
 try:
     extensions.find(b'strip')
 except KeyError:
     # note: load is lazy so we could avoid the try-except,
     # but I (marmoute) prefer this explicit code.
     class dummyui:
         def debug(self, msg):
             pass
 
         def log(self, event, msgfmt, *msgargs, **opts):
             pass
 
     extensions.load(dummyui(), b'strip', b'')
 
 strip = strip.strip
 
 
 def checksubstate(repo, baserev=None):
     """return list of subrepos at a different revision than substate.
     Abort if any subrepos have uncommitted changes."""
     inclsubs = []
     wctx = repo[None]
     if baserev:
         bctx = repo[baserev]
     else:
         bctx = wctx.p1()
     for s in sorted(wctx.substate):
         wctx.sub(s).bailifchanged(True)
         if s not in bctx.substate or bctx.sub(s).dirty():
             inclsubs.append(s)
     return inclsubs
 
 
 # Patch names looks like unix-file names.
 # They must be joinable with queue directory and result in the patch path.
 normname = util.normpath
 
 
 class statusentry:
     def __init__(self, node, name):
         self.node, self.name = node, name
 
     def __bytes__(self):
         return hex(self.node) + b':' + self.name
 
     __str__ = encoding.strmethod(__bytes__)
     __repr__ = encoding.strmethod(__bytes__)
 
 
 # The order of the headers in 'hg export' HG patches:
 HGHEADERS = [
     #   '# HG changeset patch',
     b'# User ',
     b'# Date ',
     b'#      ',
     b'# Branch ',
     b'# Node ID ',
     b'# Parent  ',  # can occur twice for merges - but that is not relevant for mq
 ]
 # The order of headers in plain 'mail style' patches:
 PLAINHEADERS = {
     b'from': 0,
     b'date': 1,
     b'subject': 2,
 }
 
 
 def inserthgheader(lines, header, value):
     """Assuming lines contains a HG patch header, add a header line with value.
     >>> try: inserthgheader([], b'# Date ', b'z')
     ... except ValueError as inst: print("oops")
     oops
     >>> inserthgheader([b'# HG changeset patch'], b'# Date ', b'z')
     ['# HG changeset patch', '# Date z']
     >>> inserthgheader([b'# HG changeset patch', b''], b'# Date ', b'z')
     ['# HG changeset patch', '# Date z', '']
     >>> inserthgheader([b'# HG changeset patch', b'# User y'], b'# Date ', b'z')
     ['# HG changeset patch', '# User y', '# Date z']
     >>> inserthgheader([b'# HG changeset patch', b'# Date x', b'# User y'],
     ...                b'# User ', b'z')
     ['# HG changeset patch', '# Date x', '# User z']
     >>> inserthgheader([b'# HG changeset patch', b'# Date y'], b'# Date ', b'z')
     ['# HG changeset patch', '# Date z']
     >>> inserthgheader([b'# HG changeset patch', b'', b'# Date y'],
     ...                b'# Date ', b'z')
     ['# HG changeset patch', '# Date z', '', '# Date y']
     >>> inserthgheader([b'# HG changeset patch', b'# Parent  y'],
     ...                b'# Date ', b'z')
     ['# HG changeset patch', '# Date z', '# Parent  y']
     """
     start = lines.index(b'# HG changeset patch') + 1
     newindex = HGHEADERS.index(header)
     bestpos = len(lines)
     for i in range(start, len(lines)):
         line = lines[i]
         if not line.startswith(b'# '):
             bestpos = min(bestpos, i)
             break
         for lineindex, h in enumerate(HGHEADERS):
             if line.startswith(h):
                 if lineindex == newindex:
                     lines[i] = header + value
                     return lines
                 if lineindex > newindex:
                     bestpos = min(bestpos, i)
                 break  # next line
     lines.insert(bestpos, header + value)
     return lines
 
 
 def insertplainheader(lines, header, value):
     """For lines containing a plain patch header, add a header line with value.
     >>> insertplainheader([], b'Date', b'z')
     ['Date: z']
     >>> insertplainheader([b''], b'Date', b'z')
     ['Date: z', '']
     >>> insertplainheader([b'x'], b'Date', b'z')
     ['Date: z', '', 'x']
     >>> insertplainheader([b'From: y', b'x'], b'Date', b'z')
     ['From: y', 'Date: z', '', 'x']
     >>> insertplainheader([b' date : x', b' from : y', b''], b'From', b'z')
     [' date : x', 'From: z', '']
     >>> insertplainheader([b'', b'Date: y'], b'Date', b'z')
     ['Date: z', '', 'Date: y']
     >>> insertplainheader([b'foo: bar', b'DATE: z', b'x'], b'From', b'y')
     ['From: y', 'foo: bar', 'DATE: z', '', 'x']
     """
     newprio = PLAINHEADERS[header.lower()]
     bestpos = len(lines)
     for i, line in enumerate(lines):
         if b':' in line:
             lheader = line.split(b':', 1)[0].strip().lower()
             lprio = PLAINHEADERS.get(lheader, newprio + 1)
             if lprio == newprio:
                 lines[i] = b'%s: %s' % (header, value)
                 return lines
             if lprio > newprio and i < bestpos:
                 bestpos = i
         else:
             if line:
                 lines.insert(i, b'')
             if i < bestpos:
                 bestpos = i
             break
     lines.insert(bestpos, b'%s: %s' % (header, value))
     return lines
 
 
 class patchheader:
     def __init__(self, pf, plainmode=False):
         def eatdiff(lines):
             while lines:
                 l = lines[-1]
                 if (
                     l.startswith(b"diff -")
                     or l.startswith(b"Index:")
                     or l.startswith(b"===========")
                 ):
                     del lines[-1]
                 else:
                     break
 
         def eatempty(lines):
             while lines:
                 if not lines[-1].strip():
                     del lines[-1]
                 else:
                     break
 
         message = []
         comments = []
         user = None
         date = None
         parent = None
         format = None
         subject = None
         branch = None
         nodeid = None
         diffstart = 0
 
         for line in open(pf, b'rb'):
             line = line.rstrip()
             if line.startswith(b'diff --git') or (
                 diffstart and line.startswith(b'+++ ')
             ):
                 diffstart = 2
                 break
             diffstart = 0  # reset
             if line.startswith(b"--- "):
                 diffstart = 1
                 continue
             elif format == b"hgpatch":
                 # parse values when importing the result of an hg export
                 if line.startswith(b"# User "):
                     user = line[7:]
                 elif line.startswith(b"# Date "):
                     date = line[7:]
                 elif line.startswith(b"# Parent "):
                     parent = line[9:].lstrip()  # handle double trailing space
                 elif line.startswith(b"# Branch "):
                     branch = line[9:]
                 elif line.startswith(b"# Node ID "):
                     nodeid = line[10:]
                 elif not line.startswith(b"# ") and line:
                     message.append(line)
                     format = None
             elif line == b'# HG changeset patch':
                 message = []
                 format = b"hgpatch"
             elif format != b"tagdone" and (
                 line.startswith(b"Subject: ") or line.startswith(b"subject: ")
             ):
                 subject = line[9:]
                 format = b"tag"
             elif format != b"tagdone" and (
                 line.startswith(b"From: ") or line.startswith(b"from: ")
             ):
                 user = line[6:]
                 format = b"tag"
             elif format != b"tagdone" and (
                 line.startswith(b"Date: ") or line.startswith(b"date: ")
             ):
                 date = line[6:]
                 format = b"tag"
             elif format == b"tag" and line == b"":
                 # when looking for tags (subject: from: etc) they
                 # end once you find a blank line in the source
                 format = b"tagdone"
             elif message or line:
                 message.append(line)
             comments.append(line)
 
         eatdiff(message)
         eatdiff(comments)
         # Remember the exact starting line of the patch diffs before consuming
         # empty lines, for external use by TortoiseHg and others
         self.diffstartline = len(comments)
         eatempty(message)
         eatempty(comments)
 
         # make sure message isn't empty
         if format and format.startswith(b"tag") and subject:
             message.insert(0, subject)
 
         self.message = message
         self.comments = comments
         self.user = user
         self.date = date
         self.parent = parent
         # nodeid and branch are for external use by TortoiseHg and others
         self.nodeid = nodeid
         self.branch = branch
         self.haspatch = diffstart > 1
         self.plainmode = (
             plainmode
             or b'# HG changeset patch' not in self.comments
             and any(
                 c.startswith(b'Date: ') or c.startswith(b'From: ')
                 for c in self.comments
             )
         )
 
     def setuser(self, user):
         try:
             inserthgheader(self.comments, b'# User ', user)
         except ValueError:
             if self.plainmode:
                 insertplainheader(self.comments, b'From', user)
             else:
                 tmp = [b'# HG changeset patch', b'# User ' + user]
                 self.comments = tmp + self.comments
         self.user = user
 
     def setdate(self, date):
         try:
             inserthgheader(self.comments, b'# Date ', date)
         except ValueError:
             if self.plainmode:
                 insertplainheader(self.comments, b'Date', date)
             else:
                 tmp = [b'# HG changeset patch', b'# Date ' + date]
                 self.comments = tmp + self.comments
         self.date = date
 
     def setparent(self, parent):
         try:
             inserthgheader(self.comments, b'# Parent  ', parent)
         except ValueError:
             if not self.plainmode:
                 tmp = [b'# HG changeset patch', b'# Parent  ' + parent]
                 self.comments = tmp + self.comments
         self.parent = parent
 
     def setmessage(self, message):
         if self.comments:
             self._delmsg()
         self.message = [message]
         if message:
             if self.plainmode and self.comments and self.comments[-1]:
                 self.comments.append(b'')
             self.comments.append(message)
 
     def __bytes__(self):
         s = b'\n'.join(self.comments).rstrip()
         if not s:
             return b''
         return s + b'\n\n'
 
     __str__ = encoding.strmethod(__bytes__)
 
     def _delmsg(self):
         """Remove existing message, keeping the rest of the comments fields.
         If comments contains 'subject: ', message will prepend
         the field and a blank line."""
         if self.message:
             subj = b'subject: ' + self.message[0].lower()
-            for i in pycompat.xrange(len(self.comments)):
+            for i in range(len(self.comments)):
                 if subj == self.comments[i].lower():
                     del self.comments[i]
                     self.message = self.message[2:]
                     break
         ci = 0
         for mi in self.message:
             while mi != self.comments[ci]:
                 ci += 1
             del self.comments[ci]
 
 
 def newcommit(repo, phase, *args, **kwargs):
     """helper dedicated to ensure a commit respect mq.secret setting
 
     It should be used instead of repo.commit inside the mq source for operation
     creating new changeset.
     """
     repo = repo.unfiltered()
     if phase is None:
         if repo.ui.configbool(b'mq', b'secret'):
             phase = phases.secret
     overrides = {(b'ui', b'allowemptycommit'): True}
     if phase is not None:
         overrides[(b'phases', b'new-commit')] = phase
     with repo.ui.configoverride(overrides, b'mq'):
         repo.ui.setconfig(b'ui', b'allowemptycommit', True)
         return repo.commit(*args, **kwargs)
 
 
 class AbortNoCleanup(error.Abort):
     pass
 
 
 class queue:
     def __init__(self, ui, baseui, path, patchdir=None):
         self.basepath = path
         try:
             with open(os.path.join(path, b'patches.queue'), 'rb') as fh:
                 cur = fh.read().rstrip()
 
             if not cur:
                 curpath = os.path.join(path, b'patches')
             else:
                 curpath = os.path.join(path, b'patches-' + cur)
         except IOError:
             curpath = os.path.join(path, b'patches')
         self.path = patchdir or curpath
         self.opener = vfsmod.vfs(self.path)
         self.ui = ui
         self.baseui = baseui
         self.applieddirty = False
         self.seriesdirty = False
         self.added = []
         self.seriespath = b"series"
         self.statuspath = b"status"
         self.guardspath = b"guards"
         self.activeguards = None
         self.guardsdirty = False
         # Handle mq.git as a bool with extended values
         gitmode = ui.config(b'mq', b'git').lower()
         boolmode = stringutil.parsebool(gitmode)
         if boolmode is not None:
             if boolmode:
                 gitmode = b'yes'
             else:
                 gitmode = b'no'
         self.gitmode = gitmode
         # deprecated config: mq.plain
         self.plainmode = ui.configbool(b'mq', b'plain')
         self.checkapplied = True
 
     @util.propertycache
     def applied(self):
         def parselines(lines):
             for l in lines:
                 entry = l.split(b':', 1)
                 if len(entry) > 1:
                     n, name = entry
                     yield statusentry(bin(n), name)
                 elif l.strip():
                     self.ui.warn(
                         _(b'malformated mq status line: %s\n')
                         % stringutil.pprint(entry)
                     )
                 # else we ignore empty lines
 
         try:
             lines = self.opener.read(self.statuspath).splitlines()
             return list(parselines(lines))
         except IOError as e:
             if e.errno == errno.ENOENT:
                 return []
             raise
 
     @util.propertycache
     def fullseries(self):
         try:
             return self.opener.read(self.seriespath).splitlines()
         except IOError as e:
             if e.errno == errno.ENOENT:
                 return []
             raise
 
     @util.propertycache
     def series(self):
         self.parseseries()
         return self.series
 
     @util.propertycache
     def seriesguards(self):
         self.parseseries()
         return self.seriesguards
 
     def invalidate(self):
         for a in 'applied fullseries series seriesguards'.split():
             if a in self.__dict__:
                 delattr(self, a)
         self.applieddirty = False
         self.seriesdirty = False
         self.guardsdirty = False
         self.activeguards = None
 
     def diffopts(self, opts=None, patchfn=None, plain=False):
         """Return diff options tweaked for this mq use, possibly upgrading to
         git format, and possibly plain and without lossy options."""
         diffopts = patchmod.difffeatureopts(
             self.ui,
             opts,
             git=True,
             whitespace=not plain,
             formatchanging=not plain,
         )
         if self.gitmode == b'auto':
             diffopts.upgrade = True
         elif self.gitmode == b'keep':
             pass
         elif self.gitmode in (b'yes', b'no'):
             diffopts.git = self.gitmode == b'yes'
         else:
             raise error.Abort(
                 _(b'mq.git option can be auto/keep/yes/no got %s')
                 % self.gitmode
             )
         if patchfn:
             diffopts = self.patchopts(diffopts, patchfn)
         return diffopts
 
     def patchopts(self, diffopts, *patches):
         """Return a copy of input diff options with git set to true if
         referenced patch is a git patch and should be preserved as such.
         """
         diffopts = diffopts.copy()
         if not diffopts.git and self.gitmode == b'keep':
             for patchfn in patches:
                 patchf = self.opener(patchfn, b'r')
                 # if the patch was a git patch, refresh it as a git patch
                 diffopts.git = any(
                     line.startswith(b'diff --git') for line in patchf
                 )
                 patchf.close()
         return diffopts
 
     def join(self, *p):
         return os.path.join(self.path, *p)
 
     def findseries(self, patch):
         def matchpatch(l):
             l = l.split(b'#', 1)[0]
             return l.strip() == patch
 
         for index, l in enumerate(self.fullseries):
             if matchpatch(l):
                 return index
         return None
 
     guard_re = re.compile(br'\s?#([-+][^-+# \t\r\n\f][^# \t\r\n\f]*)')
 
     def parseseries(self):
         self.series = []
         self.seriesguards = []
         for l in self.fullseries:
             h = l.find(b'#')
             if h == -1:
                 patch = l
                 comment = b''
             elif h == 0:
                 continue
             else:
                 patch = l[:h]
                 comment = l[h:]
             patch = patch.strip()
             if patch:
                 if patch in self.series:
                     raise error.Abort(
                         _(b'%s appears more than once in %s')
                         % (patch, self.join(self.seriespath))
                     )
                 self.series.append(patch)
                 self.seriesguards.append(self.guard_re.findall(comment))
 
     def checkguard(self, guard):
         if not guard:
             return _(b'guard cannot be an empty string')
         bad_chars = b'# \t\r\n\f'
         first = guard[0]
         if first in b'-+':
             return _(b'guard %r starts with invalid character: %r') % (
                 guard,
                 first,
             )
         for c in bad_chars:
             if c in guard:
                 return _(b'invalid character in guard %r: %r') % (guard, c)
 
     def setactive(self, guards):
         for guard in guards:
             bad = self.checkguard(guard)
             if bad:
                 raise error.Abort(bad)
         guards = sorted(set(guards))
         self.ui.debug(b'active guards: %s\n' % b' '.join(guards))
         self.activeguards = guards
         self.guardsdirty = True
 
     def active(self):
         if self.activeguards is None:
             self.activeguards = []
             try:
                 guards = self.opener.read(self.guardspath).split()
             except IOError as err:
                 if err.errno != errno.ENOENT:
                     raise
                 guards = []
             for i, guard in enumerate(guards):
                 bad = self.checkguard(guard)
                 if bad:
                     self.ui.warn(
                         b'%s:%d: %s\n'
                         % (self.join(self.guardspath), i + 1, bad)
                     )
                 else:
                     self.activeguards.append(guard)
         return self.activeguards
 
     def setguards(self, idx, guards):
         for g in guards:
             if len(g) < 2:
                 raise error.Abort(_(b'guard %r too short') % g)
             if g[0] not in b'-+':
                 raise error.Abort(_(b'guard %r starts with invalid char') % g)
             bad = self.checkguard(g[1:])
             if bad:
                 raise error.Abort(bad)
         drop = self.guard_re.sub(b'', self.fullseries[idx])
         self.fullseries[idx] = drop + b''.join([b' #' + g for g in guards])
         self.parseseries()
         self.seriesdirty = True
 
     def pushable(self, idx):
         if isinstance(idx, bytes):
             idx = self.series.index(idx)
         patchguards = self.seriesguards[idx]
         if not patchguards:
             return True, None
         guards = self.active()
         exactneg = [
             g for g in patchguards if g.startswith(b'-') and g[1:] in guards
         ]
         if exactneg:
             return False, stringutil.pprint(exactneg[0])
         pos = [g for g in patchguards if g.startswith(b'+')]
         exactpos = [g for g in pos if g[1:] in guards]
         if pos:
             if exactpos:
                 return True, stringutil.pprint(exactpos[0])
             return False, b' '.join([stringutil.pprint(p) for p in pos])
         return True, b''
 
     def explainpushable(self, idx, all_patches=False):
         if all_patches:
             write = self.ui.write
         else:
             write = self.ui.warn
 
         if all_patches or self.ui.verbose:
             if isinstance(idx, bytes):
                 idx = self.series.index(idx)
             pushable, why = self.pushable(idx)
             if all_patches and pushable:
                 if why is None:
                     write(
                         _(b'allowing %s - no guards in effect\n')
                         % self.series[idx]
                     )
                 else:
                     if not why:
                         write(
                             _(b'allowing %s - no matching negative guards\n')
                             % self.series[idx]
                         )
                     else:
                         write(
                             _(b'allowing %s - guarded by %s\n')
                             % (self.series[idx], why)
                         )
             if not pushable:
                 if why:
                     write(
                         _(b'skipping %s - guarded by %s\n')
                         % (self.series[idx], why)
                     )
                 else:
                     write(
                         _(b'skipping %s - no matching guards\n')
                         % self.series[idx]
                     )
 
     def savedirty(self):
         def writelist(items, path):
             fp = self.opener(path, b'wb')
             for i in items:
                 fp.write(b"%s\n" % i)
             fp.close()
 
         if self.applieddirty:
             writelist(map(bytes, self.applied), self.statuspath)
             self.applieddirty = False
         if self.seriesdirty:
             writelist(self.fullseries, self.seriespath)
             self.seriesdirty = False
         if self.guardsdirty:
             writelist(self.activeguards, self.guardspath)
             self.guardsdirty = False
         if self.added:
             qrepo = self.qrepo()
             if qrepo:
                 qrepo[None].add(f for f in self.added if f not in qrepo[None])
             self.added = []
 
     def removeundo(self, repo):
         undo = repo.sjoin(b'undo')
         if not os.path.exists(undo):
             return
         try:
             os.unlink(undo)
         except OSError as inst:
             self.ui.warn(
                 _(b'error removing undo: %s\n') % stringutil.forcebytestr(inst)
             )
 
     def backup(self, repo, files, copy=False):
         # backup local changes in --force case
         for f in sorted(files):
             absf = repo.wjoin(f)
             if os.path.lexists(absf):
                 absorig = scmutil.backuppath(self.ui, repo, f)
                 self.ui.note(
                     _(b'saving current version of %s as %s\n')
                     % (f, os.path.relpath(absorig))
                 )
 
                 if copy:
                     util.copyfile(absf, absorig)
                 else:
                     util.rename(absf, absorig)
 
     def printdiff(
         self,
         repo,
         diffopts,
         node1,
         node2=None,
         files=None,
         fp=None,
         changes=None,
         opts=None,
     ):
         if opts is None:
             opts = {}
         stat = opts.get(b'stat')
         m = scmutil.match(repo[node1], files, opts)
         logcmdutil.diffordiffstat(
             self.ui,
             repo,
             diffopts,
             repo[node1],
             repo[node2],
             m,
             changes,
             stat,
             fp,
         )
 
     def mergeone(self, repo, mergeq, head, patch, rev, diffopts):
         # first try just applying the patch
         (err, n) = self.apply(
             repo, [patch], update_status=False, strict=True, merge=rev
         )
 
         if err == 0:
             return (err, n)
 
         if n is None:
             raise error.Abort(_(b"apply failed for patch %s") % patch)
 
         self.ui.warn(_(b"patch didn't work out, merging %s\n") % patch)
 
         # apply failed, strip away that rev and merge.
         hg.clean(repo, head)
         strip(self.ui, repo, [n], update=False, backup=False)
 
         ctx = repo[rev]
         ret = hg.merge(ctx, remind=False)
         if ret:
             raise error.Abort(_(b"update returned %d") % ret)
         n = newcommit(repo, None, ctx.description(), ctx.user(), force=True)
         if n is None:
             raise error.Abort(_(b"repo commit failed"))
         try:
             ph = patchheader(mergeq.join(patch), self.plainmode)
         except Exception:
             raise error.Abort(_(b"unable to read %s") % patch)
 
         diffopts = self.patchopts(diffopts, patch)
         patchf = self.opener(patch, b"w")
         comments = bytes(ph)
         if comments:
             patchf.write(comments)
         self.printdiff(repo, diffopts, head, n, fp=patchf)
         patchf.close()
         self.removeundo(repo)
         return (0, n)
 
     def qparents(self, repo, rev=None):
         """return the mq handled parent or p1
 
         In some case where mq get himself in being the parent of a merge the
         appropriate parent may be p2.
         (eg: an in progress merge started with mq disabled)
 
         If no parent are managed by mq, p1 is returned.
         """
         if rev is None:
             (p1, p2) = repo.dirstate.parents()
             if p2 == repo.nullid:
                 return p1
             if not self.applied:
                 return None
             return self.applied[-1].node
         p1, p2 = repo.changelog.parents(rev)
         if p2 != repo.nullid and p2 in [x.node for x in self.applied]:
             return p2
         return p1
 
     def mergepatch(self, repo, mergeq, series, diffopts):
         if not self.applied:
             # each of the patches merged in will have two parents.  This
             # can confuse the qrefresh, qdiff, and strip code because it
             # needs to know which parent is actually in the patch queue.
             # so, we insert a merge marker with only one parent.  This way
             # the first patch in the queue is never a merge patch
             #
             pname = b".hg.patches.merge.marker"
             n = newcommit(repo, None, b'[mq]: merge marker', force=True)
             self.removeundo(repo)
             self.applied.append(statusentry(n, pname))
             self.applieddirty = True
 
         head = self.qparents(repo)
 
         for patch in series:
             patch = mergeq.lookup(patch, strict=True)
             if not patch:
                 self.ui.warn(_(b"patch %s does not exist\n") % patch)
                 return (1, None)
             pushable, reason = self.pushable(patch)
             if not pushable:
                 self.explainpushable(patch, all_patches=True)
                 continue
             info = mergeq.isapplied(patch)
             if not info:
                 self.ui.warn(_(b"patch %s is not applied\n") % patch)
                 return (1, None)
             rev = info[1]
             err, head = self.mergeone(repo, mergeq, head, patch, rev, diffopts)
             if head:
                 self.applied.append(statusentry(head, patch))
                 self.applieddirty = True
             if err:
                 return (err, head)
         self.savedirty()
         return (0, head)
 
     def patch(self, repo, patchfile):
         """Apply patchfile  to the working directory.
         patchfile: name of patch file"""
         files = set()
         try:
             fuzz = patchmod.patch(
                 self.ui, repo, patchfile, strip=1, files=files, eolmode=None
             )
             return (True, list(files), fuzz)
         except Exception as inst:
             self.ui.note(stringutil.forcebytestr(inst) + b'\n')
             if not self.ui.verbose:
                 self.ui.warn(_(b"patch failed, unable to continue (try -v)\n"))
             self.ui.traceback()
             return (False, list(files), False)
 
     def apply(
         self,
         repo,
         series,
         list=False,
         update_status=True,
         strict=False,
         patchdir=None,
         merge=None,
         all_files=None,
         tobackup=None,
         keepchanges=False,
     ):
         wlock = lock = tr = None
         try:
             wlock = repo.wlock()
             lock = repo.lock()
             tr = repo.transaction(b"qpush")
             try:
                 ret = self._apply(
                     repo,
                     series,
                     list,
                     update_status,
                     strict,
                     patchdir,
                     merge,
                     all_files=all_files,
                     tobackup=tobackup,
                     keepchanges=keepchanges,
                 )
                 tr.close()
                 self.savedirty()
                 return ret
             except AbortNoCleanup:
                 tr.close()
                 self.savedirty()
                 raise
             except:  # re-raises
                 try:
                     tr.abort()
                 finally:
                     self.invalidate()
                 raise
         finally:
             release(tr, lock, wlock)
             self.removeundo(repo)
 
     def _apply(
         self,
         repo,
         series,
         list=False,
         update_status=True,
         strict=False,
         patchdir=None,
         merge=None,
         all_files=None,
         tobackup=None,
         keepchanges=False,
     ):
         """returns (error, hash)
 
         error = 1 for unable to read, 2 for patch failed, 3 for patch
         fuzz. tobackup is None or a set of files to backup before they
         are modified by a patch.
         """
         # TODO unify with commands.py
         if not patchdir:
             patchdir = self.path
         err = 0
         n = None
         for patchname in series:
             pushable, reason = self.pushable(patchname)
             if not pushable:
                 self.explainpushable(patchname, all_patches=True)
                 continue
             self.ui.status(_(b"applying %s\n") % patchname)
             pf = os.path.join(patchdir, patchname)
 
             try:
                 ph = patchheader(self.join(patchname), self.plainmode)
             except IOError:
                 self.ui.warn(_(b"unable to read %s\n") % patchname)
                 err = 1
                 break
 
             message = ph.message
             if not message:
                 # The commit message should not be translated
                 message = b"imported patch %s\n" % patchname
             else:
                 if list:
                     # The commit message should not be translated
                     message.append(b"\nimported patch %s" % patchname)
                 message = b'\n'.join(message)
 
             if ph.haspatch:
                 if tobackup:
                     touched = patchmod.changedfiles(self.ui, repo, pf)
                     touched = set(touched) & tobackup
                     if touched and keepchanges:
                         raise AbortNoCleanup(
                             _(b"conflicting local changes found"),
                             hint=_(b"did you forget to qrefresh?"),
                         )
                     self.backup(repo, touched, copy=True)
                     tobackup = tobackup - touched
                 (patcherr, files, fuzz) = self.patch(repo, pf)
                 if all_files is not None:
                     all_files.update(files)
                 patcherr = not patcherr
             else:
                 self.ui.warn(_(b"patch %s is empty\n") % patchname)
                 patcherr, files, fuzz = 0, [], 0
 
             if merge and files:
                 # Mark as removed/merged and update dirstate parent info
                 with repo.dirstate.parentchange():
                     for f in files:
                         repo.dirstate.update_file_p1(f, p1_tracked=True)
                     p1 = repo.dirstate.p1()
                     repo.setparents(p1, merge)
 
             if all_files and b'.hgsubstate' in all_files:
                 wctx = repo[None]
                 pctx = repo[b'.']
                 overwrite = False
                 mergedsubstate = subrepoutil.submerge(
                     repo, pctx, wctx, wctx, overwrite
                 )
                 files += mergedsubstate.keys()
 
             match = scmutil.matchfiles(repo, files or [])
             oldtip = repo.changelog.tip()
             n = newcommit(
                 repo, None, message, ph.user, ph.date, match=match, force=True
             )
             if repo.changelog.tip() == oldtip:
                 raise error.Abort(
                     _(b"qpush exactly duplicates child changeset")
                 )
             if n is None:
                 raise error.Abort(_(b"repository commit failed"))
 
             if update_status:
                 self.applied.append(statusentry(n, patchname))
 
             if patcherr:
                 self.ui.warn(
                     _(b"patch failed, rejects left in working directory\n")
                 )
                 err = 2
                 break
 
             if fuzz and strict:
                 self.ui.warn(_(b"fuzz found when applying patch, stopping\n"))
                 err = 3
                 break
         return (err, n)
 
     def _cleanup(self, patches, numrevs, keep=False):
         if not keep:
             r = self.qrepo()
             if r:
                 r[None].forget(patches)
             for p in patches:
                 try:
                     os.unlink(self.join(p))
                 except OSError as inst:
                     if inst.errno != errno.ENOENT:
                         raise
 
         qfinished = []
         if numrevs:
             qfinished = self.applied[:numrevs]
             del self.applied[:numrevs]
             self.applieddirty = True
 
         unknown = []
 
         sortedseries = []
         for p in patches:
             idx = self.findseries(p)
             if idx is None:
                 sortedseries.append((-1, p))
             else:
                 sortedseries.append((idx, p))
 
         sortedseries.sort(reverse=True)
         for (i, p) in sortedseries:
             if i != -1:
                 del self.fullseries[i]
             else:
                 unknown.append(p)
 
         if unknown:
             if numrevs:
                 rev = {entry.name: entry.node for entry in qfinished}
                 for p in unknown:
                     msg = _(b'revision %s refers to unknown patches: %s\n')
                     self.ui.warn(msg % (short(rev[p]), p))
             else:
                 msg = _(b'unknown patches: %s\n')
                 raise error.Abort(b''.join(msg % p for p in unknown))
 
         self.parseseries()
         self.seriesdirty = True
         return [entry.node for entry in qfinished]
 
     def _revpatches(self, repo, revs):
         firstrev = repo[self.applied[0].node].rev()
         patches = []
         for i, rev in enumerate(revs):
 
             if rev < firstrev:
                 raise error.Abort(_(b'revision %d is not managed') % rev)
 
             ctx = repo[rev]
             base = self.applied[i].node
             if ctx.node() != base:
                 msg = _(b'cannot delete revision %d above applied patches')
                 raise error.Abort(msg % rev)
 
             patch = self.applied[i].name
             for fmt in (b'[mq]: %s', b'imported patch %s'):
                 if ctx.description() == fmt % patch:
                     msg = _(b'patch %s finalized without changeset message\n')
                     repo.ui.status(msg % patch)
                     break
 
             patches.append(patch)
         return patches
 
     def finish(self, repo, revs):
         # Manually trigger phase computation to ensure phasedefaults is
         # executed before we remove the patches.
         repo._phasecache
         patches = self._revpatches(repo, sorted(revs))
         qfinished = self._cleanup(patches, len(patches))
         if qfinished and repo.ui.configbool(b'mq', b'secret'):
             # only use this logic when the secret option is added
             oldqbase = repo[qfinished[0]]
             tphase = phases.newcommitphase(repo.ui)
             if oldqbase.phase() > tphase and oldqbase.p1().phase() <= tphase:
                 with repo.transaction(b'qfinish') as tr:
                     phases.advanceboundary(repo, tr, tphase, qfinished)
 
     def delete(self, repo, patches, opts):
         if not patches and not opts.get(b'rev'):
             raise error.Abort(
                 _(b'qdelete requires at least one revision or patch name')
             )
 
         realpatches = []
         for patch in patches:
             patch = self.lookup(patch, strict=True)
             info = self.isapplied(patch)
             if info:
                 raise error.Abort(_(b"cannot delete applied patch %s") % patch)
             if patch not in self.series:
                 raise error.Abort(_(b"patch %s not in series file") % patch)
             if patch not in realpatches:
                 realpatches.append(patch)
 
         numrevs = 0
         if opts.get(b'rev'):
             if not self.applied:
                 raise error.Abort(_(b'no patches applied'))
             revs = logcmdutil.revrange(repo, opts.get(b'rev'))
             revs.sort()
             revpatches = self._revpatches(repo, revs)
             realpatches += revpatches
             numrevs = len(revpatches)
 
         self._cleanup(realpatches, numrevs, opts.get(b'keep'))
 
     def checktoppatch(self, repo):
         '''check that working directory is at qtip'''
         if self.applied:
             top = self.applied[-1].node
             patch = self.applied[-1].name
             if repo.dirstate.p1() != top:
                 raise error.Abort(_(b"working directory revision is not qtip"))
             return top, patch
         return None, None
 
     def putsubstate2changes(self, substatestate, changes):
         if isinstance(changes, list):
             mar = changes[:3]
         else:
             mar = (changes.modified, changes.added, changes.removed)
         if any((b'.hgsubstate' in files for files in mar)):
             return  # already listed up
         # not yet listed up
         if substatestate.added or not substatestate.any_tracked:
             mar[1].append(b'.hgsubstate')
         elif substatestate.removed:
             mar[2].append(b'.hgsubstate')
         else:  # modified
             mar[0].append(b'.hgsubstate')
 
     def checklocalchanges(self, repo, force=False, refresh=True):
         excsuffix = b''
         if refresh:
             excsuffix = b', qrefresh first'
             # plain versions for i18n tool to detect them
             _(b"local changes found, qrefresh first")
             _(b"local changed subrepos found, qrefresh first")
 
         s = repo.status()
         if not force:
             cmdutil.checkunfinished(repo)
             if s.modified or s.added or s.removed or s.deleted:
                 _(b"local changes found")  # i18n tool detection
                 raise error.Abort(_(b"local changes found" + excsuffix))
             if checksubstate(repo):
                 _(b"local changed subrepos found")  # i18n tool detection
                 raise error.Abort(
                     _(b"local changed subrepos found" + excsuffix)
                 )
         else:
             cmdutil.checkunfinished(repo, skipmerge=True)
         return s
 
     _reserved = (b'series', b'status', b'guards', b'.', b'..')
 
     def checkreservedname(self, name):
         if name in self._reserved:
             raise error.Abort(
                 _(b'"%s" cannot be used as the name of a patch') % name
             )
         if name != name.strip():
             # whitespace is stripped by parseseries()
             raise error.Abort(
                 _(b'patch name cannot begin or end with whitespace')
             )
         for prefix in (b'.hg', b'.mq'):
             if name.startswith(prefix):
                 raise error.Abort(
                     _(b'patch name cannot begin with "%s"') % prefix
                 )
         for c in (b'#', b':', b'\r', b'\n'):
             if c in name:
                 raise error.Abort(
                     _(b'%r cannot be used in the name of a patch')
                     % pycompat.bytestr(c)
                 )
 
     def checkpatchname(self, name, force=False):
         self.checkreservedname(name)
         if not force and os.path.exists(self.join(name)):
             if os.path.isdir(self.join(name)):
                 raise error.Abort(
                     _(b'"%s" already exists as a directory') % name
                 )
             else:
                 raise error.Abort(_(b'patch "%s" already exists') % name)
 
     def makepatchname(self, title, fallbackname):
         """Return a suitable filename for title, adding a suffix to make
         it unique in the existing list"""
         namebase = re.sub(br'[\s\W_]+', b'_', title.lower()).strip(b'_')
         namebase = namebase[:75]  # avoid too long name (issue5117)
         if namebase:
             try:
                 self.checkreservedname(namebase)
             except error.Abort:
                 namebase = fallbackname
         else:
             namebase = fallbackname
         name = namebase
         i = 0
         while True:
             if name not in self.fullseries:
                 try:
                     self.checkpatchname(name)
                     break
                 except error.Abort:
                     pass
             i += 1
             name = b'%s__%d' % (namebase, i)
         return name
 
     def checkkeepchanges(self, keepchanges, force):
         if force and keepchanges:
             raise error.Abort(_(b'cannot use both --force and --keep-changes'))
 
     def new(self, repo, patchfn, *pats, **opts):
         """options:
         msg: a string or a no-argument function returning a string
         """
         opts = pycompat.byteskwargs(opts)
         msg = opts.get(b'msg')
         edit = opts.get(b'edit')
         editform = opts.get(b'editform', b'mq.qnew')
         user = opts.get(b'user')
         date = opts.get(b'date')
         if date:
             date = dateutil.parsedate(date)
         diffopts = self.diffopts({b'git': opts.get(b'git')}, plain=True)
         if opts.get(b'checkname', True):
             self.checkpatchname(patchfn)
         inclsubs = checksubstate(repo)
         if inclsubs:
             substatestate = repo.dirstate.get_entry(b'.hgsubstate')
         if opts.get(b'include') or opts.get(b'exclude') or pats:
             # detect missing files in pats
             def badfn(f, msg):
                 if f != b'.hgsubstate':  # .hgsubstate is auto-created
                     raise error.Abort(b'%s: %s' % (f, msg))
 
             match = scmutil.match(repo[None], pats, opts, badfn=badfn)
             changes = repo.status(match=match)
         else:
             changes = self.checklocalchanges(repo, force=True)
         commitfiles = list(inclsubs)
         commitfiles.extend(changes.modified)
         commitfiles.extend(changes.added)
         commitfiles.extend(changes.removed)
         match = scmutil.matchfiles(repo, commitfiles)
         if len(repo[None].parents()) > 1:
             raise error.Abort(_(b'cannot manage merge changesets'))
         self.checktoppatch(repo)
         insert = self.fullseriesend()
         with repo.wlock():
             try:
                 # if patch file write fails, abort early
                 p = self.opener(patchfn, b"w")
             except IOError as e:
                 raise error.Abort(
                     _(b'cannot write patch "%s": %s')
                     % (patchfn, encoding.strtolocal(e.strerror))
                 )
             try:
                 defaultmsg = b"[mq]: %s" % patchfn
                 editor = cmdutil.getcommiteditor(editform=editform)
                 if edit:
 
                     def finishdesc(desc):
                         if desc.rstrip():
                             return desc
                         else:
                             return defaultmsg
 
                     # i18n: this message is shown in editor with "HG: " prefix
                     extramsg = _(b'Leave message empty to use default message.')
                     editor = cmdutil.getcommiteditor(
                         finishdesc=finishdesc,
                         extramsg=extramsg,
                         editform=editform,
                     )
                     commitmsg = msg
                 else:
                     commitmsg = msg or defaultmsg
 
                 n = newcommit(
                     repo,
                     None,
                     commitmsg,
                     user,
                     date,
                     match=match,
                     force=True,
                     editor=editor,
                 )
                 if n is None:
                     raise error.Abort(_(b"repo commit failed"))
                 try:
                     self.fullseries[insert:insert] = [patchfn]
                     self.applied.append(statusentry(n, patchfn))
                     self.parseseries()
                     self.seriesdirty = True
                     self.applieddirty = True
                     nctx = repo[n]
                     ph = patchheader(self.join(patchfn), self.plainmode)
                     if user:
                         ph.setuser(user)
                     if date:
                         ph.setdate(b'%d %d' % date)
                     ph.setparent(hex(nctx.p1().node()))
                     msg = nctx.description().strip()
                     if msg == defaultmsg.strip():
                         msg = b''
                     ph.setmessage(msg)
                     p.write(bytes(ph))
                     if commitfiles:
                         parent = self.qparents(repo, n)
                         if inclsubs:
                             self.putsubstate2changes(substatestate, changes)
                         chunks = patchmod.diff(
                             repo,
                             node1=parent,
                             node2=n,
                             changes=changes,
                             opts=diffopts,
                         )
                         for chunk in chunks:
                             p.write(chunk)
                     p.close()
                     r = self.qrepo()
                     if r:
                         r[None].add([patchfn])
                 except:  # re-raises
                     repo.rollback()
                     raise
             except Exception:
                 patchpath = self.join(patchfn)
                 try:
                     os.unlink(patchpath)
                 except OSError:
                     self.ui.warn(_(b'error unlinking %s\n') % patchpath)
                 raise
             self.removeundo(repo)
 
     def isapplied(self, patch):
         """returns (index, rev, patch)"""
         for i, a in enumerate(self.applied):
             if a.name == patch:
                 return (i, a.node, a.name)
         return None
 
     # if the exact patch name does not exist, we try a few
     # variations.  If strict is passed, we try only #1
     #
     # 1) a number (as string) to indicate an offset in the series file
     # 2) a unique substring of the patch name was given
     # 3) patchname[-+]num to indicate an offset in the series file
     def lookup(self, patch, strict=False):
         def partialname(s):
             if s in self.series:
                 return s
             matches = [x for x in self.series if s in x]
             if len(matches) > 1:
                 self.ui.warn(_(b'patch name "%s" is ambiguous:\n') % s)
                 for m in matches:
                     self.ui.warn(b'  %s\n' % m)
                 return None
             if matches:
                 return matches[0]
             if self.series and self.applied:
                 if s == b'qtip':
                     return self.series[self.seriesend(True) - 1]
                 if s == b'qbase':
                     return self.series[0]
             return None
 
         if patch in self.series:
             return patch
 
         if not os.path.isfile(self.join(patch)):
             try:
                 sno = int(patch)
             except (ValueError, OverflowError):
                 pass
             else:
                 if -len(self.series) <= sno < len(self.series):
                     return self.series[sno]
 
             if not strict:
                 res = partialname(patch)
                 if res:
                     return res
                 minus = patch.rfind(b'-')
                 if minus >= 0:
                     res = partialname(patch[:minus])
                     if res:
                         i = self.series.index(res)
                         try:
                             off = int(patch[minus + 1 :] or 1)
                         except (ValueError, OverflowError):
                             pass
                         else:
                             if i - off >= 0:
                                 return self.series[i - off]
                 plus = patch.rfind(b'+')
                 if plus >= 0:
                     res = partialname(patch[:plus])
                     if res:
                         i = self.series.index(res)
                         try:
                             off = int(patch[plus + 1 :] or 1)
                         except (ValueError, OverflowError):
                             pass
                         else:
                             if i + off < len(self.series):
                                 return self.series[i + off]
         raise error.Abort(_(b"patch %s not in series") % patch)
 
     def push(
         self,
         repo,
         patch=None,
         force=False,
         list=False,
         mergeq=None,
         all=False,
         move=False,
         exact=False,
         nobackup=False,
         keepchanges=False,
     ):
         self.checkkeepchanges(keepchanges, force)
         diffopts = self.diffopts()
         with repo.wlock():
             heads = []
             for hs in repo.branchmap().iterheads():
                 heads.extend(hs)
             if not heads:
                 heads = [repo.nullid]
             if repo.dirstate.p1() not in heads and not exact:
                 self.ui.status(_(b"(working directory not at a head)\n"))
 
             if not self.series:
                 self.ui.warn(_(b'no patches in series\n'))
                 return 0
 
             # Suppose our series file is: A B C and the current 'top'
             # patch is B. qpush C should be performed (moving forward)
             # qpush B is a NOP (no change) qpush A is an error (can't
             # go backwards with qpush)
             if patch:
                 patch = self.lookup(patch)
                 info = self.isapplied(patch)
                 if info and info[0] >= len(self.applied) - 1:
                     self.ui.warn(
                         _(b'qpush: %s is already at the top\n') % patch
                     )
                     return 0
 
                 pushable, reason = self.pushable(patch)
                 if pushable:
                     if self.series.index(patch) < self.seriesend():
                         raise error.Abort(
                             _(b"cannot push to a previous patch: %s") % patch
                         )
                 else:
                     if reason:
                         reason = _(b'guarded by %s') % reason
                     else:
                         reason = _(b'no matching guards')
                     self.ui.warn(
                         _(b"cannot push '%s' - %s\n") % (patch, reason)
                     )
                     return 1
             elif all:
                 patch = self.series[-1]
                 if self.isapplied(patch):
                     self.ui.warn(_(b'all patches are currently applied\n'))
                     return 0
 
             # Following the above example, starting at 'top' of B:
             # qpush should be performed (pushes C), but a subsequent
             # qpush without an argument is an error (nothing to
             # apply). This allows a loop of "...while hg qpush..." to
             # work as it detects an error when done
             start = self.seriesend()
             if start == len(self.series):
                 self.ui.warn(_(b'patch series already fully applied\n'))
                 return 1
             if not force and not keepchanges:
                 self.checklocalchanges(repo, refresh=self.applied)
 
             if exact:
                 if keepchanges:
                     raise error.Abort(
                         _(b"cannot use --exact and --keep-changes together")
                     )
                 if move:
                     raise error.Abort(
                         _(b'cannot use --exact and --move together')
                     )
                 if self.applied:
                     raise error.Abort(
                         _(b'cannot push --exact with applied patches')
                     )
                 root = self.series[start]
                 target = patchheader(self.join(root), self.plainmode).parent
                 if not target:
                     raise error.Abort(
                         _(b"%s does not have a parent recorded") % root
                     )
                 if not repo[target] == repo[b'.']:
                     hg.update(repo, target)
 
             if move:
                 if not patch:
                     raise error.Abort(_(b"please specify the patch to move"))
                 for fullstart, rpn in enumerate(self.fullseries):
                     # strip markers for patch guards
                     if self.guard_re.split(rpn, 1)[0] == self.series[start]:
                         break
                 for i, rpn in enumerate(self.fullseries[fullstart:]):
                     # strip markers for patch guards
                     if self.guard_re.split(rpn, 1)[0] == patch:
                         break
                 index = fullstart + i
                 assert index < len(self.fullseries)
                 fullpatch = self.fullseries[index]
                 del self.fullseries[index]
                 self.fullseries.insert(fullstart, fullpatch)
                 self.parseseries()
                 self.seriesdirty = True
 
             self.applieddirty = True
             if start > 0:
                 self.checktoppatch(repo)
             if not patch:
                 patch = self.series[start]
                 end = start + 1
             else:
                 end = self.series.index(patch, start) + 1
 
             tobackup = set()
             if (not nobackup and force) or keepchanges:
                 status = self.checklocalchanges(repo, force=True)
                 if keepchanges:
                     tobackup.update(
                         status.modified
                         + status.added
                         + status.removed
                         + status.deleted
                     )
                 else:
                     tobackup.update(status.modified + status.added)
 
             s = self.series[start:end]
             all_files = set()
             try:
                 if mergeq:
                     ret = self.mergepatch(repo, mergeq, s, diffopts)
                 else:
                     ret = self.apply(
                         repo,
                         s,
                         list,
                         all_files=all_files,
                         tobackup=tobackup,
                         keepchanges=keepchanges,
                     )
             except AbortNoCleanup:
                 raise
             except:  # re-raises
                 self.ui.warn(_(b'cleaning up working directory...\n'))
                 cmdutil.revert(
                     self.ui,
                     repo,
                     repo[b'.'],
                     no_backup=True,
                 )
                 # only remove unknown files that we know we touched or
                 # created while patching
                 for f in all_files:
                     if f not in repo.dirstate:
                         repo.wvfs.unlinkpath(f, ignoremissing=True)
                 self.ui.warn(_(b'done\n'))
                 raise
 
             if not self.applied:
                 return ret[0]
             top = self.applied[-1].name
             if ret[0] and ret[0] > 1:
                 msg = _(b"errors during apply, please fix and qrefresh %s\n")
                 self.ui.write(msg % top)
             else:
                 self.ui.write(_(b"now at: %s\n") % top)
             return ret[0]
 
     def pop(
         self,
         repo,
         patch=None,
         force=False,
         update=True,
         all=False,
         nobackup=False,
         keepchanges=False,
     ):
         self.checkkeepchanges(keepchanges, force)
         with repo.wlock():
             if patch:
                 # index, rev, patch
                 info = self.isapplied(patch)
                 if not info:
                     patch = self.lookup(patch)
                 info = self.isapplied(patch)
                 if not info:
                     raise error.Abort(_(b"patch %s is not applied") % patch)
 
             if not self.applied:
                 # Allow qpop -a to work repeatedly,
                 # but not qpop without an argument
                 self.ui.warn(_(b"no patches applied\n"))
                 return not all
 
             if all:
                 start = 0
             elif patch:
                 start = info[0] + 1
             else:
                 start = len(self.applied) - 1
 
             if start >= len(self.applied):
                 self.ui.warn(_(b"qpop: %s is already at the top\n") % patch)
                 return
 
             if not update:
                 parents = repo.dirstate.parents()
                 rr = [x.node for x in self.applied]
                 for p in parents:
                     if p in rr:
                         self.ui.warn(_(b"qpop: forcing dirstate update\n"))
                         update = True
             else:
                 parents = [p.node() for p in repo[None].parents()]
                 update = any(
                     entry.node in parents for entry in self.applied[start:]
                 )
 
             tobackup = set()
             if update:
                 s = self.checklocalchanges(repo, force=force or keepchanges)
                 if force:
                     if not nobackup:
                         tobackup.update(s.modified + s.added)
                 elif keepchanges:
                     tobackup.update(
                         s.modified + s.added + s.removed + s.deleted
                     )
 
             self.applieddirty = True
             end = len(self.applied)
             rev = self.applied[start].node
 
             try:
                 heads = repo.changelog.heads(rev)
             except error.LookupError:
                 node = short(rev)
                 raise error.Abort(_(b'trying to pop unknown node %s') % node)
 
             if heads != [self.applied[-1].node]:
                 raise error.Abort(
                     _(
                         b"popping would remove a revision not "
                         b"managed by this patch queue"
                     )
                 )
             if not repo[self.applied[-1].node].mutable():
                 raise error.Abort(
                     _(b"popping would remove a public revision"),
                     hint=_(b"see 'hg help phases' for details"),
                 )
 
             # we know there are no local changes, so we can make a simplified
             # form of hg.update.
             if update:
                 qp = self.qparents(repo, rev)
                 ctx = repo[qp]
                 st = repo.status(qp, b'.')
                 m, a, r, d = st.modified, st.added, st.removed, st.deleted
                 if d:
                     raise error.Abort(_(b"deletions found between repo revs"))
 
                 tobackup = set(a + m + r) & tobackup
                 if keepchanges and tobackup:
                     raise error.Abort(_(b"local changes found, qrefresh first"))
                 self.backup(repo, tobackup)
                 with repo.dirstate.parentchange():
                     for f in a:
                         repo.wvfs.unlinkpath(f, ignoremissing=True)
                         repo.dirstate.update_file(
                             f, p1_tracked=False, wc_tracked=False
                         )
                     for f in m + r:
                         fctx = ctx[f]
                         repo.wwrite(f, fctx.data(), fctx.flags())
                         repo.dirstate.update_file(
                             f, p1_tracked=True, wc_tracked=True
                         )
                     repo.setparents(qp, repo.nullid)
             for patch in reversed(self.applied[start:end]):
                 self.ui.status(_(b"popping %s\n") % patch.name)
             del self.applied[start:end]
             strip(self.ui, repo, [rev], update=False, backup=False)
             for s, state in repo[b'.'].substate.items():
                 repo[b'.'].sub(s).get(state)
             if self.applied:
                 self.ui.write(_(b"now at: %s\n") % self.applied[-1].name)
             else:
                 self.ui.write(_(b"patch queue now empty\n"))
 
     def diff(self, repo, pats, opts):
         top, patch = self.checktoppatch(repo)
         if not top:
             self.ui.write(_(b"no patches applied\n"))
             return
         qp = self.qparents(repo, top)
         if opts.get(b'reverse'):
             node1, node2 = None, qp
         else:
             node1, node2 = qp, None
         diffopts = self.diffopts(opts, patch)
         self.printdiff(repo, diffopts, node1, node2, files=pats, opts=opts)
 
     def refresh(self, repo, pats=None, **opts):
         opts = pycompat.byteskwargs(opts)
         if not self.applied:
             self.ui.write(_(b"no patches applied\n"))
             return 1
         msg = opts.get(b'msg', b'').rstrip()
         edit = opts.get(b'edit')
         editform = opts.get(b'editform', b'mq.qrefresh')
         newuser = opts.get(b'user')
         newdate = opts.get(b'date')
         if newdate:
             newdate = b'%d %d' % dateutil.parsedate(newdate)
         wlock = repo.wlock()
 
         try:
             self.checktoppatch(repo)
             (top, patchfn) = (self.applied[-1].node, self.applied[-1].name)
             if repo.changelog.heads(top) != [top]:
                 raise error.Abort(
                     _(b"cannot qrefresh a revision with children")
                 )
             if not repo[top].mutable():
                 raise error.Abort(
                     _(b"cannot qrefresh public revision"),
                     hint=_(b"see 'hg help phases' for details"),
                 )
 
             cparents = repo.changelog.parents(top)
             patchparent = self.qparents(repo, top)
 
             inclsubs = checksubstate(repo, patchparent)
             if inclsubs:
                 substatestate = repo.dirstate.get_entry(b'.hgsubstate')
 
             ph = patchheader(self.join(patchfn), self.plainmode)
             diffopts = self.diffopts(
                 {b'git': opts.get(b'git')}, patchfn, plain=True
             )
             if newuser:
                 ph.setuser(newuser)
             if newdate:
                 ph.setdate(newdate)
             ph.setparent(hex(patchparent))
 
             # only commit new patch when write is complete
             patchf = self.opener(patchfn, b'w', atomictemp=True)
 
             # update the dirstate in place, strip off the qtip commit
             # and then commit.
             #
             # this should really read:
             #   st = repo.status(top, patchparent)
             # but we do it backwards to take advantage of manifest/changelog
             # caching against the next repo.status call
             st = repo.status(patchparent, top)
             mm, aa, dd = st.modified, st.added, st.removed
             ctx = repo[top]
             aaa = aa[:]
             match1 = scmutil.match(repo[None], pats, opts)
             # in short mode, we only diff the files included in the
             # patch already plus specified files
             if opts.get(b'short'):
                 # if amending a patch, we start with existing
                 # files plus specified files - unfiltered
                 match = scmutil.matchfiles(repo, mm + aa + dd + match1.files())
                 # filter with include/exclude options
                 match1 = scmutil.match(repo[None], opts=opts)
             else:
                 match = scmutil.matchall(repo)
             stb = repo.status(match=match)
             m, a, r, d = stb.modified, stb.added, stb.removed, stb.deleted
             mm = set(mm)
             aa = set(aa)
             dd = set(dd)
 
             # we might end up with files that were added between
             # qtip and the dirstate parent, but then changed in the
             # local dirstate. in this case, we want them to only
             # show up in the added section
             for x in m:
                 if x not in aa:
                     mm.add(x)
             # we might end up with files added by the local dirstate that
             # were deleted by the patch.  In this case, they should only
             # show up in the changed section.
             for x in a:
                 if x in dd:
                     dd.remove(x)
                     mm.add(x)
                 else:
                     aa.add(x)
             # make sure any files deleted in the local dirstate
             # are not in the add or change column of the patch
             forget = []
             for x in d + r:
                 if x in aa:
                     aa.remove(x)
                     forget.append(x)
                     continue
                 else:
                     mm.discard(x)
                 dd.add(x)
 
             m = list(mm)
             r = list(dd)
             a = list(aa)
 
             # create 'match' that includes the files to be recommitted.
             # apply match1 via repo.status to ensure correct case handling.
             st = repo.status(patchparent, match=match1)
             cm, ca, cr, cd = st.modified, st.added, st.removed, st.deleted
             allmatches = set(cm + ca + cr + cd)
             refreshchanges = [x.intersection(allmatches) for x in (mm, aa, dd)]
 
             files = set(inclsubs)
             for x in refreshchanges:
                 files.update(x)
             match = scmutil.matchfiles(repo, files)
 
             bmlist = repo[top].bookmarks()
 
             with repo.dirstate.parentchange():
                 # XXX do we actually need the dirstateguard
                 dsguard = None
                 try:
                     dsguard = dirstateguard.dirstateguard(repo, b'mq.refresh')
                     if diffopts.git or diffopts.upgrade:
                         copies = {}
                         for dst in a:
                             src = repo.dirstate.copied(dst)
                             # during qfold, the source file for copies may
                             # be removed. Treat this as a simple add.
                             if src is not None and src in repo.dirstate:
                                 copies.setdefault(src, []).append(dst)
                             repo.dirstate.update_file(
                                 dst, p1_tracked=False, wc_tracked=True
                             )
                         # remember the copies between patchparent and qtip
                         for dst in aaa:
                             src = ctx[dst].copysource()
                             if src:
                                 copies.setdefault(src, []).extend(
                                     copies.get(dst, [])
                                 )
                                 if dst in a:
                                     copies[src].append(dst)
                             # we can't copy a file created by the patch itself
                             if dst in copies:
                                 del copies[dst]
                         for src, dsts in copies.items():
                             for dst in dsts:
                                 repo.dirstate.copy(src, dst)
                     else:
                         for dst in a:
                             repo.dirstate.update_file(
                                 dst, p1_tracked=False, wc_tracked=True
                             )
                         # Drop useless copy information
                         for f in list(repo.dirstate.copies()):
                             repo.dirstate.copy(None, f)
                     for f in r:
                         repo.dirstate.update_file_p1(f, p1_tracked=True)
                     # if the patch excludes a modified file, mark that
                     # file with mtime=0 so status can see it.
                     mm = []
-                    for i in pycompat.xrange(len(m) - 1, -1, -1):
+                    for i in range(len(m) - 1, -1, -1):
                         if not match1(m[i]):
                             mm.append(m[i])
                             del m[i]
                     for f in m:
                         repo.dirstate.update_file_p1(f, p1_tracked=True)
                     for f in mm:
                         repo.dirstate.update_file_p1(f, p1_tracked=True)
                     for f in forget:
                         repo.dirstate.update_file_p1(f, p1_tracked=False)
 
                     user = ph.user or ctx.user()
 
                     oldphase = repo[top].phase()
 
                     # assumes strip can roll itself back if interrupted
                     repo.setparents(*cparents)
                     self.applied.pop()
                     self.applieddirty = True
                     strip(self.ui, repo, [top], update=False, backup=False)
                     dsguard.close()
                 finally:
                     release(dsguard)
 
             try:
                 # might be nice to attempt to roll back strip after this
 
                 defaultmsg = b"[mq]: %s" % patchfn
                 editor = cmdutil.getcommiteditor(editform=editform)
                 if edit:
 
                     def finishdesc(desc):
                         if desc.rstrip():
                             ph.setmessage(desc)
                             return desc
                         return defaultmsg
 
                     # i18n: this message is shown in editor with "HG: " prefix
                     extramsg = _(b'Leave message empty to use default message.')
                     editor = cmdutil.getcommiteditor(
                         finishdesc=finishdesc,
                         extramsg=extramsg,
                         editform=editform,
                     )
                     message = msg or b"\n".join(ph.message)
                 elif not msg:
                     if not ph.message:
                         message = defaultmsg
                     else:
                         message = b"\n".join(ph.message)
                 else:
                     message = msg
                     ph.setmessage(msg)
 
                 # Ensure we create a new changeset in the same phase than
                 # the old one.
                 lock = tr = None
                 try:
                     lock = repo.lock()
                     tr = repo.transaction(b'mq')
                     n = newcommit(
                         repo,
                         oldphase,
                         message,
                         user,
                         ph.date,
                         match=match,
                         force=True,
                         editor=editor,
                     )
                     # only write patch after a successful commit
                     c = [list(x) for x in refreshchanges]
                     if inclsubs:
                         self.putsubstate2changes(substatestate, c)
                     chunks = patchmod.diff(
                         repo, patchparent, changes=c, opts=diffopts
                     )
                     comments = bytes(ph)
                     if comments:
                         patchf.write(comments)
                     for chunk in chunks:
                         patchf.write(chunk)
                     patchf.close()
 
                     marks = repo._bookmarks
                     marks.applychanges(repo, tr, [(bm, n) for bm in bmlist])
                     tr.close()
 
                     self.applied.append(statusentry(n, patchfn))
                 finally:
                     lockmod.release(tr, lock)
             except:  # re-raises
                 ctx = repo[cparents[0]]
                 repo.dirstate.rebuild(ctx.node(), ctx.manifest())
                 self.savedirty()
                 self.ui.warn(
                     _(
                         b'qrefresh interrupted while patch was popped! '
                         b'(revert --all, qpush to recover)\n'
                     )
                 )
                 raise
         finally:
             wlock.release()
             self.removeundo(repo)
 
     def init(self, repo, create=False):
         if not create and os.path.isdir(self.path):
             raise error.Abort(_(b"patch queue directory already exists"))
         try:
             os.mkdir(self.path)
         except OSError as inst:
             if inst.errno != errno.EEXIST or not create:
                 raise
         if create:
             return self.qrepo(create=True)
 
     def unapplied(self, repo, patch=None):
         if patch and patch not in self.series:
             raise error.Abort(_(b"patch %s is not in series file") % patch)
         if not patch:
             start = self.seriesend()
         else:
             start = self.series.index(patch) + 1
         unapplied = []
-        for i in pycompat.xrange(start, len(self.series)):
+        for i in range(start, len(self.series)):
             pushable, reason = self.pushable(i)
             if pushable:
                 unapplied.append((i, self.series[i]))
             self.explainpushable(i)
         return unapplied
 
     def qseries(
         self,
         repo,
         missing=None,
         start=0,
         length=None,
         status=None,
         summary=False,
     ):
         def displayname(pfx, patchname, state):
             if pfx:
                 self.ui.write(pfx)
             if summary:
                 ph = patchheader(self.join(patchname), self.plainmode)
                 if ph.message:
                     msg = ph.message[0]
                 else:
                     msg = b''
 
                 if self.ui.formatted():
                     width = self.ui.termwidth() - len(pfx) - len(patchname) - 2
                     if width > 0:
                         msg = stringutil.ellipsis(msg, width)
                     else:
                         msg = b''
                 self.ui.write(patchname, label=b'qseries.' + state)
                 self.ui.write(b': ')
                 self.ui.write(msg, label=b'qseries.message.' + state)
             else:
                 self.ui.write(patchname, label=b'qseries.' + state)
             self.ui.write(b'\n')
 
         applied = {p.name for p in self.applied}
         if length is None:
             length = len(self.series) - start
         if not missing:
             if self.ui.verbose:
                 idxwidth = len(b"%d" % (start + length - 1))
-            for i in pycompat.xrange(start, start + length):
+            for i in range(start, start + length):
                 patch = self.series[i]
                 if patch in applied:
                     char, state = b'A', b'applied'
                 elif self.pushable(i)[0]:
                     char, state = b'U', b'unapplied'
                 else:
                     char, state = b'G', b'guarded'
                 pfx = b''
                 if self.ui.verbose:
                     pfx = b'%*d %s ' % (idxwidth, i, char)
                 elif status and status != char:
                     continue
                 displayname(pfx, patch, state)
         else:
             msng_list = []
             for root, dirs, files in os.walk(self.path):
                 d = root[len(self.path) + 1 :]
                 for f in files:
                     fl = os.path.join(d, f)
                     if (
                         fl not in self.series
                         and fl
                         not in (
                             self.statuspath,
                             self.seriespath,
                             self.guardspath,
                         )
                         and not fl.startswith(b'.')
                     ):
                         msng_list.append(fl)
             for x in sorted(msng_list):
                 pfx = self.ui.verbose and b'D ' or b''
                 displayname(pfx, x, b'missing')
 
     def issaveline(self, l):
         if l.name == b'.hg.patches.save.line':
             return True
 
     def qrepo(self, create=False):
         ui = self.baseui.copy()
         # copy back attributes set by ui.pager()
         if self.ui.pageractive and not ui.pageractive:
             ui.pageractive = self.ui.pageractive
             # internal config: ui.formatted
             ui.setconfig(
                 b'ui',
                 b'formatted',
                 self.ui.config(b'ui', b'formatted'),
                 b'mqpager',
             )
             ui.setconfig(
                 b'ui',
                 b'interactive',
                 self.ui.config(b'ui', b'interactive'),
                 b'mqpager',
             )
         if create or os.path.isdir(self.join(b".hg")):
             return hg.repository(ui, path=self.path, create=create)
 
     def restore(self, repo, rev, delete=None, qupdate=None):
         desc = repo[rev].description().strip()
         lines = desc.splitlines()
         datastart = None
         series = []
         applied = []
         qpp = None
         for i, line in enumerate(lines):
             if line == b'Patch Data:':
                 datastart = i + 1
             elif line.startswith(b'Dirstate:'):
                 l = line.rstrip()
                 l = l[10:].split(b' ')
                 qpp = [bin(x) for x in l]
             elif datastart is not None:
                 l = line.rstrip()
                 n, name = l.split(b':', 1)
                 if n:
                     applied.append(statusentry(bin(n), name))
                 else:
                     series.append(l)
         if datastart is None:
             self.ui.warn(_(b"no saved patch data found\n"))
             return 1
         self.ui.warn(_(b"restoring status: %s\n") % lines[0])
         self.fullseries = series
         self.applied = applied
         self.parseseries()
         self.seriesdirty = True
         self.applieddirty = True
         heads = repo.changelog.heads()
         if delete:
             if rev not in heads:
                 self.ui.warn(_(b"save entry has children, leaving it alone\n"))
             else:
                 self.ui.warn(_(b"removing save entry %s\n") % short(rev))
                 pp = repo.dirstate.parents()
                 if rev in pp:
                     update = True
                 else:
                     update = False
                 strip(self.ui, repo, [rev], update=update, backup=False)
         if qpp:
             self.ui.warn(
                 _(b"saved queue repository parents: %s %s\n")
                 % (short(qpp[0]), short(qpp[1]))
             )
             if qupdate:
                 self.ui.status(_(b"updating queue directory\n"))
                 r = self.qrepo()
                 if not r:
                     self.ui.warn(_(b"unable to load queue repository\n"))
                     return 1
                 hg.clean(r, qpp[0])
 
     def save(self, repo, msg=None):
         if not self.applied:
             self.ui.warn(_(b"save: no patches applied, exiting\n"))
             return 1
         if self.issaveline(self.applied[-1]):
             self.ui.warn(_(b"status is already saved\n"))
             return 1
 
         if not msg:
             msg = _(b"hg patches saved state")
         else:
             msg = b"hg patches: " + msg.rstrip(b'\r\n')
         r = self.qrepo()
         if r:
             pp = r.dirstate.parents()
             msg += b"\nDirstate: %s %s" % (hex(pp[0]), hex(pp[1]))
         msg += b"\n\nPatch Data:\n"
         msg += b''.join(b'%s\n' % x for x in self.applied)
         msg += b''.join(b':%s\n' % x for x in self.fullseries)
         n = repo.commit(msg, force=True)
         if not n:
             self.ui.warn(_(b"repo commit failed\n"))
             return 1
         self.applied.append(statusentry(n, b'.hg.patches.save.line'))
         self.applieddirty = True
         self.removeundo(repo)
 
     def fullseriesend(self):
         if self.applied:
             p = self.applied[-1].name
             end = self.findseries(p)
             if end is None:
                 return len(self.fullseries)
             return end + 1
         return 0
 
     def seriesend(self, all_patches=False):
         """If all_patches is False, return the index of the next pushable patch
         in the series, or the series length. If all_patches is True, return the
         index of the first patch past the last applied one.
         """
         end = 0
 
         def nextpatch(start):
             if all_patches or start >= len(self.series):
                 return start
-            for i in pycompat.xrange(start, len(self.series)):
+            for i in range(start, len(self.series)):
                 p, reason = self.pushable(i)
                 if p:
                     return i
                 self.explainpushable(i)
             return len(self.series)
 
         if self.applied:
             p = self.applied[-1].name
             try:
                 end = self.series.index(p)
             except ValueError:
                 return 0
             return nextpatch(end + 1)
         return nextpatch(end)
 
     def appliedname(self, index):
         pname = self.applied[index].name
         if not self.ui.verbose:
             p = pname
         else:
             p = (b"%d" % self.series.index(pname)) + b" " + pname
         return p
 
     def qimport(
         self,
         repo,
         files,
         patchname=None,
         rev=None,
         existing=None,
         force=None,
         git=False,
     ):
         def checkseries(patchname):
             if patchname in self.series:
                 raise error.Abort(
                     _(b'patch %s is already in the series file') % patchname
                 )
 
         if rev:
             if files:
                 raise error.Abort(
                     _(b'option "-r" not valid when importing files')
                 )
             rev = logcmdutil.revrange(repo, rev)
             rev.sort(reverse=True)
         elif not files:
             raise error.Abort(_(b'no files or revisions specified'))
         if (len(files) > 1 or len(rev) > 1) and patchname:
             raise error.Abort(
                 _(b'option "-n" not valid when importing multiple patches')
             )
         imported = []
         if rev:
             # If mq patches are applied, we can only import revisions
             # that form a linear path to qbase.
             # Otherwise, they should form a linear path to a head.
             heads = repo.changelog.heads(repo.changelog.node(rev.first()))
             if len(heads) > 1:
                 raise error.Abort(
                     _(b'revision %d is the root of more than one branch')
                     % rev.last()
                 )
             if self.applied:
                 base = repo.changelog.node(rev.first())
                 if base in [n.node for n in self.applied]:
                     raise error.Abort(
                         _(b'revision %d is already managed') % rev.first()
                     )
                 if heads != [self.applied[-1].node]:
                     raise error.Abort(
                         _(b'revision %d is not the parent of the queue')
                         % rev.first()
                     )
                 base = repo.changelog.rev(self.applied[0].node)
                 lastparent = repo.changelog.parentrevs(base)[0]
             else:
                 if heads != [repo.changelog.node(rev.first())]:
                     raise error.Abort(
                         _(b'revision %d has unmanaged children') % rev.first()
                     )
                 lastparent = None
 
             diffopts = self.diffopts({b'git': git})
             with repo.transaction(b'qimport') as tr:
                 for r in rev:
                     if not repo[r].mutable():
                         raise error.Abort(
                             _(b'revision %d is not mutable') % r,
                             hint=_(b"see 'hg help phases' " b'for details'),
                         )
                     p1, p2 = repo.changelog.parentrevs(r)
                     n = repo.changelog.node(r)
                     if p2 != nullrev:
                         raise error.Abort(
                             _(b'cannot import merge revision %d') % r
                         )
                     if lastparent and lastparent != r:
                         raise error.Abort(
                             _(b'revision %d is not the parent of %d')
                             % (r, lastparent)
                         )
                     lastparent = p1
 
                     if not patchname:
                         patchname = self.makepatchname(
                             repo[r].description().split(b'\n', 1)[0],
                             b'%d.diff' % r,
                         )
                     checkseries(patchname)
                     self.checkpatchname(patchname, force)
                     self.fullseries.insert(0, patchname)
 
                     with self.opener(patchname, b"w") as fp:
                         cmdutil.exportfile(repo, [n], fp, opts=diffopts)
 
                     se = statusentry(n, patchname)
                     self.applied.insert(0, se)
 
                     self.added.append(patchname)
                     imported.append(patchname)
                     patchname = None
                     if rev and repo.ui.configbool(b'mq', b'secret'):
                         # if we added anything with --rev, move the secret root
                         phases.retractboundary(repo, tr, phases.secret, [n])
                     self.parseseries()
                     self.applieddirty = True
                     self.seriesdirty = True
 
         for i, filename in enumerate(files):
             if existing:
                 if filename == b'-':
                     raise error.Abort(
                         _(b'-e is incompatible with import from -')
                     )
                 filename = normname(filename)
                 self.checkreservedname(filename)
                 if urlutil.url(filename).islocal():
                     originpath = self.join(filename)
                     if not os.path.isfile(originpath):
                         raise error.Abort(
                             _(b"patch %s does not exist") % filename
                         )
 
                 if patchname:
                     self.checkpatchname(patchname, force)
 
                     self.ui.write(
                         _(b'renaming %s to %s\n') % (filename, patchname)
                     )
                     util.rename(originpath, self.join(patchname))
                 else:
                     patchname = filename
 
             else:
                 if filename == b'-' and not patchname:
                     raise error.Abort(
                         _(b'need --name to import a patch from -')
                     )
                 elif not patchname:
                     patchname = normname(
                         os.path.basename(filename.rstrip(b'/'))
                     )
                 self.checkpatchname(patchname, force)
                 try:
                     if filename == b'-':
                         text = self.ui.fin.read()
                     else:
                         fp = hg.openpath(self.ui, filename)
                         text = fp.read()
                         fp.close()
                 except (OSError, IOError):
                     raise error.Abort(_(b"unable to read file %s") % filename)
                 patchf = self.opener(patchname, b"w")
                 patchf.write(text)
                 patchf.close()
             if not force:
                 checkseries(patchname)
             if patchname not in self.series:
                 index = self.fullseriesend() + i
                 self.fullseries[index:index] = [patchname]
             self.parseseries()
             self.seriesdirty = True
             self.ui.warn(_(b"adding %s to series file\n") % patchname)
             self.added.append(patchname)
             imported.append(patchname)
             patchname = None
 
         self.removeundo(repo)
         return imported
 
 
 def fixkeepchangesopts(ui, opts):
     if (
         not ui.configbool(b'mq', b'keepchanges')
         or opts.get(b'force')
         or opts.get(b'exact')
     ):
         return opts
     opts = dict(opts)
     opts[b'keep_changes'] = True
     return opts
 
 
 @command(
     b"qdelete|qremove|qrm",
     [
         (b'k', b'keep', None, _(b'keep patch file')),
         (
             b'r',
             b'rev',
             [],
             _(b'stop managing a revision (DEPRECATED)'),
             _(b'REV'),
         ),
     ],
     _(b'hg qdelete [-k] [PATCH]...'),
     helpcategory=command.CATEGORY_CHANGE_ORGANIZATION,
 )
 def delete(ui, repo, *patches, **opts):
     """remove patches from queue
 
     The patches must not be applied, and at least one patch is required. Exact
     patch identifiers must be given. With -k/--keep, the patch files are
     preserved in the patch directory.
 
     To stop managing a patch and move it into permanent history,
     use the :hg:`qfinish` command."""
     q = repo.mq
     q.delete(repo, patches, pycompat.byteskwargs(opts))
     q.savedirty()
     return 0
 
 
 @command(
     b"qapplied",
     [(b'1', b'last', None, _(b'show only the preceding applied patch'))]
     + seriesopts,
     _(b'hg qapplied [-1] [-s] [PATCH]'),
     helpcategory=command.CATEGORY_CHANGE_ORGANIZATION,
 )
 def applied(ui, repo, patch=None, **opts):
     """print the patches already applied
 
     Returns 0 on success."""
 
     q = repo.mq
     opts = pycompat.byteskwargs(opts)
 
     if patch:
         if patch not in q.series:
             raise error.Abort(_(b"patch %s is not in series file") % patch)
         end = q.series.index(patch) + 1
     else:
         end = q.seriesend(True)
 
     if opts.get(b'last') and not end:
         ui.write(_(b"no patches applied\n"))
         return 1
     elif opts.get(b'last') and end == 1:
         ui.write(_(b"only one patch applied\n"))
         return 1
     elif opts.get(b'last'):
         start = end - 2
         end = 1
     else:
         start = 0
 
     q.qseries(
         repo, length=end, start=start, status=b'A', summary=opts.get(b'summary')
     )
 
 
 @command(
     b"qunapplied",
     [(b'1', b'first', None, _(b'show only the first patch'))] + seriesopts,
     _(b'hg qunapplied [-1] [-s] [PATCH]'),
     helpcategory=command.CATEGORY_CHANGE_ORGANIZATION,
 )
 def unapplied(ui, repo, patch=None, **opts):
     """print the patches not yet applied
 
     Returns 0 on success."""
 
     q = repo.mq
     opts = pycompat.byteskwargs(opts)
     if patch:
         if patch not in q.series:
             raise error.Abort(_(b"patch %s is not in series file") % patch)
         start = q.series.index(patch) + 1
     else:
         start = q.seriesend(True)
 
     if start == len(q.series) and opts.get(b'first'):
         ui.write(_(b"all patches applied\n"))
         return 1
 
     if opts.get(b'first'):
         length = 1
     else:
         length = None
     q.qseries(
         repo,
         start=start,
         length=length,
         status=b'U',
         summary=opts.get(b'summary'),
     )
 
 
 @command(
     b"qimport",
     [
         (b'e', b'existing', None, _(b'import file in patch directory')),
         (b'n', b'name', b'', _(b'name of patch file'), _(b'NAME')),
         (b'f', b'force', None, _(b'overwrite existing files')),
         (
             b'r',
             b'rev',
             [],
             _(b'place existing revisions under mq control'),
             _(b'REV'),
         ),
         (b'g', b'git', None, _(b'use git extended diff format')),
         (b'P', b'push', None, _(b'qpush after importing')),
     ],
     _(b'hg qimport [-e] [-n NAME] [-f] [-g] [-P] [-r REV]... [FILE]...'),
     helpcategory=command.CATEGORY_IMPORT_EXPORT,
 )
 def qimport(ui, repo, *filename, **opts):
     """import a patch or existing changeset
 
     The patch is inserted into the series after the last applied
     patch. If no patches have been applied, qimport prepends the patch
     to the series.
 
     The patch will have the same name as its source file unless you
     give it a new one with -n/--name.
 
     You can register an existing patch inside the patch directory with
     the -e/--existing flag.
 
     With -f/--force, an existing patch of the same name will be
     overwritten.
 
     An existing changeset may be placed under mq control with -r/--rev
     (e.g. qimport --rev . -n patch will place the current revision
     under mq control). With -g/--git, patches imported with --rev will
     use the git diff format. See the diffs help topic for information
     on why this is important for preserving rename/copy information
     and permission changes. Use :hg:`qfinish` to remove changesets
     from mq control.
 
     To import a patch from standard input, pass - as the patch file.
     When importing from standard input, a patch name must be specified
     using the --name flag.
 
     To import an existing patch while renaming it::
 
       hg qimport -e existing-patch -n new-name
 
     Returns 0 if import succeeded.
     """
     opts = pycompat.byteskwargs(opts)
     with repo.lock():  # cause this may move phase
         q = repo.mq
         try:
             imported = q.qimport(
                 repo,
                 filename,
                 patchname=opts.get(b'name'),
                 existing=opts.get(b'existing'),
                 force=opts.get(b'force'),
                 rev=opts.get(b'rev'),
                 git=opts.get(b'git'),
             )
         finally:
             q.savedirty()
 
     if imported and opts.get(b'push') and not opts.get(b'rev'):
         return q.push(repo, imported[-1])
     return 0
 
 
 def qinit(ui, repo, create):
     """initialize a new queue repository
 
     This command also creates a series file for ordering patches, and
     an mq-specific .hgignore file in the queue repository, to exclude
     the status and guards files (these contain mostly transient state).
 
     Returns 0 if initialization succeeded."""
     q = repo.mq
     r = q.init(repo, create)
     q.savedirty()
     if r:
         if not os.path.exists(r.wjoin(b'.hgignore')):
             fp = r.wvfs(b'.hgignore', b'w')
             fp.write(b'^\\.hg\n')
             fp.write(b'^\\.mq\n')
             fp.write(b'syntax: glob\n')
             fp.write(b'status\n')
             fp.write(b'guards\n')
             fp.close()
         if not os.path.exists(r.wjoin(b'series')):
             r.wvfs(b'series', b'w').close()
         r[None].add([b'.hgignore', b'series'])
         commands.add(ui, r)
     return 0
 
 
 @command(
     b"qinit",
     [(b'c', b'create-repo', None, _(b'create queue repository'))],
     _(b'hg qinit [-c]'),
     helpcategory=command.CATEGORY_REPO_CREATION,
     helpbasic=True,
 )
 def init(ui, repo, **opts):
     """init a new queue repository (DEPRECATED)
 
     The queue repository is unversioned by default. If
     -c/--create-repo is specified, qinit will create a separate nested
     repository for patches (qinit -c may also be run later to convert
     an unversioned patch repository into a versioned one). You can use
     qcommit to commit changes to this queue repository.
 
     This command is deprecated. Without -c, it's implied by other relevant
     commands. With -c, use :hg:`init --mq` instead."""
     return qinit(ui, repo, create=opts.get('create_repo'))
 
 
 @command(
     b"qclone",
     [
         (b'', b'pull', None, _(b'use pull protocol to copy metadata')),
         (
             b'U',
             b'noupdate',
             None,
             _(b'do not update the new working directories'),
         ),
         (
             b'',
             b'uncompressed',
             None,
             _(b'use uncompressed transfer (fast over LAN)'),
         ),
         (
             b'p',
             b'patches',
             b'',
             _(b'location of source patch repository'),
             _(b'REPO'),
         ),
     ]
     + cmdutil.remoteopts,
     _(b'hg qclone [OPTION]... SOURCE [DEST]'),
     helpcategory=command.CATEGORY_REPO_CREATION,
     norepo=True,
 )
 def clone(ui, source, dest=None, **opts):
     """clone main and patch repository at same time
 
     If source is local, destination will have no patches applied. If
     source is remote, this command can not check if patches are
     applied in source, so cannot guarantee that patches are not
     applied in destination. If you clone remote repository, be sure
     before that it has no patches applied.
 
     Source patch repository is looked for in <src>/.hg/patches by
     default. Use -p <url> to change.
 
     The patch directory must be a nested Mercurial repository, as
     would be created by :hg:`init --mq`.
 
     Return 0 on success.
     """
     opts = pycompat.byteskwargs(opts)
 
     def patchdir(repo):
         """compute a patch repo url from a repo object"""
         url = repo.url()
         if url.endswith(b'/'):
             url = url[:-1]
         return url + b'/.hg/patches'
 
     # main repo (destination and sources)
     if dest is None:
         dest = hg.defaultdest(source)
     __, source_path, __ = urlutil.get_clone_path(ui, source)
     sr = hg.peer(ui, opts, source_path)
 
     # patches repo (source only)
     if opts.get(b'patches'):
         __, patchespath, __ = urlutil.get_clone_path(ui, opts.get(b'patches'))
     else:
         patchespath = patchdir(sr)
     try:
         hg.peer(ui, opts, patchespath)
     except error.RepoError:
         raise error.Abort(
             _(b'versioned patch repository not found (see init --mq)')
         )
     qbase, destrev = None, None
     if sr.local():
         repo = sr.local()
         if repo.mq.applied and repo[qbase].phase() != phases.secret:
             qbase = repo.mq.applied[0].node
             if not hg.islocal(dest):
                 heads = set(repo.heads())
                 destrev = list(heads.difference(repo.heads(qbase)))
                 destrev.append(repo.changelog.parents(qbase)[0])
     elif sr.capable(b'lookup'):
         try:
             qbase = sr.lookup(b'qbase')
         except error.RepoError:
             pass
 
     ui.note(_(b'cloning main repository\n'))
     sr, dr = hg.clone(
         ui,
         opts,
         sr.url(),
         dest,
         pull=opts.get(b'pull'),
         revs=destrev,
         update=False,
         stream=opts.get(b'uncompressed'),
     )
 
     ui.note(_(b'cloning patch repository\n'))
     hg.clone(
         ui,
         opts,
         opts.get(b'patches') or patchdir(sr),
         patchdir(dr),
         pull=opts.get(b'pull'),
         update=not opts.get(b'noupdate'),
         stream=opts.get(b'uncompressed'),
     )
 
     if dr.local():
         repo = dr.local()
         if qbase:
             ui.note(
                 _(
                     b'stripping applied patches from destination '
                     b'repository\n'
                 )
             )
             strip(ui, repo, [qbase], update=False, backup=None)
         if not opts.get(b'noupdate'):
             ui.note(_(b'updating destination repository\n'))
             hg.update(repo, repo.changelog.tip())
 
 
 @command(
     b"qcommit|qci",
     commands.table[b"commit|ci"][1],
     _(b'hg qcommit [OPTION]... [FILE]...'),
     helpcategory=command.CATEGORY_COMMITTING,
     inferrepo=True,
 )
 def commit(ui, repo, *pats, **opts):
     """commit changes in the queue repository (DEPRECATED)
 
     This command is deprecated; use :hg:`commit --mq` instead."""
     q = repo.mq
     r = q.qrepo()
     if not r:
         raise error.Abort(b'no queue repository')
     commands.commit(r.ui, r, *pats, **opts)
 
 
 @command(
     b"qseries",
     [
         (b'm', b'missing', None, _(b'print patches not in series')),
     ]
     + seriesopts,
     _(b'hg qseries [-ms]'),
     helpcategory=command.CATEGORY_CHANGE_ORGANIZATION,
 )
 def series(ui, repo, **opts):
     """print the entire series file
 
     Returns 0 on success."""
     repo.mq.qseries(
         repo, missing=opts.get('missing'), summary=opts.get('summary')
     )
     return 0
 
 
 @command(
     b"qtop",
     seriesopts,
     _(b'hg qtop [-s]'),
     helpcategory=command.CATEGORY_CHANGE_ORGANIZATION,
 )
 def top(ui, repo, **opts):
     """print the name of the current patch
 
     Returns 0 on success."""
     q = repo.mq
     if q.applied:
         t = q.seriesend(True)
     else:
         t = 0
 
     if t:
         q.qseries(
             repo,
             start=t - 1,
             length=1,
             status=b'A',
             summary=opts.get('summary'),
         )
     else:
         ui.write(_(b"no patches applied\n"))
         return 1
 
 
 @command(
     b"qnext",
     seriesopts,
     _(b'hg qnext [-s]'),
     helpcategory=command.CATEGORY_CHANGE_ORGANIZATION,
 )
 def next(ui, repo, **opts):
     """print the name of the next pushable patch
 
     Returns 0 on success."""
     q = repo.mq
     end = q.seriesend()
     if end == len(q.series):
         ui.write(_(b"all patches applied\n"))
         return 1
     q.qseries(repo, start=end, length=1, summary=opts.get('summary'))
 
 
 @command(
     b"qprev",
     seriesopts,
     _(b'hg qprev [-s]'),
     helpcategory=command.CATEGORY_CHANGE_ORGANIZATION,
 )
 def prev(ui, repo, **opts):
     """print the name of the preceding applied patch
 
     Returns 0 on success."""
     q = repo.mq
     l = len(q.applied)
     if l == 1:
         ui.write(_(b"only one patch applied\n"))
         return 1
     if not l:
         ui.write(_(b"no patches applied\n"))
         return 1
     idx = q.series.index(q.applied[-2].name)
     q.qseries(
         repo, start=idx, length=1, status=b'A', summary=opts.get('summary')
     )
 
 
 def setupheaderopts(ui, opts):
     if not opts.get(b'user') and opts.get(b'currentuser'):
         opts[b'user'] = ui.username()
     if not opts.get(b'date') and opts.get(b'currentdate'):
         opts[b'date'] = b"%d %d" % dateutil.makedate()
 
 
 @command(
     b"qnew",
     [
         (b'e', b'edit', None, _(b'invoke editor on commit messages')),
         (b'f', b'force', None, _(b'import uncommitted changes (DEPRECATED)')),
         (b'g', b'git', None, _(b'use git extended diff format')),
         (b'U', b'currentuser', None, _(b'add "From: <current user>" to patch')),
         (b'u', b'user', b'', _(b'add "From: <USER>" to patch'), _(b'USER')),
         (b'D', b'currentdate', None, _(b'add "Date: <current date>" to patch')),
         (b'd', b'date', b'', _(b'add "Date: <DATE>" to patch'), _(b'DATE')),
     ]
     + cmdutil.walkopts
     + cmdutil.commitopts,
     _(b'hg qnew [-e] [-m TEXT] [-l FILE] PATCH [FILE]...'),
     helpcategory=command.CATEGORY_COMMITTING,
     helpbasic=True,
     inferrepo=True,
 )
 def new(ui, repo, patch, *args, **opts):
     """create a new patch
 
     qnew creates a new patch on top of the currently-applied patch (if
     any). The patch will be initialized with any outstanding changes
     in the working directory. You may also use -I/--include,
     -X/--exclude, and/or a list of files after the patch name to add
     only changes to matching files to the new patch, leaving the rest
     as uncommitted modifications.
 
     -u/--user and -d/--date can be used to set the (given) user and
     date, respectively. -U/--currentuser and -D/--currentdate set user
     to current user and date to current date.
 
     -e/--edit, -m/--message or -l/--logfile set the patch header as
     well as the commit message. If none is specified, the header is
     empty and the commit message is '[mq]: PATCH'.
 
     Use the -g/--git option to keep the patch in the git extended diff
     format. Read the diffs help topic for more information on why this
     is important for preserving permission changes and copy/rename
     information.
 
     Returns 0 on successful creation of a new patch.
     """
     opts = pycompat.byteskwargs(opts)
     msg = cmdutil.logmessage(ui, opts)
     q = repo.mq
     opts[b'msg'] = msg
     setupheaderopts(ui, opts)
     q.new(repo, patch, *args, **pycompat.strkwargs(opts))
     q.savedirty()
     return 0
 
 
 @command(
     b"qrefresh",
     [
         (b'e', b'edit', None, _(b'invoke editor on commit messages')),
         (b'g', b'git', None, _(b'use git extended diff format')),
         (
             b's',
             b'short',
             None,
             _(b'refresh only files already in the patch and specified files'),
         ),
         (
             b'U',
             b'currentuser',
             None,
             _(b'add/update author field in patch with current user'),
         ),
         (
             b'u',
             b'user',
             b'',
             _(b'add/update author field in patch with given user'),
             _(b'USER'),
         ),
         (
             b'D',
             b'currentdate',
             None,
             _(b'add/update date field in patch with current date'),
         ),
         (
             b'd',
             b'date',
             b'',
             _(b'add/update date field in patch with given date'),
             _(b'DATE'),
         ),
     ]
     + cmdutil.walkopts
     + cmdutil.commitopts,
     _(b'hg qrefresh [-I] [-X] [-e] [-m TEXT] [-l FILE] [-s] [FILE]...'),
     helpcategory=command.CATEGORY_COMMITTING,
     helpbasic=True,
     inferrepo=True,
 )
 def refresh(ui, repo, *pats, **opts):
     """update the current patch
 
     If any file patterns are provided, the refreshed patch will
     contain only the modifications that match those patterns; the
     remaining modifications will remain in the working directory.
 
     If -s/--short is specified, files currently included in the patch
     will be refreshed just like matched files and remain in the patch.
 
     If -e/--edit is specified, Mercurial will start your configured editor for
     you to enter a message. In case qrefresh fails, you will find a backup of
     your message in ``.hg/last-message.txt``.
 
     hg add/remove/copy/rename work as usual, though you might want to
     use git-style patches (-g/--git or [diff] git=1) to track copies
     and renames. See the diffs help topic for more information on the
     git diff format.
 
     Returns 0 on success.
     """
     opts = pycompat.byteskwargs(opts)
     q = repo.mq
     message = cmdutil.logmessage(ui, opts)
     setupheaderopts(ui, opts)
     with repo.wlock():
         ret = q.refresh(repo, pats, msg=message, **pycompat.strkwargs(opts))
         q.savedirty()
         return ret
 
 
 @command(
     b"qdiff",
     cmdutil.diffopts + cmdutil.diffopts2 + cmdutil.walkopts,
     _(b'hg qdiff [OPTION]... [FILE]...'),
     helpcategory=command.CATEGORY_FILE_CONTENTS,
     helpbasic=True,
     inferrepo=True,
 )
 def diff(ui, repo, *pats, **opts):
     """diff of the current patch and subsequent modifications
 
     Shows a diff which includes the current patch as well as any
     changes which have been made in the working directory since the
     last refresh (thus showing what the current patch would become
     after a qrefresh).
 
     Use :hg:`diff` if you only want to see the changes made since the
     last qrefresh, or :hg:`export qtip` if you want to see changes
     made by the current patch without including changes made since the
     qrefresh.
 
     Returns 0 on success.
     """
     ui.pager(b'qdiff')
     repo.mq.diff(repo, pats, pycompat.byteskwargs(opts))
     return 0
 
 
 @command(
     b'qfold',
     [
         (b'e', b'edit', None, _(b'invoke editor on commit messages')),
         (b'k', b'keep', None, _(b'keep folded patch files')),
     ]
     + cmdutil.commitopts,
     _(b'hg qfold [-e] [-k] [-m TEXT] [-l FILE] PATCH...'),
     helpcategory=command.CATEGORY_CHANGE_MANAGEMENT,
 )
 def fold(ui, repo, *files, **opts):
     """fold the named patches into the current patch
 
     Patches must not yet be applied. Each patch will be successively
     applied to the current patch in the order given. If all the
     patches apply successfully, the current patch will be refreshed
     with the new cumulative patch, and the folded patches will be
     deleted. With -k/--keep, the folded patch files will not be
     removed afterwards.
 
     The header for each folded patch will be concatenated with the
     current patch header, separated by a line of ``* * *``.
 
     Returns 0 on success."""
     opts = pycompat.byteskwargs(opts)
     q = repo.mq
     if not files:
         raise error.Abort(_(b'qfold requires at least one patch name'))
     if not q.checktoppatch(repo)[0]:
         raise error.Abort(_(b'no patches applied'))
     q.checklocalchanges(repo)
 
     message = cmdutil.logmessage(ui, opts)
 
     parent = q.lookup(b'qtip')
     patches = []
     messages = []
     for f in files:
         p = q.lookup(f)
         if p in patches or p == parent:
             ui.warn(_(b'skipping already folded patch %s\n') % p)
         if q.isapplied(p):
             raise error.Abort(
                 _(b'qfold cannot fold already applied patch %s') % p
             )
         patches.append(p)
 
     for p in patches:
         if not message:
             ph = patchheader(q.join(p), q.plainmode)
             if ph.message:
                 messages.append(ph.message)
         pf = q.join(p)
         (patchsuccess, files, fuzz) = q.patch(repo, pf)
         if not patchsuccess:
             raise error.Abort(_(b'error folding patch %s') % p)
 
     if not message:
         ph = patchheader(q.join(parent), q.plainmode)
         message = ph.message
         for msg in messages:
             if msg:
                 if message:
                     message.append(b'* * *')
                 message.extend(msg)
         message = b'\n'.join(message)
 
     diffopts = q.patchopts(q.diffopts(), *patches)
     with repo.wlock():
         q.refresh(
             repo,
             msg=message,
             git=diffopts.git,
             edit=opts.get(b'edit'),
             editform=b'mq.qfold',
         )
         q.delete(repo, patches, opts)
         q.savedirty()
 
 
 @command(
     b"qgoto",
     [
         (
             b'',
             b'keep-changes',
             None,
             _(b'tolerate non-conflicting local changes'),
         ),
         (b'f', b'force', None, _(b'overwrite any local changes')),
         (b'', b'no-backup', None, _(b'do not save backup copies of files')),
     ],
     _(b'hg qgoto [OPTION]... PATCH'),
     helpcategory=command.CATEGORY_CHANGE_ORGANIZATION,
 )
 def goto(ui, repo, patch, **opts):
     """push or pop patches until named patch is at top of stack
 
     Returns 0 on success."""
     opts = pycompat.byteskwargs(opts)
     opts = fixkeepchangesopts(ui, opts)
     q = repo.mq
     patch = q.lookup(patch)
     nobackup = opts.get(b'no_backup')
     keepchanges = opts.get(b'keep_changes')
     if q.isapplied(patch):
         ret = q.pop(
             repo,
             patch,
             force=opts.get(b'force'),
             nobackup=nobackup,
             keepchanges=keepchanges,
         )
     else:
         ret = q.push(
             repo,
             patch,
             force=opts.get(b'force'),
             nobackup=nobackup,
             keepchanges=keepchanges,
         )
     q.savedirty()
     return ret
 
 
 @command(
     b"qguard",
     [
         (b'l', b'list', None, _(b'list all patches and guards')),
         (b'n', b'none', None, _(b'drop all guards')),
     ],
     _(b'hg qguard [-l] [-n] [PATCH] [-- [+GUARD]... [-GUARD]...]'),
     helpcategory=command.CATEGORY_CHANGE_ORGANIZATION,
 )
 def guard(ui, repo, *args, **opts):
     """set or print guards for a patch
 
     Guards control whether a patch can be pushed. A patch with no
     guards is always pushed. A patch with a positive guard ("+foo") is
     pushed only if the :hg:`qselect` command has activated it. A patch with
     a negative guard ("-foo") is never pushed if the :hg:`qselect` command
     has activated it.
 
     With no arguments, print the currently active guards.
     With arguments, set guards for the named patch.
 
     .. note::
 
        Specifying negative guards now requires '--'.
 
     To set guards on another patch::
 
       hg qguard other.patch -- +2.6.17 -stable
 
     Returns 0 on success.
     """
 
     def status(idx):
         guards = q.seriesguards[idx] or [b'unguarded']
         if q.series[idx] in applied:
             state = b'applied'
         elif q.pushable(idx)[0]:
             state = b'unapplied'
         else:
             state = b'guarded'
         label = b'qguard.patch qguard.%s qseries.%s' % (state, state)
         ui.write(b'%s: ' % ui.label(q.series[idx], label))
 
         for i, guard in enumerate(guards):
             if guard.startswith(b'+'):
                 ui.write(guard, label=b'qguard.positive')
             elif guard.startswith(b'-'):
                 ui.write(guard, label=b'qguard.negative')
             else:
                 ui.write(guard, label=b'qguard.unguarded')
             if i != len(guards) - 1:
                 ui.write(b' ')
         ui.write(b'\n')
 
     q = repo.mq
     applied = {p.name for p in q.applied}
     patch = None
     args = list(args)
     if opts.get('list'):
         if args or opts.get('none'):
             raise error.Abort(
                 _(b'cannot mix -l/--list with options or arguments')
             )
-        for i in pycompat.xrange(len(q.series)):
+        for i in range(len(q.series)):
             status(i)
         return
     if not args or args[0][0:1] in b'-+':
         if not q.applied:
             raise error.Abort(_(b'no patches applied'))
         patch = q.applied[-1].name
     if patch is None and args[0][0:1] not in b'-+':
         patch = args.pop(0)
     if patch is None:
         raise error.Abort(_(b'no patch to work with'))
     if args or opts.get('none'):
         idx = q.findseries(patch)
         if idx is None:
             raise error.Abort(_(b'no patch named %s') % patch)
         q.setguards(idx, args)
         q.savedirty()
     else:
         status(q.series.index(q.lookup(patch)))
 
 
 @command(
     b"qheader",
     [],
     _(b'hg qheader [PATCH]'),
     helpcategory=command.CATEGORY_CHANGE_ORGANIZATION,
 )
 def header(ui, repo, patch=None):
     """print the header of the topmost or specified patch
 
     Returns 0 on success."""
     q = repo.mq
 
     if patch:
         patch = q.lookup(patch)
     else:
         if not q.applied:
             ui.write(_(b'no patches applied\n'))
             return 1
         patch = q.lookup(b'qtip')
     ph = patchheader(q.join(patch), q.plainmode)
 
     ui.write(b'\n'.join(ph.message) + b'\n')
 
 
 def lastsavename(path):
     (directory, base) = os.path.split(path)
     names = os.listdir(directory)
     namere = re.compile(b"%s.([0-9]+)" % base)
     maxindex = None
     maxname = None
     for f in names:
         m = namere.match(f)
         if m:
             index = int(m.group(1))
             if maxindex is None or index > maxindex:
                 maxindex = index
                 maxname = f
     if maxname:
         return (os.path.join(directory, maxname), maxindex)
     return (None, None)
 
 
 def savename(path):
     (last, index) = lastsavename(path)
     if last is None:
         index = 0
     newpath = path + b".%d" % (index + 1)
     return newpath
 
 
 @command(
     b"qpush",
     [
         (
             b'',
             b'keep-changes',
             None,
             _(b'tolerate non-conflicting local changes'),
         ),
         (b'f', b'force', None, _(b'apply on top of local changes')),
         (
             b'e',
             b'exact',
             None,
             _(b'apply the target patch to its recorded parent'),
         ),
         (b'l', b'list', None, _(b'list patch name in commit text')),
         (b'a', b'all', None, _(b'apply all patches')),
         (b'm', b'merge', None, _(b'merge from another queue (DEPRECATED)')),
         (b'n', b'name', b'', _(b'merge queue name (DEPRECATED)'), _(b'NAME')),
         (
             b'',
             b'move',
             None,
             _(b'reorder patch series and apply only the patch'),
         ),
         (b'', b'no-backup', None, _(b'do not save backup copies of files')),
     ],
     _(b'hg qpush [-f] [-l] [-a] [--move] [PATCH | INDEX]'),
     helpcategory=command.CATEGORY_CHANGE_ORGANIZATION,
     helpbasic=True,
 )
 def push(ui, repo, patch=None, **opts):
     """push the next patch onto the stack
 
     By default, abort if the working directory contains uncommitted
     changes. With --keep-changes, abort only if the uncommitted files
     overlap with patched files. With -f/--force, backup and patch over
     uncommitted changes.
 
     Return 0 on success.
     """
     q = repo.mq
     mergeq = None
 
     opts = pycompat.byteskwargs(opts)
     opts = fixkeepchangesopts(ui, opts)
     if opts.get(b'merge'):
         if opts.get(b'name'):
             newpath = repo.vfs.join(opts.get(b'name'))
         else:
             newpath, i = lastsavename(q.path)
         if not newpath:
             ui.warn(_(b"no saved queues found, please use -n\n"))
             return 1
         mergeq = queue(ui, repo.baseui, repo.path, newpath)
         ui.warn(_(b"merging with queue at: %s\n") % mergeq.path)
     ret = q.push(
         repo,
         patch,
         force=opts.get(b'force'),
         list=opts.get(b'list'),
         mergeq=mergeq,
         all=opts.get(b'all'),
         move=opts.get(b'move'),
         exact=opts.get(b'exact'),
         nobackup=opts.get(b'no_backup'),
         keepchanges=opts.get(b'keep_changes'),
     )
     return ret
 
 
 @command(
     b"qpop",
     [
         (b'a', b'all', None, _(b'pop all patches')),
         (b'n', b'name', b'', _(b'queue name to pop (DEPRECATED)'), _(b'NAME')),
         (
             b'',
             b'keep-changes',
             None,
             _(b'tolerate non-conflicting local changes'),
         ),
         (b'f', b'force', None, _(b'forget any local changes to patched files')),
         (b'', b'no-backup', None, _(b'do not save backup copies of files')),
     ],
     _(b'hg qpop [-a] [-f] [PATCH | INDEX]'),
     helpcategory=command.CATEGORY_CHANGE_ORGANIZATION,
     helpbasic=True,
 )
 def pop(ui, repo, patch=None, **opts):
     """pop the current patch off the stack
 
     Without argument, pops off the top of the patch stack. If given a
     patch name, keeps popping off patches until the named patch is at
     the top of the stack.
 
     By default, abort if the working directory contains uncommitted
     changes. With --keep-changes, abort only if the uncommitted files
     overlap with patched files. With -f/--force, backup and discard
     changes made to such files.
 
     Return 0 on success.
     """
     opts = pycompat.byteskwargs(opts)
     opts = fixkeepchangesopts(ui, opts)
     localupdate = True
     if opts.get(b'name'):
         q = queue(ui, repo.baseui, repo.path, repo.vfs.join(opts.get(b'name')))
         ui.warn(_(b'using patch queue: %s\n') % q.path)
         localupdate = False
     else:
         q = repo.mq
     ret = q.pop(
         repo,
         patch,
         force=opts.get(b'force'),
         update=localupdate,
         all=opts.get(b'all'),
         nobackup=opts.get(b'no_backup'),
         keepchanges=opts.get(b'keep_changes'),
     )
     q.savedirty()
     return ret
 
 
 @command(
     b"qrename|qmv",
     [],
     _(b'hg qrename PATCH1 [PATCH2]'),
     helpcategory=command.CATEGORY_CHANGE_ORGANIZATION,
 )
 def rename(ui, repo, patch, name=None, **opts):
     """rename a patch
 
     With one argument, renames the current patch to PATCH1.
     With two arguments, renames PATCH1 to PATCH2.
 
     Returns 0 on success."""
     q = repo.mq
     if not name:
         name = patch
         patch = None
 
     if patch:
         patch = q.lookup(patch)
     else:
         if not q.applied:
             ui.write(_(b'no patches applied\n'))
             return
         patch = q.lookup(b'qtip')
     absdest = q.join(name)
     if os.path.isdir(absdest):
         name = normname(os.path.join(name, os.path.basename(patch)))
         absdest = q.join(name)
     q.checkpatchname(name)
 
     ui.note(_(b'renaming %s to %s\n') % (patch, name))
     i = q.findseries(patch)
     guards = q.guard_re.findall(q.fullseries[i])
     q.fullseries[i] = name + b''.join([b' #' + g for g in guards])
     q.parseseries()
     q.seriesdirty = True
 
     info = q.isapplied(patch)
     if info:
         q.applied[info[0]] = statusentry(info[1], name)
     q.applieddirty = True
 
     destdir = os.path.dirname(absdest)
     if not os.path.isdir(destdir):
         os.makedirs(destdir)
     util.rename(q.join(patch), absdest)
     r = q.qrepo()
     if r and patch in r.dirstate:
         wctx = r[None]
         with r.wlock():
             if r.dirstate.get_entry(patch).added:
                 r.dirstate.set_untracked(patch)
                 r.dirstate.set_tracked(name)
             else:
                 wctx.copy(patch, name)
                 wctx.forget([patch])
 
     q.savedirty()
 
 
 @command(
     b"qrestore",
     [
         (b'd', b'delete', None, _(b'delete save entry')),
         (b'u', b'update', None, _(b'update queue working directory')),
     ],
     _(b'hg qrestore [-d] [-u] REV'),
     helpcategory=command.CATEGORY_CHANGE_ORGANIZATION,
 )
 def restore(ui, repo, rev, **opts):
     """restore the queue state saved by a revision (DEPRECATED)
 
     This command is deprecated, use :hg:`rebase` instead."""
     rev = repo.lookup(rev)
     q = repo.mq
     q.restore(repo, rev, delete=opts.get('delete'), qupdate=opts.get('update'))
     q.savedirty()
     return 0
 
 
 @command(
     b"qsave",
     [
         (b'c', b'copy', None, _(b'copy patch directory')),
         (b'n', b'name', b'', _(b'copy directory name'), _(b'NAME')),
         (b'e', b'empty', None, _(b'clear queue status file')),
         (b'f', b'force', None, _(b'force copy')),
     ]
     + cmdutil.commitopts,
     _(b'hg qsave [-m TEXT] [-l FILE] [-c] [-n NAME] [-e] [-f]'),
     helpcategory=command.CATEGORY_CHANGE_ORGANIZATION,
 )
 def save(ui, repo, **opts):
     """save current queue state (DEPRECATED)
 
     This command is deprecated, use :hg:`rebase` instead."""
     q = repo.mq
     opts = pycompat.byteskwargs(opts)
     message = cmdutil.logmessage(ui, opts)
     ret = q.save(repo, msg=message)
     if ret:
         return ret
     q.savedirty()  # save to .hg/patches before copying
     if opts.get(b'copy'):
         path = q.path
         if opts.get(b'name'):
             newpath = os.path.join(q.basepath, opts.get(b'name'))
             if os.path.exists(newpath):
                 if not os.path.isdir(newpath):
                     raise error.Abort(
                         _(b'destination %s exists and is not a directory')
                         % newpath
                     )
                 if not opts.get(b'force'):
                     raise error.Abort(
                         _(b'destination %s exists, use -f to force') % newpath
                     )
         else:
             newpath = savename(path)
         ui.warn(_(b"copy %s to %s\n") % (path, newpath))
         util.copyfiles(path, newpath)
     if opts.get(b'empty'):
         del q.applied[:]
         q.applieddirty = True
         q.savedirty()
     return 0
 
 
 @command(
     b"qselect",
     [
         (b'n', b'none', None, _(b'disable all guards')),
         (b's', b'series', None, _(b'list all guards in series file')),
         (b'', b'pop', None, _(b'pop to before first guarded applied patch')),
         (b'', b'reapply', None, _(b'pop, then reapply patches')),
     ],
     _(b'hg qselect [OPTION]... [GUARD]...'),
     helpcategory=command.CATEGORY_CHANGE_ORGANIZATION,
 )
 def select(ui, repo, *args, **opts):
     """set or print guarded patches to push
 
     Use the :hg:`qguard` command to set or print guards on patch, then use
     qselect to tell mq which guards to use. A patch will be pushed if
     it has no guards or any positive guards match the currently
     selected guard, but will not be pushed if any negative guards
     match the current guard. For example::
 
         qguard foo.patch -- -stable    (negative guard)
         qguard bar.patch    +stable    (positive guard)
         qselect stable
 
     This activates the "stable" guard. mq will skip foo.patch (because
     it has a negative match) but push bar.patch (because it has a
     positive match).
 
     With no arguments, prints the currently active guards.
     With one argument, sets the active guard.
 
     Use -n/--none to deactivate guards (no other arguments needed).
     When no guards are active, patches with positive guards are
     skipped and patches with negative guards are pushed.
 
     qselect can change the guards on applied patches. It does not pop
     guarded patches by default. Use --pop to pop back to the last
     applied patch that is not guarded. Use --reapply (which implies
     --pop) to push back to the current patch afterwards, but skip
     guarded patches.
 
     Use -s/--series to print a list of all guards in the series file
     (no other arguments needed). Use -v for more information.
 
     Returns 0 on success."""
 
     q = repo.mq
     opts = pycompat.byteskwargs(opts)
     guards = q.active()
     pushable = lambda i: q.pushable(q.applied[i].name)[0]
     if args or opts.get(b'none'):
         old_unapplied = q.unapplied(repo)
-        old_guarded = [
-            i for i in pycompat.xrange(len(q.applied)) if not pushable(i)
-        ]
+        old_guarded = [i for i in range(len(q.applied)) if not pushable(i)]
         q.setactive(args)
         q.savedirty()
         if not args:
             ui.status(_(b'guards deactivated\n'))
         if not opts.get(b'pop') and not opts.get(b'reapply'):
             unapplied = q.unapplied(repo)
-            guarded = [
-                i for i in pycompat.xrange(len(q.applied)) if not pushable(i)
-            ]
+            guarded = [i for i in range(len(q.applied)) if not pushable(i)]
             if len(unapplied) != len(old_unapplied):
                 ui.status(
                     _(
                         b'number of unguarded, unapplied patches has '
                         b'changed from %d to %d\n'
                     )
                     % (len(old_unapplied), len(unapplied))
                 )
             if len(guarded) != len(old_guarded):
                 ui.status(
                     _(
                         b'number of guarded, applied patches has changed '
                         b'from %d to %d\n'
                     )
                     % (len(old_guarded), len(guarded))
                 )
     elif opts.get(b'series'):
         guards = {}
         noguards = 0
         for gs in q.seriesguards:
             if not gs:
                 noguards += 1
             for g in gs:
                 guards.setdefault(g, 0)
                 guards[g] += 1
         if ui.verbose:
             guards[b'NONE'] = noguards
         guards = list(guards.items())
         guards.sort(key=lambda x: x[0][1:])
         if guards:
             ui.note(_(b'guards in series file:\n'))
             for guard, count in guards:
                 ui.note(b'%2d  ' % count)
                 ui.write(guard, b'\n')
         else:
             ui.note(_(b'no guards in series file\n'))
     else:
         if guards:
             ui.note(_(b'active guards:\n'))
             for g in guards:
                 ui.write(g, b'\n')
         else:
             ui.write(_(b'no active guards\n'))
     reapply = opts.get(b'reapply') and q.applied and q.applied[-1].name
     popped = False
     if opts.get(b'pop') or opts.get(b'reapply'):
-        for i in pycompat.xrange(len(q.applied)):
+        for i in range(len(q.applied)):
             if not pushable(i):
                 ui.status(_(b'popping guarded patches\n'))
                 popped = True
                 if i == 0:
                     q.pop(repo, all=True)
                 else:
                     q.pop(repo, q.applied[i - 1].name)
                 break
     if popped:
         try:
             if reapply:
                 ui.status(_(b'reapplying unguarded patches\n'))
                 q.push(repo, reapply)
         finally:
             q.savedirty()
 
 
 @command(
     b"qfinish",
     [(b'a', b'applied', None, _(b'finish all applied changesets'))],
     _(b'hg qfinish [-a] [REV]...'),
     helpcategory=command.CATEGORY_CHANGE_ORGANIZATION,
 )
 def finish(ui, repo, *revrange, **opts):
     """move applied patches into repository history
 
     Finishes the specified revisions (corresponding to applied
     patches) by moving them out of mq control into regular repository
     history.
 
     Accepts a revision range or the -a/--applied option. If --applied
     is specified, all applied mq revisions are removed from mq
     control. Otherwise, the given revisions must be at the base of the
     stack of applied patches.
 
     This can be especially useful if your changes have been applied to
     an upstream repository, or if you are about to push your changes
     to upstream.
 
     Returns 0 on success.
     """
     if not opts.get('applied') and not revrange:
         raise error.Abort(_(b'no revisions specified'))
     elif opts.get('applied'):
         revrange = (b'qbase::qtip',) + revrange
 
     q = repo.mq
     if not q.applied:
         ui.status(_(b'no patches applied\n'))
         return 0
 
     revs = logcmdutil.revrange(repo, revrange)
     if repo[b'.'].rev() in revs and repo[None].files():
         ui.warn(_(b'warning: uncommitted changes in the working directory\n'))
     # queue.finish may changes phases but leave the responsibility to lock the
     # repo to the caller to avoid deadlock with wlock. This command code is
     # responsibility for this locking.
     with repo.lock():
         q.finish(repo, revs)
         q.savedirty()
     return 0
 
 
 @command(
     b"qqueue",
     [
         (b'l', b'list', False, _(b'list all available queues')),
         (b'', b'active', False, _(b'print name of active queue')),
         (b'c', b'create', False, _(b'create new queue')),
         (b'', b'rename', False, _(b'rename active queue')),
         (b'', b'delete', False, _(b'delete reference to queue')),
         (b'', b'purge', False, _(b'delete queue, and remove patch dir')),
     ],
     _(b'[OPTION] [QUEUE]'),
     helpcategory=command.CATEGORY_CHANGE_ORGANIZATION,
 )
 def qqueue(ui, repo, name=None, **opts):
     """manage multiple patch queues
 
     Supports switching between different patch queues, as well as creating
     new patch queues and deleting existing ones.
 
     Omitting a queue name or specifying -l/--list will show you the registered
     queues - by default the "normal" patches queue is registered. The currently
     active queue will be marked with "(active)". Specifying --active will print
     only the name of the active queue.
 
     To create a new queue, use -c/--create. The queue is automatically made
     active, except in the case where there are applied patches from the
     currently active queue in the repository. Then the queue will only be
     created and switching will fail.
 
     To delete an existing queue, use --delete. You cannot delete the currently
     active queue.
 
     Returns 0 on success.
     """
     q = repo.mq
     _defaultqueue = b'patches'
     _allqueues = b'patches.queues'
     _activequeue = b'patches.queue'
 
     def _getcurrent():
         cur = os.path.basename(q.path)
         if cur.startswith(b'patches-'):
             cur = cur[8:]
         return cur
 
     def _noqueues():
         try:
             fh = repo.vfs(_allqueues, b'r')
             fh.close()
         except IOError:
             return True
 
         return False
 
     def _getqueues():
         current = _getcurrent()
 
         try:
             fh = repo.vfs(_allqueues, b'r')
             queues = [queue.strip() for queue in fh if queue.strip()]
             fh.close()
             if current not in queues:
                 queues.append(current)
         except IOError:
             queues = [_defaultqueue]
 
         return sorted(queues)
 
     def _setactive(name):
         if q.applied:
             raise error.Abort(
                 _(
                     b'new queue created, but cannot make active '
                     b'as patches are applied'
                 )
             )
         _setactivenocheck(name)
 
     def _setactivenocheck(name):
         fh = repo.vfs(_activequeue, b'w')
         if name != b'patches':
             fh.write(name)
         fh.close()
 
     def _addqueue(name):
         fh = repo.vfs(_allqueues, b'a')
         fh.write(b'%s\n' % (name,))
         fh.close()
 
     def _queuedir(name):
         if name == b'patches':
             return repo.vfs.join(b'patches')
         else:
             return repo.vfs.join(b'patches-' + name)
 
     def _validname(name):
         for n in name:
             if n in b':\\/.':
                 return False
         return True
 
     def _delete(name):
         if name not in existing:
             raise error.Abort(_(b'cannot delete queue that does not exist'))
 
         current = _getcurrent()
 
         if name == current:
             raise error.Abort(_(b'cannot delete currently active queue'))
 
         fh = repo.vfs(b'patches.queues.new', b'w')
         for queue in existing:
             if queue == name:
                 continue
             fh.write(b'%s\n' % (queue,))
         fh.close()
         repo.vfs.rename(b'patches.queues.new', _allqueues)
 
     opts = pycompat.byteskwargs(opts)
     if not name or opts.get(b'list') or opts.get(b'active'):
         current = _getcurrent()
         if opts.get(b'active'):
             ui.write(b'%s\n' % (current,))
             return
         for queue in _getqueues():
             ui.write(b'%s' % (queue,))
             if queue == current and not ui.quiet:
                 ui.write(_(b' (active)\n'))
             else:
                 ui.write(b'\n')
         return
 
     if not _validname(name):
         raise error.Abort(
             _(b'invalid queue name, may not contain the characters ":\\/."')
         )
 
     with repo.wlock():
         existing = _getqueues()
 
         if opts.get(b'create'):
             if name in existing:
                 raise error.Abort(_(b'queue "%s" already exists') % name)
             if _noqueues():
                 _addqueue(_defaultqueue)
             _addqueue(name)
             _setactive(name)
         elif opts.get(b'rename'):
             current = _getcurrent()
             if name == current:
                 raise error.Abort(
                     _(b'can\'t rename "%s" to its current name') % name
                 )
             if name in existing:
                 raise error.Abort(_(b'queue "%s" already exists') % name)
 
             olddir = _queuedir(current)
             newdir = _queuedir(name)
 
             if os.path.exists(newdir):
                 raise error.Abort(
                     _(b'non-queue directory "%s" already exists') % newdir
                 )
 
             fh = repo.vfs(b'patches.queues.new', b'w')
             for queue in existing:
                 if queue == current:
                     fh.write(b'%s\n' % (name,))
                     if os.path.exists(olddir):
                         util.rename(olddir, newdir)
                 else:
                     fh.write(b'%s\n' % (queue,))
             fh.close()
             repo.vfs.rename(b'patches.queues.new', _allqueues)
             _setactivenocheck(name)
         elif opts.get(b'delete'):
             _delete(name)
         elif opts.get(b'purge'):
             if name in existing:
                 _delete(name)
             qdir = _queuedir(name)
             if os.path.exists(qdir):
                 shutil.rmtree(qdir)
         else:
             if name not in existing:
                 raise error.Abort(_(b'use --create to create a new queue'))
             _setactive(name)
 
 
 def mqphasedefaults(repo, roots):
     """callback used to set mq changeset as secret when no phase data exists"""
     if repo.mq.applied:
         if repo.ui.configbool(b'mq', b'secret'):
             mqphase = phases.secret
         else:
             mqphase = phases.draft
         qbase = repo[repo.mq.applied[0].node]
         roots[mqphase].add(qbase.node())
     return roots
 
 
 def reposetup(ui, repo):
     class mqrepo(repo.__class__):
         @localrepo.unfilteredpropertycache
         def mq(self):
             return queue(self.ui, self.baseui, self.path)
 
         def invalidateall(self):
             super(mqrepo, self).invalidateall()
             if localrepo.hasunfilteredcache(self, 'mq'):
                 # recreate mq in case queue path was changed
                 delattr(self.unfiltered(), 'mq')
 
         def abortifwdirpatched(self, errmsg, force=False):
             if self.mq.applied and self.mq.checkapplied and not force:
                 parents = self.dirstate.parents()
                 patches = [s.node for s in self.mq.applied]
                 if any(p in patches for p in parents):
                     raise error.Abort(errmsg)
 
         def commit(
             self,
             text=b"",
             user=None,
             date=None,
             match=None,
             force=False,
             editor=False,
             extra=None,
         ):
             if extra is None:
                 extra = {}
             self.abortifwdirpatched(
                 _(b'cannot commit over an applied mq patch'), force
             )
 
             return super(mqrepo, self).commit(
                 text, user, date, match, force, editor, extra
             )
 
         def checkpush(self, pushop):
             if self.mq.applied and self.mq.checkapplied and not pushop.force:
                 outapplied = [e.node for e in self.mq.applied]
                 if pushop.revs:
                     # Assume applied patches have no non-patch descendants and
                     # are not on remote already. Filtering any changeset not
                     # pushed.
                     heads = set(pushop.revs)
                     for node in reversed(outapplied):
                         if node in heads:
                             break
                         else:
                             outapplied.pop()
                 # looking for pushed and shared changeset
                 for node in outapplied:
                     if self[node].phase() < phases.secret:
                         raise error.Abort(_(b'source has mq patches applied'))
                 # no non-secret patches pushed
             super(mqrepo, self).checkpush(pushop)
 
         def _findtags(self):
             '''augment tags from base class with patch tags'''
             result = super(mqrepo, self)._findtags()
 
             q = self.mq
             if not q.applied:
                 return result
 
             mqtags = [(patch.node, patch.name) for patch in q.applied]
 
             try:
                 # for now ignore filtering business
                 self.unfiltered().changelog.rev(mqtags[-1][0])
             except error.LookupError:
                 self.ui.warn(
                     _(b'mq status file refers to unknown node %s\n')
                     % short(mqtags[-1][0])
                 )
                 return result
 
             # do not add fake tags for filtered revisions
             included = self.changelog.hasnode
             mqtags = [mqt for mqt in mqtags if included(mqt[0])]
             if not mqtags:
                 return result
 
             mqtags.append((mqtags[-1][0], b'qtip'))
             mqtags.append((mqtags[0][0], b'qbase'))
             mqtags.append((self.changelog.parents(mqtags[0][0])[0], b'qparent'))
             tags = result[0]
             for patch in mqtags:
                 if patch[1] in tags:
                     self.ui.warn(
                         _(b'tag %s overrides mq patch of the same name\n')
                         % patch[1]
                     )
                 else:
                     tags[patch[1]] = patch[0]
 
             return result
 
     if repo.local():
         repo.__class__ = mqrepo
 
         repo._phasedefaults.append(mqphasedefaults)
 
 
 def mqimport(orig, ui, repo, *args, **kwargs):
     if util.safehasattr(repo, b'abortifwdirpatched') and not kwargs.get(
         'no_commit', False
     ):
         repo.abortifwdirpatched(
             _(b'cannot import over an applied patch'), kwargs.get('force')
         )
     return orig(ui, repo, *args, **kwargs)
 
 
 def mqinit(orig, ui, *args, **kwargs):
     mq = kwargs.pop('mq', None)
 
     if not mq:
         return orig(ui, *args, **kwargs)
 
     if args:
         repopath = args[0]
         if not hg.islocal(repopath):
             raise error.Abort(
                 _(b'only a local queue repository may be initialized')
             )
     else:
         repopath = cmdutil.findrepo(encoding.getcwd())
         if not repopath:
             raise error.Abort(
                 _(b'there is no Mercurial repository here (.hg not found)')
             )
     repo = hg.repository(ui, repopath)
     return qinit(ui, repo, True)
 
 
 def mqcommand(orig, ui, repo, *args, **kwargs):
     """Add --mq option to operate on patch repository instead of main"""
 
     # some commands do not like getting unknown options
     mq = kwargs.pop('mq', None)
 
     if not mq:
         return orig(ui, repo, *args, **kwargs)
 
     q = repo.mq
     r = q.qrepo()
     if not r:
         raise error.Abort(_(b'no queue repository'))
     return orig(r.ui, r, *args, **kwargs)
 
 
 def summaryhook(ui, repo):
     q = repo.mq
     m = []
     a, u = len(q.applied), len(q.unapplied(repo))
     if a:
         m.append(ui.label(_(b"%d applied"), b'qseries.applied') % a)
     if u:
         m.append(ui.label(_(b"%d unapplied"), b'qseries.unapplied') % u)
     if m:
         # i18n: column positioning for "hg summary"
         ui.write(_(b"mq:     %s\n") % b', '.join(m))
     else:
         # i18n: column positioning for "hg summary"
         ui.note(_(b"mq:     (empty queue)\n"))
 
 
 revsetpredicate = registrar.revsetpredicate()
 
 
 @revsetpredicate(b'mq()')
 def revsetmq(repo, subset, x):
     """Changesets managed by MQ."""
     revsetlang.getargs(x, 0, 0, _(b"mq takes no arguments"))
     applied = {repo[r.node].rev() for r in repo.mq.applied}
     return smartset.baseset([r for r in subset if r in applied])
 
 
 # tell hggettext to extract docstrings from these functions:
 i18nfunctions = [revsetmq]
 
 
 def extsetup(ui):
     # Ensure mq wrappers are called first, regardless of extension load order by
     # NOT wrapping in uisetup() and instead deferring to init stage two here.
     mqopt = [(b'', b'mq', None, _(b"operate on patch repository"))]
 
     extensions.wrapcommand(commands.table, b'import', mqimport)
     cmdutil.summaryhooks.add(b'mq', summaryhook)
 
     entry = extensions.wrapcommand(commands.table, b'init', mqinit)
     entry[1].extend(mqopt)
 
     def dotable(cmdtable):
         for cmd, entry in cmdtable.items():
             cmd = cmdutil.parsealiases(cmd)[0]
             func = entry[0]
             if func.norepo:
                 continue
             entry = extensions.wrapcommand(cmdtable, cmd, mqcommand)
             entry[1].extend(mqopt)
 
     dotable(commands.table)
 
     thismodule = sys.modules["hgext.mq"]
     for extname, extmodule in extensions.extensions():
         if extmodule != thismodule:
             dotable(getattr(extmodule, 'cmdtable', {}))
 
 
 colortable = {
     b'qguard.negative': b'red',
     b'qguard.positive': b'yellow',
     b'qguard.unguarded': b'green',
     b'qseries.applied': b'blue bold underline',
     b'qseries.guarded': b'black bold',
     b'qseries.missing': b'red bold',
     b'qseries.unapplied': b'black bold',
 }

hgext/remotefilelog/basepack.py

@@ -1,559 +1,559 b''
 import collections
 import errno
 import mmap
 import os
 import struct
 import time
 
 from mercurial.i18n import _
 from mercurial.pycompat import (
     getattr,
     open,
 )
 from mercurial.node import hex
 from mercurial import (
     policy,
     pycompat,
     util,
     vfs as vfsmod,
 )
 from mercurial.utils import hashutil
 from . import shallowutil
 
 osutil = policy.importmod('osutil')
 
 # The pack version supported by this implementation. This will need to be
 # rev'd whenever the byte format changes. Ex: changing the fanout prefix,
 # changing any of the int sizes, changing the delta algorithm, etc.
 PACKVERSIONSIZE = 1
 INDEXVERSIONSIZE = 2
 
 FANOUTSTART = INDEXVERSIONSIZE
 
 # Constant that indicates a fanout table entry hasn't been filled in. (This does
 # not get serialized)
 EMPTYFANOUT = -1
 
 # The fanout prefix is the number of bytes that can be addressed by the fanout
 # table. Example: a fanout prefix of 1 means we use the first byte of a hash to
 # look in the fanout table (which will be 2^8 entries long).
 SMALLFANOUTPREFIX = 1
 LARGEFANOUTPREFIX = 2
 
 # The number of entries in the index at which point we switch to a large fanout.
 # It is chosen to balance the linear scan through a sparse fanout, with the
 # size of the bisect in actual index.
 # 2^16 / 8 was chosen because it trades off (1 step fanout scan + 5 step
 # bisect) with (8 step fanout scan + 1 step bisect)
 # 5 step bisect = log(2^16 / 8 / 255)  # fanout
 # 10 step fanout scan = 2^16 / (2^16 / 8)  # fanout space divided by entries
 SMALLFANOUTCUTOFF = 2 ** 16 // 8
 
 # The amount of time to wait between checking for new packs. This prevents an
 # exception when data is moved to a new pack after the process has already
 # loaded the pack list.
 REFRESHRATE = 0.1
 
 if pycompat.isposix and not pycompat.ispy3:
     # With glibc 2.7+ the 'e' flag uses O_CLOEXEC when opening.
     # The 'e' flag will be ignored on older versions of glibc.
     # Python 3 can't handle the 'e' flag.
     PACKOPENMODE = b'rbe'
 else:
     PACKOPENMODE = b'rb'
 
 
 class _cachebackedpacks:
     def __init__(self, packs, cachesize):
         self._packs = set(packs)
         self._lrucache = util.lrucachedict(cachesize)
         self._lastpack = None
 
         # Avoid cold start of the cache by populating the most recent packs
         # in the cache.
         for i in reversed(range(min(cachesize, len(packs)))):
             self._movetofront(packs[i])
 
     def _movetofront(self, pack):
         # This effectively makes pack the first entry in the cache.
         self._lrucache[pack] = True
 
     def _registerlastpackusage(self):
         if self._lastpack is not None:
             self._movetofront(self._lastpack)
             self._lastpack = None
 
     def add(self, pack):
         self._registerlastpackusage()
 
         # This method will mostly be called when packs are not in cache.
         # Therefore, adding pack to the cache.
         self._movetofront(pack)
         self._packs.add(pack)
 
     def __iter__(self):
         self._registerlastpackusage()
 
         # Cache iteration is based on LRU.
         for pack in self._lrucache:
             self._lastpack = pack
             yield pack
 
         cachedpacks = {pack for pack in self._lrucache}
         # Yield for paths not in the cache.
         for pack in self._packs - cachedpacks:
             self._lastpack = pack
             yield pack
 
         # Data not found in any pack.
         self._lastpack = None
 
 
 class basepackstore:
     # Default cache size limit for the pack files.
     DEFAULTCACHESIZE = 100
 
     def __init__(self, ui, path):
         self.ui = ui
         self.path = path
 
         # lastrefesh is 0 so we'll immediately check for new packs on the first
         # failure.
         self.lastrefresh = 0
 
         packs = []
         for filepath, __, __ in self._getavailablepackfilessorted():
             try:
                 pack = self.getpack(filepath)
             except Exception as ex:
                 # An exception may be thrown if the pack file is corrupted
                 # somehow.  Log a warning but keep going in this case, just
                 # skipping this pack file.
                 #
                 # If this is an ENOENT error then don't even bother logging.
                 # Someone could have removed the file since we retrieved the
                 # list of paths.
                 if getattr(ex, 'errno', None) != errno.ENOENT:
                     ui.warn(_(b'unable to load pack %s: %s\n') % (filepath, ex))
                 continue
             packs.append(pack)
 
         self.packs = _cachebackedpacks(packs, self.DEFAULTCACHESIZE)
 
     def _getavailablepackfiles(self):
         """For each pack file (a index/data file combo), yields:
           (full path without extension, mtime, size)
 
         mtime will be the mtime of the index/data file (whichever is newer)
         size is the combined size of index/data file
         """
         indexsuffixlen = len(self.INDEXSUFFIX)
         packsuffixlen = len(self.PACKSUFFIX)
 
         ids = set()
         sizes = collections.defaultdict(lambda: 0)
         mtimes = collections.defaultdict(lambda: [])
         try:
             for filename, type, stat in osutil.listdir(self.path, stat=True):
                 id = None
                 if filename[-indexsuffixlen:] == self.INDEXSUFFIX:
                     id = filename[:-indexsuffixlen]
                 elif filename[-packsuffixlen:] == self.PACKSUFFIX:
                     id = filename[:-packsuffixlen]
 
                 # Since we expect to have two files corresponding to each ID
                 # (the index file and the pack file), we can yield once we see
                 # it twice.
                 if id:
                     sizes[id] += stat.st_size  # Sum both files' sizes together
                     mtimes[id].append(stat.st_mtime)
                     if id in ids:
                         yield (
                             os.path.join(self.path, id),
                             max(mtimes[id]),
                             sizes[id],
                         )
                     else:
                         ids.add(id)
         except OSError as ex:
             if ex.errno != errno.ENOENT:
                 raise
 
     def _getavailablepackfilessorted(self):
         """Like `_getavailablepackfiles`, but also sorts the files by mtime,
         yielding newest files first.
 
         This is desirable, since it is more likely newer packfiles have more
         desirable data.
         """
         files = []
         for path, mtime, size in self._getavailablepackfiles():
             files.append((mtime, size, path))
         files = sorted(files, reverse=True)
         for mtime, size, path in files:
             yield path, mtime, size
 
     def gettotalsizeandcount(self):
         """Returns the total disk size (in bytes) of all the pack files in
         this store, and the count of pack files.
 
         (This might be smaller than the total size of the ``self.path``
         directory, since this only considers fuly-writen pack files, and not
         temporary files or other detritus on the directory.)
         """
         totalsize = 0
         count = 0
         for __, __, size in self._getavailablepackfiles():
             totalsize += size
             count += 1
         return totalsize, count
 
     def getmetrics(self):
         """Returns metrics on the state of this store."""
         size, count = self.gettotalsizeandcount()
         return {
             b'numpacks': count,
             b'totalpacksize': size,
         }
 
     def getpack(self, path):
         raise NotImplementedError()
 
     def getmissing(self, keys):
         missing = keys
         for pack in self.packs:
             missing = pack.getmissing(missing)
 
             # Ensures better performance of the cache by keeping the most
             # recently accessed pack at the beginning in subsequent iterations.
             if not missing:
                 return missing
 
         if missing:
             for pack in self.refresh():
                 missing = pack.getmissing(missing)
 
         return missing
 
     def markledger(self, ledger, options=None):
         for pack in self.packs:
             pack.markledger(ledger)
 
     def markforrefresh(self):
         """Tells the store that there may be new pack files, so the next time it
         has a lookup miss it should check for new files."""
         self.lastrefresh = 0
 
     def refresh(self):
         """Checks for any new packs on disk, adds them to the main pack list,
         and returns a list of just the new packs."""
         now = time.time()
 
         # If we experience a lot of misses (like in the case of getmissing() on
         # new objects), let's only actually check disk for new stuff every once
         # in a while. Generally this code path should only ever matter when a
         # repack is going on in the background, and that should be pretty rare
         # to have that happen twice in quick succession.
         newpacks = []
         if now > self.lastrefresh + REFRESHRATE:
             self.lastrefresh = now
             previous = {p.path for p in self.packs}
             for filepath, __, __ in self._getavailablepackfilessorted():
                 if filepath not in previous:
                     newpack = self.getpack(filepath)
                     newpacks.append(newpack)
                     self.packs.add(newpack)
 
         return newpacks
 
 
 class versionmixin:
     # Mix-in for classes with multiple supported versions
     VERSION = None
     SUPPORTED_VERSIONS = [2]
 
     def _checkversion(self, version):
         if version in self.SUPPORTED_VERSIONS:
             if self.VERSION is None:
                 # only affect this instance
                 self.VERSION = version
             elif self.VERSION != version:
                 raise RuntimeError(b'inconsistent version: %d' % version)
         else:
             raise RuntimeError(b'unsupported version: %d' % version)
 
 
 class basepack(versionmixin):
     # The maximum amount we should read via mmap before remmaping so the old
     # pages can be released (100MB)
     MAXPAGEDIN = 100 * 1024 ** 2
 
     SUPPORTED_VERSIONS = [2]
 
     def __init__(self, path):
         self.path = path
         self.packpath = path + self.PACKSUFFIX
         self.indexpath = path + self.INDEXSUFFIX
 
         self.indexsize = os.stat(self.indexpath).st_size
         self.datasize = os.stat(self.packpath).st_size
 
         self._index = None
         self._data = None
         self.freememory()  # initialize the mmap
 
         version = struct.unpack(b'!B', self._data[:PACKVERSIONSIZE])[0]
         self._checkversion(version)
 
         version, config = struct.unpack(b'!BB', self._index[:INDEXVERSIONSIZE])
         self._checkversion(version)
 
         if 0b10000000 & config:
             self.params = indexparams(LARGEFANOUTPREFIX, version)
         else:
             self.params = indexparams(SMALLFANOUTPREFIX, version)
 
     @util.propertycache
     def _fanouttable(self):
         params = self.params
         rawfanout = self._index[FANOUTSTART : FANOUTSTART + params.fanoutsize]
         fanouttable = []
-        for i in pycompat.xrange(0, params.fanoutcount):
+        for i in range(0, params.fanoutcount):
             loc = i * 4
             fanoutentry = struct.unpack(b'!I', rawfanout[loc : loc + 4])[0]
             fanouttable.append(fanoutentry)
         return fanouttable
 
     @util.propertycache
     def _indexend(self):
         nodecount = struct.unpack_from(
             b'!Q', self._index, self.params.indexstart - 8
         )[0]
         return self.params.indexstart + nodecount * self.INDEXENTRYLENGTH
 
     def freememory(self):
         """Unmap and remap the memory to free it up after known expensive
         operations. Return True if self._data and self._index were reloaded.
         """
         if self._index:
             if self._pagedin < self.MAXPAGEDIN:
                 return False
 
             self._index.close()
             self._data.close()
 
         # TODO: use an opener/vfs to access these paths
         with open(self.indexpath, PACKOPENMODE) as indexfp:
             # memory-map the file, size 0 means whole file
             self._index = mmap.mmap(
                 indexfp.fileno(), 0, access=mmap.ACCESS_READ
             )
         with open(self.packpath, PACKOPENMODE) as datafp:
             self._data = mmap.mmap(datafp.fileno(), 0, access=mmap.ACCESS_READ)
 
         self._pagedin = 0
         return True
 
     def getmissing(self, keys):
         raise NotImplementedError()
 
     def markledger(self, ledger, options=None):
         raise NotImplementedError()
 
     def cleanup(self, ledger):
         raise NotImplementedError()
 
     def __iter__(self):
         raise NotImplementedError()
 
     def iterentries(self):
         raise NotImplementedError()
 
 
 class mutablebasepack(versionmixin):
     def __init__(self, ui, packdir, version=2):
         self._checkversion(version)
         # TODO(augie): make this configurable
         self._compressor = b'GZ'
         opener = vfsmod.vfs(packdir)
         opener.createmode = 0o444
         self.opener = opener
 
         self.entries = {}
 
         shallowutil.mkstickygroupdir(ui, packdir)
         self.packfp, self.packpath = opener.mkstemp(
             suffix=self.PACKSUFFIX + b'-tmp'
         )
         self.idxfp, self.idxpath = opener.mkstemp(
             suffix=self.INDEXSUFFIX + b'-tmp'
         )
         self.packfp = os.fdopen(self.packfp, 'wb+')
         self.idxfp = os.fdopen(self.idxfp, 'wb+')
         self.sha = hashutil.sha1()
         self._closed = False
 
         # The opener provides no way of doing permission fixup on files created
         # via mkstemp, so we must fix it ourselves. We can probably fix this
         # upstream in vfs.mkstemp so we don't need to use the private method.
         opener._fixfilemode(opener.join(self.packpath))
         opener._fixfilemode(opener.join(self.idxpath))
 
         # Write header
         # TODO: make it extensible (ex: allow specifying compression algorithm,
         # a flexible key/value header, delta algorithm, fanout size, etc)
         versionbuf = struct.pack(b'!B', self.VERSION)  # unsigned 1 byte int
         self.writeraw(versionbuf)
 
     def __enter__(self):
         return self
 
     def __exit__(self, exc_type, exc_value, traceback):
         if exc_type is None:
             self.close()
         else:
             self.abort()
 
     def abort(self):
         # Unclean exit
         self._cleantemppacks()
 
     def writeraw(self, data):
         self.packfp.write(data)
         self.sha.update(data)
 
     def close(self, ledger=None):
         if self._closed:
             return
 
         try:
             sha = hex(self.sha.digest())
             self.packfp.close()
             self.writeindex()
 
             if len(self.entries) == 0:
                 # Empty pack
                 self._cleantemppacks()
                 self._closed = True
                 return None
 
             self.opener.rename(self.packpath, sha + self.PACKSUFFIX)
             try:
                 self.opener.rename(self.idxpath, sha + self.INDEXSUFFIX)
             except Exception as ex:
                 try:
                     self.opener.unlink(sha + self.PACKSUFFIX)
                 except Exception:
                     pass
                 # Throw exception 'ex' explicitly since a normal 'raise' would
                 # potentially throw an exception from the unlink cleanup.
                 raise ex
         except Exception:
             # Clean up temp packs in all exception cases
             self._cleantemppacks()
             raise
 
         self._closed = True
         result = self.opener.join(sha)
         if ledger:
             ledger.addcreated(result)
         return result
 
     def _cleantemppacks(self):
         try:
             self.opener.unlink(self.packpath)
         except Exception:
             pass
         try:
             self.opener.unlink(self.idxpath)
         except Exception:
             pass
 
     def writeindex(self):
         largefanout = len(self.entries) > SMALLFANOUTCUTOFF
         if largefanout:
             params = indexparams(LARGEFANOUTPREFIX, self.VERSION)
         else:
             params = indexparams(SMALLFANOUTPREFIX, self.VERSION)
 
         fanouttable = [EMPTYFANOUT] * params.fanoutcount
 
         # Precompute the location of each entry
         locations = {}
         count = 0
         for node in sorted(self.entries):
             location = count * self.INDEXENTRYLENGTH
             locations[node] = location
             count += 1
 
             # Must use [0] on the unpack result since it's always a tuple.
             fanoutkey = struct.unpack(
                 params.fanoutstruct, node[: params.fanoutprefix]
             )[0]
             if fanouttable[fanoutkey] == EMPTYFANOUT:
                 fanouttable[fanoutkey] = location
 
         rawfanouttable = b''
         last = 0
         for offset in fanouttable:
             offset = offset if offset != EMPTYFANOUT else last
             last = offset
             rawfanouttable += struct.pack(b'!I', offset)
 
         rawentrieslength = struct.pack(b'!Q', len(self.entries))
 
         # The index offset is the it's location in the file. So after the 2 byte
         # header and the fanouttable.
         rawindex = self.createindex(locations, 2 + len(rawfanouttable))
 
         self._writeheader(params)
         self.idxfp.write(rawfanouttable)
         self.idxfp.write(rawentrieslength)
         self.idxfp.write(rawindex)
         self.idxfp.close()
 
     def createindex(self, nodelocations):
         raise NotImplementedError()
 
     def _writeheader(self, indexparams):
         # Index header
         #    <version: 1 byte>
         #    <large fanout: 1 bit> # 1 means 2^16, 0 means 2^8
         #    <unused: 7 bit> # future use (compression, delta format, etc)
         config = 0
         if indexparams.fanoutprefix == LARGEFANOUTPREFIX:
             config = 0b10000000
         self.idxfp.write(struct.pack(b'!BB', self.VERSION, config))
 
 
 class indexparams:
     __slots__ = (
         'fanoutprefix',
         'fanoutstruct',
         'fanoutcount',
         'fanoutsize',
         'indexstart',
     )
 
     def __init__(self, prefixsize, version):
         self.fanoutprefix = prefixsize
 
         # The struct pack format for fanout table location (i.e. the format that
         # converts the node prefix into an integer location in the fanout
         # table).
         if prefixsize == SMALLFANOUTPREFIX:
             self.fanoutstruct = b'!B'
         elif prefixsize == LARGEFANOUTPREFIX:
             self.fanoutstruct = b'!H'
         else:
             raise ValueError(b"invalid fanout prefix size: %s" % prefixsize)
 
         # The number of fanout table entries
         self.fanoutcount = 2 ** (prefixsize * 8)
 
         # The total bytes used by the fanout table
         self.fanoutsize = self.fanoutcount * 4
 
         self.indexstart = FANOUTSTART + self.fanoutsize
         # Skip the index length
         self.indexstart += 8

hgext/remotefilelog/basestore.py

@@ -1,459 +1,459 b''
 import errno
 import os
 import shutil
 import stat
 import time
 
 from mercurial.i18n import _
 from mercurial.node import bin, hex
 from mercurial.pycompat import open
 from mercurial import (
     error,
     pycompat,
     util,
 )
 from mercurial.utils import hashutil
 from . import (
     constants,
     shallowutil,
 )
 
 
 class basestore:
     def __init__(self, repo, path, reponame, shared=False):
         """Creates a remotefilelog store object for the given repo name.
 
         `path` - The file path where this store keeps its data
         `reponame` - The name of the repo. This is used to partition data from
         many repos.
         `shared` - True if this store is a shared cache of data from the central
         server, for many repos on this machine. False means this store is for
         the local data for one repo.
         """
         self.repo = repo
         self.ui = repo.ui
         self._path = path
         self._reponame = reponame
         self._shared = shared
         self._uid = os.getuid() if not pycompat.iswindows else None
 
         self._validatecachelog = self.ui.config(
             b"remotefilelog", b"validatecachelog"
         )
         self._validatecache = self.ui.config(
             b"remotefilelog", b"validatecache", b'on'
         )
         if self._validatecache not in (b'on', b'strict', b'off'):
             self._validatecache = b'on'
         if self._validatecache == b'off':
             self._validatecache = False
 
         if shared:
             shallowutil.mkstickygroupdir(self.ui, path)
 
     def getmissing(self, keys):
         missing = []
         for name, node in keys:
             filepath = self._getfilepath(name, node)
             exists = os.path.exists(filepath)
             if (
                 exists
                 and self._validatecache == b'strict'
                 and not self._validatekey(filepath, b'contains')
             ):
                 exists = False
             if not exists:
                 missing.append((name, node))
 
         return missing
 
     # BELOW THIS ARE IMPLEMENTATIONS OF REPACK SOURCE
 
     def markledger(self, ledger, options=None):
         if options and options.get(constants.OPTION_PACKSONLY):
             return
         if self._shared:
             for filename, nodes in self._getfiles():
                 for node in nodes:
                     ledger.markdataentry(self, filename, node)
                     ledger.markhistoryentry(self, filename, node)
 
     def cleanup(self, ledger):
         ui = self.ui
         entries = ledger.sources.get(self, [])
         count = 0
         progress = ui.makeprogress(
             _(b"cleaning up"), unit=b"files", total=len(entries)
         )
         for entry in entries:
             if entry.gced or (entry.datarepacked and entry.historyrepacked):
                 progress.update(count)
                 path = self._getfilepath(entry.filename, entry.node)
                 util.tryunlink(path)
             count += 1
         progress.complete()
 
         # Clean up the repo cache directory.
         self._cleanupdirectory(self._getrepocachepath())
 
     # BELOW THIS ARE NON-STANDARD APIS
 
     def _cleanupdirectory(self, rootdir):
         """Removes the empty directories and unnecessary files within the root
         directory recursively. Note that this method does not remove the root
         directory itself."""
 
         oldfiles = set()
         otherfiles = set()
         # osutil.listdir returns stat information which saves some rmdir/listdir
         # syscalls.
         for name, mode in util.osutil.listdir(rootdir):
             if stat.S_ISDIR(mode):
                 dirpath = os.path.join(rootdir, name)
                 self._cleanupdirectory(dirpath)
 
                 # Now that the directory specified by dirpath is potentially
                 # empty, try and remove it.
                 try:
                     os.rmdir(dirpath)
                 except OSError:
                     pass
 
             elif stat.S_ISREG(mode):
                 if name.endswith(b'_old'):
                     oldfiles.add(name[:-4])
                 else:
                     otherfiles.add(name)
 
         # Remove the files which end with suffix '_old' and have no
         # corresponding file without the suffix '_old'. See addremotefilelognode
         # method for the generation/purpose of files with '_old' suffix.
         for filename in oldfiles - otherfiles:
             filepath = os.path.join(rootdir, filename + b'_old')
             util.tryunlink(filepath)
 
     def _getfiles(self):
         """Return a list of (filename, [node,...]) for all the revisions that
         exist in the store.
 
         This is useful for obtaining a list of all the contents of the store
         when performing a repack to another store, since the store API requires
         name+node keys and not namehash+node keys.
         """
         existing = {}
         for filenamehash, node in self._listkeys():
             existing.setdefault(filenamehash, []).append(node)
 
         filenamemap = self._resolvefilenames(existing.keys())
 
         for filename, sha in filenamemap.items():
             yield (filename, existing[sha])
 
     def _resolvefilenames(self, hashes):
         """Given a list of filename hashes that are present in the
         remotefilelog store, return a mapping from filename->hash.
 
         This is useful when converting remotefilelog blobs into other storage
         formats.
         """
         if not hashes:
             return {}
 
         filenames = {}
         missingfilename = set(hashes)
 
         # Start with a full manifest, since it'll cover the majority of files
         for filename in self.repo[b'tip'].manifest():
             sha = hashutil.sha1(filename).digest()
             if sha in missingfilename:
                 filenames[filename] = sha
                 missingfilename.discard(sha)
 
         # Scan the changelog until we've found every file name
         cl = self.repo.unfiltered().changelog
-        for rev in pycompat.xrange(len(cl) - 1, -1, -1):
+        for rev in range(len(cl) - 1, -1, -1):
             if not missingfilename:
                 break
             files = cl.readfiles(cl.node(rev))
             for filename in files:
                 sha = hashutil.sha1(filename).digest()
                 if sha in missingfilename:
                     filenames[filename] = sha
                     missingfilename.discard(sha)
 
         return filenames
 
     def _getrepocachepath(self):
         return (
             os.path.join(self._path, self._reponame)
             if self._shared
             else self._path
         )
 
     def _listkeys(self):
         """List all the remotefilelog keys that exist in the store.
 
         Returns a iterator of (filename hash, filecontent hash) tuples.
         """
 
         for root, dirs, files in os.walk(self._getrepocachepath()):
             for filename in files:
                 if len(filename) != 40:
                     continue
                 node = filename
                 if self._shared:
                     # .../1a/85ffda..be21
                     filenamehash = root[-41:-39] + root[-38:]
                 else:
                     filenamehash = root[-40:]
                 yield (bin(filenamehash), bin(node))
 
     def _getfilepath(self, name, node):
         node = hex(node)
         if self._shared:
             key = shallowutil.getcachekey(self._reponame, name, node)
         else:
             key = shallowutil.getlocalkey(name, node)
 
         return os.path.join(self._path, key)
 
     def _getdata(self, name, node):
         filepath = self._getfilepath(name, node)
         try:
             data = shallowutil.readfile(filepath)
             if self._validatecache and not self._validatedata(data, filepath):
                 if self._validatecachelog:
                     with open(self._validatecachelog, b'ab+') as f:
                         f.write(b"corrupt %s during read\n" % filepath)
                 os.rename(filepath, filepath + b".corrupt")
                 raise KeyError(b"corrupt local cache file %s" % filepath)
         except IOError:
             raise KeyError(
                 b"no file found at %s for %s:%s" % (filepath, name, hex(node))
             )
 
         return data
 
     def addremotefilelognode(self, name, node, data):
         filepath = self._getfilepath(name, node)
 
         oldumask = os.umask(0o002)
         try:
             # if this node already exists, save the old version for
             # recovery/debugging purposes.
             if os.path.exists(filepath):
                 newfilename = filepath + b'_old'
                 # newfilename can be read-only and shutil.copy will fail.
                 # Delete newfilename to avoid it
                 if os.path.exists(newfilename):
                     shallowutil.unlinkfile(newfilename)
                 shutil.copy(filepath, newfilename)
 
             shallowutil.mkstickygroupdir(self.ui, os.path.dirname(filepath))
             shallowutil.writefile(filepath, data, readonly=True)
 
             if self._validatecache:
                 if not self._validatekey(filepath, b'write'):
                     raise error.Abort(
                         _(b"local cache write was corrupted %s") % filepath
                     )
         finally:
             os.umask(oldumask)
 
     def markrepo(self, path):
         """Call this to add the given repo path to the store's list of
         repositories that are using it. This is useful later when doing garbage
         collection, since it allows us to insecpt the repos to see what nodes
         they want to be kept alive in the store.
         """
         repospath = os.path.join(self._path, b"repos")
         with open(repospath, b'ab') as reposfile:
             reposfile.write(os.path.dirname(path) + b"\n")
 
         repospathstat = os.stat(repospath)
         if repospathstat.st_uid == self._uid:
             os.chmod(repospath, 0o0664)
 
     def _validatekey(self, path, action):
         with open(path, b'rb') as f:
             data = f.read()
 
         if self._validatedata(data, path):
             return True
 
         if self._validatecachelog:
             with open(self._validatecachelog, b'ab+') as f:
                 f.write(b"corrupt %s during %s\n" % (path, action))
 
         os.rename(path, path + b".corrupt")
         return False
 
     def _validatedata(self, data, path):
         try:
             if len(data) > 0:
                 # see remotefilelogserver.createfileblob for the format
                 offset, size, flags = shallowutil.parsesizeflags(data)
                 if len(data) <= size:
                     # it is truncated
                     return False
 
                 # extract the node from the metadata
                 offset += size
                 datanode = data[offset : offset + 20]
 
                 # and compare against the path
                 if os.path.basename(path) == hex(datanode):
                     # Content matches the intended path
                     return True
                 return False
         except (ValueError, shallowutil.BadRemotefilelogHeader):
             pass
 
         return False
 
     def gc(self, keepkeys):
         ui = self.ui
         cachepath = self._path
 
         # prune cache
         queue = pycompat.queue.PriorityQueue()
         originalsize = 0
         size = 0
         count = 0
         removed = 0
 
         # keep files newer than a day even if they aren't needed
         limit = time.time() - (60 * 60 * 24)
 
         progress = ui.makeprogress(
             _(b"removing unnecessary files"), unit=b"files"
         )
         progress.update(0)
         for root, dirs, files in os.walk(cachepath):
             for file in files:
                 if file == b'repos':
                     continue
 
                 # Don't delete pack files
                 if b'/packs/' in root:
                     continue
 
                 progress.update(count)
                 path = os.path.join(root, file)
                 key = os.path.relpath(path, cachepath)
                 count += 1
                 try:
                     pathstat = os.stat(path)
                 except OSError as e:
                     # errno.ENOENT = no such file or directory
                     if e.errno != errno.ENOENT:
                         raise
                     msg = _(
                         b"warning: file %s was removed by another process\n"
                     )
                     ui.warn(msg % path)
                     continue
 
                 originalsize += pathstat.st_size
 
                 if key in keepkeys or pathstat.st_atime > limit:
                     queue.put((pathstat.st_atime, path, pathstat))
                     size += pathstat.st_size
                 else:
                     try:
                         shallowutil.unlinkfile(path)
                     except OSError as e:
                         # errno.ENOENT = no such file or directory
                         if e.errno != errno.ENOENT:
                             raise
                         msg = _(
                             b"warning: file %s was removed by another "
                             b"process\n"
                         )
                         ui.warn(msg % path)
                         continue
                     removed += 1
         progress.complete()
 
         # remove oldest files until under limit
         limit = ui.configbytes(b"remotefilelog", b"cachelimit")
         if size > limit:
             excess = size - limit
             progress = ui.makeprogress(
                 _(b"enforcing cache limit"), unit=b"bytes", total=excess
             )
             removedexcess = 0
             while queue and size > limit and size > 0:
                 progress.update(removedexcess)
                 atime, oldpath, oldpathstat = queue.get()
                 try:
                     shallowutil.unlinkfile(oldpath)
                 except OSError as e:
                     # errno.ENOENT = no such file or directory
                     if e.errno != errno.ENOENT:
                         raise
                     msg = _(
                         b"warning: file %s was removed by another process\n"
                     )
                     ui.warn(msg % oldpath)
                 size -= oldpathstat.st_size
                 removed += 1
                 removedexcess += oldpathstat.st_size
             progress.complete()
 
         ui.status(
             _(b"finished: removed %d of %d files (%0.2f GB to %0.2f GB)\n")
             % (
                 removed,
                 count,
                 float(originalsize) / 1024.0 / 1024.0 / 1024.0,
                 float(size) / 1024.0 / 1024.0 / 1024.0,
             )
         )
 
 
 class baseunionstore:
     def __init__(self, *args, **kwargs):
         # If one of the functions that iterates all of the stores is about to
         # throw a KeyError, try this many times with a full refresh between
         # attempts. A repack operation may have moved data from one store to
         # another while we were running.
         self.numattempts = kwargs.get('numretries', 0) + 1
         # If not-None, call this function on every retry and if the attempts are
         # exhausted.
         self.retrylog = kwargs.get('retrylog', None)
 
     def markforrefresh(self):
         for store in self.stores:
             if util.safehasattr(store, b'markforrefresh'):
                 store.markforrefresh()
 
     @staticmethod
     def retriable(fn):
         def noop(*args):
             pass
 
         def wrapped(self, *args, **kwargs):
             retrylog = self.retrylog or noop
             funcname = fn.__name__
             i = 0
             while i < self.numattempts:
                 if i > 0:
                     retrylog(
                         b're-attempting (n=%d) %s\n'
                         % (i, pycompat.sysbytes(funcname))
                     )
                     self.markforrefresh()
                 i += 1
                 try:
                     return fn(self, *args, **kwargs)
                 except KeyError:
                     if i == self.numattempts:
                         # retries exhausted
                         retrylog(
                             b'retries exhausted in %s, raising KeyError\n'
                             % pycompat.sysbytes(funcname)
                         )
                         raise
 
         return wrapped

hgext/remotefilelog/contentstore.py

@@ -1,397 +1,396 b''
 import threading
 
 from mercurial.node import (
     hex,
     sha1nodeconstants,
 )
 from mercurial.pycompat import getattr
 from mercurial import (
     mdiff,
-    pycompat,
     revlog,
 )
 from . import (
     basestore,
     constants,
     shallowutil,
 )
 
 
 class ChainIndicies:
     """A static class for easy reference to the delta chain indicies."""
 
     # The filename of this revision delta
     NAME = 0
     # The mercurial file node for this revision delta
     NODE = 1
     # The filename of the delta base's revision. This is useful when delta
     # between different files (like in the case of a move or copy, we can delta
     # against the original file content).
     BASENAME = 2
     # The mercurial file node for the delta base revision. This is the nullid if
     # this delta is a full text.
     BASENODE = 3
     # The actual delta or full text data.
     DATA = 4
 
 
 class unioncontentstore(basestore.baseunionstore):
     def __init__(self, *args, **kwargs):
         super(unioncontentstore, self).__init__(*args, **kwargs)
 
         self.stores = args
         self.writestore = kwargs.get('writestore')
 
         # If allowincomplete==True then the union store can return partial
         # delta chains, otherwise it will throw a KeyError if a full
         # deltachain can't be found.
         self.allowincomplete = kwargs.get('allowincomplete', False)
 
     def get(self, name, node):
         """Fetches the full text revision contents of the given name+node pair.
         If the full text doesn't exist, throws a KeyError.
 
         Under the hood, this uses getdeltachain() across all the stores to build
         up a full chain to produce the full text.
         """
         chain = self.getdeltachain(name, node)
 
         if chain[-1][ChainIndicies.BASENODE] != sha1nodeconstants.nullid:
             # If we didn't receive a full chain, throw
             raise KeyError((name, hex(node)))
 
         # The last entry in the chain is a full text, so we start our delta
         # applies with that.
         fulltext = chain.pop()[ChainIndicies.DATA]
 
         text = fulltext
         while chain:
             delta = chain.pop()[ChainIndicies.DATA]
             text = mdiff.patches(text, [delta])
 
         return text
 
     @basestore.baseunionstore.retriable
     def getdelta(self, name, node):
         """Return the single delta entry for the given name/node pair."""
         for store in self.stores:
             try:
                 return store.getdelta(name, node)
             except KeyError:
                 pass
 
         raise KeyError((name, hex(node)))
 
     def getdeltachain(self, name, node):
         """Returns the deltachain for the given name/node pair.
 
         Returns an ordered list of:
 
           [(name, node, deltabasename, deltabasenode, deltacontent),...]
 
         where the chain is terminated by a full text entry with a nullid
         deltabasenode.
         """
         chain = self._getpartialchain(name, node)
         while chain[-1][ChainIndicies.BASENODE] != sha1nodeconstants.nullid:
             x, x, deltabasename, deltabasenode, x = chain[-1]
             try:
                 morechain = self._getpartialchain(deltabasename, deltabasenode)
                 chain.extend(morechain)
             except KeyError:
                 # If we allow incomplete chains, don't throw.
                 if not self.allowincomplete:
                     raise
                 break
 
         return chain
 
     @basestore.baseunionstore.retriable
     def getmeta(self, name, node):
         """Returns the metadata dict for given node."""
         for store in self.stores:
             try:
                 return store.getmeta(name, node)
             except KeyError:
                 pass
         raise KeyError((name, hex(node)))
 
     def getmetrics(self):
         metrics = [s.getmetrics() for s in self.stores]
         return shallowutil.sumdicts(*metrics)
 
     @basestore.baseunionstore.retriable
     def _getpartialchain(self, name, node):
         """Returns a partial delta chain for the given name/node pair.
 
         A partial chain is a chain that may not be terminated in a full-text.
         """
         for store in self.stores:
             try:
                 return store.getdeltachain(name, node)
             except KeyError:
                 pass
 
         raise KeyError((name, hex(node)))
 
     def add(self, name, node, data):
         raise RuntimeError(
             b"cannot add content only to remotefilelog contentstore"
         )
 
     def getmissing(self, keys):
         missing = keys
         for store in self.stores:
             if missing:
                 missing = store.getmissing(missing)
         return missing
 
     def addremotefilelognode(self, name, node, data):
         if self.writestore:
             self.writestore.addremotefilelognode(name, node, data)
         else:
             raise RuntimeError(b"no writable store configured")
 
     def markledger(self, ledger, options=None):
         for store in self.stores:
             store.markledger(ledger, options)
 
 
 class remotefilelogcontentstore(basestore.basestore):
     def __init__(self, *args, **kwargs):
         super(remotefilelogcontentstore, self).__init__(*args, **kwargs)
         self._threaddata = threading.local()
 
     def get(self, name, node):
         # return raw revision text
         data = self._getdata(name, node)
 
         offset, size, flags = shallowutil.parsesizeflags(data)
         content = data[offset : offset + size]
 
         ancestormap = shallowutil.ancestormap(data)
         p1, p2, linknode, copyfrom = ancestormap[node]
         copyrev = None
         if copyfrom:
             copyrev = hex(p1)
 
         self._updatemetacache(node, size, flags)
 
         # lfs tracks renames in its own metadata, remove hg copy metadata,
         # because copy metadata will be re-added by lfs flag processor.
         if flags & revlog.REVIDX_EXTSTORED:
             copyrev = copyfrom = None
         revision = shallowutil.createrevlogtext(content, copyfrom, copyrev)
         return revision
 
     def getdelta(self, name, node):
         # Since remotefilelog content stores only contain full texts, just
         # return that.
         revision = self.get(name, node)
         return (
             revision,
             name,
             sha1nodeconstants.nullid,
             self.getmeta(name, node),
         )
 
     def getdeltachain(self, name, node):
         # Since remotefilelog content stores just contain full texts, we return
         # a fake delta chain that just consists of a single full text revision.
         # The nullid in the deltabasenode slot indicates that the revision is a
         # fulltext.
         revision = self.get(name, node)
         return [(name, node, None, sha1nodeconstants.nullid, revision)]
 
     def getmeta(self, name, node):
         self._sanitizemetacache()
         if node != self._threaddata.metacache[0]:
             data = self._getdata(name, node)
             offset, size, flags = shallowutil.parsesizeflags(data)
             self._updatemetacache(node, size, flags)
         return self._threaddata.metacache[1]
 
     def add(self, name, node, data):
         raise RuntimeError(
             b"cannot add content only to remotefilelog contentstore"
         )
 
     def _sanitizemetacache(self):
         metacache = getattr(self._threaddata, 'metacache', None)
         if metacache is None:
             self._threaddata.metacache = (None, None)  # (node, meta)
 
     def _updatemetacache(self, node, size, flags):
         self._sanitizemetacache()
         if node == self._threaddata.metacache[0]:
             return
         meta = {constants.METAKEYFLAG: flags, constants.METAKEYSIZE: size}
         self._threaddata.metacache = (node, meta)
 
 
 class remotecontentstore:
     def __init__(self, ui, fileservice, shared):
         self._fileservice = fileservice
         # type(shared) is usually remotefilelogcontentstore
         self._shared = shared
 
     def get(self, name, node):
         self._fileservice.prefetch(
             [(name, hex(node))], force=True, fetchdata=True
         )
         return self._shared.get(name, node)
 
     def getdelta(self, name, node):
         revision = self.get(name, node)
         return (
             revision,
             name,
             sha1nodeconstants.nullid,
             self._shared.getmeta(name, node),
         )
 
     def getdeltachain(self, name, node):
         # Since our remote content stores just contain full texts, we return a
         # fake delta chain that just consists of a single full text revision.
         # The nullid in the deltabasenode slot indicates that the revision is a
         # fulltext.
         revision = self.get(name, node)
         return [(name, node, None, sha1nodeconstants.nullid, revision)]
 
     def getmeta(self, name, node):
         self._fileservice.prefetch(
             [(name, hex(node))], force=True, fetchdata=True
         )
         return self._shared.getmeta(name, node)
 
     def add(self, name, node, data):
         raise RuntimeError(b"cannot add to a remote store")
 
     def getmissing(self, keys):
         return keys
 
     def markledger(self, ledger, options=None):
         pass
 
 
 class manifestrevlogstore:
     def __init__(self, repo):
         self._store = repo.store
         self._svfs = repo.svfs
         self._revlogs = dict()
         self._cl = revlog.revlog(self._svfs, radix=b'00changelog.i')
         self._repackstartlinkrev = 0
 
     def get(self, name, node):
         return self._revlog(name).rawdata(node)
 
     def getdelta(self, name, node):
         revision = self.get(name, node)
         return revision, name, self._cl.nullid, self.getmeta(name, node)
 
     def getdeltachain(self, name, node):
         revision = self.get(name, node)
         return [(name, node, None, self._cl.nullid, revision)]
 
     def getmeta(self, name, node):
         rl = self._revlog(name)
         rev = rl.rev(node)
         return {
             constants.METAKEYFLAG: rl.flags(rev),
             constants.METAKEYSIZE: rl.rawsize(rev),
         }
 
     def getancestors(self, name, node, known=None):
         if known is None:
             known = set()
         if node in known:
             return []
 
         rl = self._revlog(name)
         ancestors = {}
         missing = {node}
         for ancrev in rl.ancestors([rl.rev(node)], inclusive=True):
             ancnode = rl.node(ancrev)
             missing.discard(ancnode)
 
             p1, p2 = rl.parents(ancnode)
             if p1 != self._cl.nullid and p1 not in known:
                 missing.add(p1)
             if p2 != self._cl.nullid and p2 not in known:
                 missing.add(p2)
 
             linknode = self._cl.node(rl.linkrev(ancrev))
             ancestors[rl.node(ancrev)] = (p1, p2, linknode, b'')
             if not missing:
                 break
         return ancestors
 
     def getnodeinfo(self, name, node):
         cl = self._cl
         rl = self._revlog(name)
         parents = rl.parents(node)
         linkrev = rl.linkrev(rl.rev(node))
         return (parents[0], parents[1], cl.node(linkrev), None)
 
     def add(self, *args):
         raise RuntimeError(b"cannot add to a revlog store")
 
     def _revlog(self, name):
         rl = self._revlogs.get(name)
         if rl is None:
             revlogname = b'00manifesttree'
             if name != b'':
                 revlogname = b'meta/%s/00manifest' % name
             rl = revlog.revlog(self._svfs, radix=revlogname)
             self._revlogs[name] = rl
         return rl
 
     def getmissing(self, keys):
         missing = []
         for name, node in keys:
             mfrevlog = self._revlog(name)
             if node not in mfrevlog.nodemap:
                 missing.append((name, node))
 
         return missing
 
     def setrepacklinkrevrange(self, startrev, endrev):
         self._repackstartlinkrev = startrev
         self._repackendlinkrev = endrev
 
     def markledger(self, ledger, options=None):
         if options and options.get(constants.OPTION_PACKSONLY):
             return
         treename = b''
         rl = revlog.revlog(self._svfs, radix=b'00manifesttree')
         startlinkrev = self._repackstartlinkrev
         endlinkrev = self._repackendlinkrev
-        for rev in pycompat.xrange(len(rl) - 1, -1, -1):
+        for rev in range(len(rl) - 1, -1, -1):
             linkrev = rl.linkrev(rev)
             if linkrev < startlinkrev:
                 break
             if linkrev > endlinkrev:
                 continue
             node = rl.node(rev)
             ledger.markdataentry(self, treename, node)
             ledger.markhistoryentry(self, treename, node)
 
         for t, path, size in self._store.datafiles():
             if path[:5] != b'meta/' or path[-2:] != b'.i':
                 continue
 
             treename = path[5 : -len(b'/00manifest')]
 
             rl = revlog.revlog(self._svfs, indexfile=path[:-2])
-            for rev in pycompat.xrange(len(rl) - 1, -1, -1):
+            for rev in range(len(rl) - 1, -1, -1):
                 linkrev = rl.linkrev(rev)
                 if linkrev < startlinkrev:
                     break
                 if linkrev > endlinkrev:
                     continue
                 node = rl.node(rev)
                 ledger.markdataentry(self, treename, node)
                 ledger.markhistoryentry(self, treename, node)
 
     def cleanup(self, ledger):
         pass

hgext/remotefilelog/datapack.py

@@ -1,474 +1,473 b''
 import struct
 import zlib
 
 from mercurial.node import (
     hex,
     sha1nodeconstants,
 )
 from mercurial.i18n import _
 from mercurial import (
-    pycompat,
     util,
 )
 from . import (
     basepack,
     constants,
     shallowutil,
 )
 
 NODELENGTH = 20
 
 # The indicator value in the index for a fulltext entry.
 FULLTEXTINDEXMARK = -1
 NOBASEINDEXMARK = -2
 
 INDEXSUFFIX = b'.dataidx'
 PACKSUFFIX = b'.datapack'
 
 
 class datapackstore(basepack.basepackstore):
     INDEXSUFFIX = INDEXSUFFIX
     PACKSUFFIX = PACKSUFFIX
 
     def __init__(self, ui, path):
         super(datapackstore, self).__init__(ui, path)
 
     def getpack(self, path):
         return datapack(path)
 
     def get(self, name, node):
         raise RuntimeError(b"must use getdeltachain with datapackstore")
 
     def getmeta(self, name, node):
         for pack in self.packs:
             try:
                 return pack.getmeta(name, node)
             except KeyError:
                 pass
 
         for pack in self.refresh():
             try:
                 return pack.getmeta(name, node)
             except KeyError:
                 pass
 
         raise KeyError((name, hex(node)))
 
     def getdelta(self, name, node):
         for pack in self.packs:
             try:
                 return pack.getdelta(name, node)
             except KeyError:
                 pass
 
         for pack in self.refresh():
             try:
                 return pack.getdelta(name, node)
             except KeyError:
                 pass
 
         raise KeyError((name, hex(node)))
 
     def getdeltachain(self, name, node):
         for pack in self.packs:
             try:
                 return pack.getdeltachain(name, node)
             except KeyError:
                 pass
 
         for pack in self.refresh():
             try:
                 return pack.getdeltachain(name, node)
             except KeyError:
                 pass
 
         raise KeyError((name, hex(node)))
 
     def add(self, name, node, data):
         raise RuntimeError(b"cannot add to datapackstore")
 
 
 class datapack(basepack.basepack):
     INDEXSUFFIX = INDEXSUFFIX
     PACKSUFFIX = PACKSUFFIX
 
     # Format is <node><delta offset><pack data offset><pack data size>
     # See the mutabledatapack doccomment for more details.
     INDEXFORMAT = b'!20siQQ'
     INDEXENTRYLENGTH = 40
 
     SUPPORTED_VERSIONS = [2]
 
     def getmissing(self, keys):
         missing = []
         for name, node in keys:
             value = self._find(node)
             if not value:
                 missing.append((name, node))
 
         return missing
 
     def get(self, name, node):
         raise RuntimeError(
             b"must use getdeltachain with datapack (%s:%s)" % (name, hex(node))
         )
 
     def getmeta(self, name, node):
         value = self._find(node)
         if value is None:
             raise KeyError((name, hex(node)))
 
         node, deltabaseoffset, offset, size = value
         rawentry = self._data[offset : offset + size]
 
         # see docstring of mutabledatapack for the format
         offset = 0
         offset += struct.unpack_from(b'!H', rawentry, offset)[0] + 2  # filename
         offset += 40  # node, deltabase node
         offset += struct.unpack_from(b'!Q', rawentry, offset)[0] + 8  # delta
 
         metalen = struct.unpack_from(b'!I', rawentry, offset)[0]
         offset += 4
 
         meta = shallowutil.parsepackmeta(rawentry[offset : offset + metalen])
 
         return meta
 
     def getdelta(self, name, node):
         value = self._find(node)
         if value is None:
             raise KeyError((name, hex(node)))
 
         node, deltabaseoffset, offset, size = value
         entry = self._readentry(offset, size, getmeta=True)
         filename, node, deltabasenode, delta, meta = entry
 
         # If we've read a lot of data from the mmap, free some memory.
         self.freememory()
 
         return delta, filename, deltabasenode, meta
 
     def getdeltachain(self, name, node):
         value = self._find(node)
         if value is None:
             raise KeyError((name, hex(node)))
 
         params = self.params
 
         # Precompute chains
         chain = [value]
         deltabaseoffset = value[1]
         entrylen = self.INDEXENTRYLENGTH
         while (
             deltabaseoffset != FULLTEXTINDEXMARK
             and deltabaseoffset != NOBASEINDEXMARK
         ):
             loc = params.indexstart + deltabaseoffset
             value = struct.unpack(
                 self.INDEXFORMAT, self._index[loc : loc + entrylen]
             )
             deltabaseoffset = value[1]
             chain.append(value)
 
         # Read chain data
         deltachain = []
         for node, deltabaseoffset, offset, size in chain:
             filename, node, deltabasenode, delta = self._readentry(offset, size)
             deltachain.append((filename, node, filename, deltabasenode, delta))
 
         # If we've read a lot of data from the mmap, free some memory.
         self.freememory()
 
         return deltachain
 
     def _readentry(self, offset, size, getmeta=False):
         rawentry = self._data[offset : offset + size]
         self._pagedin += len(rawentry)
 
         # <2 byte len> + <filename>
         lengthsize = 2
         filenamelen = struct.unpack(b'!H', rawentry[:2])[0]
         filename = rawentry[lengthsize : lengthsize + filenamelen]
 
         # <20 byte node> + <20 byte deltabase>
         nodestart = lengthsize + filenamelen
         deltabasestart = nodestart + NODELENGTH
         node = rawentry[nodestart:deltabasestart]
         deltabasenode = rawentry[deltabasestart : deltabasestart + NODELENGTH]
 
         # <8 byte len> + <delta>
         deltastart = deltabasestart + NODELENGTH
         rawdeltalen = rawentry[deltastart : deltastart + 8]
         deltalen = struct.unpack(b'!Q', rawdeltalen)[0]
 
         delta = rawentry[deltastart + 8 : deltastart + 8 + deltalen]
         delta = self._decompress(delta)
 
         if getmeta:
             metastart = deltastart + 8 + deltalen
             metalen = struct.unpack_from(b'!I', rawentry, metastart)[0]
 
             rawmeta = rawentry[metastart + 4 : metastart + 4 + metalen]
             meta = shallowutil.parsepackmeta(rawmeta)
             return filename, node, deltabasenode, delta, meta
         else:
             return filename, node, deltabasenode, delta
 
     def _decompress(self, data):
         return zlib.decompress(data)
 
     def add(self, name, node, data):
         raise RuntimeError(b"cannot add to datapack (%s:%s)" % (name, node))
 
     def _find(self, node):
         params = self.params
         fanoutkey = struct.unpack(
             params.fanoutstruct, node[: params.fanoutprefix]
         )[0]
         fanout = self._fanouttable
 
         start = fanout[fanoutkey] + params.indexstart
         indexend = self._indexend
 
         # Scan forward to find the first non-same entry, which is the upper
         # bound.
-        for i in pycompat.xrange(fanoutkey + 1, params.fanoutcount):
+        for i in range(fanoutkey + 1, params.fanoutcount):
             end = fanout[i] + params.indexstart
             if end != start:
                 break
         else:
             end = indexend
 
         # Bisect between start and end to find node
         index = self._index
         startnode = index[start : start + NODELENGTH]
         endnode = index[end : end + NODELENGTH]
         entrylen = self.INDEXENTRYLENGTH
         if startnode == node:
             entry = index[start : start + entrylen]
         elif endnode == node:
             entry = index[end : end + entrylen]
         else:
             while start < end - entrylen:
                 mid = start + (end - start) // 2
                 mid = mid - ((mid - params.indexstart) % entrylen)
                 midnode = index[mid : mid + NODELENGTH]
                 if midnode == node:
                     entry = index[mid : mid + entrylen]
                     break
                 if node > midnode:
                     start = mid
                 elif node < midnode:
                     end = mid
             else:
                 return None
 
         return struct.unpack(self.INDEXFORMAT, entry)
 
     def markledger(self, ledger, options=None):
         for filename, node in self:
             ledger.markdataentry(self, filename, node)
 
     def cleanup(self, ledger):
         entries = ledger.sources.get(self, [])
         allkeys = set(self)
         repackedkeys = {
             (e.filename, e.node) for e in entries if e.datarepacked or e.gced
         }
 
         if len(allkeys - repackedkeys) == 0:
             if self.path not in ledger.created:
                 util.unlinkpath(self.indexpath, ignoremissing=True)
                 util.unlinkpath(self.packpath, ignoremissing=True)
 
     def __iter__(self):
         for f, n, deltabase, deltalen in self.iterentries():
             yield f, n
 
     def iterentries(self):
         # Start at 1 to skip the header
         offset = 1
         data = self._data
         while offset < self.datasize:
             oldoffset = offset
 
             # <2 byte len> + <filename>
             filenamelen = struct.unpack(b'!H', data[offset : offset + 2])[0]
             offset += 2
             filename = data[offset : offset + filenamelen]
             offset += filenamelen
 
             # <20 byte node>
             node = data[offset : offset + constants.NODESIZE]
             offset += constants.NODESIZE
             # <20 byte deltabase>
             deltabase = data[offset : offset + constants.NODESIZE]
             offset += constants.NODESIZE
 
             # <8 byte len> + <delta>
             rawdeltalen = data[offset : offset + 8]
             deltalen = struct.unpack(b'!Q', rawdeltalen)[0]
             offset += 8
 
             # TODO(augie): we should store a header that is the
             # uncompressed size.
             uncompressedlen = len(
                 self._decompress(data[offset : offset + deltalen])
             )
             offset += deltalen
 
             # <4 byte len> + <metadata-list>
             metalen = struct.unpack_from(b'!I', data, offset)[0]
             offset += 4 + metalen
 
             yield (filename, node, deltabase, uncompressedlen)
 
             # If we've read a lot of data from the mmap, free some memory.
             self._pagedin += offset - oldoffset
             if self.freememory():
                 data = self._data
 
 
 class mutabledatapack(basepack.mutablebasepack):
     """A class for constructing and serializing a datapack file and index.
 
     A datapack is a pair of files that contain the revision contents for various
     file revisions in Mercurial. It contains only revision contents (like file
     contents), not any history information.
 
     It consists of two files, with the following format. All bytes are in
     network byte order (big endian).
 
     .datapack
         The pack itself is a series of revision deltas with some basic header
         information on each. A revision delta may be a fulltext, represented by
         a deltabasenode equal to the nullid.
 
         datapack = <version: 1 byte>
                    [<revision>,...]
         revision = <filename len: 2 byte unsigned int>
                    <filename>
                    <node: 20 byte>
                    <deltabasenode: 20 byte>
                    <delta len: 8 byte unsigned int>
                    <delta>
                    <metadata-list len: 4 byte unsigned int> [1]
                    <metadata-list>                          [1]
         metadata-list = [<metadata-item>, ...]
         metadata-item = <metadata-key: 1 byte>
                         <metadata-value len: 2 byte unsigned>
                         <metadata-value>
 
         metadata-key could be METAKEYFLAG or METAKEYSIZE or other single byte
         value in the future.
 
     .dataidx
         The index file consists of two parts, the fanout and the index.
 
         The index is a list of index entries, sorted by node (one per revision
         in the pack). Each entry has:
 
         - node (The 20 byte node of the entry; i.e. the commit hash, file node
                 hash, etc)
         - deltabase index offset (The location in the index of the deltabase for
                                   this entry. The deltabase is the next delta in
                                   the chain, with the chain eventually
                                   terminating in a full-text, represented by a
                                   deltabase offset of -1. This lets us compute
                                   delta chains from the index, then do
                                   sequential reads from the pack if the revision
                                   are nearby on disk.)
         - pack entry offset (The location of this entry in the datapack)
         - pack content size (The on-disk length of this entry's pack data)
 
         The fanout is a quick lookup table to reduce the number of steps for
         bisecting the index. It is a series of 4 byte pointers to positions
         within the index. It has 2^16 entries, which corresponds to hash
         prefixes [0000, 0001,..., FFFE, FFFF]. Example: the pointer in slot
         4F0A points to the index position of the first revision whose node
         starts with 4F0A. This saves log(2^16)=16 bisect steps.
 
         dataidx = <fanouttable>
                   <index>
         fanouttable = [<index offset: 4 byte unsigned int>,...] (2^16 entries)
         index = [<index entry>,...]
         indexentry = <node: 20 byte>
                      <deltabase location: 4 byte signed int>
                      <pack entry offset: 8 byte unsigned int>
                      <pack entry size: 8 byte unsigned int>
 
     [1]: new in version 1.
     """
 
     INDEXSUFFIX = INDEXSUFFIX
     PACKSUFFIX = PACKSUFFIX
 
     # v[01] index format: <node><delta offset><pack data offset><pack data size>
     INDEXFORMAT = datapack.INDEXFORMAT
     INDEXENTRYLENGTH = datapack.INDEXENTRYLENGTH
 
     # v1 has metadata support
     SUPPORTED_VERSIONS = [2]
 
     def _compress(self, data):
         return zlib.compress(data)
 
     def add(self, name, node, deltabasenode, delta, metadata=None):
         # metadata is a dict, ex. {METAKEYFLAG: flag}
         if len(name) > 2 ** 16:
             raise RuntimeError(_(b"name too long %s") % name)
         if len(node) != 20:
             raise RuntimeError(_(b"node should be 20 bytes %s") % node)
 
         if node in self.entries:
             # The revision has already been added
             return
 
         # TODO: allow configurable compression
         delta = self._compress(delta)
 
         rawdata = b''.join(
             (
                 struct.pack(b'!H', len(name)),  # unsigned 2 byte int
                 name,
                 node,
                 deltabasenode,
                 struct.pack(b'!Q', len(delta)),  # unsigned 8 byte int
                 delta,
             )
         )
 
         # v1 support metadata
         rawmeta = shallowutil.buildpackmeta(metadata)
         rawdata += struct.pack(b'!I', len(rawmeta))  # unsigned 4 byte
         rawdata += rawmeta
 
         offset = self.packfp.tell()
 
         size = len(rawdata)
 
         self.entries[node] = (deltabasenode, offset, size)
 
         self.writeraw(rawdata)
 
     def createindex(self, nodelocations, indexoffset):
         entries = sorted(
             (n, db, o, s) for n, (db, o, s) in self.entries.items()
         )
 
         rawindex = b''
         fmt = self.INDEXFORMAT
         for node, deltabase, offset, size in entries:
             if deltabase == sha1nodeconstants.nullid:
                 deltabaselocation = FULLTEXTINDEXMARK
             else:
                 # Instead of storing the deltabase node in the index, let's
                 # store a pointer directly to the index entry for the deltabase.
                 deltabaselocation = nodelocations.get(
                     deltabase, NOBASEINDEXMARK
                 )
 
             entry = struct.pack(fmt, node, deltabaselocation, offset, size)
             rawindex += entry
 
         return rawindex