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
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
26
38
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
27
39
## 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
31
50
def find_branch(f, **args):
32
51
if f and (f.startswith('http://') or f.startswith('https://')):
108
128
head, tail = os.path.split(f)
110
130
# reached the root, whatever that may be
111
raise BzrError('%r is not in a branch' % orig_f)
131
raise bzrlib.errors.NotBranchError('%s is not in a branch' % orig_f)
136
# XXX: move into bzrlib.errors; subclass BzrError
114
137
class DivergedBranches(Exception):
115
138
def __init__(self, branch1, branch2):
116
139
self.branch1 = branch1
247
258
self._lock = None
248
259
self._lock_mode = self._lock_count = None
251
261
def abspath(self, name):
252
262
"""Return absolute filename for something in the branch"""
253
263
return os.path.join(self.base, name)
256
265
def relpath(self, path):
257
266
"""Return path relative to this branch of something inside it.
259
268
Raises an error if path is not in this branch."""
260
269
return _relpath(self.base, path)
263
271
def controlfilename(self, file_or_path):
264
272
"""Return location relative to branch."""
265
273
if isinstance(file_or_path, basestring):
312
317
self.controlfile(f, 'w').write('')
313
318
mutter('created control directory in ' + self.base)
315
pack_xml(Inventory(gen_root_id()), self.controlfile('inventory','w'))
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)
318
327
def _check_format(self):
327
336
# on Windows from Linux and so on. I think it might be better
328
337
# to always make all internal files in unix format.
329
338
fmt = self.controlfile('branch-format', 'r').read()
330
fmt.replace('\r\n', '')
339
fmt = fmt.replace('\r\n', '\n')
331
340
if fmt != BZR_BRANCH_FORMAT:
332
341
raise BzrError('sorry, branch format %r not supported' % fmt,
333
342
['use a different bzr version',
353
362
def read_working_inventory(self):
354
363
"""Read the working inventory."""
355
364
from bzrlib.inventory import Inventory
356
from bzrlib.xml import unpack_xml
357
from time import time
361
367
# 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))
369
f = self.controlfile('inventory', 'rb')
370
return bzrlib.xml.serializer_v4.read_inventory(f)
396
398
"""Inventory for the working copy.""")
399
def add(self, files, verbose=False, ids=None):
401
def add(self, files, ids=None):
400
402
"""Make files versioned.
402
Note that the command line normally calls smart_add instead.
404
Note that the command line normally calls smart_add instead,
405
which can automatically recurse.
404
407
This puts the files in the Added state, so that they will be
405
408
recorded by the next commit.
415
418
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
421
TODO: Perhaps yield the ids and paths as they're added.
425
from bzrlib.textui import show_status
426
423
# TODO: Re-adding a file that is removed in the working copy
427
424
# should probably put it back with the previous ID.
428
425
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
585
597
def get_revision(self, revision_id):
586
598
"""Return the Revision object for a named revision"""
587
from bzrlib.revision import Revision
588
from bzrlib.xml import unpack_xml
599
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])
602
r = bzrlib.xml.serializer_v4.read_revision(xml_file)
603
except SyntaxError, e:
604
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
598
608
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)
602
635
def get_revision_sha1(self, revision_id):
617
650
parameter which can be either an integer revno or a
619
652
from bzrlib.inventory import Inventory
620
from bzrlib.xml import unpack_xml
622
return unpack_xml(Inventory, self.inventory_store[inventory_id])
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
625
665
def get_inventory_sha1(self, inventory_id):
626
666
"""Return the sha1 hash of the inventory entry
628
return sha_file(self.inventory_store[inventory_id])
668
return sha_file(self.get_inventory_xml(inventory_id))
631
671
def get_revision_inventory(self, revision_id):
697
737
return r+1, my_history[r]
698
738
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
742
"""Return current revision number for this branch.
777
796
if stop_revision is None:
778
797
stop_revision = other_len
779
798
elif stop_revision > other_len:
780
raise NoSuchRevision(self, stop_revision)
799
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
782
801
return other_history[self_len:stop_revision]
785
804
def update_revisions(self, other, stop_revision=None):
786
805
"""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
807
from bzrlib.fetch import greedy_fetch
808
from bzrlib.revision import get_intervening_revisions
810
pb = bzrlib.ui.ui_factory.progress_bar()
812
811
pb.update('comparing histories')
813
revision_ids = self.missing_revisions(other, stop_revision)
812
if stop_revision is None:
813
other_revision = other.last_patch()
815
other_revision = other.lookup_revision(stop_revision)
816
count = greedy_fetch(self, other, other_revision, pb)[0]
818
revision_ids = self.missing_revisions(other, stop_revision)
819
except DivergedBranches, e:
821
revision_ids = get_intervening_revisions(self.last_patch(),
822
other_revision, self)
823
assert self.last_patch() not in revision_ids
824
except bzrlib.errors.NotAncestor:
827
self.append_revision(*revision_ids)
830
def install_revisions(self, other, revision_ids, pb):
815
831
if hasattr(other.revision_store, "prefetch"):
816
832
other.revision_store.prefetch(revision_ids)
817
833
if hasattr(other.inventory_store, "prefetch"):
818
834
inventory_ids = [other.get_revision(r).inventory_id
819
835
for r in revision_ids]
820
836
other.inventory_store.prefetch(inventory_ids)
839
pb = bzrlib.ui.ui_factory.progress_bar()
823
842
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)
846
for i, rev_id in enumerate(revision_ids):
847
pb.update('fetching revision', i+1, len(revision_ids))
849
rev = other.get_revision(rev_id)
850
except bzrlib.errors.NoSuchRevision:
829
854
revisions.append(rev)
830
855
inv = other.get_inventory(str(rev.inventory_id))
831
856
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
864
count, cp_fail = self.text_store.copy_multi(other.text_store,
866
#print "Added %d texts." % count
841
867
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
868
count, cp_fail = self.inventory_store.copy_multi(other.inventory_store,
870
#print "Added %d inventories." % count
845
871
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
873
count, cp_fail = self.revision_store.copy_multi(other.revision_store,
876
assert len(cp_fail) == 0
877
return count, failures
853
880
def commit(self, *args, **kw):
854
881
from bzrlib.commit import commit
855
882
commit(self, *args, **kw)
858
885
def lookup_revision(self, revision):
859
886
"""Return the revision identifier for a given revision information."""
860
revno, info = self.get_revision_info(revision)
887
revno, info = self._get_revision_info(revision)
891
def revision_id_to_revno(self, revision_id):
892
"""Given a revision id, return its revno"""
893
history = self.revision_history()
895
return history.index(revision_id) + 1
897
raise bzrlib.errors.NoSuchRevision(self, revision_id)
863
900
def get_revision_info(self, revision):
864
901
"""Return (revno, revision id) for revision identifier.
868
905
revision can also be a string, in which case it is parsed for something like
869
906
'date:' or 'revid:' etc.
908
revno, rev_id = self._get_revision_info(revision)
910
raise bzrlib.errors.NoSuchRevision(self, revision)
913
def get_rev_id(self, revno, history=None):
914
"""Find the revision id of the specified revno."""
918
history = self.revision_history()
919
elif revno <= 0 or revno > len(history):
920
raise bzrlib.errors.NoSuchRevision(self, revno)
921
return history[revno - 1]
923
def _get_revision_info(self, revision):
924
"""Return (revno, revision id) for revision specifier.
926
revision can be an integer, in which case it is assumed to be revno
927
(though this will translate negative values into positive ones)
928
revision can also be a string, in which case it is parsed for something
929
like 'date:' or 'revid:' etc.
931
A revid is always returned. If it is None, the specifier referred to
932
the null revision. If the revid does not occur in the revision
933
history, revno will be None.
871
936
if revision is None:
878
943
revs = self.revision_history()
879
944
if isinstance(revision, int):
882
# Mabye we should do this first, but we don't need it if revision == 0
884
946
revno = len(revs) + revision + 1
949
rev_id = self.get_rev_id(revno, revs)
887
950
elif isinstance(revision, basestring):
888
951
for prefix, func in Branch.REVISION_NAMESPACES.iteritems():
889
952
if revision.startswith(prefix):
890
revno = func(self, revs, revision)
953
result = func(self, revs, revision)
955
revno, rev_id = result
958
rev_id = self.get_rev_id(revno, revs)
893
raise BzrError('No namespace registered for string: %r' % revision)
961
raise BzrError('No namespace registered for string: %r' %
964
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]
968
raise bzrlib.errors.NoSuchRevision(self, revision)
899
971
def _namespace_revno(self, revs, revision):
900
972
"""Lookup a revision by revision number"""
901
973
assert revision.startswith('revno:')
903
return int(revision[6:])
975
return (int(revision[6:]),)
904
976
except ValueError:
906
978
REVISION_NAMESPACES['revno:'] = _namespace_revno
908
980
def _namespace_revid(self, revs, revision):
909
981
assert revision.startswith('revid:')
982
rev_id = revision[len('revid:'):]
911
return revs.index(revision[6:]) + 1
984
return revs.index(rev_id) + 1, rev_id
912
985
except ValueError:
914
987
REVISION_NAMESPACES['revid:'] = _namespace_revid
916
989
def _namespace_last(self, revs, revision):
1019
1092
`revision_id` may be None for the null revision, in which case
1020
1093
an `EmptyTree` is returned."""
1021
from bzrlib.tree import EmptyTree, RevisionTree
1022
1094
# TODO: refactor this to use an existing revision object
1023
1095
# so we don't need to read it in twice.
1024
1096
if revision_id == None:
1025
return EmptyTree(self.get_root_id())
1027
1099
inv = self.get_revision_inventory(revision_id)
1028
1100
return RevisionTree(self.text_store, inv)
1327
def get_parent(self):
1328
"""Return the parent location of the branch.
1330
This is the default location for push/pull/missing. The usual
1331
pattern is that the user can override it by specifying a
1335
_locs = ['parent', 'pull', 'x-pull']
1338
return self.controlfile(l, 'r').read().strip('\n')
1340
if e.errno != errno.ENOENT:
1345
def set_parent(self, url):
1346
# TODO: Maybe delete old location files?
1347
from bzrlib.atomicfile import AtomicFile
1350
f = AtomicFile(self.controlfilename('parent'))
1359
def check_revno(self, revno):
1361
Check whether a revno corresponds to any revision.
1362
Zero (the NULL revision) is considered valid.
1365
self.check_real_revno(revno)
1367
def check_real_revno(self, revno):
1369
Check whether a revno corresponds to a real revision.
1370
Zero (the NULL revision) is considered invalid
1372
if revno < 1 or revno > self.revno():
1373
raise InvalidRevisionNumber(revno)
1253
1378
class ScratchBranch(Branch):
1254
1379
"""Special test class: a branch that cleans up after itself.
1371
1498
"""Return a new tree-root file id."""
1372
1499
return gen_file_id('TREE_ROOT')
1502
def pull_loc(branch):
1503
# TODO: Should perhaps just make attribute be 'base' in
1504
# RemoteBranch and Branch?
1505
if hasattr(branch, "baseurl"):
1506
return branch.baseurl
1511
def copy_branch(branch_from, to_location, revision=None):
1512
"""Copy branch_from into the existing directory to_location.
1515
If not None, only revisions up to this point will be copied.
1516
The head of the new branch will be that revision.
1519
The name of a local directory that exists but is empty.
1521
from bzrlib.merge import merge
1522
from bzrlib.branch import Branch
1524
assert isinstance(branch_from, Branch)
1525
assert isinstance(to_location, basestring)
1527
br_to = Branch(to_location, init=True)
1528
br_to.set_root_id(branch_from.get_root_id())
1529
if revision is None:
1530
revno = branch_from.revno()
1532
revno, rev_id = branch_from.get_revision_info(revision)
1533
br_to.update_revisions(branch_from, stop_revision=revno)
1534
merge((to_location, -1), (to_location, 0), this_dir=to_location,
1535
check_clean=False, ignore_zero=True)
1537
from_location = pull_loc(branch_from)
1538
br_to.set_parent(pull_loc(branch_from))