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, \
28
DivergedBranches, NotBranchError
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://')):
52
from bzrlib.remotebranch import RemoteBranch
53
return RemoteBranch(f, **args)
34
return remotebranch.RemoteBranch(f, **args)
55
36
return Branch(f, **args)
58
39
def find_cached_branch(f, cache_root, **args):
59
from bzrlib.remotebranch import RemoteBranch
40
from remotebranch import RemoteBranch
60
41
br = find_branch(f, **args)
61
42
def cacheify(br, store_name):
62
from bzrlib.meta_store import CachedStore
43
from meta_store import CachedStore
63
44
cache_path = os.path.join(cache_root, store_name)
64
45
os.mkdir(cache_path)
65
46
new_store = CachedStore(getattr(br, store_name), cache_path)
127
108
head, tail = os.path.split(f)
129
110
# reached the root, whatever that may be
130
raise NotBranchError('%s is not in a branch' % orig_f)
111
raise BzrError('%r is not in a branch' % orig_f)
114
class DivergedBranches(Exception):
115
def __init__(self, branch1, branch2):
116
self.branch1 = branch1
117
self.branch2 = branch2
118
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)
136
129
######################################################################
250
247
self._lock = None
251
248
self._lock_mode = self._lock_count = None
253
251
def abspath(self, name):
254
252
"""Return absolute filename for something in the branch"""
255
253
return os.path.join(self.base, name)
257
256
def relpath(self, path):
258
257
"""Return path relative to this branch of something inside it.
260
259
Raises an error if path is not in this branch."""
261
260
return _relpath(self.base, path)
263
263
def controlfilename(self, file_or_path):
264
264
"""Return location relative to branch."""
265
265
if isinstance(file_or_path, basestring):
354
353
def read_working_inventory(self):
355
354
"""Read the working inventory."""
356
355
from bzrlib.inventory import Inventory
356
from bzrlib.xml import unpack_xml
357
from time import time
359
361
# ElementTree does its own conversion from UTF-8, so open in
361
f = self.controlfile('inventory', 'rb')
362
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))
390
396
"""Inventory for the working copy.""")
393
def add(self, files, ids=None):
399
def add(self, files, verbose=False, ids=None):
394
400
"""Make files versioned.
396
Note that the command line normally calls smart_add instead,
397
which can automatically recurse.
402
Note that the command line normally calls smart_add instead.
399
404
This puts the files in the Added state, so that they will be
400
405
recorded by the next commit.
410
415
TODO: Perhaps have an option to add the ids even if the files do
413
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
415
426
# TODO: Re-adding a file that is removed in the working copy
416
427
# should probably put it back with the previous ID.
417
428
if isinstance(files, basestring):
570
def get_revision_xml_file(self, revision_id):
571
"""Return XML file object for revision object."""
572
if not revision_id or not isinstance(revision_id, basestring):
573
raise InvalidRevisionId(revision_id)
578
return self.revision_store[revision_id]
580
raise bzrlib.errors.NoSuchRevision(self, revision_id)
586
get_revision_xml = get_revision_xml_file
589
585
def get_revision(self, revision_id):
590
586
"""Return the Revision object for a named revision"""
591
xml_file = self.get_revision_xml_file(revision_id)
587
from bzrlib.revision import Revision
588
from bzrlib.xml import unpack_xml
594
r = bzrlib.xml.serializer_v4.read_revision(xml_file)
595
except SyntaxError, e:
596
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])
600
598
assert r.revision_id == revision_id
604
def get_revision_delta(self, revno):
605
"""Return the delta for one revision.
607
The delta is relative to its mainline predecessor, or the
608
empty tree for revision 1.
610
assert isinstance(revno, int)
611
rh = self.revision_history()
612
if not (1 <= revno <= len(rh)):
613
raise InvalidRevisionNumber(revno)
615
# revno is 1-based; list is 0-based
617
new_tree = self.revision_tree(rh[revno-1])
619
old_tree = EmptyTree()
621
old_tree = self.revision_tree(rh[revno-2])
623
return compare_trees(old_tree, new_tree)
627
602
def get_revision_sha1(self, revision_id):
642
617
parameter which can be either an integer revno or a
644
619
from bzrlib.inventory import Inventory
646
f = self.get_inventory_xml_file(inventory_id)
647
return bzrlib.xml.serializer_v4.read_inventory(f)
650
def get_inventory_xml(self, inventory_id):
651
"""Get inventory XML as a file object."""
652
return self.inventory_store[inventory_id]
654
get_inventory_xml_file = get_inventory_xml
620
from bzrlib.xml import unpack_xml
622
return unpack_xml(Inventory, self.inventory_store[inventory_id])
657
625
def get_inventory_sha1(self, inventory_id):
658
626
"""Return the sha1 hash of the inventory entry
660
return sha_file(self.get_inventory_xml(inventory_id))
628
return sha_file(self.inventory_store[inventory_id])
663
631
def get_revision_inventory(self, revision_id):
688
656
def common_ancestor(self, other, self_revno=None, other_revno=None):
690
>>> from bzrlib.commit import commit
691
659
>>> sb = ScratchBranch(files=['foo', 'foo~'])
692
660
>>> sb.common_ancestor(sb) == (None, None)
694
>>> commit(sb, "Committing first revision", verbose=False)
662
>>> commit.commit(sb, "Committing first revision", verbose=False)
695
663
>>> sb.common_ancestor(sb)[0]
697
665
>>> clone = sb.clone()
698
>>> commit(sb, "Committing second revision", verbose=False)
666
>>> commit.commit(sb, "Committing second revision", verbose=False)
699
667
>>> sb.common_ancestor(sb)[0]
701
669
>>> sb.common_ancestor(clone)[0]
703
>>> commit(clone, "Committing divergent second revision",
671
>>> commit.commit(clone, "Committing divergent second revision",
704
672
... verbose=False)
705
673
>>> sb.common_ancestor(clone)[0]
729
697
return r+1, my_history[r]
730
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)
734
723
"""Return current revision number for this branch.
788
777
if stop_revision is None:
789
778
stop_revision = other_len
790
779
elif stop_revision > other_len:
791
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
780
raise NoSuchRevision(self, stop_revision)
793
782
return other_history[self_len:stop_revision]
796
785
def update_revisions(self, other, stop_revision=None):
797
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()
799
from bzrlib.fetch import greedy_fetch
800
from bzrlib.revision import get_intervening_revisions
802
pb = bzrlib.ui.ui_factory.progress_bar()
808
from bzrlib.progress import ProgressBar
803
812
pb.update('comparing histories')
804
if stop_revision is None:
805
other_revision = other.last_patch()
807
other_revision = other.lookup_revision(stop_revision)
808
count = greedy_fetch(self, other, other_revision, pb)[0]
810
revision_ids = self.missing_revisions(other, stop_revision)
811
except DivergedBranches, e:
813
revision_ids = get_intervening_revisions(self.last_patch(),
814
other_revision, self)
815
assert self.last_patch() not in revision_ids
816
except bzrlib.errors.NotAncestor:
819
self.append_revision(*revision_ids)
822
def install_revisions(self, other, revision_ids, pb):
813
revision_ids = self.missing_revisions(other, stop_revision)
823
815
if hasattr(other.revision_store, "prefetch"):
824
816
other.revision_store.prefetch(revision_ids)
825
817
if hasattr(other.inventory_store, "prefetch"):
827
for rev_id in revision_ids:
829
revision = other.get_revision(rev_id).inventory_id
830
inventory_ids.append(revision)
831
except bzrlib.errors.NoSuchRevision:
818
inventory_ids = [other.get_revision(r).inventory_id
819
for r in revision_ids]
833
820
other.inventory_store.prefetch(inventory_ids)
836
pb = bzrlib.ui.ui_factory.progress_bar()
839
823
needed_texts = set()
843
for i, rev_id in enumerate(revision_ids):
844
pb.update('fetching revision', i+1, len(revision_ids))
846
rev = other.get_revision(rev_id)
847
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)
851
829
revisions.append(rev)
852
830
inv = other.get_inventory(str(rev.inventory_id))
853
831
for key, entry in inv.iter_entries():
861
count, cp_fail = self.text_store.copy_multi(other.text_store,
863
#print "Added %d texts." % count
839
count = self.text_store.copy_multi(other.text_store, needed_texts)
840
print "Added %d texts." % count
864
841
inventory_ids = [ f.inventory_id for f in revisions ]
865
count, cp_fail = self.inventory_store.copy_multi(other.inventory_store,
867
#print "Added %d inventories." % count
842
count = self.inventory_store.copy_multi(other.inventory_store,
844
print "Added %d inventories." % count
868
845
revision_ids = [ f.revision_id for f in revisions]
870
count, cp_fail = self.revision_store.copy_multi(other.revision_store,
873
assert len(cp_fail) == 0
874
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
877
853
def commit(self, *args, **kw):
878
854
from bzrlib.commit import commit
879
855
commit(self, *args, **kw)
882
858
def lookup_revision(self, revision):
883
859
"""Return the revision identifier for a given revision information."""
884
revno, info = self._get_revision_info(revision)
860
revno, info = self.get_revision_info(revision)
888
def revision_id_to_revno(self, revision_id):
889
"""Given a revision id, return its revno"""
890
history = self.revision_history()
892
return history.index(revision_id) + 1
894
raise bzrlib.errors.NoSuchRevision(self, revision_id)
897
863
def get_revision_info(self, revision):
898
864
"""Return (revno, revision id) for revision identifier.
902
868
revision can also be a string, in which case it is parsed for something like
903
869
'date:' or 'revid:' etc.
905
revno, rev_id = self._get_revision_info(revision)
907
raise bzrlib.errors.NoSuchRevision(self, revision)
910
def get_rev_id(self, revno, history=None):
911
"""Find the revision id of the specified revno."""
915
history = self.revision_history()
916
elif revno <= 0 or revno > len(history):
917
raise bzrlib.errors.NoSuchRevision(self, revno)
918
return history[revno - 1]
920
def _get_revision_info(self, revision):
921
"""Return (revno, revision id) for revision specifier.
923
revision can be an integer, in which case it is assumed to be revno
924
(though this will translate negative values into positive ones)
925
revision can also be a string, in which case it is parsed for something
926
like 'date:' or 'revid:' etc.
928
A revid is always returned. If it is None, the specifier referred to
929
the null revision. If the revid does not occur in the revision
930
history, revno will be None.
933
871
if revision is None:
940
878
revs = self.revision_history()
941
879
if isinstance(revision, int):
882
# Mabye we should do this first, but we don't need it if revision == 0
943
884
revno = len(revs) + revision + 1
946
rev_id = self.get_rev_id(revno, revs)
947
887
elif isinstance(revision, basestring):
948
888
for prefix, func in Branch.REVISION_NAMESPACES.iteritems():
949
889
if revision.startswith(prefix):
950
result = func(self, revs, revision)
952
revno, rev_id = result
955
rev_id = self.get_rev_id(revno, revs)
890
revno = func(self, revs, revision)
958
raise BzrError('No namespace registered for string: %r' %
961
raise TypeError('Unhandled revision type %s' % revision)
893
raise BzrError('No namespace registered for string: %r' % revision)
965
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]
968
899
def _namespace_revno(self, revs, revision):
969
900
"""Lookup a revision by revision number"""
970
901
assert revision.startswith('revno:')
972
return (int(revision[6:]),)
903
return int(revision[6:])
973
904
except ValueError:
975
906
REVISION_NAMESPACES['revno:'] = _namespace_revno
977
908
def _namespace_revid(self, revs, revision):
978
909
assert revision.startswith('revid:')
979
rev_id = revision[len('revid:'):]
981
return revs.index(rev_id) + 1, rev_id
911
return revs.index(revision[6:]) + 1
982
912
except ValueError:
984
914
REVISION_NAMESPACES['revid:'] = _namespace_revid
986
916
def _namespace_last(self, revs, revision):
1073
1003
# TODO: Handle timezone.
1074
1004
dt = datetime.datetime.fromtimestamp(r.timestamp)
1075
1005
if first >= dt and (last is None or dt >= last):
1078
1008
for i in range(len(revs)):
1079
1009
r = self.get_revision(revs[i])
1080
1010
# TODO: Handle timezone.
1081
1011
dt = datetime.datetime.fromtimestamp(r.timestamp)
1082
1012
if first <= dt and (last is None or dt <= last):
1084
1014
REVISION_NAMESPACES['date:'] = _namespace_date
1087
def _namespace_ancestor(self, revs, revision):
1088
from revision import common_ancestor, MultipleRevisionSources
1089
other_branch = find_branch(_trim_namespace('ancestor', revision))
1090
revision_a = self.last_patch()
1091
revision_b = other_branch.last_patch()
1092
for r, b in ((revision_a, self), (revision_b, other_branch)):
1094
raise bzrlib.errors.NoCommits(b)
1095
revision_source = MultipleRevisionSources(self, other_branch)
1096
result = common_ancestor(revision_a, revision_b, revision_source)
1098
revno = self.revision_id_to_revno(result)
1099
except bzrlib.errors.NoSuchRevision:
1104
REVISION_NAMESPACES['ancestor:'] = _namespace_ancestor
1106
1016
def revision_tree(self, revision_id):
1107
1017
"""Return Tree for a revision on this branch.
1109
1019
`revision_id` may be None for the null revision, in which case
1110
1020
an `EmptyTree` is returned."""
1021
from bzrlib.tree import EmptyTree, RevisionTree
1111
1022
# TODO: refactor this to use an existing revision object
1112
1023
# so we don't need to read it in twice.
1113
1024
if revision_id == None:
1025
return EmptyTree(self.get_root_id())
1116
1027
inv = self.get_revision_inventory(revision_id)
1117
1028
return RevisionTree(self.text_store, inv)
1344
def get_parent(self):
1345
"""Return the parent location of the branch.
1347
This is the default location for push/pull/missing. The usual
1348
pattern is that the user can override it by specifying a
1352
_locs = ['parent', 'pull', 'x-pull']
1355
return self.controlfile(l, 'r').read().strip('\n')
1357
if e.errno != errno.ENOENT:
1362
def set_parent(self, url):
1363
# TODO: Maybe delete old location files?
1364
from bzrlib.atomicfile import AtomicFile
1367
f = AtomicFile(self.controlfilename('parent'))
1376
def check_revno(self, revno):
1378
Check whether a revno corresponds to any revision.
1379
Zero (the NULL revision) is considered valid.
1382
self.check_real_revno(revno)
1384
def check_real_revno(self, revno):
1386
Check whether a revno corresponds to a real revision.
1387
Zero (the NULL revision) is considered invalid
1389
if revno < 1 or revno > self.revno():
1390
raise InvalidRevisionNumber(revno)
1395
1253
class ScratchBranch(Branch):
1396
1254
"""Special test class: a branch that cleans up after itself.
1515
1371
"""Return a new tree-root file id."""
1516
1372
return gen_file_id('TREE_ROOT')
1519
def copy_branch(branch_from, to_location, revision=None):
1520
"""Copy branch_from into the existing directory to_location.
1523
If not None, only revisions up to this point will be copied.
1524
The head of the new branch will be that revision.
1527
The name of a local directory that exists but is empty.
1529
from bzrlib.merge import merge
1531
assert isinstance(branch_from, Branch)
1532
assert isinstance(to_location, basestring)
1534
br_to = Branch(to_location, init=True)
1535
br_to.set_root_id(branch_from.get_root_id())
1536
if revision is None:
1537
revno = branch_from.revno()
1539
revno, rev_id = branch_from.get_revision_info(revision)
1540
br_to.update_revisions(branch_from, stop_revision=revno)
1541
merge((to_location, -1), (to_location, 0), this_dir=to_location,
1542
check_clean=False, ignore_zero=True)
1543
br_to.set_parent(branch_from.base)
1546
def _trim_namespace(namespace, spec):
1547
full_namespace = namespace + ':'
1548
assert spec.startswith(full_namespace)
1549
return spec[len(full_namespace):]