bookmarks: forbid \0 \r \n : in bookmark names (BC)

We restrict : to 1. make it easer to convert bookmarks to git branches,
2. use : later for a syntax to push a local bookmark to a remote bookmark
of a different name. \0, \n, \r are fobbidden they are used to separate
bookmarks in the bookmark file.

This change breaks backward compatbility as ':' was an allowed character in
previous versions.

mercurial/bookmarks.py

@@ -1,160 +1,176 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 nullid, nullrev, bin, hex, short
-from mercurial import encoding
+from mercurial import encoding, util
 import os
 
+def valid(mark):
+    for c in (':', '\0', '\n', '\r'):
+        if c in mark:
+            return False
+    return True
+
 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
     '''
     try:
         bookmarks = {}
         for line in repo.opener('bookmarks'):
             sha, refspec = line.strip().split(' ', 1)
             refspec = encoding.tolocal(refspec)
             bookmarks[refspec] = repo.changelog.lookup(sha)
     except:
         pass
     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
     if os.path.exists(repo.join('bookmarks.current')):
         file = repo.opener('bookmarks.current')
         # No readline() in posixfile_nt, reading everything is cheap
         mark = encoding.tolocal((file.readlines() or [''])[0])
         if mark == '':
             mark = None
         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
 
     try:
         bms = repo.opener('bookmarks').read()
     except IOError:
         bms = ''
     repo.opener('undo.bookmarks', 'w').write(bms)
 
     if repo._bookmarkcurrent not in refs:
         setcurrent(repo, None)
+    for mark in refs.keys():
+        if not valid(mark):
+            raise util.Abort(_("bookmark '%s' contains illegal "
+                "character" % 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.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 = ''
+    if not valid(mark):
+        raise util.Abort(_("bookmark '%s' contains illegal "
+            "character" % 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 update(repo, parents, node):
     marks = repo._bookmarks
     update = False
     mark = repo._bookmarkcurrent
     if mark and marks[mark] in parents:
         marks[mark] = node
         update = True
     if update:
         write(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 diff(ui, repo, remote):
     ui.status(_("searching for changed bookmarks\n"))
 
     lmarks = repo.listkeys('bookmarks')
     rmarks = remote.listkeys('bookmarks')
 
     diff = sorted(set(rmarks) - set(lmarks))
     for k in diff:
         ui.write("   %-25s %s\n" % (k, rmarks[k][:12]))
 
     if len(diff) <= 0:
         ui.status(_("no changed bookmarks found\n"))
         return 1
     return 0

tests/test-bookmarks.t

@@ -1,214 +1,221 b''
   $ echo "[extensions]" >> $HGRCPATH
   $ echo "bookmarks=" >> $HGRCPATH
 
   $ 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
   bookmark:    X2
   user:        test
   date:        Thu Jan 01 00:00:00 1970 +0000
   summary:     0
   
   $ hg log -r 'bookmark(Y)'
   $ hg log -r 'bookmark(X2)'
   changeset:   0:f7b1eb17ad24
   bookmark:    X
   bookmark:    X2
   user:        test
   date:        Thu Jan 01 00:00:00 1970 +0000
   summary:     0
   
   $ 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                        0:f7b1eb17ad24
      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                        0:f7b1eb17ad24
      Y                         -1:000000000000
      Z                         0:f7b1eb17ad24
 
 rename nonexistent bookmark
 
   $ hg bookmark -m A B
   abort: a bookmark of this name does not exist
   [255]
 
 rename to existent bookmark
 
   $ hg bookmark -m X Y
   abort: a bookmark of the same name already exists
   [255]
 
 force rename to existent bookmark
 
   $ hg bookmark -f -m X Y
 
 list bookmarks
 
   $ hg bookmark
      X2                        0:f7b1eb17ad24
    * Y                         2:db815d6d32e6
      Z                         0:f7b1eb17ad24
 
 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: a bookmark of this name does not exist
   [255]
 
 bookmark name with spaces should be stripped
 
   $ hg bookmark ' x  y '
 
 list bookmarks
 
   $ hg bookmarks
      X2                        0:f7b1eb17ad24
      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 name cannot contain newlines
   [255]
 
 bookmark with existing name
 
   $ hg bookmark Z
   abort: a bookmark of the same name already exists
   [255]
 
 force bookmark with existing name
 
   $ hg bookmark -f Z
 
 list bookmarks
 
   $ hg bookmark
      X2                        0:f7b1eb17ad24
      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]
+
+invalid bookmark
+
+  $ hg bookmark 'foo:bar'
+  abort: bookmark 'foo:bar' contains illegal character
+  [255]
+