15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22
21
from bzrlib.trace import mutter, note
23
from bzrlib.osutils import isdir, quotefn, compact_date, rand_bytes, \
22
from bzrlib.osutils import isdir, quotefn, compact_date, rand_bytes, splitpath, \
25
23
sha_file, appendpath, file_kind
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
24
from bzrlib.errors import BzrError
38
26
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
39
27
## TODO: Maybe include checks for common corruption of newlines, etc?
42
# TODO: Some operations like log might retrieve the same revisions
43
# repeatedly to calculate deltas. We could perhaps have a weakref
44
# cache in memory to make this faster.
46
# TODO: please move the revision-string syntax stuff out of the branch
47
# object; it's clutter
50
31
def find_branch(f, **args):
51
32
if f and (f.startswith('http://') or f.startswith('https://')):
258
247
self._lock = None
259
248
self._lock_mode = self._lock_count = None
261
251
def abspath(self, name):
262
252
"""Return absolute filename for something in the branch"""
263
253
return os.path.join(self.base, name)
265
256
def relpath(self, path):
266
257
"""Return path relative to this branch of something inside it.
268
259
Raises an error if path is not in this branch."""
269
260
return _relpath(self.base, path)
271
263
def controlfilename(self, file_or_path):
272
264
"""Return location relative to branch."""
273
265
if isinstance(file_or_path, basestring):
317
312
self.controlfile(f, 'w').write('')
318
313
mutter('created control directory in ' + self.base)
320
# if we want per-tree root ids then this is the place to set
321
# them; they're not needed for now and so ommitted for
323
f = self.controlfile('inventory','w')
324
bzrlib.xml.serializer_v4.write_inventory(Inventory(), f)
315
pack_xml(Inventory(gen_root_id()), self.controlfile('inventory','w'))
327
318
def _check_format(self):
336
327
# on Windows from Linux and so on. I think it might be better
337
328
# to always make all internal files in unix format.
338
329
fmt = self.controlfile('branch-format', 'r').read()
339
fmt = fmt.replace('\r\n', '\n')
330
fmt.replace('\r\n', '')
340
331
if fmt != BZR_BRANCH_FORMAT:
341
332
raise BzrError('sorry, branch format %r not supported' % fmt,
342
333
['use a different bzr version',
362
353
def read_working_inventory(self):
363
354
"""Read the working inventory."""
364
355
from bzrlib.inventory import Inventory
356
from bzrlib.xml import unpack_xml
357
from time import time
367
361
# ElementTree does its own conversion from UTF-8, so open in
369
f = self.controlfile('inventory', 'rb')
370
return bzrlib.xml.serializer_v4.read_inventory(f)
363
inv = unpack_xml(Inventory,
364
self.controlfile('inventory', 'rb'))
365
mutter("loaded inventory of %d items in %f"
366
% (len(inv), time() - before))
398
396
"""Inventory for the working copy.""")
401
def add(self, files, ids=None):
399
def add(self, files, verbose=False, ids=None):
402
400
"""Make files versioned.
404
Note that the command line normally calls smart_add instead,
405
which can automatically recurse.
402
Note that the command line normally calls smart_add instead.
407
404
This puts the files in the Added state, so that they will be
408
405
recorded by the next commit.
418
415
TODO: Perhaps have an option to add the ids even if the files do
421
TODO: Perhaps yield the ids and paths as they're added.
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
425
from bzrlib.textui import show_status
423
426
# TODO: Re-adding a file that is removed in the working copy
424
427
# should probably put it back with the previous ID.
425
428
if isinstance(files, basestring):
578
def get_revision_xml_file(self, revision_id):
579
"""Return XML file object for revision object."""
580
if not revision_id or not isinstance(revision_id, basestring):
581
raise InvalidRevisionId(revision_id)
586
return self.revision_store[revision_id]
588
raise bzrlib.errors.NoSuchRevision(self, revision_id)
594
get_revision_xml = get_revision_xml_file
597
585
def get_revision(self, revision_id):
598
586
"""Return the Revision object for a named revision"""
599
xml_file = self.get_revision_xml_file(revision_id)
587
from bzrlib.revision import Revision
588
from bzrlib.xml import unpack_xml
602
r = bzrlib.xml.serializer_v4.read_revision(xml_file)
603
except SyntaxError, e:
604
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
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])
608
598
assert r.revision_id == revision_id
612
def get_revision_delta(self, revno):
613
"""Return the delta for one revision.
615
The delta is relative to its mainline predecessor, or the
616
empty tree for revision 1.
618
assert isinstance(revno, int)
619
rh = self.revision_history()
620
if not (1 <= revno <= len(rh)):
621
raise InvalidRevisionNumber(revno)
623
# revno is 1-based; list is 0-based
625
new_tree = self.revision_tree(rh[revno-1])
627
old_tree = EmptyTree()
629
old_tree = self.revision_tree(rh[revno-2])
631
return compare_trees(old_tree, new_tree)
635
602
def get_revision_sha1(self, revision_id):
650
617
parameter which can be either an integer revno or a
652
619
from bzrlib.inventory import Inventory
654
f = self.get_inventory_xml_file(inventory_id)
655
return bzrlib.xml.serializer_v4.read_inventory(f)
658
def get_inventory_xml(self, inventory_id):
659
"""Get inventory XML as a file object."""
660
return self.inventory_store[inventory_id]
662
get_inventory_xml_file = get_inventory_xml
620
from bzrlib.xml import unpack_xml
622
return unpack_xml(Inventory, self.inventory_store[inventory_id])
665
625
def get_inventory_sha1(self, inventory_id):
666
626
"""Return the sha1 hash of the inventory entry
668
return sha_file(self.get_inventory_xml(inventory_id))
628
return sha_file(self.inventory_store[inventory_id])
671
631
def get_revision_inventory(self, revision_id):
737
697
return r+1, my_history[r]
738
698
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)
742
723
"""Return current revision number for this branch.
796
777
if stop_revision is None:
797
778
stop_revision = other_len
798
779
elif stop_revision > other_len:
799
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
780
raise NoSuchRevision(self, stop_revision)
801
782
return other_history[self_len:stop_revision]
804
785
def update_revisions(self, other, stop_revision=None):
805
786
"""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()
807
from bzrlib.fetch import greedy_fetch
808
from bzrlib.revision import get_intervening_revisions
810
pb = bzrlib.ui.ui_factory.progress_bar()
808
from bzrlib.progress import ProgressBar
811
812
pb.update('comparing histories')
814
revision_ids = self.missing_revisions(other, stop_revision)
815
except DivergedBranches, e:
817
if stop_revision is None:
818
end_revision = other.last_patch()
819
revision_ids = get_intervening_revisions(self.last_patch(),
821
assert self.last_patch() not in revision_ids
822
except bzrlib.errors.NotAncestor:
825
if len(revision_ids) > 0:
826
count = greedy_fetch(self, other, revision_ids[-1], pb)[0]
829
self.append_revision(*revision_ids)
830
## note("Added %d revisions." % count)
833
def install_revisions(self, other, revision_ids, pb):
813
revision_ids = self.missing_revisions(other, stop_revision)
834
815
if hasattr(other.revision_store, "prefetch"):
835
816
other.revision_store.prefetch(revision_ids)
836
817
if hasattr(other.inventory_store, "prefetch"):
837
818
inventory_ids = [other.get_revision(r).inventory_id
838
819
for r in revision_ids]
839
820
other.inventory_store.prefetch(inventory_ids)
842
pb = bzrlib.ui.ui_factory.progress_bar()
845
823
needed_texts = set()
849
for i, rev_id in enumerate(revision_ids):
850
pb.update('fetching revision', i+1, len(revision_ids))
852
rev = other.get_revision(rev_id)
853
except bzrlib.errors.NoSuchRevision:
825
for rev_id in revision_ids:
827
pb.update('fetching revision', i, len(revision_ids))
828
rev = other.get_revision(rev_id)
857
829
revisions.append(rev)
858
830
inv = other.get_inventory(str(rev.inventory_id))
859
831
for key, entry in inv.iter_entries():
867
count, cp_fail = self.text_store.copy_multi(other.text_store,
869
#print "Added %d texts." % count
839
count = self.text_store.copy_multi(other.text_store, needed_texts)
840
print "Added %d texts." % count
870
841
inventory_ids = [ f.inventory_id for f in revisions ]
871
count, cp_fail = self.inventory_store.copy_multi(other.inventory_store,
873
#print "Added %d inventories." % count
842
count = self.inventory_store.copy_multi(other.inventory_store,
844
print "Added %d inventories." % count
874
845
revision_ids = [ f.revision_id for f in revisions]
876
count, cp_fail = self.revision_store.copy_multi(other.revision_store,
879
assert len(cp_fail) == 0
880
return count, failures
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
883
853
def commit(self, *args, **kw):
884
854
from bzrlib.commit import commit
885
855
commit(self, *args, **kw)
888
858
def lookup_revision(self, revision):
889
859
"""Return the revision identifier for a given revision information."""
890
revno, info = self._get_revision_info(revision)
860
revno, info = self.get_revision_info(revision)
894
def revision_id_to_revno(self, revision_id):
895
"""Given a revision id, return its revno"""
896
history = self.revision_history()
898
return history.index(revision_id) + 1
900
raise bzrlib.errors.NoSuchRevision(self, revision_id)
903
863
def get_revision_info(self, revision):
904
864
"""Return (revno, revision id) for revision identifier.
908
868
revision can also be a string, in which case it is parsed for something like
909
869
'date:' or 'revid:' etc.
911
revno, rev_id = self._get_revision_info(revision)
913
raise bzrlib.errors.NoSuchRevision(self, revision)
916
def get_rev_id(self, revno, history=None):
917
"""Find the revision id of the specified revno."""
921
history = self.revision_history()
922
elif revno <= 0 or revno > len(history):
923
raise bzrlib.errors.NoSuchRevision(self, revno)
924
return history[revno - 1]
926
def _get_revision_info(self, revision):
927
"""Return (revno, revision id) for revision specifier.
929
revision can be an integer, in which case it is assumed to be revno
930
(though this will translate negative values into positive ones)
931
revision can also be a string, in which case it is parsed for something
932
like 'date:' or 'revid:' etc.
934
A revid is always returned. If it is None, the specifier referred to
935
the null revision. If the revid does not occur in the revision
936
history, revno will be None.
939
871
if revision is None:
946
878
revs = self.revision_history()
947
879
if isinstance(revision, int):
882
# Mabye we should do this first, but we don't need it if revision == 0
949
884
revno = len(revs) + revision + 1
952
rev_id = self.get_rev_id(revno, revs)
953
887
elif isinstance(revision, basestring):
954
888
for prefix, func in Branch.REVISION_NAMESPACES.iteritems():
955
889
if revision.startswith(prefix):
956
result = func(self, revs, revision)
958
revno, rev_id = result
961
rev_id = self.get_rev_id(revno, revs)
890
revno = func(self, revs, revision)
964
raise BzrError('No namespace registered for string: %r' %
967
raise TypeError('Unhandled revision type %s' % revision)
893
raise BzrError('No namespace registered for string: %r' % revision)
971
raise bzrlib.errors.NoSuchRevision(self, 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]
974
899
def _namespace_revno(self, revs, revision):
975
900
"""Lookup a revision by revision number"""
976
901
assert revision.startswith('revno:')
978
return (int(revision[6:]),)
903
return int(revision[6:])
979
904
except ValueError:
981
906
REVISION_NAMESPACES['revno:'] = _namespace_revno
983
908
def _namespace_revid(self, revs, revision):
984
909
assert revision.startswith('revid:')
985
rev_id = revision[len('revid:'):]
987
return revs.index(rev_id) + 1, rev_id
911
return revs.index(revision[6:]) + 1
988
912
except ValueError:
990
914
REVISION_NAMESPACES['revid:'] = _namespace_revid
992
916
def _namespace_last(self, revs, revision):
1095
1019
`revision_id` may be None for the null revision, in which case
1096
1020
an `EmptyTree` is returned."""
1021
from bzrlib.tree import EmptyTree, RevisionTree
1097
1022
# TODO: refactor this to use an existing revision object
1098
1023
# so we don't need to read it in twice.
1099
1024
if revision_id == None:
1025
return EmptyTree(self.get_root_id())
1102
1027
inv = self.get_revision_inventory(revision_id)
1103
1028
return RevisionTree(self.text_store, inv)
1330
def get_parent(self):
1331
"""Return the parent location of the branch.
1333
This is the default location for push/pull/missing. The usual
1334
pattern is that the user can override it by specifying a
1338
_locs = ['parent', 'pull', 'x-pull']
1341
return self.controlfile(l, 'r').read().strip('\n')
1343
if e.errno != errno.ENOENT:
1348
def set_parent(self, url):
1349
# TODO: Maybe delete old location files?
1350
from bzrlib.atomicfile import AtomicFile
1353
f = AtomicFile(self.controlfilename('parent'))
1362
def check_revno(self, revno):
1364
Check whether a revno corresponds to any revision.
1365
Zero (the NULL revision) is considered valid.
1368
self.check_real_revno(revno)
1370
def check_real_revno(self, revno):
1372
Check whether a revno corresponds to a real revision.
1373
Zero (the NULL revision) is considered invalid
1375
if revno < 1 or revno > self.revno():
1376
raise InvalidRevisionNumber(revno)
1381
1253
class ScratchBranch(Branch):
1382
1254
"""Special test class: a branch that cleans up after itself.
1501
1371
"""Return a new tree-root file id."""
1502
1372
return gen_file_id('TREE_ROOT')
1505
def pull_loc(branch):
1506
# TODO: Should perhaps just make attribute be 'base' in
1507
# RemoteBranch and Branch?
1508
if hasattr(branch, "baseurl"):
1509
return branch.baseurl
1514
def copy_branch(branch_from, to_location, revision=None):
1515
"""Copy branch_from into the existing directory to_location.
1518
If not None, only revisions up to this point will be copied.
1519
The head of the new branch will be that revision.
1522
The name of a local directory that exists but is empty.
1524
from bzrlib.merge import merge
1525
from bzrlib.branch import Branch
1527
assert isinstance(branch_from, Branch)
1528
assert isinstance(to_location, basestring)
1530
br_to = Branch(to_location, init=True)
1531
br_to.set_root_id(branch_from.get_root_id())
1532
if revision is None:
1533
revno = branch_from.revno()
1535
revno, rev_id = branch_from.get_revision_info(revision)
1536
br_to.update_revisions(branch_from, stop_revision=revno)
1537
merge((to_location, -1), (to_location, 0), this_dir=to_location,
1538
check_clean=False, ignore_zero=True)
1540
from_location = pull_loc(branch_from)
1541
br_to.set_parent(pull_loc(branch_from))