21
from warnings import warn
22
from cStringIO import StringIO
26
from bzrlib.inventory import InventoryEntry
27
import bzrlib.inventory as inventory
22
28
from bzrlib.trace import mutter, note
23
from bzrlib.osutils import isdir, quotefn, compact_date, rand_bytes, \
25
sha_file, appendpath, file_kind
27
from bzrlib.errors import BzrError, InvalidRevisionNumber, InvalidRevisionId, \
28
DivergedBranches, NotBranchError
29
from bzrlib.osutils import (isdir, quotefn, compact_date, rand_bytes,
30
rename, splitpath, sha_file, appendpath,
32
from bzrlib.errors import (BzrError, InvalidRevisionNumber, InvalidRevisionId,
33
NoSuchRevision, HistoryMissing, NotBranchError,
34
DivergedBranches, LockError, UnlistableStore,
35
UnlistableBranch, NoSuchFile)
29
36
from bzrlib.textui import show_status
30
37
from bzrlib.revision import Revision
31
38
from bzrlib.delta import compare_trees
32
39
from bzrlib.tree import EmptyTree, RevisionTree
40
from bzrlib.inventory import Inventory
41
from bzrlib.store import copy_all
42
from bzrlib.store.compressed_text import CompressedTextStore
43
from bzrlib.store.text import TextStore
44
from bzrlib.store.weave import WeaveStore
45
from bzrlib.transport import Transport, get_transport
38
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
50
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
51
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
39
52
## TODO: Maybe include checks for common corruption of newlines, etc?
42
55
# TODO: Some operations like log might retrieve the same revisions
43
56
# 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
def find_branch(f, **args):
51
if f and (f.startswith('http://') or f.startswith('https://')):
52
from bzrlib.remotebranch import RemoteBranch
53
return RemoteBranch(f, **args)
55
return LocalBranch(f, **args)
58
def find_cached_branch(f, cache_root, **args):
59
from bzrlib.remotebranch import RemoteBranch
60
br = find_branch(f, **args)
61
def cacheify(br, store_name):
62
from bzrlib.meta_store import CachedStore
63
cache_path = os.path.join(cache_root, store_name)
65
new_store = CachedStore(getattr(br, store_name), cache_path)
66
setattr(br, store_name, new_store)
68
if isinstance(br, RemoteBranch):
69
cacheify(br, 'inventory_store')
70
cacheify(br, 'text_store')
71
cacheify(br, 'revision_store')
57
# cache in memory to make this faster. In general anything can be
58
# cached in memory between lock and unlock operations.
60
def find_branch(*ignored, **ignored_too):
61
# XXX: leave this here for about one release, then remove it
62
raise NotImplementedError('find_branch() is not supported anymore, '
63
'please use one of the new branch constructors')
75
64
def _relpath(base, path):
76
65
"""Return path relative to base, or raise exception.
147
def __new__(cls, *a, **kw):
148
"""this is temporary, till we get rid of all code that does
151
# XXX: AAARGH! MY EYES! UUUUGLY!!!
154
b = object.__new__(cls)
158
class LocalBranch(Branch):
123
def __init__(self, *ignored, **ignored_too):
124
raise NotImplementedError('The Branch class is abstract')
127
def open_downlevel(base):
128
"""Open a branch which may be of an old format.
130
Only local branches are supported."""
131
return _Branch(get_transport(base), relax_version_check=True)
135
"""Open an existing branch, rooted at 'base' (url)"""
136
t = get_transport(base)
137
mutter("trying to open %r with transport %r", base, t)
141
def open_containing(url):
142
"""Open an existing branch which contains url.
144
This probes for a branch at url, and searches upwards from there.
146
t = get_transport(url)
147
t = find_branch_root(t)
151
def initialize(base):
152
"""Create a new branch, rooted at 'base' (url)"""
153
t = get_transport(base)
154
return _Branch(t, init=True)
156
def setup_caching(self, cache_root):
157
"""Subclasses that care about caching should override this, and set
158
up cached stores located under cache_root.
160
self.cache_root = cache_root
163
class _Branch(Branch):
159
164
"""A branch stored in the actual filesystem.
161
166
Note that it's "local" in the context of the filesystem; it doesn't
179
184
_lock_mode = None
180
185
_lock_count = None
183
def __init__(self, base, init=False, find_root=True):
187
_inventory_weave = None
189
# Map some sort of prefix into a namespace
190
# stuff like "revno:10", "revid:", etc.
191
# This should match a prefix with a function which accepts
192
REVISION_NAMESPACES = {}
194
def push_stores(self, branch_to):
195
"""Copy the content of this branches store to branch_to."""
196
if (self._branch_format != branch_to._branch_format
197
or self._branch_format != 4):
198
from bzrlib.fetch import greedy_fetch
199
mutter("falling back to fetch logic to push between %s(%s) and %s(%s)",
200
self, self._branch_format, branch_to, branch_to._branch_format)
201
greedy_fetch(to_branch=branch_to, from_branch=self,
202
revision=self.last_revision())
205
store_pairs = ((self.text_store, branch_to.text_store),
206
(self.inventory_store, branch_to.inventory_store),
207
(self.revision_store, branch_to.revision_store))
209
for from_store, to_store in store_pairs:
210
copy_all(from_store, to_store)
211
except UnlistableStore:
212
raise UnlistableBranch(from_store)
214
def __init__(self, transport, init=False,
215
relax_version_check=False):
184
216
"""Create new branch object at a particular location.
186
base -- Base directory for the branch.
218
transport -- A Transport object, defining how to access files.
219
(If a string, transport.transport() will be used to
220
create a Transport object)
188
222
init -- If True, create new control files in a previously
189
223
unversioned directory. If False, the branch must already
192
find_root -- If true and init is false, find the root of the
193
existing branch containing base.
226
relax_version_check -- If true, the usual check for the branch
227
version is not applied. This is intended only for
228
upgrade/recovery type use; it's not guaranteed that
229
all operations will work on old format branches.
195
231
In the test suite, creation of new trees is tested using the
196
232
`ScratchBranch` class.
198
from bzrlib.store import ImmutableStore
234
assert isinstance(transport, Transport), \
235
"%r is not a Transport" % transport
236
self._transport = transport
200
self.base = os.path.realpath(base)
201
238
self._make_control()
203
self.base = find_branch_root(base)
205
self.base = os.path.realpath(base)
206
if not isdir(self.controlfilename('.')):
207
raise NotBranchError("not a bzr branch: %s" % quotefn(base),
208
['use "bzr init" to initialize a new working tree',
209
'current bzr can only operate from top-of-tree'])
212
self.text_store = ImmutableStore(self.controlfilename('text-store'))
213
self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
214
self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
239
self._check_format(relax_version_check)
241
def get_store(name, compressed=True):
242
# FIXME: This approach of assuming stores are all entirely compressed
243
# or entirely uncompressed is tidy, but breaks upgrade from
244
# some existing branches where there's a mixture; we probably
245
# still want the option to look for both.
246
relpath = self._rel_controlfilename(name)
248
store = CompressedTextStore(self._transport.clone(relpath))
250
store = TextStore(self._transport.clone(relpath))
251
#if self._transport.should_cache():
252
# cache_path = os.path.join(self.cache_root, name)
253
# os.mkdir(cache_path)
254
# store = bzrlib.store.CachedStore(store, cache_path)
257
relpath = self._rel_controlfilename(name)
258
ws = WeaveStore(self._transport.clone(relpath))
259
if self._transport.should_cache():
260
ws.enable_cache = True
263
if self._branch_format == 4:
264
self.inventory_store = get_store('inventory-store')
265
self.text_store = get_store('text-store')
266
self.revision_store = get_store('revision-store')
267
elif self._branch_format == 5:
268
self.control_weaves = get_weave([])
269
self.weave_store = get_weave('weaves')
270
self.revision_store = get_store('revision-store', compressed=False)
217
272
def __str__(self):
218
return '%s(%r)' % (self.__class__.__name__, self.base)
273
return '%s(%r)' % (self.__class__.__name__, self._transport.base)
221
276
__repr__ = __str__
224
279
def __del__(self):
225
280
if self._lock_mode or self._lock:
226
from bzrlib.warnings import warn
281
# XXX: This should show something every time, and be suitable for
282
# headless operation and embedding
227
283
warn("branch %r was not explicitly unlocked" % self)
228
284
self._lock.unlock()
286
# TODO: It might be best to do this somewhere else,
287
# but it is nice for a Branch object to automatically
288
# cache it's information.
289
# Alternatively, we could have the Transport objects cache requests
290
# See the earlier discussion about how major objects (like Branch)
291
# should never expect their __del__ function to run.
292
if hasattr(self, 'cache_root') and self.cache_root is not None:
295
shutil.rmtree(self.cache_root)
298
self.cache_root = None
302
return self._transport.base
305
base = property(_get_base)
231
308
def lock_write(self):
309
# TODO: Upgrade locking to support using a Transport,
310
# and potentially a remote locking protocol
232
311
if self._lock_mode:
233
312
if self._lock_mode != 'w':
234
from bzrlib.errors import LockError
235
313
raise LockError("can't upgrade to a write lock from %r" %
237
315
self._lock_count += 1
239
from bzrlib.lock import WriteLock
241
self._lock = WriteLock(self.controlfilename('branch-lock'))
317
self._lock = self._transport.lock_write(
318
self._rel_controlfilename('branch-lock'))
242
319
self._lock_mode = 'w'
243
320
self._lock_count = 1
270
345
def abspath(self, name):
271
346
"""Return absolute filename for something in the branch"""
272
return os.path.join(self.base, name)
347
return self._transport.abspath(name)
274
349
def relpath(self, path):
275
350
"""Return path relative to this branch of something inside it.
277
352
Raises an error if path is not in this branch."""
278
return _relpath(self.base, path)
353
return self._transport.relpath(path)
356
def _rel_controlfilename(self, file_or_path):
357
if isinstance(file_or_path, basestring):
358
file_or_path = [file_or_path]
359
return [bzrlib.BZRDIR] + file_or_path
280
361
def controlfilename(self, file_or_path):
281
362
"""Return location relative to branch."""
282
if isinstance(file_or_path, basestring):
283
file_or_path = [file_or_path]
284
return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
363
return self._transport.abspath(self._rel_controlfilename(file_or_path))
287
366
def controlfile(self, file_or_path, mode='r'):
295
374
Controlfiles should almost never be opened in write mode but
296
375
rather should be atomically copied and replaced using atomicfile.
299
fn = self.controlfilename(file_or_path)
301
if mode == 'rb' or mode == 'wb':
302
return file(fn, mode)
303
elif mode == 'r' or mode == 'w':
304
# open in binary mode anyhow so there's no newline translation;
305
# codecs uses line buffering by default; don't want that.
307
return codecs.open(fn, mode + 'b', 'utf-8',
379
relpath = self._rel_controlfilename(file_or_path)
380
#TODO: codecs.open() buffers linewise, so it was overloaded with
381
# a much larger buffer, do we need to do the same for getreader/getwriter?
383
return self._transport.get(relpath)
385
raise BzrError("Branch.controlfile(mode='wb') is not supported, use put_controlfiles")
387
return codecs.getreader('utf-8')(self._transport.get(relpath), errors='replace')
389
raise BzrError("Branch.controlfile(mode='w') is not supported, use put_controlfiles")
310
391
raise BzrError("invalid controlfile mode %r" % mode)
393
def put_controlfile(self, path, f, encode=True):
394
"""Write an entry as a controlfile.
396
:param path: The path to put the file, relative to the .bzr control
398
:param f: A file-like or string object whose contents should be copied.
399
:param encode: If true, encode the contents as utf-8
401
self.put_controlfiles([(path, f)], encode=encode)
403
def put_controlfiles(self, files, encode=True):
404
"""Write several entries as controlfiles.
406
:param files: A list of [(path, file)] pairs, where the path is the directory
407
underneath the bzr control directory
408
:param encode: If true, encode the contents as utf-8
412
for path, f in files:
414
if isinstance(f, basestring):
415
f = f.encode('utf-8', 'replace')
417
f = codecs.getwriter('utf-8')(f, errors='replace')
418
path = self._rel_controlfilename(path)
419
ctrl_files.append((path, f))
420
self._transport.put_multi(ctrl_files)
312
422
def _make_control(self):
313
423
from bzrlib.inventory import Inventory
424
from bzrlib.weavefile import write_weave_v5
425
from bzrlib.weave import Weave
315
os.mkdir(self.controlfilename([]))
316
self.controlfile('README', 'w').write(
317
"This is a Bazaar-NG control directory.\n"
318
"Do not change any files in this directory.\n")
319
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
320
for d in ('text-store', 'inventory-store', 'revision-store'):
321
os.mkdir(self.controlfilename(d))
322
for f in ('revision-history', 'merged-patches',
323
'pending-merged-patches', 'branch-name',
326
self.controlfile(f, 'w').write('')
327
mutter('created control directory in ' + self.base)
427
# Create an empty inventory
329
429
# if we want per-tree root ids then this is the place to set
330
430
# them; they're not needed for now and so ommitted for
332
f = self.controlfile('inventory','w')
333
bzrlib.xml.serializer_v4.write_inventory(Inventory(), f)
336
def _check_format(self):
432
bzrlib.xml5.serializer_v5.write_inventory(Inventory(), sio)
433
empty_inv = sio.getvalue()
435
bzrlib.weavefile.write_weave_v5(Weave(), sio)
436
empty_weave = sio.getvalue()
438
dirs = [[], 'revision-store', 'weaves']
440
"This is a Bazaar-NG control directory.\n"
441
"Do not change any files in this directory.\n"),
442
('branch-format', BZR_BRANCH_FORMAT_5),
443
('revision-history', ''),
446
('pending-merges', ''),
447
('inventory', empty_inv),
448
('inventory.weave', empty_weave),
449
('ancestry.weave', empty_weave)
451
cfn = self._rel_controlfilename
452
self._transport.mkdir_multi([cfn(d) for d in dirs])
453
self.put_controlfiles(files)
454
mutter('created control directory in ' + self._transport.base)
456
def _check_format(self, relax_version_check):
337
457
"""Check this branch format is supported.
339
The current tool only supports the current unstable format.
459
The format level is stored, as an integer, in
460
self._branch_format for code that needs to check it later.
341
462
In the future, we might need different in-memory Branch
342
463
classes to support downlevel branches. But not yet.
344
# This ignores newlines so that we can open branches created
345
# on Windows from Linux and so on. I think it might be better
346
# to always make all internal files in unix format.
347
fmt = self.controlfile('branch-format', 'r').read()
348
fmt = fmt.replace('\r\n', '\n')
349
if fmt != BZR_BRANCH_FORMAT:
466
fmt = self.controlfile('branch-format', 'r').read()
468
raise NotBranchError(self.base)
469
mutter("got branch format %r", fmt)
470
if fmt == BZR_BRANCH_FORMAT_5:
471
self._branch_format = 5
472
elif fmt == BZR_BRANCH_FORMAT_4:
473
self._branch_format = 4
475
if (not relax_version_check
476
and self._branch_format != 5):
350
477
raise BzrError('sorry, branch format %r not supported' % fmt,
351
478
['use a different bzr version',
352
'or remove the .bzr directory and "bzr init" again'])
479
'or remove the .bzr directory'
480
' and "bzr init" again'])
354
482
def get_root_id(self):
355
483
"""Return the id of this branches root"""
649
779
# the revision, (add signatures/remove signatures) and still
650
780
# have all hash pointers stay consistent.
651
781
# But for now, just hash the contents.
652
return bzrlib.osutils.sha_file(self.get_revision_xml(revision_id))
655
def get_inventory(self, inventory_id):
656
"""Get Inventory object by hash.
658
TODO: Perhaps for this and similar methods, take a revision
659
parameter which can be either an integer revno or a
661
from bzrlib.inventory import Inventory
663
f = self.get_inventory_xml_file(inventory_id)
664
return bzrlib.xml.serializer_v4.read_inventory(f)
667
def get_inventory_xml(self, inventory_id):
782
return bzrlib.osutils.sha_file(self.get_revision_xml_file(revision_id))
784
def get_ancestry(self, revision_id):
785
"""Return a list of revision-ids integrated by a revision.
787
This currently returns a list, but the ordering is not guaranteed:
790
if revision_id is None:
792
w = self.control_weaves.get_weave('inventory')
793
return [None] + map(w.idx_to_name,
794
w.inclusions([w.lookup(revision_id)]))
796
def get_inventory_weave(self):
797
return self.control_weaves.get_weave('inventory')
799
def get_inventory(self, revision_id):
800
"""Get Inventory object by hash."""
801
xml = self.get_inventory_xml(revision_id)
802
return bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
804
def get_inventory_xml(self, revision_id):
668
805
"""Get inventory XML as a file object."""
669
return self.inventory_store[inventory_id]
671
get_inventory_xml_file = get_inventory_xml
674
def get_inventory_sha1(self, inventory_id):
807
assert isinstance(revision_id, basestring), type(revision_id)
808
iw = self.get_inventory_weave()
809
return iw.get_text(iw.lookup(revision_id))
811
raise bzrlib.errors.HistoryMissing(self, 'inventory', revision_id)
813
def get_inventory_sha1(self, revision_id):
675
814
"""Return the sha1 hash of the inventory entry
677
return sha_file(self.get_inventory_xml(inventory_id))
816
return self.get_revision(revision_id).inventory_sha1
680
818
def get_revision_inventory(self, revision_id):
681
819
"""Return inventory of a past revision."""
682
# bzr 0.0.6 imposes the constraint that the inventory_id
820
# TODO: Unify this with get_inventory()
821
# bzr 0.0.6 and later imposes the constraint that the inventory_id
683
822
# must be the same as its revision, so this is trivial.
684
823
if revision_id == None:
685
from bzrlib.inventory import Inventory
686
824
return Inventory(self.get_root_id())
688
826
return self.get_inventory(revision_id)
691
828
def revision_history(self):
692
"""Return sequence of revision hashes on to this branch.
694
>>> ScratchBranch().revision_history()
829
"""Return sequence of revision hashes on to this branch."""
699
832
return [l.rstrip('\r\n') for l in
805
941
if stop_revision is None:
806
942
stop_revision = other_len
807
elif stop_revision > other_len:
808
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
944
assert isinstance(stop_revision, int)
945
if stop_revision > other_len:
946
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
810
947
return other_history[self_len:stop_revision]
813
949
def update_revisions(self, other, stop_revision=None):
814
"""Pull in all new revisions from other branch.
950
"""Pull in new perfect-fit revisions."""
816
951
from bzrlib.fetch import greedy_fetch
818
pb = bzrlib.ui.ui_factory.progress_bar()
819
pb.update('comparing histories')
821
revision_ids = self.missing_revisions(other, stop_revision)
823
if len(revision_ids) > 0:
824
count = greedy_fetch(self, other, revision_ids[-1], pb)[0]
827
self.append_revision(*revision_ids)
828
## note("Added %d revisions." % count)
831
def install_revisions(self, other, revision_ids, pb):
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)
840
pb = bzrlib.ui.ui_factory.progress_bar()
847
for i, rev_id in enumerate(revision_ids):
848
pb.update('fetching revision', i+1, len(revision_ids))
850
rev = other.get_revision(rev_id)
851
except bzrlib.errors.NoSuchRevision:
855
revisions.append(rev)
856
inv = other.get_inventory(str(rev.inventory_id))
857
for key, entry in inv.iter_entries():
858
if entry.text_id is None:
860
if entry.text_id not in self.text_store:
861
needed_texts.add(entry.text_id)
865
count, cp_fail = self.text_store.copy_multi(other.text_store,
867
#print "Added %d texts." % count
868
inventory_ids = [ f.inventory_id for f in revisions ]
869
count, cp_fail = self.inventory_store.copy_multi(other.inventory_store,
871
#print "Added %d inventories." % count
872
revision_ids = [ f.revision_id for f in revisions]
874
count, cp_fail = self.revision_store.copy_multi(other.revision_store,
877
assert len(cp_fail) == 0
878
return count, failures
952
from bzrlib.revision import get_intervening_revisions
953
if stop_revision is None:
954
stop_revision = other.last_revision()
955
greedy_fetch(to_branch=self, from_branch=other,
956
revision=stop_revision)
957
pullable_revs = self.missing_revisions(
958
other, other.revision_id_to_revno(stop_revision))
960
greedy_fetch(to_branch=self,
962
revision=pullable_revs[-1])
963
self.append_revision(*pullable_revs)
881
966
def commit(self, *args, **kw):
882
from bzrlib.commit import commit
883
commit(self, *args, **kw)
886
def lookup_revision(self, revision):
887
"""Return the revision identifier for a given revision specifier."""
888
# XXX: I'm not sure this method belongs here; I'd rather have the
889
# revision spec stuff be an UI thing, and branch blissfully unaware
891
# Also, I'm not entirely happy with this method returning None
892
# when the revision doesn't exist.
893
# But I'm keeping the contract I found, because this seems to be
894
# used in a lot of places - and when I do change these, I'd rather
895
# figure out case-by-case which ones actually want to care about
896
# revision specs (eg, they are UI-level) and which ones should trust
897
# that they have a revno/revid.
898
# -- lalo@exoweb.net, 2005-09-07
899
from bzrlib.errors import NoSuchRevision
900
from bzrlib.revisionspec import RevisionSpec
902
spec = RevisionSpec(self, revision)
903
except NoSuchRevision:
967
from bzrlib.commit import Commit
968
Commit().commit(self, *args, **kw)
908
970
def revision_id_to_revno(self, revision_id):
909
971
"""Given a revision id, return its revno"""
972
if revision_id is None:
910
974
history = self.revision_history()
912
976
return history.index(revision_id) + 1
913
977
except ValueError:
914
978
raise bzrlib.errors.NoSuchRevision(self, revision_id)
917
980
def get_rev_id(self, revno, history=None):
918
981
"""Find the revision id of the specified revno."""
1337
1399
return gen_file_id('TREE_ROOT')
1340
def copy_branch(branch_from, to_location, revision=None):
1341
"""Copy branch_from into the existing directory to_location.
1344
If not None, only revisions up to this point will be copied.
1345
The head of the new branch will be that revision.
1348
The name of a local directory that exists but is empty.
1350
from bzrlib.merge import merge
1351
from bzrlib.revisionspec import RevisionSpec
1353
assert isinstance(branch_from, Branch)
1354
assert isinstance(to_location, basestring)
1356
br_to = Branch(to_location, init=True)
1357
br_to.set_root_id(branch_from.get_root_id())
1358
if revision is None:
1359
revno = branch_from.revno()
1361
revno, rev_id = RevisionSpec(branch_from, revision)
1362
br_to.update_revisions(branch_from, stop_revision=revno)
1363
merge((to_location, -1), (to_location, 0), this_dir=to_location,
1364
check_clean=False, ignore_zero=True)
1366
from_location = branch_from.base
1367
br_to.set_parent(branch_from.base)