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
import bzrlib.errors as errors
33
from bzrlib.errors import (BzrError, InvalidRevisionNumber, InvalidRevisionId,
34
NoSuchRevision, HistoryMissing, NotBranchError,
35
DivergedBranches, LockError, UnlistableStore,
36
UnlistableBranch, NoSuchFile, NotVersionedError)
29
37
from bzrlib.textui import show_status
30
from bzrlib.revision import Revision
38
from bzrlib.revision import Revision, is_ancestor, get_intervening_revisions
31
40
from bzrlib.delta import compare_trees
32
41
from bzrlib.tree import EmptyTree, RevisionTree
42
from bzrlib.inventory import Inventory
43
from bzrlib.store import copy_all
44
from bzrlib.store.compressed_text import CompressedTextStore
45
from bzrlib.store.text import TextStore
46
from bzrlib.store.weave import WeaveStore
47
from bzrlib.testament import Testament
48
import bzrlib.transactions as transactions
49
from bzrlib.transport import Transport, get_transport
38
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
54
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
55
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
56
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
39
57
## TODO: Maybe include checks for common corruption of newlines, etc?
42
60
# TODO: Some operations like log might retrieve the same revisions
43
61
# repeatedly to calculate deltas. We could perhaps have a weakref
44
# cache in memory to make this faster.
62
# cache in memory to make this faster. In general anything can be
63
# cached in memory between lock and unlock operations.
46
65
def find_branch(*ignored, **ignored_too):
47
66
# XXX: leave this here for about one release, then remove it
48
67
raise NotImplementedError('find_branch() is not supported anymore, '
49
68
'please use one of the new branch constructors')
51
def _relpath(base, path):
52
"""Return path relative to base, or raise exception.
54
The path may be either an absolute path or a path relative to the
55
current working directory.
57
Lifted out of Branch.relpath for ease of testing.
59
os.path.commonprefix (python2.4) has a bad bug that it works just
60
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
61
avoids that problem."""
62
rp = os.path.abspath(path)
66
while len(head) >= len(base):
69
head, tail = os.path.split(head)
73
raise NotBranchError("path %r is not within branch %r" % (rp, base))
78
def find_branch_root(f=None):
79
"""Find the branch root enclosing f, or pwd.
81
f may be a filename or a URL.
83
It is not necessary that f exists.
85
Basically we keep looking up until we find the control directory or
86
run into the root. If there isn't one, raises NotBranchError.
90
elif hasattr(os.path, 'realpath'):
91
f = os.path.realpath(f)
93
f = os.path.abspath(f)
94
if not os.path.exists(f):
95
raise BzrError('%r does not exist' % f)
101
if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
103
head, tail = os.path.split(f)
105
# reached the root, whatever that may be
106
raise NotBranchError('%s is not in a branch' % orig_f)
71
def needs_read_lock(unbound):
72
"""Decorate unbound to take out and release a read lock."""
73
def decorated(self, *args, **kwargs):
76
return unbound(self, *args, **kwargs)
82
def needs_write_lock(unbound):
83
"""Decorate unbound to take out and release a write lock."""
84
def decorated(self, *args, **kwargs):
87
return unbound(self, *args, **kwargs)
112
92
######################################################################
124
104
raise NotImplementedError('The Branch class is abstract')
107
def open_downlevel(base):
108
"""Open a branch which may be of an old format.
110
Only local branches are supported."""
111
return _Branch(get_transport(base), relax_version_check=True)
128
115
"""Open an existing branch, rooted at 'base' (url)"""
129
if base and (base.startswith('http://') or base.startswith('https://')):
130
from bzrlib.remotebranch import RemoteBranch
131
return RemoteBranch(base, find_root=False)
133
return LocalBranch(base, find_root=False)
116
t = get_transport(base)
117
mutter("trying to open %r with transport %r", base, t)
136
121
def open_containing(url):
137
"""Open an existing branch, containing url (search upwards for the root)
122
"""Open an existing branch which contains url.
124
This probes for a branch at url, and searches upwards from there.
126
Basically we keep looking up until we find the control directory or
127
run into the root. If there isn't one, raises NotBranchError.
128
If there is one, it is returned, along with the unused portion of url.
139
if url and (url.startswith('http://') or url.startswith('https://')):
140
from bzrlib.remotebranch import RemoteBranch
141
return RemoteBranch(url)
143
return LocalBranch(url)
130
t = get_transport(url)
133
return _Branch(t), t.relpath(url)
134
except NotBranchError:
136
new_t = t.clone('..')
137
if new_t.base == t.base:
138
# reached the root, whatever that may be
139
raise NotBranchError(path=url)
146
143
def initialize(base):
147
144
"""Create a new branch, rooted at 'base' (url)"""
148
if base and (base.startswith('http://') or base.startswith('https://')):
149
from bzrlib.remotebranch import RemoteBranch
150
return RemoteBranch(base, init=True)
152
return LocalBranch(base, init=True)
145
t = get_transport(base)
146
return _Branch(t, init=True)
154
148
def setup_caching(self, cache_root):
155
149
"""Subclasses that care about caching should override this, and set
156
150
up cached stores located under cache_root.
160
class LocalBranch(Branch):
152
self.cache_root = cache_root
155
class _Branch(Branch):
161
156
"""A branch stored in the actual filesystem.
163
158
Note that it's "local" in the context of the filesystem; it doesn't
181
176
_lock_mode = None
182
177
_lock_count = None
185
def __init__(self, base, init=False, find_root=True):
179
_inventory_weave = None
181
# Map some sort of prefix into a namespace
182
# stuff like "revno:10", "revid:", etc.
183
# This should match a prefix with a function which accepts
184
REVISION_NAMESPACES = {}
186
def push_stores(self, branch_to):
187
"""Copy the content of this branches store to branch_to."""
188
if (self._branch_format != branch_to._branch_format
189
or self._branch_format != 4):
190
from bzrlib.fetch import greedy_fetch
191
mutter("falling back to fetch logic to push between %s(%s) and %s(%s)",
192
self, self._branch_format, branch_to, branch_to._branch_format)
193
greedy_fetch(to_branch=branch_to, from_branch=self,
194
revision=self.last_revision())
197
store_pairs = ((self.text_store, branch_to.text_store),
198
(self.inventory_store, branch_to.inventory_store),
199
(self.revision_store, branch_to.revision_store))
201
for from_store, to_store in store_pairs:
202
copy_all(from_store, to_store)
203
except UnlistableStore:
204
raise UnlistableBranch(from_store)
206
def __init__(self, transport, init=False,
207
relax_version_check=False):
186
208
"""Create new branch object at a particular location.
188
base -- Base directory for the branch. May be a file:// url.
210
transport -- A Transport object, defining how to access files.
211
(If a string, transport.transport() will be used to
212
create a Transport object)
190
214
init -- If True, create new control files in a previously
191
215
unversioned directory. If False, the branch must already
194
find_root -- If true and init is false, find the root of the
195
existing branch containing base.
218
relax_version_check -- If true, the usual check for the branch
219
version is not applied. This is intended only for
220
upgrade/recovery type use; it's not guaranteed that
221
all operations will work on old format branches.
197
223
In the test suite, creation of new trees is tested using the
198
224
`ScratchBranch` class.
200
from bzrlib.store import ImmutableStore
226
assert isinstance(transport, Transport), \
227
"%r is not a Transport" % transport
228
self._transport = transport
202
self.base = os.path.realpath(base)
203
230
self._make_control()
205
self.base = find_branch_root(base)
207
if base.startswith("file://"):
209
self.base = os.path.realpath(base)
210
if not isdir(self.controlfilename('.')):
211
raise NotBranchError("not a bzr branch: %s" % quotefn(base),
212
['use "bzr init" to initialize a new working tree',
213
'current bzr can only operate from top-of-tree'])
216
self.text_store = ImmutableStore(self.controlfilename('text-store'))
217
self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
218
self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
231
self._check_format(relax_version_check)
233
def get_store(name, compressed=True, prefixed=False):
234
# FIXME: This approach of assuming stores are all entirely compressed
235
# or entirely uncompressed is tidy, but breaks upgrade from
236
# some existing branches where there's a mixture; we probably
237
# still want the option to look for both.
238
relpath = self._rel_controlfilename(name)
240
store = CompressedTextStore(self._transport.clone(relpath),
243
store = TextStore(self._transport.clone(relpath),
245
#if self._transport.should_cache():
246
# cache_path = os.path.join(self.cache_root, name)
247
# os.mkdir(cache_path)
248
# store = bzrlib.store.CachedStore(store, cache_path)
250
def get_weave(name, prefixed=False):
251
relpath = self._rel_controlfilename(name)
252
ws = WeaveStore(self._transport.clone(relpath), prefixed=prefixed)
253
if self._transport.should_cache():
254
ws.enable_cache = True
257
if self._branch_format == 4:
258
self.inventory_store = get_store('inventory-store')
259
self.text_store = get_store('text-store')
260
self.revision_store = get_store('revision-store')
261
elif self._branch_format == 5:
262
self.control_weaves = get_weave('')
263
self.weave_store = get_weave('weaves')
264
self.revision_store = get_store('revision-store', compressed=False)
265
elif self._branch_format == 6:
266
self.control_weaves = get_weave('')
267
self.weave_store = get_weave('weaves', prefixed=True)
268
self.revision_store = get_store('revision-store', compressed=False,
270
self.revision_store.register_suffix('sig')
271
self._transaction = None
221
273
def __str__(self):
222
return '%s(%r)' % (self.__class__.__name__, self.base)
274
return '%s(%r)' % (self.__class__.__name__, self._transport.base)
225
277
__repr__ = __str__
228
280
def __del__(self):
229
281
if self._lock_mode or self._lock:
230
from bzrlib.warnings import warn
282
# XXX: This should show something every time, and be suitable for
283
# headless operation and embedding
231
284
warn("branch %r was not explicitly unlocked" % self)
232
285
self._lock.unlock()
287
# TODO: It might be best to do this somewhere else,
288
# but it is nice for a Branch object to automatically
289
# cache it's information.
290
# Alternatively, we could have the Transport objects cache requests
291
# See the earlier discussion about how major objects (like Branch)
292
# should never expect their __del__ function to run.
293
if hasattr(self, 'cache_root') and self.cache_root is not None:
296
shutil.rmtree(self.cache_root)
299
self.cache_root = None
303
return self._transport.base
306
base = property(_get_base, doc="The URL for the root of this branch.")
308
def _finish_transaction(self):
309
"""Exit the current transaction."""
310
if self._transaction is None:
311
raise errors.LockError('Branch %s is not in a transaction' %
313
transaction = self._transaction
314
self._transaction = None
317
def get_transaction(self):
318
"""Return the current active transaction.
320
If no transaction is active, this returns a passthrough object
321
for which all data is immedaitely flushed and no caching happens.
323
if self._transaction is None:
324
return transactions.PassThroughTransaction()
326
return self._transaction
328
def _set_transaction(self, new_transaction):
329
"""Set a new active transaction."""
330
if self._transaction is not None:
331
raise errors.LockError('Branch %s is in a transaction already.' %
333
self._transaction = new_transaction
234
335
def lock_write(self):
336
mutter("lock write: %s (%s)", self, self._lock_count)
337
# TODO: Upgrade locking to support using a Transport,
338
# and potentially a remote locking protocol
235
339
if self._lock_mode:
236
340
if self._lock_mode != 'w':
237
from bzrlib.errors import LockError
238
341
raise LockError("can't upgrade to a write lock from %r" %
240
343
self._lock_count += 1
242
from bzrlib.lock import WriteLock
244
self._lock = WriteLock(self.controlfilename('branch-lock'))
345
self._lock = self._transport.lock_write(
346
self._rel_controlfilename('branch-lock'))
245
347
self._lock_mode = 'w'
246
348
self._lock_count = 1
349
self._set_transaction(transactions.PassThroughTransaction())
249
351
def lock_read(self):
352
mutter("lock read: %s (%s)", self, self._lock_count)
250
353
if self._lock_mode:
251
354
assert self._lock_mode in ('r', 'w'), \
252
355
"invalid lock mode %r" % self._lock_mode
253
356
self._lock_count += 1
255
from bzrlib.lock import ReadLock
257
self._lock = ReadLock(self.controlfilename('branch-lock'))
358
self._lock = self._transport.lock_read(
359
self._rel_controlfilename('branch-lock'))
258
360
self._lock_mode = 'r'
259
361
self._lock_count = 1
362
self._set_transaction(transactions.ReadOnlyTransaction())
363
# 5K may be excessive, but hey, its a knob.
364
self.get_transaction().set_cache_size(5000)
261
366
def unlock(self):
367
mutter("unlock: %s (%s)", self, self._lock_count)
262
368
if not self._lock_mode:
263
from bzrlib.errors import LockError
264
369
raise LockError('branch %r is not locked' % (self))
266
371
if self._lock_count > 1:
267
372
self._lock_count -= 1
374
self._finish_transaction()
269
375
self._lock.unlock()
270
376
self._lock = None
271
377
self._lock_mode = self._lock_count = None
273
379
def abspath(self, name):
274
"""Return absolute filename for something in the branch"""
275
return os.path.join(self.base, name)
277
def relpath(self, path):
278
"""Return path relative to this branch of something inside it.
280
Raises an error if path is not in this branch."""
281
return _relpath(self.base, path)
380
"""Return absolute filename for something in the branch
382
XXX: Robert Collins 20051017 what is this used for? why is it a branch
383
method and not a tree method.
385
return self._transport.abspath(name)
387
def _rel_controlfilename(self, file_or_path):
388
if not isinstance(file_or_path, basestring):
389
file_or_path = '/'.join(file_or_path)
390
if file_or_path == '':
392
return bzrlib.transport.urlescape(bzrlib.BZRDIR + '/' + file_or_path)
283
394
def controlfilename(self, file_or_path):
284
395
"""Return location relative to branch."""
285
if isinstance(file_or_path, basestring):
286
file_or_path = [file_or_path]
287
return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
396
return self._transport.abspath(self._rel_controlfilename(file_or_path))
290
399
def controlfile(self, file_or_path, mode='r'):
298
407
Controlfiles should almost never be opened in write mode but
299
408
rather should be atomically copied and replaced using atomicfile.
302
fn = self.controlfilename(file_or_path)
304
if mode == 'rb' or mode == 'wb':
305
return file(fn, mode)
306
elif mode == 'r' or mode == 'w':
307
# open in binary mode anyhow so there's no newline translation;
308
# codecs uses line buffering by default; don't want that.
310
return codecs.open(fn, mode + 'b', 'utf-8',
412
relpath = self._rel_controlfilename(file_or_path)
413
#TODO: codecs.open() buffers linewise, so it was overloaded with
414
# a much larger buffer, do we need to do the same for getreader/getwriter?
416
return self._transport.get(relpath)
418
raise BzrError("Branch.controlfile(mode='wb') is not supported, use put_controlfiles")
420
return codecs.getreader('utf-8')(self._transport.get(relpath), errors='replace')
422
raise BzrError("Branch.controlfile(mode='w') is not supported, use put_controlfiles")
313
424
raise BzrError("invalid controlfile mode %r" % mode)
426
def put_controlfile(self, path, f, encode=True):
427
"""Write an entry as a controlfile.
429
:param path: The path to put the file, relative to the .bzr control
431
:param f: A file-like or string object whose contents should be copied.
432
:param encode: If true, encode the contents as utf-8
434
self.put_controlfiles([(path, f)], encode=encode)
436
def put_controlfiles(self, files, encode=True):
437
"""Write several entries as controlfiles.
439
:param files: A list of [(path, file)] pairs, where the path is the directory
440
underneath the bzr control directory
441
:param encode: If true, encode the contents as utf-8
445
for path, f in files:
447
if isinstance(f, basestring):
448
f = f.encode('utf-8', 'replace')
450
f = codecs.getwriter('utf-8')(f, errors='replace')
451
path = self._rel_controlfilename(path)
452
ctrl_files.append((path, f))
453
self._transport.put_multi(ctrl_files)
315
455
def _make_control(self):
316
456
from bzrlib.inventory import Inventory
457
from bzrlib.weavefile import write_weave_v5
458
from bzrlib.weave import Weave
318
os.mkdir(self.controlfilename([]))
319
self.controlfile('README', 'w').write(
320
"This is a Bazaar-NG control directory.\n"
321
"Do not change any files in this directory.\n")
322
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
323
for d in ('text-store', 'inventory-store', 'revision-store'):
324
os.mkdir(self.controlfilename(d))
325
for f in ('revision-history', 'merged-patches',
326
'pending-merged-patches', 'branch-name',
329
self.controlfile(f, 'w').write('')
330
mutter('created control directory in ' + self.base)
460
# Create an empty inventory
332
462
# if we want per-tree root ids then this is the place to set
333
463
# them; they're not needed for now and so ommitted for
335
f = self.controlfile('inventory','w')
336
bzrlib.xml.serializer_v4.write_inventory(Inventory(), f)
339
def _check_format(self):
465
bzrlib.xml5.serializer_v5.write_inventory(Inventory(), sio)
466
empty_inv = sio.getvalue()
468
bzrlib.weavefile.write_weave_v5(Weave(), sio)
469
empty_weave = sio.getvalue()
471
dirs = [[], 'revision-store', 'weaves']
473
"This is a Bazaar-NG control directory.\n"
474
"Do not change any files in this directory.\n"),
475
('branch-format', BZR_BRANCH_FORMAT_6),
476
('revision-history', ''),
479
('pending-merges', ''),
480
('inventory', empty_inv),
481
('inventory.weave', empty_weave),
482
('ancestry.weave', empty_weave)
484
cfn = self._rel_controlfilename
485
self._transport.mkdir_multi([cfn(d) for d in dirs])
486
self.put_controlfiles(files)
487
mutter('created control directory in ' + self._transport.base)
489
def _check_format(self, relax_version_check):
340
490
"""Check this branch format is supported.
342
The current tool only supports the current unstable format.
492
The format level is stored, as an integer, in
493
self._branch_format for code that needs to check it later.
344
495
In the future, we might need different in-memory Branch
345
496
classes to support downlevel branches. But not yet.
347
# This ignores newlines so that we can open branches created
348
# on Windows from Linux and so on. I think it might be better
349
# to always make all internal files in unix format.
350
fmt = self.controlfile('branch-format', 'r').read()
351
fmt = fmt.replace('\r\n', '\n')
352
if fmt != BZR_BRANCH_FORMAT:
353
raise BzrError('sorry, branch format %r not supported' % fmt,
499
fmt = self.controlfile('branch-format', 'r').read()
501
raise NotBranchError(path=self.base)
502
mutter("got branch format %r", fmt)
503
if fmt == BZR_BRANCH_FORMAT_6:
504
self._branch_format = 6
505
elif fmt == BZR_BRANCH_FORMAT_5:
506
self._branch_format = 5
507
elif fmt == BZR_BRANCH_FORMAT_4:
508
self._branch_format = 4
510
if (not relax_version_check
511
and self._branch_format not in (5, 6)):
512
raise errors.UnsupportedFormatError(
513
'sorry, branch format %r not supported' % fmt,
354
514
['use a different bzr version',
355
'or remove the .bzr directory and "bzr init" again'])
515
'or remove the .bzr directory'
516
' and "bzr init" again'])
357
518
def get_root_id(self):
358
519
"""Return the id of this branches root"""
371
532
entry.parent_id = inv.root.file_id
372
533
self._write_inventory(inv)
374
536
def read_working_inventory(self):
375
537
"""Read the working inventory."""
376
from bzrlib.inventory import Inventory
379
# ElementTree does its own conversion from UTF-8, so open in
381
f = self.controlfile('inventory', 'rb')
382
return bzrlib.xml.serializer_v4.read_inventory(f)
538
# ElementTree does its own conversion from UTF-8, so open in
540
f = self.controlfile('inventory', 'rb')
541
return bzrlib.xml5.serializer_v5.read_inventory(f)
387
544
def _write_inventory(self, inv):
388
545
"""Update the working inventory.
390
547
That is to say, the inventory describing changes underway, that
391
548
will be committed to the next revision.
393
from bzrlib.atomicfile import AtomicFile
397
f = AtomicFile(self.controlfilename('inventory'), 'wb')
399
bzrlib.xml.serializer_v4.write_inventory(inv, f)
550
from cStringIO import StringIO
552
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
554
# Transport handles atomicity
555
self.put_controlfile('inventory', sio)
406
557
mutter('wrote working inventory')
409
559
inventory = property(read_working_inventory, _write_inventory, None,
410
560
"""Inventory for the working copy.""")
413
563
def add(self, files, ids=None):
414
564
"""Make files versioned.
446
596
assert(len(ids) == len(files))
450
inv = self.read_working_inventory()
451
for f,file_id in zip(files, ids):
452
if is_control_file(f):
453
raise BzrError("cannot add control file %s" % quotefn(f))
458
raise BzrError("cannot add top-level %r" % f)
460
fullpath = os.path.normpath(self.abspath(f))
463
kind = file_kind(fullpath)
465
# maybe something better?
466
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
468
if kind != 'file' and kind != 'directory':
469
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
472
file_id = gen_file_id(f)
473
inv.add_path(f, kind=kind, file_id=file_id)
475
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
477
self._write_inventory(inv)
598
inv = self.read_working_inventory()
599
for f,file_id in zip(files, ids):
600
if is_control_file(f):
601
raise BzrError("cannot add control file %s" % quotefn(f))
606
raise BzrError("cannot add top-level %r" % f)
608
fullpath = os.path.normpath(self.abspath(f))
611
kind = file_kind(fullpath)
613
# maybe something better?
614
raise BzrError('cannot add: not a regular file, symlink or directory: %s' % quotefn(f))
616
if not InventoryEntry.versionable_kind(kind):
617
raise BzrError('cannot add: not a versionable file ('
618
'i.e. regular file, symlink or directory): %s' % quotefn(f))
621
file_id = gen_file_id(f)
622
inv.add_path(f, kind=kind, file_id=file_id)
624
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
626
self._write_inventory(inv)
482
629
def print_file(self, file, revno):
483
630
"""Print `file` to stdout."""
486
tree = self.revision_tree(self.get_rev_id(revno))
487
# use inventory as it was in that revision
488
file_id = tree.inventory.path2id(file)
490
raise BzrError("%r is not present in revision %s" % (file, revno))
491
tree.print_file(file_id)
496
def remove(self, files, verbose=False):
497
"""Mark nominated files for removal from the inventory.
499
This does not remove their text. This does not run on
501
TODO: Refuse to remove modified files unless --force is given?
503
TODO: Do something useful with directories.
505
TODO: Should this remove the text or not? Tough call; not
506
removing may be useful and the user can just use use rm, and
507
is the opposite of add. Removing it is consistent with most
508
other tools. Maybe an option.
510
## TODO: Normalize names
511
## TODO: Remove nested loops; better scalability
512
if isinstance(files, basestring):
518
tree = self.working_tree()
521
# do this before any modifications
525
raise BzrError("cannot remove unversioned file %s" % quotefn(f))
526
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
528
# having remove it, it must be either ignored or unknown
529
if tree.is_ignored(f):
533
show_status(new_status, inv[fid].kind, quotefn(f))
536
self._write_inventory(inv)
631
tree = self.revision_tree(self.get_rev_id(revno))
632
# use inventory as it was in that revision
633
file_id = tree.inventory.path2id(file)
635
raise BzrError("%r is not present in revision %s" % (file, revno))
636
tree.print_file(file_id)
541
638
# FIXME: this doesn't need to be a branch method
542
639
def set_inventory(self, new_inventory_list):
546
643
name = os.path.basename(path)
549
inv.add(InventoryEntry(file_id, name, kind, parent))
646
# fixme, there should be a factory function inv,add_??
647
if kind == 'directory':
648
inv.add(inventory.InventoryDirectory(file_id, name, parent))
650
inv.add(inventory.InventoryFile(file_id, name, parent))
651
elif kind == 'symlink':
652
inv.add(inventory.InventoryLink(file_id, name, parent))
654
raise BzrError("unknown kind %r" % kind)
550
655
self._write_inventory(inv)
553
657
def unknowns(self):
554
658
"""Return all unknown files.
556
660
These are files in the working directory that are not versioned or
557
661
control files or ignored.
663
>>> from bzrlib.workingtree import WorkingTree
559
664
>>> b = ScratchBranch(files=['foo', 'foo~'])
560
>>> list(b.unknowns())
665
>>> map(str, b.unknowns())
563
668
>>> list(b.unknowns())
670
>>> WorkingTree(b.base, b).remove('foo')
566
671
>>> list(b.unknowns())
569
674
return self.working_tree().unknowns()
572
677
def append_revision(self, *revision_ids):
573
from bzrlib.atomicfile import AtomicFile
575
678
for revision_id in revision_ids:
576
679
mutter("add {%s} to revision-history" % revision_id)
578
680
rev_history = self.revision_history()
579
681
rev_history.extend(revision_ids)
581
f = AtomicFile(self.controlfilename('revision-history'))
583
for rev_id in rev_history:
682
self.set_revision_history(rev_history)
685
def set_revision_history(self, rev_history):
686
self.put_controlfile('revision-history', '\n'.join(rev_history))
688
def has_revision(self, revision_id):
689
"""True if this branch has a copy of the revision.
691
This does not necessarily imply the revision is merge
692
or on the mainline."""
693
return (revision_id is None
694
or self.revision_store.has_id(revision_id))
590
697
def get_revision_xml_file(self, revision_id):
591
698
"""Return XML file object for revision object."""
592
699
if not revision_id or not isinstance(revision_id, basestring):
593
700
raise InvalidRevisionId(revision_id)
598
return self.revision_store[revision_id]
599
except (IndexError, KeyError):
600
raise bzrlib.errors.NoSuchRevision(self, revision_id)
702
return self.revision_store.get(revision_id)
703
except (IndexError, KeyError):
704
raise bzrlib.errors.NoSuchRevision(self, revision_id)
606
707
get_revision_xml = get_revision_xml_file
709
def get_revision_xml(self, revision_id):
710
return self.get_revision_xml_file(revision_id).read()
609
713
def get_revision(self, revision_id):
610
714
"""Return the Revision object for a named revision"""
611
715
xml_file = self.get_revision_xml_file(revision_id)
614
r = bzrlib.xml.serializer_v4.read_revision(xml_file)
718
r = bzrlib.xml5.serializer_v5.read_revision(xml_file)
615
719
except SyntaxError, e:
616
720
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
652
753
# the revision, (add signatures/remove signatures) and still
653
754
# have all hash pointers stay consistent.
654
755
# But for now, just hash the contents.
655
return bzrlib.osutils.sha_file(self.get_revision_xml(revision_id))
658
def get_inventory(self, inventory_id):
659
"""Get Inventory object by hash.
661
TODO: Perhaps for this and similar methods, take a revision
662
parameter which can be either an integer revno or a
664
from bzrlib.inventory import Inventory
666
f = self.get_inventory_xml_file(inventory_id)
667
return bzrlib.xml.serializer_v4.read_inventory(f)
670
def get_inventory_xml(self, inventory_id):
756
return bzrlib.osutils.sha_file(self.get_revision_xml_file(revision_id))
758
def get_ancestry(self, revision_id):
759
"""Return a list of revision-ids integrated by a revision.
761
This currently returns a list, but the ordering is not guaranteed:
764
if revision_id is None:
766
w = self.get_inventory_weave()
767
return [None] + map(w.idx_to_name,
768
w.inclusions([w.lookup(revision_id)]))
770
def get_inventory_weave(self):
771
return self.control_weaves.get_weave('inventory',
772
self.get_transaction())
774
def get_inventory(self, revision_id):
775
"""Get Inventory object by hash."""
776
xml = self.get_inventory_xml(revision_id)
777
return bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
779
def get_inventory_xml(self, revision_id):
671
780
"""Get inventory XML as a file object."""
672
return self.inventory_store[inventory_id]
674
get_inventory_xml_file = get_inventory_xml
677
def get_inventory_sha1(self, inventory_id):
782
assert isinstance(revision_id, basestring), type(revision_id)
783
iw = self.get_inventory_weave()
784
return iw.get_text(iw.lookup(revision_id))
786
raise bzrlib.errors.HistoryMissing(self, 'inventory', revision_id)
788
def get_inventory_sha1(self, revision_id):
678
789
"""Return the sha1 hash of the inventory entry
680
return sha_file(self.get_inventory_xml(inventory_id))
791
return self.get_revision(revision_id).inventory_sha1
683
793
def get_revision_inventory(self, revision_id):
684
794
"""Return inventory of a past revision."""
685
# bzr 0.0.6 imposes the constraint that the inventory_id
795
# TODO: Unify this with get_inventory()
796
# bzr 0.0.6 and later imposes the constraint that the inventory_id
686
797
# must be the same as its revision, so this is trivial.
687
798
if revision_id == None:
688
from bzrlib.inventory import Inventory
689
799
return Inventory(self.get_root_id())
691
801
return self.get_inventory(revision_id)
694
804
def revision_history(self):
695
"""Return sequence of revision hashes on to this branch.
697
>>> ScratchBranch().revision_history()
702
return [l.rstrip('\r\n') for l in
703
self.controlfile('revision-history', 'r').readlines()]
708
def common_ancestor(self, other, self_revno=None, other_revno=None):
710
>>> from bzrlib.commit import commit
711
>>> sb = ScratchBranch(files=['foo', 'foo~'])
712
>>> sb.common_ancestor(sb) == (None, None)
714
>>> commit(sb, "Committing first revision", verbose=False)
715
>>> sb.common_ancestor(sb)[0]
717
>>> clone = sb.clone()
718
>>> commit(sb, "Committing second revision", verbose=False)
719
>>> sb.common_ancestor(sb)[0]
721
>>> sb.common_ancestor(clone)[0]
723
>>> commit(clone, "Committing divergent second revision",
725
>>> sb.common_ancestor(clone)[0]
727
>>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
729
>>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
731
>>> clone2 = sb.clone()
732
>>> sb.common_ancestor(clone2)[0]
734
>>> sb.common_ancestor(clone2, self_revno=1)[0]
736
>>> sb.common_ancestor(clone2, other_revno=1)[0]
739
my_history = self.revision_history()
740
other_history = other.revision_history()
741
if self_revno is None:
742
self_revno = len(my_history)
743
if other_revno is None:
744
other_revno = len(other_history)
745
indices = range(min((self_revno, other_revno)))
748
if my_history[r] == other_history[r]:
749
return r+1, my_history[r]
805
"""Return sequence of revision hashes on to this branch."""
806
transaction = self.get_transaction()
807
history = transaction.map.find_revision_history()
808
if history is not None:
809
mutter("cache hit for revision-history in %s", self)
811
history = [l.rstrip('\r\n') for l in
812
self.controlfile('revision-history', 'r').readlines()]
813
transaction.map.add_revision_history(history)
814
# this call is disabled because revision_history is
815
# not really an object yet, and the transaction is for objects.
816
# transaction.register_clean(history, precious=True)
754
820
"""Return current revision number for this branch.
808
873
if stop_revision is None:
809
874
stop_revision = other_len
810
elif stop_revision > other_len:
811
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
876
assert isinstance(stop_revision, int)
877
if stop_revision > other_len:
878
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
813
879
return other_history[self_len:stop_revision]
816
881
def update_revisions(self, other, stop_revision=None):
817
"""Pull in all new revisions from other branch.
882
"""Pull in new perfect-fit revisions."""
883
# FIXME: If the branches have diverged, but the latest
884
# revision in this branch is completely merged into the other,
885
# then we should still be able to pull.
819
886
from bzrlib.fetch import greedy_fetch
820
from bzrlib.revision import get_intervening_revisions
887
if stop_revision is None:
888
stop_revision = other.last_revision()
889
### Should this be checking is_ancestor instead of revision_history?
890
if (stop_revision is not None and
891
stop_revision in self.revision_history()):
893
greedy_fetch(to_branch=self, from_branch=other,
894
revision=stop_revision)
895
pullable_revs = self.pullable_revisions(other, stop_revision)
896
if len(pullable_revs) > 0:
897
self.append_revision(*pullable_revs)
822
pb = bzrlib.ui.ui_factory.progress_bar()
823
pb.update('comparing histories')
824
if stop_revision is None:
825
other_revision = other.last_patch()
827
other_revision = other.get_rev_id(stop_revision)
828
count = greedy_fetch(self, other, other_revision, pb)[0]
899
def pullable_revisions(self, other, stop_revision):
900
other_revno = other.revision_id_to_revno(stop_revision)
830
revision_ids = self.missing_revisions(other, stop_revision)
902
return self.missing_revisions(other, other_revno)
831
903
except DivergedBranches, e:
833
revision_ids = get_intervening_revisions(self.last_patch(),
834
other_revision, self)
835
assert self.last_patch() not in revision_ids
905
pullable_revs = get_intervening_revisions(self.last_revision(),
907
assert self.last_revision() not in pullable_revs
836
909
except bzrlib.errors.NotAncestor:
839
self.append_revision(*revision_ids)
842
def install_revisions(self, other, revision_ids, pb):
843
if hasattr(other.revision_store, "prefetch"):
844
other.revision_store.prefetch(revision_ids)
845
if hasattr(other.inventory_store, "prefetch"):
847
for rev_id in revision_ids:
849
revision = other.get_revision(rev_id).inventory_id
850
inventory_ids.append(revision)
851
except bzrlib.errors.NoSuchRevision:
853
other.inventory_store.prefetch(inventory_ids)
856
pb = bzrlib.ui.ui_factory.progress_bar()
863
for i, rev_id in enumerate(revision_ids):
864
pb.update('fetching revision', i+1, len(revision_ids))
866
rev = other.get_revision(rev_id)
867
except bzrlib.errors.NoSuchRevision:
871
revisions.append(rev)
872
inv = other.get_inventory(str(rev.inventory_id))
873
for key, entry in inv.iter_entries():
874
if entry.text_id is None:
876
if entry.text_id not in self.text_store:
877
needed_texts.add(entry.text_id)
881
count, cp_fail = self.text_store.copy_multi(other.text_store,
883
#print "Added %d texts." % count
884
inventory_ids = [ f.inventory_id for f in revisions ]
885
count, cp_fail = self.inventory_store.copy_multi(other.inventory_store,
887
#print "Added %d inventories." % count
888
revision_ids = [ f.revision_id for f in revisions]
890
count, cp_fail = self.revision_store.copy_multi(other.revision_store,
893
assert len(cp_fail) == 0
894
return count, failures
910
if is_ancestor(self.last_revision(), stop_revision, self):
897
915
def commit(self, *args, **kw):
898
from bzrlib.commit import commit
899
commit(self, *args, **kw)
916
from bzrlib.commit import Commit
917
Commit().commit(self, *args, **kw)
901
919
def revision_id_to_revno(self, revision_id):
902
920
"""Given a revision id, return its revno"""
921
if revision_id is None:
903
923
history = self.revision_history()
905
925
return history.index(revision_id) + 1
943
966
If there are no revisions yet, return an `EmptyTree`.
945
r = self.last_patch()
949
return RevisionTree(self.text_store, self.get_revision_inventory(r))
968
return self.revision_tree(self.last_revision())
953
971
def rename_one(self, from_rel, to_rel):
954
972
"""Rename one file.
956
974
This can change the directory or the filename or both.
976
tree = self.working_tree()
978
if not tree.has_filename(from_rel):
979
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
980
if tree.has_filename(to_rel):
981
raise BzrError("can't rename: new working file %r already exists" % to_rel)
983
file_id = inv.path2id(from_rel)
985
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
987
if inv.path2id(to_rel):
988
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
990
to_dir, to_tail = os.path.split(to_rel)
991
to_dir_id = inv.path2id(to_dir)
992
if to_dir_id == None and to_dir != '':
993
raise BzrError("can't determine destination directory id for %r" % to_dir)
995
mutter("rename_one:")
996
mutter(" file_id {%s}" % file_id)
997
mutter(" from_rel %r" % from_rel)
998
mutter(" to_rel %r" % to_rel)
999
mutter(" to_dir %r" % to_dir)
1000
mutter(" to_dir_id {%s}" % to_dir_id)
1002
inv.rename(file_id, to_dir_id, to_tail)
1004
from_abs = self.abspath(from_rel)
1005
to_abs = self.abspath(to_rel)
960
tree = self.working_tree()
962
if not tree.has_filename(from_rel):
963
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
964
if tree.has_filename(to_rel):
965
raise BzrError("can't rename: new working file %r already exists" % to_rel)
967
file_id = inv.path2id(from_rel)
969
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
971
if inv.path2id(to_rel):
972
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
974
to_dir, to_tail = os.path.split(to_rel)
975
to_dir_id = inv.path2id(to_dir)
976
if to_dir_id == None and to_dir != '':
977
raise BzrError("can't determine destination directory id for %r" % to_dir)
979
mutter("rename_one:")
980
mutter(" file_id {%s}" % file_id)
981
mutter(" from_rel %r" % from_rel)
982
mutter(" to_rel %r" % to_rel)
983
mutter(" to_dir %r" % to_dir)
984
mutter(" to_dir_id {%s}" % to_dir_id)
986
inv.rename(file_id, to_dir_id, to_tail)
988
from_abs = self.abspath(from_rel)
989
to_abs = self.abspath(to_rel)
991
os.rename(from_abs, to_abs)
993
raise BzrError("failed to rename %r to %r: %s"
994
% (from_abs, to_abs, e[1]),
995
["rename rolled back"])
997
self._write_inventory(inv)
1007
rename(from_abs, to_abs)
1009
raise BzrError("failed to rename %r to %r: %s"
1010
% (from_abs, to_abs, e[1]),
1011
["rename rolled back"])
1013
self._write_inventory(inv)
1002
1016
def move(self, from_paths, to_name):
1003
1017
"""Rename files.
1014
1028
entry that is moved.
1019
## TODO: Option to move IDs only
1020
assert not isinstance(from_paths, basestring)
1021
tree = self.working_tree()
1022
inv = tree.inventory
1023
to_abs = self.abspath(to_name)
1024
if not isdir(to_abs):
1025
raise BzrError("destination %r is not a directory" % to_abs)
1026
if not tree.has_filename(to_name):
1027
raise BzrError("destination %r not in working directory" % to_abs)
1028
to_dir_id = inv.path2id(to_name)
1029
if to_dir_id == None and to_name != '':
1030
raise BzrError("destination %r is not a versioned directory" % to_name)
1031
to_dir_ie = inv[to_dir_id]
1032
if to_dir_ie.kind not in ('directory', 'root_directory'):
1033
raise BzrError("destination %r is not a directory" % to_abs)
1035
to_idpath = inv.get_idpath(to_dir_id)
1037
for f in from_paths:
1038
if not tree.has_filename(f):
1039
raise BzrError("%r does not exist in working tree" % f)
1040
f_id = inv.path2id(f)
1042
raise BzrError("%r is not versioned" % f)
1043
name_tail = splitpath(f)[-1]
1044
dest_path = appendpath(to_name, name_tail)
1045
if tree.has_filename(dest_path):
1046
raise BzrError("destination %r already exists" % dest_path)
1047
if f_id in to_idpath:
1048
raise BzrError("can't move %r to a subdirectory of itself" % f)
1050
# OK, so there's a race here, it's possible that someone will
1051
# create a file in this interval and then the rename might be
1052
# left half-done. But we should have caught most problems.
1054
for f in from_paths:
1055
name_tail = splitpath(f)[-1]
1056
dest_path = appendpath(to_name, name_tail)
1057
result.append((f, dest_path))
1058
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1060
os.rename(self.abspath(f), self.abspath(dest_path))
1062
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1063
["rename rolled back"])
1065
self._write_inventory(inv)
1031
## TODO: Option to move IDs only
1032
assert not isinstance(from_paths, basestring)
1033
tree = self.working_tree()
1034
inv = tree.inventory
1035
to_abs = self.abspath(to_name)
1036
if not isdir(to_abs):
1037
raise BzrError("destination %r is not a directory" % to_abs)
1038
if not tree.has_filename(to_name):
1039
raise BzrError("destination %r not in working directory" % to_abs)
1040
to_dir_id = inv.path2id(to_name)
1041
if to_dir_id == None and to_name != '':
1042
raise BzrError("destination %r is not a versioned directory" % to_name)
1043
to_dir_ie = inv[to_dir_id]
1044
if to_dir_ie.kind not in ('directory', 'root_directory'):
1045
raise BzrError("destination %r is not a directory" % to_abs)
1047
to_idpath = inv.get_idpath(to_dir_id)
1049
for f in from_paths:
1050
if not tree.has_filename(f):
1051
raise BzrError("%r does not exist in working tree" % f)
1052
f_id = inv.path2id(f)
1054
raise BzrError("%r is not versioned" % f)
1055
name_tail = splitpath(f)[-1]
1056
dest_path = appendpath(to_name, name_tail)
1057
if tree.has_filename(dest_path):
1058
raise BzrError("destination %r already exists" % dest_path)
1059
if f_id in to_idpath:
1060
raise BzrError("can't move %r to a subdirectory of itself" % f)
1062
# OK, so there's a race here, it's possible that someone will
1063
# create a file in this interval and then the rename might be
1064
# left half-done. But we should have caught most problems.
1066
for f in from_paths:
1067
name_tail = splitpath(f)[-1]
1068
dest_path = appendpath(to_name, name_tail)
1069
result.append((f, dest_path))
1070
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1072
rename(self.abspath(f), self.abspath(dest_path))
1074
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1075
["rename rolled back"])
1077
self._write_inventory(inv)
1203
1197
if revno < 1 or revno > self.revno():
1204
1198
raise InvalidRevisionNumber(revno)
1210
class ScratchBranch(LocalBranch):
1200
def sign_revision(self, revision_id, gpg_strategy):
1201
plaintext = Testament.from_revision(self, revision_id).as_short_text()
1202
self.store_revision_signature(gpg_strategy, plaintext, revision_id)
1205
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1206
self.revision_store.add(StringIO(gpg_strategy.sign(plaintext)),
1210
class ScratchBranch(_Branch):
1211
1211
"""Special test class: a branch that cleans up after itself.
1213
1213
>>> b = ScratchBranch()
1214
1214
>>> isdir(b.base)
1216
1216
>>> bd = b.base
1217
>>> b._transport.__del__()
1221
def __init__(self, files=[], dirs=[], base=None):
1222
def __init__(self, files=[], dirs=[], transport=None):
1222
1223
"""Make a test branch.
1224
1225
This creates a temporary directory and runs init-tree in it.
1226
1227
If any files are listed, they are created in the working copy.
1228
from tempfile import mkdtemp
1233
LocalBranch.__init__(self, base, init=init)
1229
if transport is None:
1230
transport = bzrlib.transport.local.ScratchTransport()
1231
super(ScratchBranch, self).__init__(transport, init=True)
1233
super(ScratchBranch, self).__init__(transport)
1235
os.mkdir(self.abspath(d))
1236
self._transport.mkdir(d)
1237
1238
for f in files:
1238
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
1239
self._transport.put(f, 'content of %s' % f)
1241
1242
def clone(self):
1243
1244
>>> orig = ScratchBranch(files=["file1", "file2"])
1244
1245
>>> clone = orig.clone()
1245
>>> os.path.samefile(orig.base, clone.base)
1246
>>> if os.name != 'nt':
1247
... os.path.samefile(orig.base, clone.base)
1249
... orig.base == clone.base
1247
1252
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1331
1314
return gen_file_id('TREE_ROOT')
1334
def copy_branch(branch_from, to_location, revision=None):
1335
"""Copy branch_from into the existing directory to_location.
1338
If not None, only revisions up to this point will be copied.
1339
The head of the new branch will be that revision.
1342
The name of a local directory that exists but is empty.
1344
from bzrlib.merge import merge
1345
from bzrlib.revisionspec import RevisionSpec
1347
assert isinstance(branch_from, Branch)
1348
assert isinstance(to_location, basestring)
1350
br_to = Branch.initialize(to_location)
1351
br_to.set_root_id(branch_from.get_root_id())
1352
if revision is None:
1353
revno = branch_from.revno()
1355
revno, rev_id = RevisionSpec(revision).in_history(branch_from)
1356
br_to.update_revisions(branch_from, stop_revision=revno)
1357
merge((to_location, -1), (to_location, 0), this_dir=to_location,
1358
check_clean=False, ignore_zero=True)
1359
br_to.set_parent(branch_from.base)