15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21
22
from bzrlib.trace import mutter, note
22
from bzrlib.osutils import isdir, quotefn, compact_date, rand_bytes, splitpath, \
23
from bzrlib.osutils import isdir, quotefn, compact_date, rand_bytes, \
23
25
sha_file, appendpath, file_kind
24
from bzrlib.errors import BzrError
26
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
27
from bzrlib.errors import BzrError, InvalidRevisionNumber, InvalidRevisionId
29
from bzrlib.textui import show_status
30
from bzrlib.revision import Revision
31
from bzrlib.delta import compare_trees
32
from bzrlib.tree import EmptyTree, RevisionTree
38
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
39
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
27
40
## TODO: Maybe include checks for common corruption of newlines, etc?
43
# TODO: Some operations like log might retrieve the same revisions
44
# repeatedly to calculate deltas. We could perhaps have a weakref
45
# cache in memory to make this faster.
47
# TODO: please move the revision-string syntax stuff out of the branch
48
# object; it's clutter
31
51
def find_branch(f, **args):
32
52
if f and (f.startswith('http://') or f.startswith('https://')):
108
129
head, tail = os.path.split(f)
110
131
# reached the root, whatever that may be
111
raise BzrError('%r is not in a branch' % orig_f)
132
raise bzrlib.errors.NotBranchError('%s is not in a branch' % orig_f)
137
# XXX: move into bzrlib.errors; subclass BzrError
114
138
class DivergedBranches(Exception):
115
139
def __init__(self, branch1, branch2):
116
140
self.branch1 = branch1
118
142
Exception.__init__(self, "These branches have diverged.")
121
class NoSuchRevision(BzrError):
122
def __init__(self, branch, revision):
124
self.revision = revision
125
msg = "Branch %s has no revision %d" % (branch, revision)
126
BzrError.__init__(self, msg)
129
145
######################################################################
247
259
self._lock = None
248
260
self._lock_mode = self._lock_count = None
251
262
def abspath(self, name):
252
263
"""Return absolute filename for something in the branch"""
253
264
return os.path.join(self.base, name)
256
266
def relpath(self, path):
257
267
"""Return path relative to this branch of something inside it.
259
269
Raises an error if path is not in this branch."""
260
270
return _relpath(self.base, path)
263
272
def controlfilename(self, file_or_path):
264
273
"""Return location relative to branch."""
265
274
if isinstance(file_or_path, basestring):
293
302
raise BzrError("invalid controlfile mode %r" % mode)
297
304
def _make_control(self):
298
305
from bzrlib.inventory import Inventory
299
from bzrlib.xml import pack_xml
301
307
os.mkdir(self.controlfilename([]))
302
308
self.controlfile('README', 'w').write(
303
309
"This is a Bazaar-NG control directory.\n"
304
310
"Do not change any files in this directory.\n")
305
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
311
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT_5)
306
312
for d in ('text-store', 'inventory-store', 'revision-store'):
307
313
os.mkdir(self.controlfilename(d))
308
314
for f in ('revision-history', 'merged-patches',
312
318
self.controlfile(f, 'w').write('')
313
319
mutter('created control directory in ' + self.base)
315
pack_xml(Inventory(gen_root_id()), self.controlfile('inventory','w'))
321
# if we want per-tree root ids then this is the place to set
322
# them; they're not needed for now and so ommitted for
324
f = self.controlfile('inventory','w')
325
bzrlib.xml.serializer_v4.write_inventory(Inventory(), f)
318
328
def _check_format(self):
319
329
"""Check this branch format is supported.
321
The current tool only supports the current unstable format.
331
The format level is stored, as an integer, in
332
self._branch_format for code that needs to check it later.
323
334
In the future, we might need different in-memory Branch
324
335
classes to support downlevel branches. But not yet.
326
# This ignores newlines so that we can open branches created
327
# on Windows from Linux and so on. I think it might be better
328
# to always make all internal files in unix format.
329
337
fmt = self.controlfile('branch-format', 'r').read()
330
fmt.replace('\r\n', '')
331
if fmt != BZR_BRANCH_FORMAT:
332
raise BzrError('sorry, branch format %r not supported' % fmt,
333
['use a different bzr version',
334
'or remove the .bzr directory and "bzr init" again'])
338
if fmt == BZR_BRANCH_FORMAT_5:
339
self._branch_format = 5
341
raise BzrError('sorry, branch format "%s" not supported; '
342
'use a different bzr version, '
343
'or run "bzr upgrade", '
344
'or remove the .bzr directory and "bzr init" again'
336
347
def get_root_id(self):
337
348
"""Return the id of this branches root"""
353
364
def read_working_inventory(self):
354
365
"""Read the working inventory."""
355
366
from bzrlib.inventory import Inventory
356
from bzrlib.xml import unpack_xml
357
from time import time
361
369
# ElementTree does its own conversion from UTF-8, so open in
363
inv = unpack_xml(Inventory,
364
self.controlfile('inventory', 'rb'))
365
mutter("loaded inventory of %d items in %f"
366
% (len(inv), time() - before))
371
f = self.controlfile('inventory', 'rb')
372
return bzrlib.xml.serializer_v4.read_inventory(f)
396
400
"""Inventory for the working copy.""")
399
def add(self, files, verbose=False, ids=None):
403
def add(self, files, ids=None):
400
404
"""Make files versioned.
402
Note that the command line normally calls smart_add instead.
406
Note that the command line normally calls smart_add instead,
407
which can automatically recurse.
404
409
This puts the files in the Added state, so that they will be
405
410
recorded by the next commit.
415
420
TODO: Perhaps have an option to add the ids even if the files do
418
TODO: Perhaps return the ids of the files? But then again it
419
is easy to retrieve them if they're needed.
421
TODO: Adding a directory should optionally recurse down and
422
add all non-ignored children. Perhaps do that in a
423
TODO: Perhaps yield the ids and paths as they're added.
425
from bzrlib.textui import show_status
426
425
# TODO: Re-adding a file that is removed in the working copy
427
426
# should probably put it back with the previous ID.
428
427
if isinstance(files, basestring):
580
def get_revision_xml_file(self, revision_id):
581
"""Return XML file object for revision object."""
582
if not revision_id or not isinstance(revision_id, basestring):
583
raise InvalidRevisionId(revision_id)
588
return self.revision_store[revision_id]
590
raise bzrlib.errors.NoSuchRevision(self, revision_id)
596
get_revision_xml = get_revision_xml_file
585
599
def get_revision(self, revision_id):
586
600
"""Return the Revision object for a named revision"""
587
from bzrlib.revision import Revision
588
from bzrlib.xml import unpack_xml
601
xml_file = self.get_revision_xml_file(revision_id)
592
if not revision_id or not isinstance(revision_id, basestring):
593
raise ValueError('invalid revision-id: %r' % revision_id)
594
r = unpack_xml(Revision, self.revision_store[revision_id])
604
r = bzrlib.xml.serializer_v4.read_revision(xml_file)
605
except SyntaxError, e:
606
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
598
610
assert r.revision_id == revision_id
614
def get_revision_delta(self, revno):
615
"""Return the delta for one revision.
617
The delta is relative to its mainline predecessor, or the
618
empty tree for revision 1.
620
assert isinstance(revno, int)
621
rh = self.revision_history()
622
if not (1 <= revno <= len(rh)):
623
raise InvalidRevisionNumber(revno)
625
# revno is 1-based; list is 0-based
627
new_tree = self.revision_tree(rh[revno-1])
629
old_tree = EmptyTree()
631
old_tree = self.revision_tree(rh[revno-2])
633
return compare_trees(old_tree, new_tree)
602
637
def get_revision_sha1(self, revision_id):
607
642
# the revision, (add signatures/remove signatures) and still
608
643
# have all hash pointers stay consistent.
609
644
# But for now, just hash the contents.
610
return sha_file(self.revision_store[revision_id])
645
return bzrlib.osutils.sha_file(self.get_revision_xml(revision_id))
613
648
def get_inventory(self, inventory_id):
617
652
parameter which can be either an integer revno or a
619
654
from bzrlib.inventory import Inventory
620
from bzrlib.xml import unpack_xml
622
return unpack_xml(Inventory, self.inventory_store[inventory_id])
656
f = self.get_inventory_xml_file(inventory_id)
657
return bzrlib.xml.serializer_v4.read_inventory(f)
660
def get_inventory_xml(self, inventory_id):
661
"""Get inventory XML as a file object."""
662
return self.inventory_store[inventory_id]
664
get_inventory_xml_file = get_inventory_xml
625
667
def get_inventory_sha1(self, inventory_id):
626
668
"""Return the sha1 hash of the inventory entry
628
return sha_file(self.inventory_store[inventory_id])
670
return sha_file(self.get_inventory_xml(inventory_id))
631
673
def get_revision_inventory(self, revision_id):
697
739
return r+1, my_history[r]
698
740
return None, None
700
def enum_history(self, direction):
701
"""Return (revno, revision_id) for history of branch.
704
'forward' is from earliest to latest
705
'reverse' is from latest to earliest
707
rh = self.revision_history()
708
if direction == 'forward':
713
elif direction == 'reverse':
719
raise ValueError('invalid history direction', direction)
723
744
"""Return current revision number for this branch.
741
def missing_revisions(self, other, stop_revision=None):
762
def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
743
764
If self and other have not diverged, return a list of the revisions
744
765
present in other, but missing from self.
777
798
if stop_revision is None:
778
799
stop_revision = other_len
779
800
elif stop_revision > other_len:
780
raise NoSuchRevision(self, stop_revision)
801
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
782
803
return other_history[self_len:stop_revision]
785
806
def update_revisions(self, other, stop_revision=None):
786
807
"""Pull in all new revisions from other branch.
788
>>> from bzrlib.commit import commit
789
>>> bzrlib.trace.silent = True
790
>>> br1 = ScratchBranch(files=['foo', 'bar'])
793
>>> commit(br1, "lala!", rev_id="REVISION-ID-1", verbose=False)
794
>>> br2 = ScratchBranch()
795
>>> br2.update_revisions(br1)
799
>>> br2.revision_history()
801
>>> br2.update_revisions(br1)
805
>>> br1.text_store.total_size() == br2.text_store.total_size()
808
from bzrlib.progress import ProgressBar
809
from bzrlib.fetch import greedy_fetch
811
pb = bzrlib.ui.ui_factory.progress_bar()
812
812
pb.update('comparing histories')
813
814
revision_ids = self.missing_revisions(other, stop_revision)
816
if len(revision_ids) > 0:
817
count = greedy_fetch(self, other, revision_ids[-1], pb)[0]
820
self.append_revision(*revision_ids)
821
## note("Added %d revisions." % count)
824
def install_revisions(self, other, revision_ids, pb):
815
825
if hasattr(other.revision_store, "prefetch"):
816
826
other.revision_store.prefetch(revision_ids)
817
827
if hasattr(other.inventory_store, "prefetch"):
818
828
inventory_ids = [other.get_revision(r).inventory_id
819
829
for r in revision_ids]
820
830
other.inventory_store.prefetch(inventory_ids)
833
pb = bzrlib.ui.ui_factory.progress_bar()
823
836
needed_texts = set()
825
for rev_id in revision_ids:
827
pb.update('fetching revision', i, len(revision_ids))
828
rev = other.get_revision(rev_id)
840
for i, rev_id in enumerate(revision_ids):
841
pb.update('fetching revision', i+1, len(revision_ids))
843
rev = other.get_revision(rev_id)
844
except bzrlib.errors.NoSuchRevision:
829
848
revisions.append(rev)
830
849
inv = other.get_inventory(str(rev.inventory_id))
831
850
for key, entry in inv.iter_entries():
839
count = self.text_store.copy_multi(other.text_store, needed_texts)
840
print "Added %d texts." % count
858
count, cp_fail = self.text_store.copy_multi(other.text_store,
860
#print "Added %d texts." % count
841
861
inventory_ids = [ f.inventory_id for f in revisions ]
842
count = self.inventory_store.copy_multi(other.inventory_store,
844
print "Added %d inventories." % count
862
count, cp_fail = self.inventory_store.copy_multi(other.inventory_store,
864
#print "Added %d inventories." % count
845
865
revision_ids = [ f.revision_id for f in revisions]
846
count = self.revision_store.copy_multi(other.revision_store,
848
for revision_id in revision_ids:
849
self.append_revision(revision_id)
850
print "Added %d revisions." % count
867
count, cp_fail = self.revision_store.copy_multi(other.revision_store,
870
assert len(cp_fail) == 0
871
return count, failures
853
874
def commit(self, *args, **kw):
854
875
from bzrlib.commit import commit
855
876
commit(self, *args, **kw)
858
879
def lookup_revision(self, revision):
859
880
"""Return the revision identifier for a given revision information."""
860
revno, info = self.get_revision_info(revision)
881
revno, info = self._get_revision_info(revision)
885
def revision_id_to_revno(self, revision_id):
886
"""Given a revision id, return its revno"""
887
history = self.revision_history()
889
return history.index(revision_id) + 1
891
raise bzrlib.errors.NoSuchRevision(self, revision_id)
863
894
def get_revision_info(self, revision):
864
895
"""Return (revno, revision id) for revision identifier.
868
899
revision can also be a string, in which case it is parsed for something like
869
900
'date:' or 'revid:' etc.
902
revno, rev_id = self._get_revision_info(revision)
904
raise bzrlib.errors.NoSuchRevision(self, revision)
907
def get_rev_id(self, revno, history=None):
908
"""Find the revision id of the specified revno."""
912
history = self.revision_history()
913
elif revno <= 0 or revno > len(history):
914
raise bzrlib.errors.NoSuchRevision(self, revno)
915
return history[revno - 1]
917
def _get_revision_info(self, revision):
918
"""Return (revno, revision id) for revision specifier.
920
revision can be an integer, in which case it is assumed to be revno
921
(though this will translate negative values into positive ones)
922
revision can also be a string, in which case it is parsed for something
923
like 'date:' or 'revid:' etc.
925
A revid is always returned. If it is None, the specifier referred to
926
the null revision. If the revid does not occur in the revision
927
history, revno will be None.
871
930
if revision is None:
878
937
revs = self.revision_history()
879
938
if isinstance(revision, int):
882
# Mabye we should do this first, but we don't need it if revision == 0
884
940
revno = len(revs) + revision + 1
943
rev_id = self.get_rev_id(revno, revs)
887
944
elif isinstance(revision, basestring):
888
945
for prefix, func in Branch.REVISION_NAMESPACES.iteritems():
889
946
if revision.startswith(prefix):
890
revno = func(self, revs, revision)
947
result = func(self, revs, revision)
949
revno, rev_id = result
952
rev_id = self.get_rev_id(revno, revs)
893
raise BzrError('No namespace registered for string: %r' % revision)
955
raise BzrError('No namespace registered for string: %r' %
958
raise TypeError('Unhandled revision type %s' % revision)
895
if revno is None or revno <= 0 or revno > len(revs):
896
raise BzrError("no such revision %s" % revision)
897
return revno, revs[revno-1]
962
raise bzrlib.errors.NoSuchRevision(self, revision)
899
965
def _namespace_revno(self, revs, revision):
900
966
"""Lookup a revision by revision number"""
901
967
assert revision.startswith('revno:')
903
return int(revision[6:])
969
return (int(revision[6:]),)
904
970
except ValueError:
906
972
REVISION_NAMESPACES['revno:'] = _namespace_revno
908
974
def _namespace_revid(self, revs, revision):
909
975
assert revision.startswith('revid:')
976
rev_id = revision[len('revid:'):]
911
return revs.index(revision[6:]) + 1
978
return revs.index(rev_id) + 1, rev_id
912
979
except ValueError:
914
981
REVISION_NAMESPACES['revid:'] = _namespace_revid
916
983
def _namespace_last(self, revs, revision):
919
986
offset = int(revision[5:])
920
987
except ValueError:
924
991
raise BzrError('You must supply a positive value for --revision last:XXX')
925
return len(revs) - offset + 1
992
return (len(revs) - offset + 1,)
926
993
REVISION_NAMESPACES['last:'] = _namespace_last
928
995
def _namespace_tag(self, revs, revision):
1003
1070
# TODO: Handle timezone.
1004
1071
dt = datetime.datetime.fromtimestamp(r.timestamp)
1005
1072
if first >= dt and (last is None or dt >= last):
1008
1075
for i in range(len(revs)):
1009
1076
r = self.get_revision(revs[i])
1010
1077
# TODO: Handle timezone.
1011
1078
dt = datetime.datetime.fromtimestamp(r.timestamp)
1012
1079
if first <= dt and (last is None or dt <= last):
1014
1081
REVISION_NAMESPACES['date:'] = _namespace_date
1016
1083
def revision_tree(self, revision_id):
1019
1086
`revision_id` may be None for the null revision, in which case
1020
1087
an `EmptyTree` is returned."""
1021
from bzrlib.tree import EmptyTree, RevisionTree
1022
1088
# TODO: refactor this to use an existing revision object
1023
1089
# so we don't need to read it in twice.
1024
1090
if revision_id == None:
1025
return EmptyTree(self.get_root_id())
1027
1093
inv = self.get_revision_inventory(revision_id)
1028
1094
return RevisionTree(self.text_store, inv)
1150
1217
for f in from_paths:
1151
1218
name_tail = splitpath(f)[-1]
1152
1219
dest_path = appendpath(to_name, name_tail)
1153
print "%s => %s" % (f, dest_path)
1220
result.append((f, dest_path))
1154
1221
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1156
1223
os.rename(self.abspath(f), self.abspath(dest_path))
1321
def get_parent(self):
1322
"""Return the parent location of the branch.
1324
This is the default location for push/pull/missing. The usual
1325
pattern is that the user can override it by specifying a
1329
_locs = ['parent', 'pull', 'x-pull']
1332
return self.controlfile(l, 'r').read().strip('\n')
1334
if e.errno != errno.ENOENT:
1339
def set_parent(self, url):
1340
# TODO: Maybe delete old location files?
1341
from bzrlib.atomicfile import AtomicFile
1344
f = AtomicFile(self.controlfilename('parent'))
1353
def check_revno(self, revno):
1355
Check whether a revno corresponds to any revision.
1356
Zero (the NULL revision) is considered valid.
1359
self.check_real_revno(revno)
1361
def check_real_revno(self, revno):
1363
Check whether a revno corresponds to a real revision.
1364
Zero (the NULL revision) is considered invalid
1366
if revno < 1 or revno > self.revno():
1367
raise InvalidRevisionNumber(revno)
1253
1372
class ScratchBranch(Branch):
1254
1373
"""Special test class: a branch that cleans up after itself.
1371
1492
"""Return a new tree-root file id."""
1372
1493
return gen_file_id('TREE_ROOT')
1496
def pull_loc(branch):
1497
# TODO: Should perhaps just make attribute be 'base' in
1498
# RemoteBranch and Branch?
1499
if hasattr(branch, "baseurl"):
1500
return branch.baseurl
1505
def copy_branch(branch_from, to_location, revision=None):
1506
"""Copy branch_from into the existing directory to_location.
1509
If not None, only revisions up to this point will be copied.
1510
The head of the new branch will be that revision.
1513
The name of a local directory that exists but is empty.
1515
from bzrlib.merge import merge
1516
from bzrlib.branch import Branch
1518
assert isinstance(branch_from, Branch)
1519
assert isinstance(to_location, basestring)
1521
br_to = Branch(to_location, init=True)
1522
br_to.set_root_id(branch_from.get_root_id())
1523
if revision is None:
1524
revno = branch_from.revno()
1526
revno, rev_id = branch_from.get_revision_info(revision)
1527
br_to.update_revisions(branch_from, stop_revision=revno)
1528
merge((to_location, -1), (to_location, 0), this_dir=to_location,
1529
check_clean=False, ignore_zero=True)
1531
from_location = pull_loc(branch_from)
1532
br_to.set_parent(pull_loc(branch_from))