bookmarks: fix _bookmarks/lookup() reentrancy issue (issue2016)

_bookmarks is loaded lazily and calls super.lookup(). Unfortunately, branch and
tags caches initializations also recurse in lookup() and end up trying to
access _bookmarks again. Massive confusion ensues.

I considered fixing all branches and tags cache loading to avoid recursing in
lookup() but it would add complexity to otherwise working code provided lookups
are performed on nodes or revnums.

hgext/bookmarks.py

@@ -1,543 +1,547 b''
 # Mercurial extension to provide the 'hg bookmark' command
 #
 # Copyright 2008 David Soria Parra <[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.
 
 '''track a line of development with movable markers
 
 Bookmarks are local movable markers to changesets. Every bookmark
 points to a changeset identified by its hash. If you commit a
 changeset that is based on a changeset that has a bookmark on it, the
 bookmark shifts to the new changeset.
 
 It is possible to use bookmark names in every revision lookup (e.g.
 :hg:`merge`, :hg:`update`).
 
 By default, when several bookmarks point to the same changeset, they
 will all move forward together. It is possible to obtain a more
 git-like experience by adding the following configuration option to
 your configuration file::
 
   [bookmarks]
   track.current = True
 
 This will cause Mercurial to track the bookmark that you are currently
 using, and only update it. This is similar to git's approach to
 branching.
 '''
 
 from mercurial.i18n import _
 from mercurial.node import nullid, nullrev, hex, short
 from mercurial import util, commands, repair, extensions, pushkey, hg, url
 import os
 
 def write(repo):
     '''Write bookmarks
 
     Write the given bookmark => hash dictionary to the .hg/bookmarks file
     in a format equal to those of localtags.
 
     We also store a backup of the previous state in undo.bookmarks that
     can be copied back on rollback.
     '''
     refs = repo._bookmarks
     if os.path.exists(repo.join('bookmarks')):
         util.copyfile(repo.join('bookmarks'), repo.join('undo.bookmarks'))
     if repo._bookmarkcurrent not in refs:
         setcurrent(repo, None)
     wlock = repo.wlock()
     try:
         file = repo.opener('bookmarks', 'w', atomictemp=True)
         for refspec, node in refs.iteritems():
             file.write("%s %s\n" % (hex(node), refspec))
         file.rename()
 
         # touch 00changelog.i so hgweb reloads bookmarks (no lock needed)
         try:
             os.utime(repo.sjoin('00changelog.i'), None)
         except OSError:
             pass
 
     finally:
         wlock.release()
 
 def setcurrent(repo, mark):
     '''Set the name of the bookmark that we are currently on
 
     Set the name of the bookmark that we are on (hg update <bookmark>).
     The name is recorded in .hg/bookmarks.current
     '''
     current = repo._bookmarkcurrent
     if current == mark:
         return
 
     refs = repo._bookmarks
 
     # do not update if we do update to a rev equal to the current bookmark
     if (mark and mark not in refs and
         current and refs[current] == repo.changectx('.').node()):
         return
     if mark not in refs:
         mark = ''
     wlock = repo.wlock()
     try:
         file = repo.opener('bookmarks.current', 'w', atomictemp=True)
         file.write(mark)
         file.rename()
     finally:
         wlock.release()
     repo._bookmarkcurrent = mark
 
 def bookmark(ui, repo, mark=None, rev=None, force=False, delete=False, rename=None):
     '''track a line of development with movable markers
 
     Bookmarks are pointers to certain commits that move when
     committing. Bookmarks are local. They can be renamed, copied and
     deleted. It is possible to use bookmark names in :hg:`merge` and
     :hg:`update` to merge and update respectively to a given bookmark.
 
     You can use :hg:`bookmark NAME` to set a bookmark on the working
     directory's parent revision with the given name. If you specify
     a revision using -r REV (where REV may be an existing bookmark),
     the bookmark is assigned to that revision.
     '''
     hexfn = ui.debugflag and hex or short
     marks = repo._bookmarks
     cur   = repo.changectx('.').node()
 
     if rename:
         if rename not in marks:
             raise util.Abort(_("a bookmark of this name does not exist"))
         if mark in marks and not force:
             raise util.Abort(_("a bookmark of the same name already exists"))
         if mark is None:
             raise util.Abort(_("new bookmark name required"))
         marks[mark] = marks[rename]
         del marks[rename]
         if repo._bookmarkcurrent == rename:
             setcurrent(repo, mark)
         write(repo)
         return
 
     if delete:
         if mark is None:
             raise util.Abort(_("bookmark name required"))
         if mark not in marks:
             raise util.Abort(_("a bookmark of this name does not exist"))
         if mark == repo._bookmarkcurrent:
             setcurrent(repo, None)
         del marks[mark]
         write(repo)
         return
 
     if mark != None:
         if "\n" in mark:
             raise util.Abort(_("bookmark name cannot contain newlines"))
         mark = mark.strip()
         if not mark:
             raise util.Abort(_("bookmark names cannot consist entirely of "
                                "whitespace"))
         if mark in marks and not force:
             raise util.Abort(_("a bookmark of the same name already exists"))
         if ((mark in repo.branchtags() or mark == repo.dirstate.branch())
             and not force):
             raise util.Abort(
                 _("a bookmark cannot have the name of an existing branch"))
         if rev:
             marks[mark] = repo.lookup(rev)
         else:
             marks[mark] = repo.changectx('.').node()
         setcurrent(repo, mark)
         write(repo)
         return
 
     if mark is None:
         if rev:
             raise util.Abort(_("bookmark name required"))
         if len(marks) == 0:
             ui.status(_("no bookmarks set\n"))
         else:
             for bmark, n in marks.iteritems():
                 if ui.configbool('bookmarks', 'track.current'):
                     current = repo._bookmarkcurrent
                     if bmark == current and n == cur:
                         prefix, label = '*', 'bookmarks.current'
                     else:
                         prefix, label = ' ', ''
                 else:
                     if n == cur:
                         prefix, label = '*', 'bookmarks.current'
                     else:
                         prefix, label = ' ', ''
 
                 if ui.quiet:
                     ui.write("%s\n" % bmark, label=label)
                 else:
                     ui.write(" %s %-25s %d:%s\n" % (
                         prefix, bmark, repo.changelog.rev(n), hexfn(n)),
                         label=label)
         return
 
 def _revstostrip(changelog, node):
     srev = changelog.rev(node)
     tostrip = [srev]
     saveheads = []
     for r in xrange(srev, len(changelog)):
         parents = changelog.parentrevs(r)
         if parents[0] in tostrip or parents[1] in tostrip:
             tostrip.append(r)
             if parents[1] != nullrev:
                 for p in parents:
                     if p not in tostrip and p > srev:
                         saveheads.append(p)
     return [r for r in tostrip if r not in saveheads]
 
 def strip(oldstrip, ui, repo, node, backup="all"):
     """Strip bookmarks if revisions are stripped using
     the mercurial.strip method. This usually happens during
     qpush and qpop"""
     revisions = _revstostrip(repo.changelog, node)
     marks = repo._bookmarks
     update = []
     for mark, n in marks.iteritems():
         if repo.changelog.rev(n) in revisions:
             update.append(mark)
     oldstrip(ui, repo, node, backup)
     if len(update) > 0:
         for m in update:
             marks[m] = repo.changectx('.').node()
         write(repo)
 
 def reposetup(ui, repo):
     if not repo.local():
         return
 
     class bookmark_repo(repo.__class__):
 
         @util.propertycache
         def _bookmarks(self):
             '''Parse .hg/bookmarks file and return a dictionary
 
             Bookmarks are stored as {HASH}\\s{NAME}\\n (localtags format) values
             in the .hg/bookmarks file.
             Read the file and return a (name=>nodeid) dictionary
             '''
+            self._loadingbookmarks = True
             try:
                 bookmarks = {}
                 for line in self.opener('bookmarks'):
                     sha, refspec = line.strip().split(' ', 1)
                     bookmarks[refspec] = super(bookmark_repo, self).lookup(sha)
             except:
                 pass
+            self._loadingbookmarks = False
             return bookmarks
 
         @util.propertycache
         def _bookmarkcurrent(self):
             '''Get the current bookmark
 
             If we use gittishsh branches we have a current bookmark that
             we are on. This function returns the name of the bookmark. It
             is stored in .hg/bookmarks.current
             '''
             mark = None
             if os.path.exists(self.join('bookmarks.current')):
                 file = self.opener('bookmarks.current')
                 # No readline() in posixfile_nt, reading everything is cheap
                 mark = (file.readlines() or [''])[0]
                 if mark == '':
                     mark = None
                 file.close()
             return mark
 
         def rollback(self, *args):
             if os.path.exists(self.join('undo.bookmarks')):
                 util.rename(self.join('undo.bookmarks'), self.join('bookmarks'))
             return super(bookmark_repo, self).rollback(*args)
 
         def lookup(self, key):
+            if not getattr(self, '_loadingbookmarks', False):
             if key in self._bookmarks:
                 key = self._bookmarks[key]
             return super(bookmark_repo, self).lookup(key)
 
         def _bookmarksupdate(self, parents, node):
             marks = self._bookmarks
             update = False
             if ui.configbool('bookmarks', 'track.current'):
                 mark = self._bookmarkcurrent
                 if mark and marks[mark] in parents:
                     marks[mark] = node
                     update = True
             else:
                 for mark, n in marks.items():
                     if n in parents:
                         marks[mark] = node
                         update = True
             if update:
                 write(self)
 
         def commitctx(self, ctx, error=False):
             """Add a revision to the repository and
             move the bookmark"""
             wlock = self.wlock() # do both commit and bookmark with lock held
             try:
                 node  = super(bookmark_repo, self).commitctx(ctx, error)
                 if node is None:
                     return None
                 parents = self.changelog.parents(node)
                 if parents[1] == nullid:
                     parents = (parents[0],)
 
                 self._bookmarksupdate(parents, node)
                 return node
             finally:
                 wlock.release()
 
         def pull(self, remote, heads=None, force=False):
             result = super(bookmark_repo, self).pull(remote, heads, force)
 
             self.ui.debug("checking for updated bookmarks\n")
             rb = remote.listkeys('bookmarks')
             changes = 0
             for k in rb.keys():
                 if k in self._bookmarks:
                     nr, nl = rb[k], self._bookmarks[k]
                     if nr in self:
                         cr = self[nr]
                         cl = self[nl]
                         if cl.rev() >= cr.rev():
                             continue
                         if cr in cl.descendants():
                             self._bookmarks[k] = cr.node()
                             changes += 1
                             self.ui.status(_("updating bookmark %s\n") % k)
                         else:
                             self.ui.warn(_("not updating divergent"
                                            " bookmark %s\n") % k)
             if changes:
                 write(repo)
 
             return result
 
         def push(self, remote, force=False, revs=None, newbranch=False):
             result = super(bookmark_repo, self).push(remote, force, revs,
                                                      newbranch)
 
             self.ui.debug("checking for updated bookmarks\n")
             rb = remote.listkeys('bookmarks')
             for k in rb.keys():
                 if k in self._bookmarks:
                     nr, nl = rb[k], self._bookmarks[k]
                     if nr in self:
                         cr = self[nr]
                         cl = self[nl]
                         if cl in cr.descendants():
                             r = remote.pushkey('bookmarks', k, nr, nl)
                             if r:
                                 self.ui.status(_("updating bookmark %s\n") % k)
                             else:
                                 self.ui.warn(_('updating bookmark %s'
                                                ' failed!\n') % k)
 
             return result
 
         def addchangegroup(self, *args, **kwargs):
             parents = self.dirstate.parents()
 
             result = super(bookmark_repo, self).addchangegroup(*args, **kwargs)
             if result > 1:
                 # We have more heads than before
                 return result
             node = self.changelog.tip()
 
             self._bookmarksupdate(parents, node)
             return result
 
         def _findtags(self):
             """Merge bookmarks with normal tags"""
             (tags, tagtypes) = super(bookmark_repo, self)._findtags()
+            if not getattr(self, '_loadingbookmarks', False):
             tags.update(self._bookmarks)
             return (tags, tagtypes)
 
         if hasattr(repo, 'invalidate'):
             def invalidate(self):
                 super(bookmark_repo, self).invalidate()
                 for attr in ('_bookmarks', '_bookmarkcurrent'):
                     if attr in self.__dict__:
                         delattr(self, attr)
 
     repo.__class__ = bookmark_repo
 
 def listbookmarks(repo):
     # We may try to list bookmarks on a repo type that does not
     # support it (e.g., statichttprepository).
     if not hasattr(repo, '_bookmarks'):
         return {}
 
     d = {}
     for k, v in repo._bookmarks.iteritems():
         d[k] = hex(v)
     return d
 
 def pushbookmark(repo, key, old, new):
     w = repo.wlock()
     try:
         marks = repo._bookmarks
         if hex(marks.get(key, '')) != old:
             return False
         if new == '':
             del marks[key]
         else:
             if new not in repo:
                 return False
             marks[key] = repo[new].node()
         write(repo)
         return True
     finally:
         w.release()
 
 def pull(oldpull, ui, repo, source="default", **opts):
     # translate bookmark args to rev args for actual pull
     if opts.get('bookmark'):
         # this is an unpleasant hack as pull will do this internally
         source, branches = hg.parseurl(ui.expandpath(source),
                                        opts.get('branch'))
         other = hg.repository(hg.remoteui(repo, opts), source)
         rb = other.listkeys('bookmarks')
 
         for b in opts['bookmark']:
             if b not in rb:
                 raise util.Abort(_('remote bookmark %s not found!') % b)
             opts.setdefault('rev', []).append(b)
 
     result = oldpull(ui, repo, source, **opts)
 
     # update specified bookmarks
     if opts.get('bookmark'):
         for b in opts['bookmark']:
             # explicit pull overrides local bookmark if any
             ui.status(_("importing bookmark %s\n") % b)
             repo._bookmarks[b] = repo[rb[b]].node()
         write(repo)
 
     return result
 
 def push(oldpush, ui, repo, dest=None, **opts):
     dopush = True
     if opts.get('bookmark'):
         dopush = False
         for b in opts['bookmark']:
             if b in repo._bookmarks:
                 dopush = True
                 opts.setdefault('rev', []).append(b)
 
     result = 0
     if dopush:
         result = oldpush(ui, repo, dest, **opts)
 
     if opts.get('bookmark'):
         # this is an unpleasant hack as push will do this internally
         dest = ui.expandpath(dest or 'default-push', dest or 'default')
         dest, branches = hg.parseurl(dest, opts.get('branch'))
         other = hg.repository(hg.remoteui(repo, opts), dest)
         rb = other.listkeys('bookmarks')
         for b in opts['bookmark']:
             # explicit push overrides remote bookmark if any
             if b in repo._bookmarks:
                 ui.status(_("exporting bookmark %s\n") % b)
                 new = repo[b].hex()
             elif b in rb:
                 ui.status(_("deleting remote bookmark %s\n") % b)
                 new = '' # delete
             else:
                 ui.warn(_('bookmark %s does not exist on the local '
                           'or remote repository!\n') % b)
                 return 2
             old = rb.get(b, '')
             r = other.pushkey('bookmarks', b, old, new)
             if not r:
                 ui.warn(_('updating bookmark %s failed!\n') % b)
                 if not result:
                     result = 2
 
     return result
 
 def diffbookmarks(ui, repo, remote):
     ui.status(_("searching for changes\n"))
 
     lmarks = repo.listkeys('bookmarks')
     rmarks = remote.listkeys('bookmarks')
 
     diff = set(rmarks) - set(lmarks)
     for k in diff:
         ui.write("   %-25s %s\n" % (k, rmarks[k][:12]))
 
     if len(diff) <= 0:
         ui.status(_("no changes found\n"))
         return 1
     return 0
 
 def incoming(oldincoming, ui, repo, source="default", **opts):
     if opts.get('bookmarks'):
         source, branches = hg.parseurl(ui.expandpath(source), opts.get('branch'))
         other = hg.repository(hg.remoteui(repo, opts), source)
         ui.status(_('comparing with %s\n') % url.hidepassword(source))
         return diffbookmarks(ui, repo, other)
     else:
         return oldincoming(ui, repo, source, **opts)
 
 def outgoing(oldoutgoing, ui, repo, dest=None, **opts):
     if opts.get('bookmarks'):
         dest = ui.expandpath(dest or 'default-push', dest or 'default')
         dest, branches = hg.parseurl(dest, opts.get('branch'))
         other = hg.repository(hg.remoteui(repo, opts), dest)
         ui.status(_('comparing with %s\n') % url.hidepassword(dest))
         return diffbookmarks(ui, other, repo)
     else:
         return oldoutgoing(ui, repo, dest, **opts)
 
 def uisetup(ui):
     extensions.wrapfunction(repair, "strip", strip)
     if ui.configbool('bookmarks', 'track.current'):
         extensions.wrapcommand(commands.table, 'update', updatecurbookmark)
 
     entry = extensions.wrapcommand(commands.table, 'pull', pull)
     entry[1].append(('B', 'bookmark', [],
                      _("bookmark to import")))
     entry = extensions.wrapcommand(commands.table, 'push', push)
     entry[1].append(('B', 'bookmark', [],
                      _("bookmark to export")))
     entry = extensions.wrapcommand(commands.table, 'incoming', incoming)
     entry[1].append(('B', 'bookmarks', False,
                      _("compare bookmark")))
     entry = extensions.wrapcommand(commands.table, 'outgoing', outgoing)
     entry[1].append(('B', 'bookmarks', False,
                      _("compare bookmark")))
 
     pushkey.register('bookmarks', pushbookmark, listbookmarks)
 
 def updatecurbookmark(orig, ui, repo, *args, **opts):
     '''Set the current bookmark
 
     If the user updates to a bookmark we update the .hg/bookmarks.current
     file.
     '''
     res = orig(ui, repo, *args, **opts)
     rev = opts['rev']
     if not rev and len(args) > 0:
         rev = args[0]
     setcurrent(repo, rev)
     return res
 
 cmdtable = {
     "bookmarks":
         (bookmark,
          [('f', 'force', False, _('force')),
           ('r', 'rev', '', _('revision'), _('REV')),
           ('d', 'delete', False, _('delete a given bookmark')),
           ('m', 'rename', '', _('rename a given bookmark'), _('NAME'))],
          _('hg bookmarks [-f] [-d] [-m NAME] [-r REV] [NAME]')),
 }
 
 colortable = {'bookmarks.current': 'green'}

tests/test-bookmarks-strip

@@ -1,45 +1,60 b''
 #!/bin/sh
 
 . $TESTDIR/helpers.sh
 echo "[extensions]" >> $HGRCPATH
 echo "bookmarks=" >> $HGRCPATH
 echo "mq=" >> $HGRCPATH
 
 hg init
 
 echo qqq>qqq.txt
 
 echo % add file
 hg add
 
 echo % commit first revision
 hg ci -m 1 -u user -d "1 0"
 
 echo % set bookmark
 hg book test
 
 echo www>>qqq.txt
 
 echo % commit second revision
 hg ci -m 2 -u usr -d "1 0"
 
 echo % set bookmark
 hg book test2
 
 echo % update to -2
 hg update -r -2
 
 echo eee>>qqq.txt
 
 echo % commit new head
 hg ci -m 3 -u user -d "1 0"
 
 echo % bookmarks updated?
 hg book
 
 echo % strip to revision 1
 hg strip 1 | hidebackup
 
 echo % list bookmarks
 hg book
 
+echo '% test immediate rollback and reentrancy issue'
+echo "mq=!" >> $HGRCPATH
+hg init repo
+cd repo
+echo a > a
+hg ci -Am adda
+echo b > b
+hg ci -Am addb
+hg bookmarks markb
+hg rollback
+hg bookmarks
+hg bookmarks markb
+hg bookmarks
+cd ..
+

tests/test-bookmarks-strip.out

@@ -1,18 +1,24 b''
 % add file
 adding qqq.txt
 % commit first revision
 % set bookmark
 % commit second revision
 % set bookmark
 % update to -2
 1 files updated, 0 files merged, 0 files removed, 0 files unresolved
 % commit new head
 created new head
 % bookmarks updated?
    test                      1:16b24da7e457
    test2                     1:16b24da7e457
 % strip to revision 1
 saved backup bundle to 
 % list bookmarks
  * test                      1:9f1b7e78eff8
  * test2                     1:9f1b7e78eff8
+% test immediate rollback and reentrancy issue
+adding a
+adding b
+rolling back to revision 0 (undo commit)
+no bookmarks set
+ * markb                     0:07f494440405