bookmarks.py
560 lines
| 17.9 KiB
| text/x-python
|
PythonLexer
/ mercurial / bookmarks.py
|
r13350 | # Mercurial bookmark support code | ||
# | ||||
# Copyright 2008 David Soria Parra <dsp@php.net> | ||||
# | ||||
# This software may be used and distributed according to the terms of the | ||||
# GNU General Public License version 2 or any later version. | ||||
|
r23360 | import os | ||
|
r13350 | from mercurial.i18n import _ | ||
|
r20025 | from mercurial.node import hex, bin | ||
|
r24962 | from mercurial import encoding, util, obsolete, lock as lockmod | ||
|
r19896 | import errno | ||
|
r13350 | |||
|
r17922 | class bmstore(dict): | ||
"""Storage for bookmarks. | ||||
This object should do all bookmark reads and writes, so that it's | ||||
fairly simple to replace the storage underlying bookmarks without | ||||
having to clone the logic surrounding bookmarks. | ||||
This particular bmstore implementation stores bookmarks as | ||||
{hash}\s{name}\n (the same format as localtags) in | ||||
.hg/bookmarks. The mapping is stored as {name: nodeid}. | ||||
|
r25100 | This class does NOT handle the "active" bookmark state at this | ||
|
r17922 | time. | ||
""" | ||||
|
r13351 | |||
|
r17922 | def __init__(self, repo): | ||
dict.__init__(self) | ||||
self._repo = repo | ||||
try: | ||||
|
r23458 | bkfile = self.getbkfile(repo) | ||
|
r23360 | for line in bkfile: | ||
|
r17922 | 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: | ||||
self[refspec] = repo.changelog.lookup(sha) | ||||
except LookupError: | ||||
pass | ||||
except IOError, inst: | ||||
if inst.errno != errno.ENOENT: | ||||
raise | ||||
|
r23458 | def getbkfile(self, repo): | ||
bkfile = None | ||||
if 'HG_PENDING' in os.environ: | ||||
try: | ||||
bkfile = repo.vfs('bookmarks.pending') | ||||
except IOError, inst: | ||||
if inst.errno != errno.ENOENT: | ||||
raise | ||||
if bkfile is None: | ||||
bkfile = repo.vfs('bookmarks') | ||||
return bkfile | ||||
|
r22665 | def recordchange(self, tr): | ||
"""record that bookmarks have been changed in a transaction | ||||
The transaction is then responsible for updating the file content.""" | ||||
tr.addfilegenerator('bookmarks', ('bookmarks',), self._write, | ||||
|
r23317 | location='plain') | ||
|
r22941 | tr.hookargs['bookmark_moved'] = '1' | ||
|
r22665 | |||
|
r17922 | def write(self): | ||
'''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. | ||||
''' | ||||
repo = self._repo | ||||
|
r23469 | self._writerepo(repo) | ||
|
r25569 | repo.invalidatevolatilesets() | ||
|
r23469 | |||
def _writerepo(self, repo): | ||||
"""Factored out for extensibility""" | ||||
|
r24947 | if repo._activebookmark not in self: | ||
|
r24944 | deactivate(repo) | ||
|
r17922 | |||
wlock = repo.wlock() | ||||
try: | ||||
file = repo.vfs('bookmarks', 'w', atomictemp=True) | ||||
|
r22664 | self._write(file) | ||
|
r17922 | file.close() | ||
# touch 00changelog.i so hgweb reloads bookmarks (no lock needed) | ||||
|
r14027 | try: | ||
|
r19896 | repo.svfs.utime('00changelog.i', None) | ||
|
r17922 | except OSError: | ||
|
r14027 | pass | ||
|
r17922 | |||
finally: | ||||
wlock.release() | ||||
|
r13351 | |||
|
r22664 | def _write(self, fp): | ||
for name, node in self.iteritems(): | ||||
fp.write("%s %s\n" % (hex(node), encoding.fromlocal(name))) | ||||
|
r24946 | def readactive(repo): | ||
""" | ||||
Get the active bookmark. We can have an active bookmark that updates | ||||
itself as we commit. This function returns the name of that bookmark. | ||||
It is stored in .hg/bookmarks.current | ||||
""" | ||||
|
r13351 | mark = None | ||
|
r14027 | try: | ||
|
r23877 | file = repo.vfs('bookmarks.current') | ||
|
r14027 | except IOError, inst: | ||
if inst.errno != errno.ENOENT: | ||||
raise | ||||
return None | ||||
try: | ||||
|
r17425 | # No readline() in osutil.posixfile, reading everything is cheap | ||
|
r13381 | mark = encoding.tolocal((file.readlines() or [''])[0]) | ||
|
r13627 | if mark == '' or mark not in repo._bookmarks: | ||
|
r13351 | mark = None | ||
|
r14027 | finally: | ||
|
r13351 | file.close() | ||
return mark | ||||
|
r24945 | def activate(repo, mark): | ||
""" | ||||
Set the given bookmark to be 'active', meaning that this bookmark will | ||||
follow new commits that are made. | ||||
|
r13350 | The name is recorded in .hg/bookmarks.current | ||
|
r24945 | """ | ||
|
r20100 | if mark not in repo._bookmarks: | ||
raise AssertionError('bookmark %s does not exist!' % mark) | ||||
|
r25100 | active = repo._activebookmark | ||
if active == mark: | ||||
|
r13350 | return | ||
|
r15908 | wlock = repo.wlock() | ||
|
r13350 | try: | ||
|
r23877 | file = repo.vfs('bookmarks.current', 'w', atomictemp=True) | ||
|
r14559 | file.write(encoding.fromlocal(mark)) | ||
|
r15057 | file.close() | ||
|
r13350 | finally: | ||
|
r15908 | wlock.release() | ||
|
r24947 | repo._activebookmark = mark | ||
|
r13352 | |||
|
r24944 | def deactivate(repo): | ||
""" | ||||
Unset the active bookmark in this reposiotry. | ||||
""" | ||||
|
r16191 | wlock = repo.wlock() | ||
try: | ||||
|
r25081 | repo.vfs.unlink('bookmarks.current') | ||
repo._activebookmark = None | ||||
except OSError, inst: | ||||
if inst.errno != errno.ENOENT: | ||||
raise | ||||
|
r16191 | finally: | ||
wlock.release() | ||||
|
r24986 | def isactivewdirparent(repo): | ||
""" | ||||
Tell whether the 'active' bookmark (the one that follows new commits) | ||||
points to one of the parents of the current working directory (wdir). | ||||
|
r18471 | |||
|
r24986 | While this is normally the case, it can on occasion be false; for example, | ||
immediately after a pull, the active bookmark can be moved to point | ||||
to a place different than the wdir. This is solved by running `hg update`. | ||||
""" | ||||
mark = repo._activebookmark | ||||
|
r18471 | marks = repo._bookmarks | ||
|
r24986 | parents = [p.node() for p in repo[None].parents()] | ||
|
r18471 | return (mark in marks and marks[mark] in parents) | ||
|
r18513 | def deletedivergent(repo, deletefrom, bm): | ||
'''Delete divergent versions of bm on nodes in deletefrom. | ||||
Return True if at least one bookmark was deleted, False otherwise.''' | ||||
deleted = False | ||||
marks = repo._bookmarks | ||||
divergent = [b for b in marks if b.split('@', 1)[0] == bm.split('@', 1)[0]] | ||||
for mark in divergent: | ||||
|
r21843 | if mark == '@' or '@' not in mark: | ||
# can't be divergent by definition | ||||
continue | ||||
|
r18513 | if mark and marks[mark] in deletefrom: | ||
if mark != bm: | ||||
del marks[mark] | ||||
deleted = True | ||||
return deleted | ||||
|
r19523 | def calculateupdate(ui, repo, checkout): | ||
'''Return a tuple (targetrev, movemarkfrom) indicating the rev to | ||||
check out and where to move the active bookmark from, if needed.''' | ||||
movemarkfrom = None | ||||
if checkout is None: | ||||
|
r25100 | activemark = repo._activebookmark | ||
|
r24986 | if isactivewdirparent(repo): | ||
|
r19523 | movemarkfrom = repo['.'].node() | ||
|
r25100 | elif activemark: | ||
ui.status(_("updating to active bookmark %s\n") % activemark) | ||||
checkout = activemark | ||||
|
r19523 | return (checkout, movemarkfrom) | ||
|
r13352 | def update(repo, parents, node): | ||
|
r19110 | deletefrom = parents | ||
|
r13352 | marks = repo._bookmarks | ||
update = False | ||||
|
r25100 | active = repo._activebookmark | ||
if not active: | ||||
|
r16706 | return False | ||
|
r25100 | if marks[active] in parents: | ||
|
r18513 | new = repo[node] | ||
|
r19110 | divs = [repo[b] for b in marks | ||
|
r25100 | if b.split('@', 1)[0] == active.split('@', 1)[0]] | ||
|
r19110 | anc = repo.changelog.ancestors([new.rev()]) | ||
deletefrom = [b.node() for b in divs if b.rev() in anc or b == new] | ||||
|
r25100 | if validdest(repo, repo[marks[active]], new): | ||
marks[active] = new.node() | ||||
|
r18513 | update = True | ||
|
r25100 | if deletedivergent(repo, deletefrom, active): | ||
|
r18513 | update = True | ||
|
r13352 | if update: | ||
|
r17922 | marks.write() | ||
|
r15621 | return update | ||
|
r13353 | |||
def listbookmarks(repo): | ||||
# We may try to list bookmarks on a repo type that does not | ||||
# support it (e.g., statichttprepository). | ||||
|
r14946 | marks = getattr(repo, '_bookmarks', {}) | ||
|
r13353 | |||
d = {} | ||||
|
r18496 | hasnode = repo.changelog.hasnode | ||
|
r14946 | for k, v in marks.iteritems(): | ||
|
r15613 | # don't expose local divergent bookmarks | ||
|
r18496 | if hasnode(v) and ('@' not in k or k.endswith('@')): | ||
|
r15613 | d[k] = hex(v) | ||
|
r13353 | return d | ||
def pushbookmark(repo, key, old, new): | ||||
|
r22667 | w = l = tr = None | ||
|
r13353 | try: | ||
|
r22667 | w = repo.wlock() | ||
l = repo.lock() | ||||
tr = repo.transaction('bookmarks') | ||||
|
r13353 | marks = repo._bookmarks | ||
|
r22364 | existing = hex(marks.get(key, '')) | ||
if existing != old and existing != new: | ||||
|
r13353 | return False | ||
if new == '': | ||||
del marks[key] | ||||
else: | ||||
if new not in repo: | ||||
return False | ||||
marks[key] = repo[new].node() | ||||
|
r22667 | marks.recordchange(tr) | ||
tr.close() | ||||
|
r13353 | return True | ||
finally: | ||||
|
r22667 | lockmod.release(tr, l, w) | ||
|
r13354 | |||
|
r20024 | def compare(repo, srcmarks, dstmarks, | ||
srchex=None, dsthex=None, targets=None): | ||||
'''Compare bookmarks between srcmarks and dstmarks | ||||
This returns tuple "(addsrc, adddst, advsrc, advdst, diverge, | ||||
differ, invalid)", each are list of bookmarks below: | ||||
:addsrc: added on src side (removed on dst side, perhaps) | ||||
:adddst: added on dst side (removed on src side, perhaps) | ||||
:advsrc: advanced on src side | ||||
:advdst: advanced on dst side | ||||
:diverge: diverge | ||||
:differ: changed, but changeset referred on src is unknown on dst | ||||
:invalid: unknown on both side | ||||
|
r23081 | :same: same on both side | ||
|
r20024 | |||
Each elements of lists in result tuple is tuple "(bookmark name, | ||||
changeset ID on source side, changeset ID on destination | ||||
side)". Each changeset IDs are 40 hexadecimal digit string or | ||||
None. | ||||
Changeset IDs of tuples in "addsrc", "adddst", "differ" or | ||||
"invalid" list may be unknown for repo. | ||||
This function expects that "srcmarks" and "dstmarks" return | ||||
changeset ID in 40 hexadecimal digit string for specified | ||||
bookmark. If not so (e.g. bmstore "repo._bookmarks" returning | ||||
binary value), "srchex" or "dsthex" should be specified to convert | ||||
into such form. | ||||
If "targets" is specified, only bookmarks listed in it are | ||||
examined. | ||||
''' | ||||
if not srchex: | ||||
srchex = lambda x: x | ||||
if not dsthex: | ||||
dsthex = lambda x: x | ||||
if targets: | ||||
bset = set(targets) | ||||
else: | ||||
srcmarkset = set(srcmarks) | ||||
dstmarkset = set(dstmarks) | ||||
|
r23081 | bset = srcmarkset | dstmarkset | ||
|
r20024 | |||
|
r23081 | results = ([], [], [], [], [], [], [], []) | ||
|
r20024 | addsrc = results[0].append | ||
adddst = results[1].append | ||||
advsrc = results[2].append | ||||
advdst = results[3].append | ||||
diverge = results[4].append | ||||
differ = results[5].append | ||||
invalid = results[6].append | ||||
|
r23081 | same = results[7].append | ||
|
r20024 | |||
for b in sorted(bset): | ||||
if b not in srcmarks: | ||||
if b in dstmarks: | ||||
adddst((b, None, dsthex(dstmarks[b]))) | ||||
else: | ||||
invalid((b, None, None)) | ||||
elif b not in dstmarks: | ||||
addsrc((b, srchex(srcmarks[b]), None)) | ||||
else: | ||||
scid = srchex(srcmarks[b]) | ||||
dcid = dsthex(dstmarks[b]) | ||||
|
r23081 | if scid == dcid: | ||
same((b, scid, dcid)) | ||||
elif scid in repo and dcid in repo: | ||||
|
r20024 | sctx = repo[scid] | ||
dctx = repo[dcid] | ||||
if sctx.rev() < dctx.rev(): | ||||
if validdest(repo, sctx, dctx): | ||||
advdst((b, scid, dcid)) | ||||
else: | ||||
diverge((b, scid, dcid)) | ||||
else: | ||||
if validdest(repo, dctx, sctx): | ||||
advsrc((b, scid, dcid)) | ||||
else: | ||||
diverge((b, scid, dcid)) | ||||
else: | ||||
# it is too expensive to examine in detail, in this case | ||||
differ((b, scid, dcid)) | ||||
return results | ||||
|
r24355 | def _diverge(ui, b, path, localmarks, remotenode): | ||
|
r24353 | '''Return appropriate diverged bookmark for specified ``path`` | ||
This returns None, if it is failed to assign any divergent | ||||
bookmark name. | ||||
|
r24355 | |||
This reuses already existing one with "@number" suffix, if it | ||||
refers ``remotenode``. | ||||
|
r24353 | ''' | ||
|
r20025 | if b == '@': | ||
b = '' | ||||
# try to use an @pathalias suffix | ||||
# if an @pathalias already exists, we overwrite (update) it | ||||
|
r22629 | if path.startswith("file:"): | ||
path = util.url(path).path | ||||
|
r20025 | for p, u in ui.configitems("paths"): | ||
|
r22629 | if u.startswith("file:"): | ||
u = util.url(u).path | ||||
|
r20025 | if path == u: | ||
|
r24354 | return '%s@%s' % (b, p) | ||
# assign a unique "@number" suffix newly | ||||
for x in range(1, 100): | ||||
n = '%s@%d' % (b, x) | ||||
|
r24355 | if n not in localmarks or localmarks[n] == remotenode: | ||
|
r24354 | return n | ||
return None | ||||
|
r20025 | |||
|
r22666 | def updatefromremote(ui, repo, remotemarks, path, trfunc, explicit=()): | ||
|
r13646 | ui.debug("checking for updated bookmarks\n") | ||
|
r17922 | localmarks = repo._bookmarks | ||
|
r23081 | (addsrc, adddst, advsrc, advdst, diverge, differ, invalid, same | ||
|
r20025 | ) = compare(repo, remotemarks, localmarks, dsthex=hex) | ||
|
r15614 | |||
|
r22644 | status = ui.status | ||
warn = ui.warn | ||||
if ui.configbool('ui', 'quietbookmarkmove', False): | ||||
status = warn = ui.debug | ||||
|
r22659 | explicit = set(explicit) | ||
|
r20025 | changed = [] | ||
for b, scid, dcid in addsrc: | ||||
if scid in repo: # add remote bookmarks for changes we already have | ||||
|
r22644 | changed.append((b, bin(scid), status, | ||
|
r20025 | _("adding remote bookmark %s\n") % (b))) | ||
|
r25564 | elif b in explicit: | ||
explicit.remove(b) | ||||
ui.warn(_("remote bookmark %s points to locally missing %s\n") | ||||
% (b, scid[:12])) | ||||
|
r20025 | for b, scid, dcid in advsrc: | ||
|
r22644 | changed.append((b, bin(scid), status, | ||
|
r20025 | _("updating bookmark %s\n") % (b))) | ||
|
r22659 | # remove normal movement from explicit set | ||
explicit.difference_update(d[0] for d in changed) | ||||
|
r20025 | for b, scid, dcid in diverge: | ||
|
r22659 | if b in explicit: | ||
explicit.discard(b) | ||||
changed.append((b, bin(scid), status, | ||||
|
r23199 | _("importing bookmark %s\n") % (b))) | ||
|
r22659 | else: | ||
|
r24355 | snode = bin(scid) | ||
db = _diverge(ui, b, path, localmarks, snode) | ||||
|
r24353 | if db: | ||
|
r24355 | changed.append((db, snode, warn, | ||
|
r24353 | _("divergent bookmark %s stored as %s\n") % | ||
(b, db))) | ||||
else: | ||||
warn(_("warning: failed to assign numbered name " | ||||
"to divergent bookmark %s\n") % (b)) | ||||
|
r22659 | for b, scid, dcid in adddst + advdst: | ||
if b in explicit: | ||||
explicit.discard(b) | ||||
changed.append((b, bin(scid), status, | ||||
|
r23199 | _("importing bookmark %s\n") % (b))) | ||
|
r25564 | for b, scid, dcid in differ: | ||
if b in explicit: | ||||
explicit.remove(b) | ||||
ui.warn(_("remote bookmark %s points to locally missing %s\n") | ||||
% (b, scid[:12])) | ||||
|
r22659 | |||
|
r13646 | if changed: | ||
|
r22666 | tr = trfunc() | ||
|
r20025 | for b, node, writer, msg in sorted(changed): | ||
localmarks[b] = node | ||||
writer(msg) | ||||
|
r22666 | localmarks.recordchange(tr) | ||
|
r13646 | |||
|
r24397 | def incoming(ui, repo, other): | ||
'''Show bookmarks incoming from other to repo | ||||
''' | ||||
ui.status(_("searching for changed bookmarks\n")) | ||||
r = compare(repo, other.listkeys('bookmarks'), repo._bookmarks, | ||||
dsthex=hex) | ||||
addsrc, adddst, advsrc, advdst, diverge, differ, invalid, same = r | ||||
incomings = [] | ||||
if ui.debugflag: | ||||
getid = lambda id: id | ||||
else: | ||||
getid = lambda id: id[:12] | ||||
|
r24660 | if ui.verbose: | ||
def add(b, id, st): | ||||
incomings.append(" %-25s %s %s\n" % (b, getid(id), st)) | ||||
else: | ||||
def add(b, id, st): | ||||
incomings.append(" %-25s %s\n" % (b, getid(id))) | ||||
|
r24397 | for b, scid, dcid in addsrc: | ||
|
r24832 | # i18n: "added" refers to a bookmark | ||
|
r24660 | add(b, scid, _('added')) | ||
|
r24657 | for b, scid, dcid in advsrc: | ||
|
r24832 | # i18n: "advanced" refers to a bookmark | ||
|
r24660 | add(b, scid, _('advanced')) | ||
|
r24657 | for b, scid, dcid in diverge: | ||
|
r24832 | # i18n: "diverged" refers to a bookmark | ||
|
r24660 | add(b, scid, _('diverged')) | ||
|
r24657 | for b, scid, dcid in differ: | ||
|
r24832 | # i18n: "changed" refers to a bookmark | ||
|
r24660 | add(b, scid, _('changed')) | ||
|
r24397 | |||
if not incomings: | ||||
ui.status(_("no changed bookmarks found\n")) | ||||
return 1 | ||||
for s in sorted(incomings): | ||||
ui.write(s) | ||||
return 0 | ||||
|
r24398 | def outgoing(ui, repo, other): | ||
'''Show bookmarks outgoing from repo to other | ||||
''' | ||||
ui.status(_("searching for changed bookmarks\n")) | ||||
r = compare(repo, repo._bookmarks, other.listkeys('bookmarks'), | ||||
srchex=hex) | ||||
addsrc, adddst, advsrc, advdst, diverge, differ, invalid, same = r | ||||
outgoings = [] | ||||
if ui.debugflag: | ||||
getid = lambda id: id | ||||
else: | ||||
getid = lambda id: id[:12] | ||||
|
r24661 | if ui.verbose: | ||
def add(b, id, st): | ||||
outgoings.append(" %-25s %s %s\n" % (b, getid(id), st)) | ||||
else: | ||||
def add(b, id, st): | ||||
outgoings.append(" %-25s %s\n" % (b, getid(id))) | ||||
|
r24398 | for b, scid, dcid in addsrc: | ||
|
r24832 | # i18n: "added refers to a bookmark | ||
|
r24661 | add(b, scid, _('added')) | ||
|
r24658 | for b, scid, dcid in adddst: | ||
|
r24832 | # i18n: "deleted" refers to a bookmark | ||
|
r24661 | add(b, ' ' * 40, _('deleted')) | ||
|
r24658 | for b, scid, dcid in advsrc: | ||
|
r24832 | # i18n: "advanced" refers to a bookmark | ||
|
r24661 | add(b, scid, _('advanced')) | ||
|
r24658 | for b, scid, dcid in diverge: | ||
|
r24832 | # i18n: "diverged" refers to a bookmark | ||
|
r24661 | add(b, scid, _('diverged')) | ||
|
r24658 | for b, scid, dcid in differ: | ||
|
r24832 | # i18n: "changed" refers to a bookmark | ||
|
r24661 | add(b, scid, _('changed')) | ||
|
r24398 | |||
if not outgoings: | ||||
ui.status(_("no changed bookmarks found\n")) | ||||
return 1 | ||||
for s in sorted(outgoings): | ||||
ui.write(s) | ||||
return 0 | ||||
|
r24400 | def summary(repo, other): | ||
'''Compare bookmarks between repo and other for "hg summary" output | ||||
This returns "(# of incoming, # of outgoing)" tuple. | ||||
''' | ||||
r = compare(repo, other.listkeys('bookmarks'), repo._bookmarks, | ||||
dsthex=hex) | ||||
addsrc, adddst, advsrc, advdst, diverge, differ, invalid, same = r | ||||
return (len(addsrc), len(adddst)) | ||||
|
r17550 | def validdest(repo, old, new): | ||
"""Is the new bookmark destination a valid update from the old one""" | ||||
|
r18008 | repo = repo.unfiltered() | ||
|
r17551 | if old == new: | ||
# Old == new -> nothing to update. | ||||
|
r17625 | return False | ||
|
r17551 | elif not old: | ||
# old is nullrev, anything is valid. | ||||
# (new != nullrev has been excluded by the previous check) | ||||
|
r17625 | return True | ||
|
r17551 | elif repo.obsstore: | ||
|
r18984 | return new.node() in obsolete.foreground(repo, [old.node()]) | ||
|
r17551 | else: | ||
|
r24180 | # still an independent clause as it is lazier (and therefore faster) | ||
|
r17627 | return old.descendant(new) | ||