20
from cStringIO import StringIO
22
23
from bzrlib.trace import mutter, note
23
24
from bzrlib.osutils import isdir, quotefn, compact_date, rand_bytes, \
25
26
sha_file, appendpath, file_kind
26
from bzrlib.errors import BzrError, InvalidRevisionNumber, InvalidRevisionId
28
from bzrlib.errors import (BzrError, InvalidRevisionNumber, InvalidRevisionId,
28
30
from bzrlib.textui import show_status
29
31
from bzrlib.revision import Revision
30
from bzrlib.xml import unpack_xml
31
32
from bzrlib.delta import compare_trees
32
33
from bzrlib.tree import EmptyTree, RevisionTree
34
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
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"
35
47
## TODO: Maybe include checks for common corruption of newlines, etc?
38
50
# TODO: Some operations like log might retrieve the same revisions
39
51
# repeatedly to calculate deltas. We could perhaps have a weakref
40
# cache in memory to make this faster.
52
# cache in memory to make this faster. In general anything can be
53
# cached in memory between lock and unlock operations.
55
# TODO: please move the revision-string syntax stuff out of the branch
56
# object; it's clutter
43
59
def find_branch(f, **args):
297
309
raise BzrError("invalid controlfile mode %r" % mode)
301
311
def _make_control(self):
302
from bzrlib.inventory import Inventory
303
from bzrlib.xml import pack_xml
305
312
os.mkdir(self.controlfilename([]))
306
313
self.controlfile('README', 'w').write(
307
314
"This is a Bazaar-NG control directory.\n"
308
315
"Do not change any files in this directory.\n")
309
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
310
for d in ('text-store', 'inventory-store', 'revision-store'):
316
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT_5)
317
for d in ('text-store', 'revision-store',
311
319
os.mkdir(self.controlfilename(d))
312
320
for f in ('revision-history', 'merged-patches',
313
321
'pending-merged-patches', 'branch-name',
316
324
self.controlfile(f, 'w').write('')
317
325
mutter('created control directory in ' + self.base)
319
pack_xml(Inventory(gen_root_id()), self.controlfile('inventory','w'))
327
# if we want per-tree root ids then this is the place to set
328
# 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)
322
335
def _check_format(self):
323
336
"""Check this branch format is supported.
325
The current tool only supports the current unstable format.
338
The format level is stored, as an integer, in
339
self._branch_format for code that needs to check it later.
327
341
In the future, we might need different in-memory Branch
328
342
classes to support downlevel branches. But not yet.
330
# This ignores newlines so that we can open branches created
331
# on Windows from Linux and so on. I think it might be better
332
# to always make all internal files in unix format.
333
344
fmt = self.controlfile('branch-format', 'r').read()
334
fmt.replace('\r\n', '')
335
if fmt != BZR_BRANCH_FORMAT:
336
raise BzrError('sorry, branch format %r not supported' % fmt,
337
['use a different bzr version',
338
'or remove the .bzr directory and "bzr init" again'])
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'))
340
354
def get_root_id(self):
341
355
"""Return the id of this branches root"""
357
371
def read_working_inventory(self):
358
372
"""Read the working inventory."""
359
from bzrlib.inventory import Inventory
360
from bzrlib.xml import unpack_xml
361
from time import time
365
375
# ElementTree does its own conversion from UTF-8, so open in
367
inv = unpack_xml(Inventory,
368
self.controlfile('inventory', 'rb'))
369
mutter("loaded inventory of %d items in %f"
370
% (len(inv), time() - before))
377
f = self.controlfile('inventory', 'rb')
378
return bzrlib.xml5.serializer_v5.read_inventory(f)
595
594
return self.revision_store[revision_id]
596
595
except IndexError:
597
raise bzrlib.errors.NoSuchRevision(revision_id)
596
raise bzrlib.errors.NoSuchRevision(self, revision_id)
602
get_revision_xml = get_revision_xml_file
602
605
def get_revision(self, revision_id):
603
606
"""Return the Revision object for a named revision"""
604
xml_file = self.get_revision_xml(revision_id)
607
xml_file = self.get_revision_xml_file(revision_id)
607
r = unpack_xml(Revision, xml_file)
610
r = bzrlib.xml5.serializer_v5.read_revision(xml_file)
608
611
except SyntaxError, e:
609
612
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
648
651
return bzrlib.osutils.sha_file(self.get_revision_xml(revision_id))
651
def get_inventory(self, inventory_id):
652
"""Get Inventory object by hash.
654
TODO: Perhaps for this and similar methods, take a revision
655
parameter which can be either an integer revno or a
657
from bzrlib.inventory import Inventory
658
from bzrlib.xml import unpack_xml
660
return unpack_xml(Inventory, self.inventory_store[inventory_id])
663
def get_inventory_sha1(self, inventory_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):
674
"""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):
664
684
"""Return the sha1 hash of the inventory entry
666
return sha_file(self.inventory_store[inventory_id])
686
return self.get_revision(revision_id).inventory_sha1
669
689
def get_revision_inventory(self, revision_id):
670
690
"""Return inventory of a past revision."""
671
# bzr 0.0.6 imposes the constraint that the inventory_id
691
# bzr 0.0.6 and later imposes the constraint that the inventory_id
672
692
# must be the same as its revision, so this is trivial.
673
693
if revision_id == None:
674
from bzrlib.inventory import Inventory
675
694
return Inventory(self.get_root_id())
677
696
return self.get_inventory(revision_id)
697
716
>>> sb = ScratchBranch(files=['foo', 'foo~'])
698
717
>>> sb.common_ancestor(sb) == (None, None)
700
>>> commit.commit(sb, "Committing first revision", verbose=False)
719
>>> commit.commit(sb, "Committing first revision")
701
720
>>> sb.common_ancestor(sb)[0]
703
722
>>> clone = sb.clone()
704
>>> commit.commit(sb, "Committing second revision", verbose=False)
723
>>> commit.commit(sb, "Committing second revision")
705
724
>>> sb.common_ancestor(sb)[0]
707
726
>>> sb.common_ancestor(clone)[0]
709
>>> commit.commit(clone, "Committing divergent second revision",
728
>>> commit.commit(clone, "Committing divergent second revision")
711
729
>>> sb.common_ancestor(clone)[0]
713
731
>>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
794
812
if stop_revision is None:
795
813
stop_revision = other_len
796
814
elif stop_revision > other_len:
797
raise NoSuchRevision(self, stop_revision)
815
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
799
817
return other_history[self_len:stop_revision]
802
820
def update_revisions(self, other, stop_revision=None):
803
821
"""Pull in all new revisions from other branch.
805
>>> from bzrlib.commit import commit
806
>>> bzrlib.trace.silent = True
807
>>> br1 = ScratchBranch(files=['foo', 'bar'])
810
>>> commit(br1, "lala!", rev_id="REVISION-ID-1", verbose=False)
811
>>> br2 = ScratchBranch()
812
>>> br2.update_revisions(br1)
816
>>> br2.revision_history()
818
>>> br2.update_revisions(br1)
822
>>> br1.text_store.total_size() == br2.text_store.total_size()
825
from bzrlib.progress import ProgressBar
823
from bzrlib.fetch import greedy_fetch
825
pb = bzrlib.ui.ui_factory.progress_bar()
829
826
pb.update('comparing histories')
830
828
revision_ids = self.missing_revisions(other, stop_revision)
832
if hasattr(other.revision_store, "prefetch"):
833
other.revision_store.prefetch(revision_ids)
834
if hasattr(other.inventory_store, "prefetch"):
835
inventory_ids = [other.get_revision(r).inventory_id
836
for r in revision_ids]
837
other.inventory_store.prefetch(inventory_ids)
842
for rev_id in revision_ids:
844
pb.update('fetching revision', i, len(revision_ids))
845
rev = other.get_revision(rev_id)
846
revisions.append(rev)
847
inv = other.get_inventory(str(rev.inventory_id))
848
for key, entry in inv.iter_entries():
849
if entry.text_id is None:
851
if entry.text_id not in self.text_store:
852
needed_texts.add(entry.text_id)
830
if len(revision_ids) > 0:
831
count = greedy_fetch(self, other, revision_ids[-1], pb)[0]
834
self.append_revision(*revision_ids)
835
## note("Added %d revisions." % count)
856
count = self.text_store.copy_multi(other.text_store, needed_texts)
857
print "Added %d texts." % count
858
inventory_ids = [ f.inventory_id for f in revisions ]
859
count = self.inventory_store.copy_multi(other.inventory_store,
861
print "Added %d inventories." % count
862
revision_ids = [ f.revision_id for f in revisions]
863
count = self.revision_store.copy_multi(other.revision_store,
865
for revision_id in revision_ids:
866
self.append_revision(revision_id)
867
print "Added %d revisions." % count
870
839
def commit(self, *args, **kw):
871
from bzrlib.commit import commit
872
commit(self, *args, **kw)
840
from bzrlib.commit import Commit
841
Commit().commit(self, *args, **kw)
875
844
def lookup_revision(self, revision):
876
845
"""Return the revision identifier for a given revision information."""
877
revno, info = self.get_revision_info(revision)
846
revno, info = self._get_revision_info(revision)
850
def revision_id_to_revno(self, revision_id):
851
"""Given a revision id, return its revno"""
852
history = self.revision_history()
854
return history.index(revision_id) + 1
856
raise bzrlib.errors.NoSuchRevision(self, revision_id)
880
859
def get_revision_info(self, revision):
881
860
"""Return (revno, revision id) for revision identifier.
885
864
revision can also be a string, in which case it is parsed for something like
886
865
'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.
888
895
if revision is None:
895
902
revs = self.revision_history()
896
903
if isinstance(revision, int):
899
# Mabye we should do this first, but we don't need it if revision == 0
901
905
revno = len(revs) + revision + 1
908
rev_id = self.get_rev_id(revno, revs)
904
909
elif isinstance(revision, basestring):
905
910
for prefix, func in Branch.REVISION_NAMESPACES.iteritems():
906
911
if revision.startswith(prefix):
907
revno = func(self, revs, revision)
912
result = func(self, revs, revision)
914
revno, rev_id = result
917
rev_id = self.get_rev_id(revno, revs)
910
raise BzrError('No namespace registered for string: %r' % revision)
920
raise BzrError('No namespace registered for string: %r' %
923
raise TypeError('Unhandled revision type %s' % revision)
912
if revno is None or revno <= 0 or revno > len(revs):
913
raise BzrError("no such revision %s" % revision)
914
return revno, revs[revno-1]
927
raise bzrlib.errors.NoSuchRevision(self, revision)
916
930
def _namespace_revno(self, revs, revision):
917
931
"""Lookup a revision by revision number"""
918
932
assert revision.startswith('revno:')
920
return int(revision[6:])
934
return (int(revision[6:]),)
921
935
except ValueError:
923
937
REVISION_NAMESPACES['revno:'] = _namespace_revno
925
939
def _namespace_revid(self, revs, revision):
926
940
assert revision.startswith('revid:')
941
rev_id = revision[len('revid:'):]
928
return revs.index(revision[6:]) + 1
943
return revs.index(rev_id) + 1, rev_id
929
944
except ValueError:
931
946
REVISION_NAMESPACES['revid:'] = _namespace_revid
933
948
def _namespace_last(self, revs, revision):
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)
1268
1332
class ScratchBranch(Branch):
1269
1333
"""Special test class: a branch that cleans up after itself.
1386
1452
"""Return a new tree-root file id."""
1387
1453
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))