26
25
sha_file, appendpath, file_kind
28
from bzrlib.errors import (BzrError, InvalidRevisionNumber, InvalidRevisionId,
27
from bzrlib.errors import BzrError, InvalidRevisionNumber, InvalidRevisionId
30
29
from bzrlib.textui import show_status
31
30
from bzrlib.revision import Revision
31
from bzrlib.xml import unpack_xml
32
32
from bzrlib.delta import compare_trees
33
33
from bzrlib.tree import EmptyTree, RevisionTree
34
from bzrlib.inventory import Inventory
35
from bzrlib.weavestore import WeaveStore
36
from bzrlib.store import ImmutableStore
41
INVENTORY_FILEID = '__inventory'
42
ANCESTRY_FILEID = '__ancestry'
45
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
46
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
38
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
47
39
## TODO: Maybe include checks for common corruption of newlines, etc?
50
42
# TODO: Some operations like log might retrieve the same revisions
51
43
# repeatedly to calculate deltas. We could perhaps have a weakref
52
# cache in memory to make this faster. In general anything can be
53
# cached in memory between lock and unlock operations.
44
# cache in memory to make this faster.
55
46
# TODO: please move the revision-string syntax stuff out of the branch
56
47
# object; it's clutter
266
262
self._lock = None
267
263
self._lock_mode = self._lock_count = None
269
266
def abspath(self, name):
270
267
"""Return absolute filename for something in the branch"""
271
268
return os.path.join(self.base, name)
273
271
def relpath(self, path):
274
272
"""Return path relative to this branch of something inside it.
276
274
Raises an error if path is not in this branch."""
277
275
return _relpath(self.base, path)
279
278
def controlfilename(self, file_or_path):
280
279
"""Return location relative to branch."""
281
280
if isinstance(file_or_path, basestring):
309
308
raise BzrError("invalid controlfile mode %r" % mode)
311
312
def _make_control(self):
313
from bzrlib.inventory import Inventory
314
from bzrlib.xml import pack_xml
312
316
os.mkdir(self.controlfilename([]))
313
317
self.controlfile('README', 'w').write(
314
318
"This is a Bazaar-NG control directory.\n"
315
319
"Do not change any files in this directory.\n")
316
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT_5)
317
for d in ('text-store', 'revision-store',
320
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
321
for d in ('text-store', 'inventory-store', 'revision-store'):
319
322
os.mkdir(self.controlfilename(d))
320
323
for f in ('revision-history', 'merged-patches',
321
324
'pending-merged-patches', 'branch-name',
327
330
# if we want per-tree root ids then this is the place to set
328
331
# them; they're not needed for now and so ommitted for
330
f = self.controlfile('inventory','w')
331
bzrlib.xml5.serializer_v5.write_inventory(Inventory(), f)
333
pack_xml(Inventory(), self.controlfile('inventory','w'))
335
336
def _check_format(self):
336
337
"""Check this branch format is supported.
338
The format level is stored, as an integer, in
339
self._branch_format for code that needs to check it later.
339
The current tool only supports the current unstable format.
341
341
In the future, we might need different in-memory Branch
342
342
classes to support downlevel branches. But not yet.
344
# This ignores newlines so that we can open branches created
345
# on Windows from Linux and so on. I think it might be better
346
# to always make all internal files in unix format.
344
347
fmt = self.controlfile('branch-format', 'r').read()
345
if fmt == BZR_BRANCH_FORMAT_5:
346
self._branch_format = 5
348
raise BzrError('sorry, branch format "%s" not supported; '
349
'use a different bzr version, '
350
'or run "bzr upgrade", '
351
'or remove the .bzr directory and "bzr init" again'
352
% fmt.rstrip('\n\r'))
348
fmt.replace('\r\n', '')
349
if fmt != BZR_BRANCH_FORMAT:
350
raise BzrError('sorry, branch format %r not supported' % fmt,
351
['use a different bzr version',
352
'or remove the .bzr directory and "bzr init" again'])
354
354
def get_root_id(self):
355
355
"""Return the id of this branches root"""
371
371
def read_working_inventory(self):
372
372
"""Read the working inventory."""
373
from bzrlib.inventory import Inventory
374
from bzrlib.xml import unpack_xml
375
from time import time
375
379
# ElementTree does its own conversion from UTF-8, so open in
377
f = self.controlfile('inventory', 'rb')
378
return bzrlib.xml5.serializer_v5.read_inventory(f)
381
inv = unpack_xml(Inventory,
382
self.controlfile('inventory', 'rb'))
383
mutter("loaded inventory of %d items in %f"
384
% (len(inv), time() - before))
406
414
"""Inventory for the working copy.""")
409
def add(self, files, ids=None):
417
def add(self, files, verbose=False, ids=None):
410
418
"""Make files versioned.
412
Note that the command line normally calls smart_add instead,
413
which can automatically recurse.
420
Note that the command line normally calls smart_add instead.
415
422
This puts the files in the Added state, so that they will be
416
423
recorded by the next commit.
426
433
TODO: Perhaps have an option to add the ids even if the files do
429
TODO: Perhaps yield the ids and paths as they're added.
436
TODO: Perhaps return the ids of the files? But then again it
437
is easy to retrieve them if they're needed.
439
TODO: Adding a directory should optionally recurse down and
440
add all non-ignored children. Perhaps do that in a
431
443
# TODO: Re-adding a file that is removed in the working copy
432
444
# should probably put it back with the previous ID.
586
def get_revision_xml_file(self, revision_id):
601
def get_revision_xml(self, revision_id):
587
602
"""Return XML file object for revision object."""
588
603
if not revision_id or not isinstance(revision_id, basestring):
589
604
raise InvalidRevisionId(revision_id)
602
get_revision_xml = get_revision_xml_file
605
616
def get_revision(self, revision_id):
606
617
"""Return the Revision object for a named revision"""
607
xml_file = self.get_revision_xml_file(revision_id)
618
xml_file = self.get_revision_xml(revision_id)
610
r = bzrlib.xml5.serializer_v5.read_revision(xml_file)
621
r = unpack_xml(Revision, xml_file)
611
622
except SyntaxError, e:
612
623
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
651
662
return bzrlib.osutils.sha_file(self.get_revision_xml(revision_id))
654
def get_ancestry(self, revision_id):
655
"""Return a list of revision-ids integrated by a revision.
657
w = self.weave_store.get_weave(ANCESTRY_FILEID)
659
return [l[:-1] for l in w.get_iter(w.lookup(revision_id))]
662
def get_inventory_weave(self):
663
return self.weave_store.get_weave(INVENTORY_FILEID)
666
def get_inventory(self, revision_id):
667
"""Get Inventory object by hash."""
668
# FIXME: The text gets passed around a lot coming from the weave.
669
f = StringIO(self.get_inventory_xml(revision_id))
670
return bzrlib.xml5.serializer_v5.read_inventory(f)
673
def get_inventory_xml(self, revision_id):
665
def get_inventory(self, inventory_id):
666
"""Get Inventory object by hash.
668
TODO: Perhaps for this and similar methods, take a revision
669
parameter which can be either an integer revno or a
671
from bzrlib.inventory import Inventory
672
from bzrlib.xml import unpack_xml
674
return unpack_xml(Inventory, self.get_inventory_xml(inventory_id))
677
def get_inventory_xml(self, inventory_id):
674
678
"""Get inventory XML as a file object."""
676
assert isinstance(revision_id, basestring), type(revision_id)
677
iw = self.get_inventory_weave()
678
return iw.get_text(iw.lookup(revision_id))
680
raise bzrlib.errors.HistoryMissing(self, 'inventory', revision_id)
683
def get_inventory_sha1(self, revision_id):
679
return self.inventory_store[inventory_id]
682
def get_inventory_sha1(self, inventory_id):
684
683
"""Return the sha1 hash of the inventory entry
686
return self.get_revision(revision_id).inventory_sha1
685
return sha_file(self.get_inventory_xml(inventory_id))
689
688
def get_revision_inventory(self, revision_id):
690
689
"""Return inventory of a past revision."""
691
# bzr 0.0.6 and later imposes the constraint that the inventory_id
690
# bzr 0.0.6 imposes the constraint that the inventory_id
692
691
# must be the same as its revision, so this is trivial.
693
692
if revision_id == None:
693
from bzrlib.inventory import Inventory
694
694
return Inventory(self.get_root_id())
696
696
return self.get_inventory(revision_id)
716
716
>>> sb = ScratchBranch(files=['foo', 'foo~'])
717
717
>>> sb.common_ancestor(sb) == (None, None)
719
>>> commit.commit(sb, "Committing first revision")
719
>>> commit.commit(sb, "Committing first revision", verbose=False)
720
720
>>> sb.common_ancestor(sb)[0]
722
722
>>> clone = sb.clone()
723
>>> commit.commit(sb, "Committing second revision")
723
>>> commit.commit(sb, "Committing second revision", verbose=False)
724
724
>>> sb.common_ancestor(sb)[0]
726
726
>>> sb.common_ancestor(clone)[0]
728
>>> commit.commit(clone, "Committing divergent second revision")
728
>>> commit.commit(clone, "Committing divergent second revision",
729
730
>>> sb.common_ancestor(clone)[0]
731
732
>>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
835
836
## note("Added %d revisions." % count)
841
def install_revisions(self, other, revision_ids, pb):
842
if hasattr(other.revision_store, "prefetch"):
843
other.revision_store.prefetch(revision_ids)
844
if hasattr(other.inventory_store, "prefetch"):
845
inventory_ids = [other.get_revision(r).inventory_id
846
for r in revision_ids]
847
other.inventory_store.prefetch(inventory_ids)
850
pb = bzrlib.ui.ui_factory.progress_bar()
857
for i, rev_id in enumerate(revision_ids):
858
pb.update('fetching revision', i+1, len(revision_ids))
860
rev = other.get_revision(rev_id)
861
except bzrlib.errors.NoSuchRevision:
865
revisions.append(rev)
866
inv = other.get_inventory(str(rev.inventory_id))
867
for key, entry in inv.iter_entries():
868
if entry.text_id is None:
870
if entry.text_id not in self.text_store:
871
needed_texts.add(entry.text_id)
875
count, cp_fail = self.text_store.copy_multi(other.text_store,
877
#print "Added %d texts." % count
878
inventory_ids = [ f.inventory_id for f in revisions ]
879
count, cp_fail = self.inventory_store.copy_multi(other.inventory_store,
881
#print "Added %d inventories." % count
882
revision_ids = [ f.revision_id for f in revisions]
884
count, cp_fail = self.revision_store.copy_multi(other.revision_store,
887
assert len(cp_fail) == 0
888
return count, failures
839
891
def commit(self, *args, **kw):
840
from bzrlib.commit import Commit
841
Commit().commit(self, *args, **kw)
892
from bzrlib.commit import commit
893
commit(self, *args, **kw)
844
896
def lookup_revision(self, revision):
845
897
"""Return the revision identifier for a given revision information."""
846
revno, info = self._get_revision_info(revision)
898
revno, info = self.get_revision_info(revision)
864
916
revision can also be a string, in which case it is parsed for something like
865
917
'date:' or 'revid:' etc.
867
revno, rev_id = self._get_revision_info(revision)
869
raise bzrlib.errors.NoSuchRevision(self, revision)
872
def get_rev_id(self, revno, history=None):
873
"""Find the revision id of the specified revno."""
877
history = self.revision_history()
878
elif revno <= 0 or revno > len(history):
879
raise bzrlib.errors.NoSuchRevision(self, revno)
880
return history[revno - 1]
882
def _get_revision_info(self, revision):
883
"""Return (revno, revision id) for revision specifier.
885
revision can be an integer, in which case it is assumed to be revno
886
(though this will translate negative values into positive ones)
887
revision can also be a string, in which case it is parsed for something
888
like 'date:' or 'revid:' etc.
890
A revid is always returned. If it is None, the specifier referred to
891
the null revision. If the revid does not occur in the revision
892
history, revno will be None.
895
919
if revision is None:
902
926
revs = self.revision_history()
903
927
if isinstance(revision, int):
930
# Mabye we should do this first, but we don't need it if revision == 0
905
932
revno = len(revs) + revision + 1
908
rev_id = self.get_rev_id(revno, revs)
909
935
elif isinstance(revision, basestring):
910
936
for prefix, func in Branch.REVISION_NAMESPACES.iteritems():
911
937
if revision.startswith(prefix):
912
result = func(self, revs, revision)
914
revno, rev_id = result
917
rev_id = self.get_rev_id(revno, revs)
938
revno = func(self, revs, revision)
920
raise BzrError('No namespace registered for string: %r' %
923
raise TypeError('Unhandled revision type %s' % revision)
941
raise BzrError('No namespace registered for string: %r' % revision)
927
raise bzrlib.errors.NoSuchRevision(self, revision)
943
if revno is None or revno <= 0 or revno > len(revs):
944
raise BzrError("no such revision %s" % revision)
945
return revno, revs[revno-1]
930
947
def _namespace_revno(self, revs, revision):
931
948
"""Lookup a revision by revision number"""
932
949
assert revision.startswith('revno:')
934
return (int(revision[6:]),)
951
return int(revision[6:])
935
952
except ValueError:
937
954
REVISION_NAMESPACES['revno:'] = _namespace_revno
939
956
def _namespace_revid(self, revs, revision):
940
957
assert revision.startswith('revid:')
941
rev_id = revision[len('revid:'):]
943
return revs.index(rev_id) + 1, rev_id
959
return revs.index(revision[6:]) + 1
944
960
except ValueError:
946
962
REVISION_NAMESPACES['revid:'] = _namespace_revid
948
964
def _namespace_last(self, revs, revision):
951
967
offset = int(revision[5:])
952
968
except ValueError:
956
972
raise BzrError('You must supply a positive value for --revision last:XXX')
957
return (len(revs) - offset + 1,)
973
return len(revs) - offset + 1
958
974
REVISION_NAMESPACES['last:'] = _namespace_last
960
976
def _namespace_tag(self, revs, revision):
1035
1051
# TODO: Handle timezone.
1036
1052
dt = datetime.datetime.fromtimestamp(r.timestamp)
1037
1053
if first >= dt and (last is None or dt >= last):
1040
1056
for i in range(len(revs)):
1041
1057
r = self.get_revision(revs[i])
1042
1058
# TODO: Handle timezone.
1043
1059
dt = datetime.datetime.fromtimestamp(r.timestamp)
1044
1060
if first <= dt and (last is None or dt <= last):
1046
1062
REVISION_NAMESPACES['date:'] = _namespace_date
1048
1064
def revision_tree(self, revision_id):
1177
1196
for f in from_paths:
1178
1197
name_tail = splitpath(f)[-1]
1179
1198
dest_path = appendpath(to_name, name_tail)
1180
result.append((f, dest_path))
1199
print "%s => %s" % (f, dest_path)
1181
1200
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1183
1202
os.rename(self.abspath(f), self.abspath(dest_path))
1281
def get_parent(self):
1282
"""Return the parent location of the branch.
1284
This is the default location for push/pull/missing. The usual
1285
pattern is that the user can override it by specifying a
1289
_locs = ['parent', 'pull', 'x-pull']
1292
return self.controlfile(l, 'r').read().strip('\n')
1294
if e.errno != errno.ENOENT:
1299
def set_parent(self, url):
1300
# TODO: Maybe delete old location files?
1301
from bzrlib.atomicfile import AtomicFile
1304
f = AtomicFile(self.controlfilename('parent'))
1313
def check_revno(self, revno):
1315
Check whether a revno corresponds to any revision.
1316
Zero (the NULL revision) is considered valid.
1319
self.check_real_revno(revno)
1321
def check_real_revno(self, revno):
1323
Check whether a revno corresponds to a real revision.
1324
Zero (the NULL revision) is considered invalid
1326
if revno < 1 or revno > self.revno():
1327
raise InvalidRevisionNumber(revno)
1332
1299
class ScratchBranch(Branch):
1333
1300
"""Special test class: a branch that cleans up after itself.
1452
1417
"""Return a new tree-root file id."""
1453
1418
return gen_file_id('TREE_ROOT')
1456
def pull_loc(branch):
1457
# TODO: Should perhaps just make attribute be 'base' in
1458
# RemoteBranch and Branch?
1459
if hasattr(branch, "baseurl"):
1460
return branch.baseurl
1465
def copy_branch(branch_from, to_location, revision=None):
1466
"""Copy branch_from into the existing directory to_location.
1469
If not None, only revisions up to this point will be copied.
1470
The head of the new branch will be that revision.
1473
The name of a local directory that exists but is empty.
1475
from bzrlib.merge import merge
1476
from bzrlib.branch import Branch
1478
assert isinstance(branch_from, Branch)
1479
assert isinstance(to_location, basestring)
1481
br_to = Branch(to_location, init=True)
1482
br_to.set_root_id(branch_from.get_root_id())
1483
if revision is None:
1484
revno = branch_from.revno()
1486
revno, rev_id = branch_from.get_revision_info(revision)
1487
br_to.update_revisions(branch_from, stop_revision=revno)
1488
merge((to_location, -1), (to_location, 0), this_dir=to_location,
1489
check_clean=False, ignore_zero=True)
1491
from_location = pull_loc(branch_from)
1492
br_to.set_parent(pull_loc(branch_from))