bookmarks: disallow bookmarks named 'tip', '.', or 'null'

This makes bookmarks reject the same reserved names as tags and branches.

mercurial/bookmarks.py

@@ -1,284 +1,286 b''
 # Mercurial bookmark support code
 #
 # 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.
 
 from mercurial.i18n import _
 from mercurial.node import hex
 from mercurial import encoding, error, util, obsolete, phases
 import errno, os
 
 def checkvalid(mark):
     for c in (':', '\0', '\n', '\r'):
         if c in mark:
             raise util.Abort(_("bookmark '%s' contains illegal "
                 "character" % mark))
+    if mark in ['tip', '.', 'null']:
+        raise util.Abort(_('the name \'%s\' is reserved') % mark)
 
 def read(repo):
     '''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
     '''
     bookmarks = {}
     try:
         for line in repo.opener('bookmarks'):
             line = line.strip()
             if not line:
                 continue
             if ' ' not in line:
                 repo.ui.warn(_('malformed line in .hg/bookmarks: %r\n') % line)
                 continue
             sha, refspec = line.split(' ', 1)
             refspec = encoding.tolocal(refspec)
             try:
                 bookmarks[refspec] = repo.changelog.lookup(sha)
             except LookupError:
                 pass
     except IOError, inst:
         if inst.errno != errno.ENOENT:
             raise
     return bookmarks
 
 def readcurrent(repo):
     '''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
     try:
         file = repo.opener('bookmarks.current')
     except IOError, inst:
         if inst.errno != errno.ENOENT:
             raise
         return None
     try:
         # No readline() in osutil.posixfile, reading everything is cheap
         mark = encoding.tolocal((file.readlines() or [''])[0])
         if mark == '' or mark not in repo._bookmarks:
             mark = None
     finally:
         file.close()
     return mark
 
 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 repo._bookmarkcurrent not in refs:
         setcurrent(repo, None)
     for mark in refs.keys():
         checkvalid(mark)
 
     wlock = repo.wlock()
     try:
 
         file = repo.opener('bookmarks', 'w', atomictemp=True)
         for refspec, node in refs.iteritems():
             file.write("%s %s\n" % (hex(node), encoding.fromlocal(refspec)))
         file.close()
 
         # 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
 
     if mark not in repo._bookmarks:
         mark = ''
     checkvalid(mark)
 
     wlock = repo.wlock()
     try:
         file = repo.opener('bookmarks.current', 'w', atomictemp=True)
         file.write(encoding.fromlocal(mark))
         file.close()
     finally:
         wlock.release()
     repo._bookmarkcurrent = mark
 
 def unsetcurrent(repo):
     wlock = repo.wlock()
     try:
         try:
             util.unlink(repo.join('bookmarks.current'))
             repo._bookmarkcurrent = None
         except OSError, inst:
             if inst.errno != errno.ENOENT:
                 raise
     finally:
         wlock.release()
 
 def updatecurrentbookmark(repo, oldnode, curbranch):
     try:
         return update(repo, oldnode, repo.branchtip(curbranch))
     except error.RepoLookupError:
         if curbranch == "default": # no default branch!
             return update(repo, oldnode, repo.lookup("tip"))
         else:
             raise util.Abort(_("branch %s not found") % curbranch)
 
 def update(repo, parents, node):
     marks = repo._bookmarks
     update = False
     cur = repo._bookmarkcurrent
     if not cur:
         return False
 
     toupdate = [b for b in marks if b.split('@', 1)[0] == cur.split('@', 1)[0]]
     for mark in toupdate:
         if mark and marks[mark] in parents:
             old = repo[marks[mark]]
             new = repo[node]
             if old.descendant(new) and mark == cur:
                 marks[cur] = new.node()
                 update = True
             if mark != cur:
                 del marks[mark]
     if update:
         repo._writebookmarks(marks)
     return update
 
 def listbookmarks(repo):
     # We may try to list bookmarks on a repo type that does not
     # support it (e.g., statichttprepository).
     marks = getattr(repo, '_bookmarks', {})
 
     d = {}
     for k, v in marks.iteritems():
         # don't expose local divergent bookmarks
         if '@' not in k or k.endswith('@'):
             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 updatefromremote(ui, repo, remote, path):
     ui.debug("checking for updated bookmarks\n")
     rb = remote.listkeys('bookmarks')
     changed = False
     for k in rb.keys():
         if k in repo._bookmarks:
             nr, nl = rb[k], repo._bookmarks[k]
             if nr in repo:
                 cr = repo[nr]
                 cl = repo[nl]
                 if cl.rev() >= cr.rev():
                     continue
                 if validdest(repo, cl, cr):
                     repo._bookmarks[k] = cr.node()
                     changed = True
                     ui.status(_("updating bookmark %s\n") % k)
                 else:
                     if k == '@':
                         kd = ''
                     else:
                         kd = k
                     # find a unique @ suffix
                     for x in range(1, 100):
                         n = '%s@%d' % (kd, x)
                         if n not in repo._bookmarks:
                             break
                     # try to use an @pathalias suffix
                     # if an @pathalias already exists, we overwrite (update) it
                     for p, u in ui.configitems("paths"):
                         if path == u:
                             n = '%s@%s' % (kd, p)
 
                     repo._bookmarks[n] = cr.node()
                     changed = True
                     ui.warn(_("divergent bookmark %s stored as %s\n") % (k, n))
         elif rb[k] in repo:
             # add remote bookmarks for changes we already have
             repo._bookmarks[k] = repo[rb[k]].node()
             changed = True
             ui.status(_("adding remote bookmark %s\n") % k)
 
     if changed:
         write(repo)
 
 def diff(ui, dst, src):
     ui.status(_("searching for changed bookmarks\n"))
 
     smarks = src.listkeys('bookmarks')
     dmarks = dst.listkeys('bookmarks')
 
     diff = sorted(set(smarks) - set(dmarks))
     for k in diff:
         mark = ui.debugflag and smarks[k] or smarks[k][:12]
         ui.write("   %-25s %s\n" % (k, mark))
 
     if len(diff) <= 0:
         ui.status(_("no changed bookmarks found\n"))
         return 1
     return 0
 
 def validdest(repo, old, new):
     """Is the new bookmark destination a valid update from the old one"""
     if old == new:
         # Old == new -> nothing to update.
         return False
     elif not old:
         # old is nullrev, anything is valid.
         # (new != nullrev has been excluded by the previous check)
         return True
     elif repo.obsstore:
         # We only need this complicated logic if there is obsolescence
         # XXX will probably deserve an optimised revset.
 
         validdests = set([old])
         plen = -1
         # compute the whole set of successors or descendants
         while len(validdests) != plen:
             plen = len(validdests)
             succs = set(c.node() for c in validdests)
             for c in validdests:
                 if c.phase() > phases.public:
                     # obsolescence marker does not apply to public changeset
                     succs.update(obsolete.anysuccessors(repo.obsstore,
                                                         c.node()))
             validdests = set(repo.set('%ln::', succs))
         validdests.remove(old)
         return new in validdests
     else:
         return old.descendant(new)

tests/test-bookmarks.t

@@ -1,520 +1,535 b''
   $ hg init
 
 no bookmarks
 
   $ hg bookmarks
   no bookmarks set
 
 bookmark rev -1
 
   $ hg bookmark X
 
 list bookmarks
 
   $ hg bookmarks
    * X                         -1:000000000000
 
 list bookmarks with color
 
   $ hg --config extensions.color= --config color.mode=ansi \
   >    bookmarks --color=always
   \x1b[0;32m * X                         -1:000000000000\x1b[0m (esc)
 
   $ echo a > a
   $ hg add a
   $ hg commit -m 0
 
 bookmark X moved to rev 0
 
   $ hg bookmarks
    * X                         0:f7b1eb17ad24
 
 look up bookmark
 
   $ hg log -r X
   changeset:   0:f7b1eb17ad24
   bookmark:    X
   tag:         tip
   user:        test
   date:        Thu Jan 01 00:00:00 1970 +0000
   summary:     0
   
 
 second bookmark for rev 0
 
   $ hg bookmark X2
 
 bookmark rev -1 again
 
   $ hg bookmark -r null Y
 
 list bookmarks
 
   $ hg bookmarks
      X                         0:f7b1eb17ad24
    * X2                        0:f7b1eb17ad24
      Y                         -1:000000000000
 
   $ echo b > b
   $ hg add b
   $ hg commit -m 1
 
 bookmarks revset
 
   $ hg log -r 'bookmark()'
   changeset:   0:f7b1eb17ad24
   bookmark:    X
   user:        test
   date:        Thu Jan 01 00:00:00 1970 +0000
   summary:     0
   
   changeset:   1:925d80f479bb
   bookmark:    X2
   tag:         tip
   user:        test
   date:        Thu Jan 01 00:00:00 1970 +0000
   summary:     1
   
   $ hg log -r 'bookmark(Y)'
   $ hg log -r 'bookmark(X2)'
   changeset:   1:925d80f479bb
   bookmark:    X2
   tag:         tip
   user:        test
   date:        Thu Jan 01 00:00:00 1970 +0000
   summary:     1
   
   $ hg log -r 'bookmark("re:X")'
   changeset:   0:f7b1eb17ad24
   bookmark:    X
   user:        test
   date:        Thu Jan 01 00:00:00 1970 +0000
   summary:     0
   
   changeset:   1:925d80f479bb
   bookmark:    X2
   tag:         tip
   user:        test
   date:        Thu Jan 01 00:00:00 1970 +0000
   summary:     1
   
   $ hg log -r 'bookmark(unknown)'
   abort: bookmark 'unknown' does not exist
   [255]
 
   $ hg help revsets | grep 'bookmark('
       "bookmark([name])"
 
 bookmarks X and X2 moved to rev 1, Y at rev -1
 
   $ hg bookmarks
      X                         0:f7b1eb17ad24
    * X2                        1:925d80f479bb
      Y                         -1:000000000000
 
 bookmark rev 0 again
 
   $ hg bookmark -r 0 Z
 
   $ hg update X
   0 files updated, 0 files merged, 1 files removed, 0 files unresolved
   $ echo c > c
   $ hg add c
   $ hg commit -m 2
   created new head
 
 bookmarks X moved to rev 2, Y at rev -1, Z at rev 0
 
   $ hg bookmarks
    * X                         2:db815d6d32e6
      X2                        1:925d80f479bb
      Y                         -1:000000000000
      Z                         0:f7b1eb17ad24
 
 rename nonexistent bookmark
 
   $ hg bookmark -m A B
   abort: bookmark 'A' does not exist
   [255]
 
 rename to existent bookmark
 
   $ hg bookmark -m X Y
   abort: bookmark 'Y' already exists (use -f to force)
   [255]
 
 force rename to existent bookmark
 
   $ hg bookmark -f -m X Y
 
 list bookmarks
 
   $ hg bookmark
      X2                        1:925d80f479bb
    * Y                         2:db815d6d32e6
      Z                         0:f7b1eb17ad24
 
 bookmarks from a revset
   $ hg bookmark -r '.^1' REVSET
   $ hg bookmark -r ':tip' TIP
   $ hg bookmarks
      REVSET                    0:f7b1eb17ad24
    * TIP                       2:db815d6d32e6
      X2                        1:925d80f479bb
      Y                         2:db815d6d32e6
      Z                         0:f7b1eb17ad24
 
   $ hg bookmark -d REVSET
   $ hg bookmark -d TIP
 
 rename without new name
 
   $ hg bookmark -m Y
   abort: new bookmark name required
   [255]
 
 delete without name
 
   $ hg bookmark -d
   abort: bookmark name required
   [255]
 
 delete nonexistent bookmark
 
   $ hg bookmark -d A
   abort: bookmark 'A' does not exist
   [255]
 
 bookmark name with spaces should be stripped
 
   $ hg bookmark ' x  y '
 
 list bookmarks
 
   $ hg bookmarks
      X2                        1:925d80f479bb
      Y                         2:db815d6d32e6
      Z                         0:f7b1eb17ad24
    * x  y                      2:db815d6d32e6
 
 look up stripped bookmark name
 
   $ hg log -r '"x  y"'
   changeset:   2:db815d6d32e6
   bookmark:    Y
   bookmark:    x  y
   tag:         tip
   parent:      0:f7b1eb17ad24
   user:        test
   date:        Thu Jan 01 00:00:00 1970 +0000
   summary:     2
   
 
 reject bookmark name with newline
 
   $ hg bookmark '
   > '
   abort: bookmark names cannot consist entirely of whitespace
   [255]
 
   $ hg bookmark -m Z '
   > '
   abort: bookmark names cannot consist entirely of whitespace
   [255]
 
+bookmark with reserved name
+
+  $ hg bookmark tip
+  abort: the name 'tip' is reserved
+  [255]
+
+  $ hg bookmark .
+  abort: the name '.' is reserved
+  [255]
+
+  $ hg bookmark null
+  abort: the name 'null' is reserved
+  [255]
+
+
 bookmark with existing name
 
   $ hg bookmark Z
   abort: bookmark 'Z' already exists (use -f to force)
   [255]
 
   $ hg bookmark -m Y Z
   abort: bookmark 'Z' already exists (use -f to force)
   [255]
 
 bookmark with name of branch
 
   $ hg bookmark default
   abort: a bookmark cannot have the name of an existing branch
   [255]
 
   $ hg bookmark -m Y default
   abort: a bookmark cannot have the name of an existing branch
   [255]
 
 incompatible options
 
   $ hg bookmark -m Y -d Z
   abort: --delete and --rename are incompatible
   [255]
 
   $ hg bookmark -r 1 -d Z
   abort: --rev is incompatible with --delete
   [255]
 
   $ hg bookmark -r 1 -m Z Y
   abort: --rev is incompatible with --rename
   [255]
 
 force bookmark with existing name
 
   $ hg bookmark -f Z
 
 list bookmarks
 
   $ hg bookmark
      X2                        1:925d80f479bb
      Y                         2:db815d6d32e6
    * Z                         2:db815d6d32e6
      x  y                      2:db815d6d32e6
 
 revision but no bookmark name
 
   $ hg bookmark -r .
   abort: bookmark name required
   [255]
 
 bookmark name with whitespace only
 
   $ hg bookmark ' '
   abort: bookmark names cannot consist entirely of whitespace
   [255]
 
   $ hg bookmark -m Y ' '
   abort: bookmark names cannot consist entirely of whitespace
   [255]
 
 invalid bookmark
 
   $ hg bookmark 'foo:bar'
   abort: bookmark 'foo:bar' contains illegal character
   [255]
 
 the bookmark extension should be ignored now that it is part of core
 
   $ echo "[extensions]" >> $HGRCPATH
   $ echo "bookmarks=" >> $HGRCPATH
   $ hg bookmarks
      X2                        1:925d80f479bb
      Y                         2:db815d6d32e6
    * Z                         2:db815d6d32e6
      x  y                      2:db815d6d32e6
 
 test summary
 
   $ hg summary
   parent: 2:db815d6d32e6 tip
    2
   branch: default
   bookmarks: *Z Y x  y
   commit: (clean)
   update: 1 new changesets, 2 branch heads (merge)
 
 test id
 
   $ hg id
   db815d6d32e6 tip Y/Z/x  y
 
 test rollback
 
   $ echo foo > f1
   $ hg ci -Amr
   adding f1
   $ hg bookmark -f Y -r 1
   $ hg bookmark -f Z -r 1
   $ hg rollback
   repository tip rolled back to revision 2 (undo commit)
   working directory now based on revision 2
   $ hg bookmarks
      X2                        1:925d80f479bb
      Y                         2:db815d6d32e6
    * Z                         2:db815d6d32e6
      x  y                      2:db815d6d32e6
 
 test clone
 
   $ hg bookmark -r 2 -i @
   $ hg bookmark -r 2 -i a@
   $ hg bookmarks
      @                         2:db815d6d32e6
      X2                        1:925d80f479bb
      Y                         2:db815d6d32e6
    * Z                         2:db815d6d32e6
      a@                        2:db815d6d32e6
      x  y                      2:db815d6d32e6
   $ hg clone . cloned-bookmarks
   updating to branch default
   2 files updated, 0 files merged, 0 files removed, 0 files unresolved
   $ hg -R cloned-bookmarks bookmarks
      @                         2:db815d6d32e6
      X2                        1:925d80f479bb
      Y                         2:db815d6d32e6
      Z                         2:db815d6d32e6
      a@                        2:db815d6d32e6
      x  y                      2:db815d6d32e6
 
 test clone with pull protocol
 
   $ hg clone --pull . cloned-bookmarks-pull
   requesting all changes
   adding changesets
   adding manifests
   adding file changes
   added 3 changesets with 3 changes to 3 files (+1 heads)
   updating to branch default
   2 files updated, 0 files merged, 0 files removed, 0 files unresolved
   $ hg -R cloned-bookmarks-pull bookmarks
      @                         2:db815d6d32e6
      X2                        1:925d80f479bb
      Y                         2:db815d6d32e6
      Z                         2:db815d6d32e6
      a@                        2:db815d6d32e6
      x  y                      2:db815d6d32e6
 
   $ hg bookmark -d @
   $ hg bookmark -d a@
 
 test clone with a specific revision
 
   $ hg clone -r 925d80 . cloned-bookmarks-rev
   adding changesets
   adding manifests
   adding file changes
   added 2 changesets with 2 changes to 2 files
   updating to branch default
   2 files updated, 0 files merged, 0 files removed, 0 files unresolved
   $ hg -R cloned-bookmarks-rev bookmarks
      X2                        1:925d80f479bb
 
 test clone with update to a bookmark
 
   $ hg clone -u Z . cloned-bookmarks-update
   updating to branch default
   2 files updated, 0 files merged, 0 files removed, 0 files unresolved
   $ hg -R cloned-bookmarks-update bookmarks
      X2                        1:925d80f479bb
      Y                         2:db815d6d32e6
    * Z                         2:db815d6d32e6
      x  y                      2:db815d6d32e6
 
 create bundle with two heads
 
   $ hg clone . tobundle
   updating to branch default
   2 files updated, 0 files merged, 0 files removed, 0 files unresolved
   $ echo x > tobundle/x
   $ hg -R tobundle add tobundle/x
   $ hg -R tobundle commit -m'x'
   $ hg -R tobundle update -r -2
   0 files updated, 0 files merged, 1 files removed, 0 files unresolved
   $ echo y > tobundle/y
   $ hg -R tobundle branch test
   marked working directory as branch test
   (branches are permanent and global, did you want a bookmark?)
   $ hg -R tobundle add tobundle/y
   $ hg -R tobundle commit -m'y'
   $ hg -R tobundle bundle tobundle.hg
   searching for changes
   2 changesets found
   $ hg unbundle tobundle.hg
   adding changesets
   adding manifests
   adding file changes
   added 2 changesets with 2 changes to 2 files (+1 heads)
   (run 'hg heads' to see heads, 'hg merge' to merge)
   $ hg update
   1 files updated, 0 files merged, 0 files removed, 0 files unresolved
   $ hg bookmarks
      X2                        1:925d80f479bb
      Y                         2:db815d6d32e6
    * Z                         3:125c9a1d6df6
      x  y                      2:db815d6d32e6
 
 test wrongly formated bookmark
 
   $ echo '' >> .hg/bookmarks
   $ hg bookmarks
      X2                        1:925d80f479bb
      Y                         2:db815d6d32e6
    * Z                         3:125c9a1d6df6
      x  y                      2:db815d6d32e6
   $ echo "Ican'thasformatedlines" >> .hg/bookmarks
   $ hg bookmarks
   malformed line in .hg/bookmarks: "Ican'thasformatedlines"
      X2                        1:925d80f479bb
      Y                         2:db815d6d32e6
    * Z                         3:125c9a1d6df6
      x  y                      2:db815d6d32e6
 
 test missing revisions
 
   $ echo "925d80f479bc z" > .hg/bookmarks
   $ hg book
   no bookmarks set
 
 test stripping a non-checked-out but bookmarked revision
 
   $ hg --config extensions.graphlog= log --graph
   o  changeset:   4:9ba5f110a0b3
   |  branch:      test
   |  tag:         tip
   |  parent:      2:db815d6d32e6
   |  user:        test
   |  date:        Thu Jan 01 00:00:00 1970 +0000
   |  summary:     y
   |
   | @  changeset:   3:125c9a1d6df6
   |/   user:        test
   |    date:        Thu Jan 01 00:00:00 1970 +0000
   |    summary:     x
   |
   o  changeset:   2:db815d6d32e6
   |  parent:      0:f7b1eb17ad24
   |  user:        test
   |  date:        Thu Jan 01 00:00:00 1970 +0000
   |  summary:     2
   |
   | o  changeset:   1:925d80f479bb
   |/   user:        test
   |    date:        Thu Jan 01 00:00:00 1970 +0000
   |    summary:     1
   |
   o  changeset:   0:f7b1eb17ad24
      user:        test
      date:        Thu Jan 01 00:00:00 1970 +0000
      summary:     0
   
   $ hg book should-end-on-two
   $ hg co --clean 4
   1 files updated, 0 files merged, 1 files removed, 0 files unresolved
   $ hg book four
   $ hg --config extensions.mq= strip 3
   saved backup bundle to * (glob)
 should-end-on-two should end up pointing to revision 2, as that's the
 tipmost surviving ancestor of the stripped revision.
   $ hg --config extensions.graphlog= log --graph
   @  changeset:   3:9ba5f110a0b3
   |  branch:      test
   |  bookmark:    four
   |  tag:         tip
   |  user:        test
   |  date:        Thu Jan 01 00:00:00 1970 +0000
   |  summary:     y
   |
   o  changeset:   2:db815d6d32e6
   |  bookmark:    should-end-on-two
   |  parent:      0:f7b1eb17ad24
   |  user:        test
   |  date:        Thu Jan 01 00:00:00 1970 +0000
   |  summary:     2
   |
   | o  changeset:   1:925d80f479bb
   |/   user:        test
   |    date:        Thu Jan 01 00:00:00 1970 +0000
   |    summary:     1
   |
   o  changeset:   0:f7b1eb17ad24
      user:        test
      date:        Thu Jan 01 00:00:00 1970 +0000
      summary:     0