« back to all changes in this revision
Viewing changes to bzrlib/branch.py
- browse files at revision 735
- compare with another revision
- download diff
- download tarball
- view history from revision 735
- Committer: Martin Pool
- Date: 2005-06-22 06:37:20 UTC
- Revision ID: mbp@sourcefrog.net-20050622063720-14e87472f1b531e7
- clean up code for running tests in selfcontained directories
- files added:
- bzrlib/remotebranch.py
- files removed:
- HACKING
- bzrlib/plugins
- bzrlib/store
- bzrlib/transport
- bzrlib/util
- bzrlib/util/configobj
- bzrlib/util/configobj/docs
- bzrlib/util/effbot
- bzrlib/util/effbot/org
- contrib/emacs
- tools
- files renamed:
- contrib/newinventory.py => bzrlib/newinventory.py
- bzrlib/store/__init__.py => bzrlib/store.py
- bzrlib/util/elementtree/ => elementtree/
- bzrlib/util/urlgrabber/ => urlgrabber/
- files modified:
- .bzrignore
- bzr *
- setup.py *
added
removed
bzrlib/branch.py
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16
16
17
17
18
import sys
19
import os
20
import errno
21
from warnings import warn
22
from cStringIO import StringIO
23
18
import sys, os, os.path, random, time, sha, sets, types, re, shutil, tempfile
19
import traceback, socket, fnmatch, difflib, time
20
from binascii import hexlify
24
21
25
22
import bzrlib
26
from bzrlib.inventory import InventoryEntry
27
import bzrlib.inventory as inventory
28
from bzrlib.trace import mutter, note
29
from bzrlib.osutils import (isdir, quotefn, compact_date, rand_bytes,
30
rename, splitpath, sha_file, appendpath,
31
file_kind, abspath)
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)
37
from bzrlib.textui import show_status
38
from bzrlib.revision import (Revision, is_ancestor, get_intervening_revisions,
39
NULL_REVISION)
40
41
from bzrlib.delta import compare_trees
42
from bzrlib.tree import EmptyTree, RevisionTree
43
from bzrlib.inventory import Inventory
44
from bzrlib.store import copy_all
45
from bzrlib.store.compressed_text import CompressedTextStore
46
from bzrlib.store.text import TextStore
47
from bzrlib.store.weave import WeaveStore
48
from bzrlib.testament import Testament
49
import bzrlib.transactions as transactions
50
from bzrlib.transport import Transport, get_transport
51
import bzrlib.xml5
52
import bzrlib.ui
53
54
55
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
56
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
57
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
23
from inventory import Inventory
24
from trace import mutter, note
25
from tree import Tree, EmptyTree, RevisionTree
26
from inventory import InventoryEntry, Inventory
27
from osutils import isdir, quotefn, isfile, uuid, sha_file, username, \
28
format_date, compact_date, pumpfile, user_email, rand_bytes, splitpath, \
29
joinpath, sha_file, sha_string, file_kind, local_time_offset, appendpath
30
from store import ImmutableStore
31
from revision import Revision
32
from errors import BzrError
33
from textui import show_status
34
35
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
58
36
## TODO: Maybe include checks for common corruption of newlines, etc?
59
37
60
38
61
# TODO: Some operations like log might retrieve the same revisions
62
# repeatedly to calculate deltas. We could perhaps have a weakref
63
# cache in memory to make this faster. In general anything can be
64
# cached in memory between lock and unlock operations.
65
66
def find_branch(*ignored, **ignored_too):
67
# XXX: leave this here for about one release, then remove it
68
raise NotImplementedError('find_branch() is not supported anymore, '
69
'please use one of the new branch constructors')
70
71
72
def needs_read_lock(unbound):
73
"""Decorate unbound to take out and release a read lock."""
74
def decorated(self, *args, **kwargs):
75
self.lock_read()
76
try:
77
return unbound(self, *args, **kwargs)
78
finally:
79
self.unlock()
80
return decorated
81
82
83
def needs_write_lock(unbound):
84
"""Decorate unbound to take out and release a write lock."""
85
def decorated(self, *args, **kwargs):
86
self.lock_write()
87
try:
88
return unbound(self, *args, **kwargs)
89
finally:
90
self.unlock()
91
return decorated
39
40
def find_branch(f, **args):
41
if f and (f.startswith('http://') or f.startswith('https://')):
42
import remotebranch
43
return remotebranch.RemoteBranch(f, **args)
44
else:
45
return Branch(f, **args)
46
47
48
49
def _relpath(base, path):
50
"""Return path relative to base, or raise exception.
51
52
The path may be either an absolute path or a path relative to the
53
current working directory.
54
55
Lifted out of Branch.relpath for ease of testing.
56
57
os.path.commonprefix (python2.4) has a bad bug that it works just
58
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
59
avoids that problem."""
60
rp = os.path.abspath(path)
61
62
s = []
63
head = rp
64
while len(head) >= len(base):
65
if head == base:
66
break
67
head, tail = os.path.split(head)
68
if tail:
69
s.insert(0, tail)
70
else:
71
from errors import NotBranchError
72
raise NotBranchError("path %r is not within branch %r" % (rp, base))
73
74
return os.sep.join(s)
75
76
77
def find_branch_root(f=None):
78
"""Find the branch root enclosing f, or pwd.
79
80
f may be a filename or a URL.
81
82
It is not necessary that f exists.
83
84
Basically we keep looking up until we find the control directory or
85
run into the root."""
86
if f == None:
87
f = os.getcwd()
88
elif hasattr(os.path, 'realpath'):
89
f = os.path.realpath(f)
90
else:
91
f = os.path.abspath(f)
92
if not os.path.exists(f):
93
raise BzrError('%r does not exist' % f)
94
95
96
orig_f = f
97
98
while True:
99
if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
100
return f
101
head, tail = os.path.split(f)
102
if head == f:
103
# reached the root, whatever that may be
104
raise BzrError('%r is not in a branch' % orig_f)
105
f = head
106
107
class DivergedBranches(Exception):
108
def __init__(self, branch1, branch2):
109
self.branch1 = branch1
110
self.branch2 = branch2
111
Exception.__init__(self, "These branches have diverged.")
112
113
114
class NoSuchRevision(BzrError):
115
def __init__(self, branch, revision):
116
self.branch = branch
117
self.revision = revision
118
msg = "Branch %s has no revision %d" % (branch, revision)
119
BzrError.__init__(self, msg)
120
92
121
93
122
######################################################################
94
123
# branch objects
97
126
"""Branch holding a history of revisions.
98
127
99
128
base
100
Base directory/url of the branch.
101
"""
102
base = None
103
104
def __init__(self, *ignored, **ignored_too):
105
raise NotImplementedError('The Branch class is abstract')
106
107
@staticmethod
108
def open_downlevel(base):
109
"""Open a branch which may be of an old format.
110
111
Only local branches are supported."""
112
return _Branch(get_transport(base), relax_version_check=True)
113
114
@staticmethod
115
def open(base):
116
"""Open an existing branch, rooted at 'base' (url)"""
117
t = get_transport(base)
118
mutter("trying to open %r with transport %r", base, t)
119
return _Branch(t)
120
121
@staticmethod
122
def open_containing(url):
123
"""Open an existing branch which contains url.
124
125
This probes for a branch at url, and searches upwards from there.
126
127
Basically we keep looking up until we find the control directory or
128
run into the root. If there isn't one, raises NotBranchError.
129
If there is one, it is returned, along with the unused portion of url.
130
"""
131
t = get_transport(url)
132
while True:
133
try:
134
return _Branch(t), t.relpath(url)
135
except NotBranchError:
136
pass
137
new_t = t.clone('..')
138
if new_t.base == t.base:
139
# reached the root, whatever that may be
140
raise NotBranchError(path=url)
141
t = new_t
142
143
@staticmethod
144
def initialize(base):
145
"""Create a new branch, rooted at 'base' (url)"""
146
t = get_transport(base)
147
return _Branch(t, init=True)
148
149
def setup_caching(self, cache_root):
150
"""Subclasses that care about caching should override this, and set
151
up cached stores located under cache_root.
152
"""
153
self.cache_root = cache_root
154
155
156
class _Branch(Branch):
157
"""A branch stored in the actual filesystem.
158
159
Note that it's "local" in the context of the filesystem; it doesn't
160
really matter if it's on an nfs/smb/afs/coda/... share, as long as
161
it's writable, and can be accessed via the normal filesystem API.
129
Base directory of the branch.
162
130
163
131
_lock_mode
164
132
None, or 'r' or 'w'
170
138
_lock
171
139
Lock object from bzrlib.lock.
172
140
"""
173
# We actually expect this class to be somewhat short-lived; part of its
174
# purpose is to try to isolate what bits of the branch logic are tied to
175
# filesystem access, so that in a later step, we can extricate them to
176
# a separarte ("storage") class.
141
base = None
177
142
_lock_mode = None
178
143
_lock_count = None
179
144
_lock = None
180
_inventory_weave = None
181
145
182
# Map some sort of prefix into a namespace
183
# stuff like "revno:10", "revid:", etc.
184
# This should match a prefix with a function which accepts
185
REVISION_NAMESPACES = {}
186
187
def push_stores(self, branch_to):
188
"""Copy the content of this branches store to branch_to."""
189
if (self._branch_format != branch_to._branch_format
190
or self._branch_format != 4):
191
from bzrlib.fetch import greedy_fetch
192
mutter("falling back to fetch logic to push between %s(%s) and %s(%s)",
193
self, self._branch_format, branch_to, branch_to._branch_format)
194
greedy_fetch(to_branch=branch_to, from_branch=self,
195
revision=self.last_revision())
196
return
197
198
store_pairs = ((self.text_store, branch_to.text_store),
199
(self.inventory_store, branch_to.inventory_store),
200
(self.revision_store, branch_to.revision_store))
201
try:
202
for from_store, to_store in store_pairs:
203
copy_all(from_store, to_store)
204
except UnlistableStore:
205
raise UnlistableBranch(from_store)
206
207
def __init__(self, transport, init=False,
208
relax_version_check=False):
146
def __init__(self, base, init=False, find_root=True):
209
147
"""Create new branch object at a particular location.
210
148
211
transport -- A Transport object, defining how to access files.
149
base -- Base directory for the branch.
212
150
213
151
init -- If True, create new control files in a previously
214
152
unversioned directory. If False, the branch must already
215
153
be versioned.
216
154
217
relax_version_check -- If true, the usual check for the branch
218
version is not applied. This is intended only for
219
upgrade/recovery type use; it's not guaranteed that
220
all operations will work on old format branches.
155
find_root -- If true and init is false, find the root of the
156
existing branch containing base.
221
157
222
158
In the test suite, creation of new trees is tested using the
223
159
`ScratchBranch` class.
224
160
"""
225
assert isinstance(transport, Transport), \
226
"%r is not a Transport" % transport
227
self._transport = transport
228
161
if init:
162
self.base = os.path.realpath(base)
229
163
self._make_control()
230
self._check_format(relax_version_check)
231
232
def get_store(name, compressed=True, prefixed=False):
233
# FIXME: This approach of assuming stores are all entirely compressed
234
# or entirely uncompressed is tidy, but breaks upgrade from
235
# some existing branches where there's a mixture; we probably
236
# still want the option to look for both.
237
relpath = self._rel_controlfilename(name)
238
if compressed:
239
store = CompressedTextStore(self._transport.clone(relpath),
240
prefixed=prefixed)
241
else:
242
store = TextStore(self._transport.clone(relpath),
243
prefixed=prefixed)
244
#if self._transport.should_cache():
245
# cache_path = os.path.join(self.cache_root, name)
246
# os.mkdir(cache_path)
247
# store = bzrlib.store.CachedStore(store, cache_path)
248
return store
249
def get_weave(name, prefixed=False):
250
relpath = self._rel_controlfilename(name)
251
ws = WeaveStore(self._transport.clone(relpath), prefixed=prefixed)
252
if self._transport.should_cache():
253
ws.enable_cache = True
254
return ws
255
256
if self._branch_format == 4:
257
self.inventory_store = get_store('inventory-store')
258
self.text_store = get_store('text-store')
259
self.revision_store = get_store('revision-store')
260
elif self._branch_format == 5:
261
self.control_weaves = get_weave('')
262
self.weave_store = get_weave('weaves')
263
self.revision_store = get_store('revision-store', compressed=False)
264
elif self._branch_format == 6:
265
self.control_weaves = get_weave('')
266
self.weave_store = get_weave('weaves', prefixed=True)
267
self.revision_store = get_store('revision-store', compressed=False,
268
prefixed=True)
269
self.revision_store.register_suffix('sig')
270
self._transaction = None
164
elif find_root:
165
self.base = find_branch_root(base)
166
else:
167
self.base = os.path.realpath(base)
168
if not isdir(self.controlfilename('.')):
169
from errors import NotBranchError
170
raise NotBranchError("not a bzr branch: %s" % quotefn(base),
171
['use "bzr init" to initialize a new working tree',
172
'current bzr can only operate from top-of-tree'])
173
self._check_format()
174
175
self.text_store = ImmutableStore(self.controlfilename('text-store'))
176
self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
177
self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
178
271
179
272
180
def __str__(self):
273
return '%s(%r)' % (self.__class__.__name__, self._transport.base)
181
return '%s(%r)' % (self.__class__.__name__, self.base)
274
182
275
183
276
184
__repr__ = __str__
278
186
279
187
def __del__(self):
280
188
if self._lock_mode or self._lock:
281
# XXX: This should show something every time, and be suitable for
282
# headless operation and embedding
189
from warnings import warn
283
190
warn("branch %r was not explicitly unlocked" % self)
284
191
self._lock.unlock()
285
192
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:
293
try:
294
import shutil
295
shutil.rmtree(self.cache_root)
296
except:
297
pass
298
self.cache_root = None
299
300
def _get_base(self):
301
if self._transport:
302
return self._transport.base
303
return None
304
305
base = property(_get_base, doc="The URL for the root of this branch.")
306
307
def _finish_transaction(self):
308
"""Exit the current transaction."""
309
if self._transaction is None:
310
raise errors.LockError('Branch %s is not in a transaction' %
311
self)
312
transaction = self._transaction
313
self._transaction = None
314
transaction.finish()
315
316
def get_transaction(self):
317
"""Return the current active transaction.
318
319
If no transaction is active, this returns a passthrough object
320
for which all data is immediately flushed and no caching happens.
321
"""
322
if self._transaction is None:
323
return transactions.PassThroughTransaction()
324
else:
325
return self._transaction
326
327
def _set_transaction(self, new_transaction):
328
"""Set a new active transaction."""
329
if self._transaction is not None:
330
raise errors.LockError('Branch %s is in a transaction already.' %
331
self)
332
self._transaction = new_transaction
193
333
194
334
195
def lock_write(self):
335
mutter("lock write: %s (%s)", self, self._lock_count)
336
# TODO: Upgrade locking to support using a Transport,
337
# and potentially a remote locking protocol
338
196
if self._lock_mode:
339
197
if self._lock_mode != 'w':
198
from errors import LockError
340
199
raise LockError("can't upgrade to a write lock from %r" %
341
200
self._lock_mode)
342
201
self._lock_count += 1
343
202
else:
344
self._lock = self._transport.lock_write(
345
self._rel_controlfilename('branch-lock'))
203
from bzrlib.lock import WriteLock
204
205
self._lock = WriteLock(self.controlfilename('branch-lock'))
346
206
self._lock_mode = 'w'
347
207
self._lock_count = 1
348
self._set_transaction(transactions.PassThroughTransaction())
208
209
349
210
350
211
def lock_read(self):
351
mutter("lock read: %s (%s)", self, self._lock_count)
352
212
if self._lock_mode:
353
213
assert self._lock_mode in ('r', 'w'), \
354
214
"invalid lock mode %r" % self._lock_mode
355
215
self._lock_count += 1
356
216
else:
357
self._lock = self._transport.lock_read(
358
self._rel_controlfilename('branch-lock'))
217
from bzrlib.lock import ReadLock
218
219
self._lock = ReadLock(self.controlfilename('branch-lock'))
359
220
self._lock_mode = 'r'
360
221
self._lock_count = 1
361
self._set_transaction(transactions.ReadOnlyTransaction())
362
# 5K may be excessive, but hey, its a knob.
363
self.get_transaction().set_cache_size(5000)
364
222
223
224
365
225
def unlock(self):
366
mutter("unlock: %s (%s)", self, self._lock_count)
367
226
if not self._lock_mode:
227
from errors import LockError
368
228
raise LockError('branch %r is not locked' % (self))
369
229
370
230
if self._lock_count > 1:
371
231
self._lock_count -= 1
372
232
else:
373
self._finish_transaction()
374
233
self._lock.unlock()
375
234
self._lock = None
376
235
self._lock_mode = self._lock_count = None
377
236
237
378
238
def abspath(self, name):
379
"""Return absolute filename for something in the branch
380
381
XXX: Robert Collins 20051017 what is this used for? why is it a branch
382
method and not a tree method.
383
"""
384
return self._transport.abspath(name)
385
386
def _rel_controlfilename(self, file_or_path):
387
if not isinstance(file_or_path, basestring):
388
file_or_path = '/'.join(file_or_path)
389
if file_or_path == '':
390
return bzrlib.BZRDIR
391
return bzrlib.transport.urlescape(bzrlib.BZRDIR + '/' + file_or_path)
239
"""Return absolute filename for something in the branch"""
240
return os.path.join(self.base, name)
241
242
243
def relpath(self, path):
244
"""Return path relative to this branch of something inside it.
245
246
Raises an error if path is not in this branch."""
247
return _relpath(self.base, path)
248
392
249
393
250
def controlfilename(self, file_or_path):
394
251
"""Return location relative to branch."""
395
return self._transport.abspath(self._rel_controlfilename(file_or_path))
252
if isinstance(file_or_path, types.StringTypes):
253
file_or_path = [file_or_path]
254
return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
255
396
256
397
257
def controlfile(self, file_or_path, mode='r'):
398
258
"""Open a control file for this branch.
405
265
Controlfiles should almost never be opened in write mode but
406
266
rather should be atomically copied and replaced using atomicfile.
407
267
"""
408
import codecs
409
410
relpath = self._rel_controlfilename(file_or_path)
411
#TODO: codecs.open() buffers linewise, so it was overloaded with
412
# a much larger buffer, do we need to do the same for getreader/getwriter?
413
if mode == 'rb':
414
return self._transport.get(relpath)
415
elif mode == 'wb':
416
raise BzrError("Branch.controlfile(mode='wb') is not supported, use put_controlfiles")
417
elif mode == 'r':
418
return codecs.getreader('utf-8')(self._transport.get(relpath), errors='replace')
419
elif mode == 'w':
420
raise BzrError("Branch.controlfile(mode='w') is not supported, use put_controlfiles")
268
269
fn = self.controlfilename(file_or_path)
270
271
if mode == 'rb' or mode == 'wb':
272
return file(fn, mode)
273
elif mode == 'r' or mode == 'w':
274
# open in binary mode anyhow so there's no newline translation;
275
# codecs uses line buffering by default; don't want that.
276
import codecs
277
return codecs.open(fn, mode + 'b', 'utf-8',
278
buffering=60000)
421
279
else:
422
280
raise BzrError("invalid controlfile mode %r" % mode)
423
281
424
def put_controlfile(self, path, f, encode=True):
425
"""Write an entry as a controlfile.
426
427
:param path: The path to put the file, relative to the .bzr control
428
directory
429
:param f: A file-like or string object whose contents should be copied.
430
:param encode: If true, encode the contents as utf-8
431
"""
432
self.put_controlfiles([(path, f)], encode=encode)
433
434
def put_controlfiles(self, files, encode=True):
435
"""Write several entries as controlfiles.
436
437
:param files: A list of [(path, file)] pairs, where the path is the directory
438
underneath the bzr control directory
439
:param encode: If true, encode the contents as utf-8
440
"""
441
import codecs
442
ctrl_files = []
443
for path, f in files:
444
if encode:
445
if isinstance(f, basestring):
446
f = f.encode('utf-8', 'replace')
447
else:
448
f = codecs.getwriter('utf-8')(f, errors='replace')
449
path = self._rel_controlfilename(path)
450
ctrl_files.append((path, f))
451
self._transport.put_multi(ctrl_files)
282
452
283
453
284
def _make_control(self):
454
from bzrlib.inventory import Inventory
455
from bzrlib.weavefile import write_weave_v5
456
from bzrlib.weave import Weave
457
458
# Create an empty inventory
459
sio = StringIO()
460
# if we want per-tree root ids then this is the place to set
461
# them; they're not needed for now and so ommitted for
462
# simplicity.
463
bzrlib.xml5.serializer_v5.write_inventory(Inventory(), sio)
464
empty_inv = sio.getvalue()
465
sio = StringIO()
466
bzrlib.weavefile.write_weave_v5(Weave(), sio)
467
empty_weave = sio.getvalue()
468
469
dirs = [[], 'revision-store', 'weaves']
470
files = [('README',
285
os.mkdir(self.controlfilename([]))
286
self.controlfile('README', 'w').write(
471
287
"This is a Bazaar-NG control directory.\n"
472
"Do not change any files in this directory.\n"),
473
('branch-format', BZR_BRANCH_FORMAT_6),
474
('revision-history', ''),
475
('branch-name', ''),
476
('branch-lock', ''),
477
('pending-merges', ''),
478
('inventory', empty_inv),
479
('inventory.weave', empty_weave),
480
('ancestry.weave', empty_weave)
481
]
482
cfn = self._rel_controlfilename
483
self._transport.mkdir_multi([cfn(d) for d in dirs])
484
self.put_controlfiles(files)
485
mutter('created control directory in ' + self._transport.base)
486
487
def _check_format(self, relax_version_check):
288
"Do not change any files in this directory.\n")
289
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
290
for d in ('text-store', 'inventory-store', 'revision-store'):
291
os.mkdir(self.controlfilename(d))
292
for f in ('revision-history', 'merged-patches',
293
'pending-merged-patches', 'branch-name',
294
'branch-lock'):
295
self.controlfile(f, 'w').write('')
296
mutter('created control directory in ' + self.base)
297
Inventory().write_xml(self.controlfile('inventory','w'))
298
299
300
def _check_format(self):
488
301
"""Check this branch format is supported.
489
302
490
The format level is stored, as an integer, in
491
self._branch_format for code that needs to check it later.
303
The current tool only supports the current unstable format.
492
304
493
305
In the future, we might need different in-memory Branch
494
306
classes to support downlevel branches. But not yet.
495
307
"""
496
try:
497
fmt = self.controlfile('branch-format', 'r').read()
498
except NoSuchFile:
499
raise NotBranchError(path=self.base)
500
mutter("got branch format %r", fmt)
501
if fmt == BZR_BRANCH_FORMAT_6:
502
self._branch_format = 6
503
elif fmt == BZR_BRANCH_FORMAT_5:
504
self._branch_format = 5
505
elif fmt == BZR_BRANCH_FORMAT_4:
506
self._branch_format = 4
507
508
if (not relax_version_check
509
and self._branch_format not in (5, 6)):
510
raise errors.UnsupportedFormatError(
511
'sorry, branch format %r not supported' % fmt,
308
# This ignores newlines so that we can open branches created
309
# on Windows from Linux and so on. I think it might be better
310
# to always make all internal files in unix format.
311
fmt = self.controlfile('branch-format', 'r').read()
312
fmt.replace('\r\n', '')
313
if fmt != BZR_BRANCH_FORMAT:
314
raise BzrError('sorry, branch format %r not supported' % fmt,
512
315
['use a different bzr version',
513
'or remove the .bzr directory'
514
' and "bzr init" again'])
515
516
def get_root_id(self):
517
"""Return the id of this branches root"""
518
inv = self.read_working_inventory()
519
return inv.root.file_id
520
521
def set_root_id(self, file_id):
522
inv = self.read_working_inventory()
523
orig_root_id = inv.root.file_id
524
del inv._byid[inv.root.file_id]
525
inv.root.file_id = file_id
526
inv._byid[inv.root.file_id] = inv.root
527
for fid in inv:
528
entry = inv[fid]
529
if entry.parent_id in (None, orig_root_id):
530
entry.parent_id = inv.root.file_id
531
self._write_inventory(inv)
532
533
@needs_read_lock
316
'or remove the .bzr directory and "bzr init" again'])
317
318
319
534
320
def read_working_inventory(self):
535
321
"""Read the working inventory."""
322
before = time.time()
536
323
# ElementTree does its own conversion from UTF-8, so open in
537
324
# binary.
538
f = self.controlfile('inventory', 'rb')
539
return bzrlib.xml5.serializer_v5.read_inventory(f)
325
self.lock_read()
326
try:
327
inv = Inventory.read_xml(self.controlfile('inventory', 'rb'))
328
mutter("loaded inventory of %d items in %f"
329
% (len(inv), time.time() - before))
330
return inv
331
finally:
332
self.unlock()
333
540
334
541
@needs_write_lock
542
335
def _write_inventory(self, inv):
543
336
"""Update the working inventory.
544
337
545
338
That is to say, the inventory describing changes underway, that
546
339
will be committed to the next revision.
547
340
"""
548
from cStringIO import StringIO
549
sio = StringIO()
550
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
551
sio.seek(0)
552
# Transport handles atomicity
553
self.put_controlfile('inventory', sio)
554
341
## TODO: factor out to atomicfile? is rename safe on windows?
342
## TODO: Maybe some kind of clean/dirty marker on inventory?
343
tmpfname = self.controlfilename('inventory.tmp')
344
tmpf = file(tmpfname, 'wb')
345
inv.write_xml(tmpf)
346
tmpf.close()
347
inv_fname = self.controlfilename('inventory')
348
if sys.platform == 'win32':
349
os.remove(inv_fname)
350
os.rename(tmpfname, inv_fname)
555
351
mutter('wrote working inventory')
556
352
353
557
354
inventory = property(read_working_inventory, _write_inventory, None,
558
355
"""Inventory for the working copy.""")
559
356
560
@needs_write_lock
561
def add(self, files, ids=None):
357
358
def add(self, files, verbose=False, ids=None):
562
359
"""Make files versioned.
563
360
564
Note that the command line normally calls smart_add instead,
565
which can automatically recurse.
361
Note that the command line normally calls smart_add instead.
566
362
567
363
This puts the files in the Added state, so that they will be
568
364
recorded by the next commit.
578
374
TODO: Perhaps have an option to add the ids even if the files do
579
375
not (yet) exist.
580
376
581
TODO: Perhaps yield the ids and paths as they're added.
377
TODO: Perhaps return the ids of the files? But then again it
378
is easy to retrieve them if they're needed.
379
380
TODO: Adding a directory should optionally recurse down and
381
add all non-ignored children. Perhaps do that in a
382
higher-level method.
582
383
"""
583
384
# TODO: Re-adding a file that is removed in the working copy
584
385
# should probably put it back with the previous ID.
585
if isinstance(files, basestring):
586
assert(ids is None or isinstance(ids, basestring))
386
if isinstance(files, types.StringTypes):
387
assert(ids is None or isinstance(ids, types.StringTypes))
587
388
files = [files]
588
389
if ids is not None:
589
390
ids = [ids]
593
394
else:
594
395
assert(len(ids) == len(files))
595
396
596
inv = self.read_working_inventory()
597
for f,file_id in zip(files, ids):
598
if is_control_file(f):
599
raise BzrError("cannot add control file %s" % quotefn(f))
600
601
fp = splitpath(f)
602
603
if len(fp) == 0:
604
raise BzrError("cannot add top-level %r" % f)
605
606
fullpath = os.path.normpath(self.abspath(f))
607
608
try:
609
kind = file_kind(fullpath)
610
except OSError:
611
# maybe something better?
612
raise BzrError('cannot add: not a regular file, symlink or directory: %s' % quotefn(f))
613
614
if not InventoryEntry.versionable_kind(kind):
615
raise BzrError('cannot add: not a versionable file ('
616
'i.e. regular file, symlink or directory): %s' % quotefn(f))
617
618
if file_id is None:
619
file_id = gen_file_id(f)
620
inv.add_path(f, kind=kind, file_id=file_id)
621
622
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
623
624
self._write_inventory(inv)
625
626
@needs_read_lock
397
self.lock_write()
398
try:
399
inv = self.read_working_inventory()
400
for f,file_id in zip(files, ids):
401
if is_control_file(f):
402
raise BzrError("cannot add control file %s" % quotefn(f))
403
404
fp = splitpath(f)
405
406
if len(fp) == 0:
407
raise BzrError("cannot add top-level %r" % f)
408
409
fullpath = os.path.normpath(self.abspath(f))
410
411
try:
412
kind = file_kind(fullpath)
413
except OSError:
414
# maybe something better?
415
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
416
417
if kind != 'file' and kind != 'directory':
418
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
419
420
if file_id is None:
421
file_id = gen_file_id(f)
422
inv.add_path(f, kind=kind, file_id=file_id)
423
424
if verbose:
425
show_status('A', kind, quotefn(f))
426
427
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
428
429
self._write_inventory(inv)
430
finally:
431
self.unlock()
432
433
627
434
def print_file(self, file, revno):
628
435
"""Print `file` to stdout."""
629
tree = self.revision_tree(self.get_rev_id(revno))
630
# use inventory as it was in that revision
631
file_id = tree.inventory.path2id(file)
632
if not file_id:
633
raise BzrError("%r is not present in revision %s" % (file, revno))
634
tree.print_file(file_id)
436
self.lock_read()
437
try:
438
tree = self.revision_tree(self.lookup_revision(revno))
439
# use inventory as it was in that revision
440
file_id = tree.inventory.path2id(file)
441
if not file_id:
442
raise BzrError("%r is not present in revision %d" % (file, revno))
443
tree.print_file(file_id)
444
finally:
445
self.unlock()
446
447
448
def remove(self, files, verbose=False):
449
"""Mark nominated files for removal from the inventory.
450
451
This does not remove their text. This does not run on
452
453
TODO: Refuse to remove modified files unless --force is given?
454
455
TODO: Do something useful with directories.
456
457
TODO: Should this remove the text or not? Tough call; not
458
removing may be useful and the user can just use use rm, and
459
is the opposite of add. Removing it is consistent with most
460
other tools. Maybe an option.
461
"""
462
## TODO: Normalize names
463
## TODO: Remove nested loops; better scalability
464
if isinstance(files, types.StringTypes):
465
files = [files]
466
467
self.lock_write()
468
469
try:
470
tree = self.working_tree()
471
inv = tree.inventory
472
473
# do this before any modifications
474
for f in files:
475
fid = inv.path2id(f)
476
if not fid:
477
raise BzrError("cannot remove unversioned file %s" % quotefn(f))
478
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
479
if verbose:
480
# having remove it, it must be either ignored or unknown
481
if tree.is_ignored(f):
482
new_status = 'I'
483
else:
484
new_status = '?'
485
show_status(new_status, inv[fid].kind, quotefn(f))
486
del inv[fid]
487
488
self._write_inventory(inv)
489
finally:
490
self.unlock()
491
635
492
636
493
# FIXME: this doesn't need to be a branch method
637
494
def set_inventory(self, new_inventory_list):
638
from bzrlib.inventory import Inventory, InventoryEntry
639
inv = Inventory(self.get_root_id())
495
inv = Inventory()
640
496
for path, file_id, parent, kind in new_inventory_list:
641
497
name = os.path.basename(path)
642
498
if name == "":
643
499
continue
644
# fixme, there should be a factory function inv,add_??
645
if kind == 'directory':
646
inv.add(inventory.InventoryDirectory(file_id, name, parent))
647
elif kind == 'file':
648
inv.add(inventory.InventoryFile(file_id, name, parent))
649
elif kind == 'symlink':
650
inv.add(inventory.InventoryLink(file_id, name, parent))
651
else:
652
raise BzrError("unknown kind %r" % kind)
500
inv.add(InventoryEntry(file_id, name, kind, parent))
653
501
self._write_inventory(inv)
654
502
503
655
504
def unknowns(self):
656
505
"""Return all unknown files.
657
506
658
507
These are files in the working directory that are not versioned or
659
508
control files or ignored.
660
509
661
>>> from bzrlib.workingtree import WorkingTree
662
510
>>> b = ScratchBranch(files=['foo', 'foo~'])
663
>>> map(str, b.unknowns())
511
>>> list(b.unknowns())
664
512
['foo']
665
513
>>> b.add('foo')
666
514
>>> list(b.unknowns())
667
515
[]
668
>>> WorkingTree(b.base, b).remove('foo')
516
>>> b.remove('foo')
669
517
>>> list(b.unknowns())
670
[u'foo']
518
['foo']
671
519
"""
672
520
return self.working_tree().unknowns()
673
521
674
@needs_write_lock
675
def append_revision(self, *revision_ids):
676
for revision_id in revision_ids:
677
mutter("add {%s} to revision-history" % revision_id)
522
523
def append_revision(self, revision_id):
524
mutter("add {%s} to revision-history" % revision_id)
678
525
rev_history = self.revision_history()
679
rev_history.extend(revision_ids)
680
self.set_revision_history(rev_history)
681
682
@needs_write_lock
683
def set_revision_history(self, rev_history):
684
self.put_controlfile('revision-history', '\n'.join(rev_history))
685
686
def has_revision(self, revision_id):
687
"""True if this branch has a copy of the revision.
688
689
This does not necessarily imply the revision is merge
690
or on the mainline."""
691
return (revision_id is None
692
or self.revision_store.has_id(revision_id))
693
694
@needs_read_lock
695
def get_revision_xml_file(self, revision_id):
696
"""Return XML file object for revision object."""
697
if not revision_id or not isinstance(revision_id, basestring):
698
raise InvalidRevisionId(revision_id=revision_id, branch=self)
699
try:
700
return self.revision_store.get(revision_id)
701
except (IndexError, KeyError):
702
raise bzrlib.errors.NoSuchRevision(self, revision_id)
703
704
#deprecated
705
get_revision_xml = get_revision_xml_file
706
707
def get_revision_xml(self, revision_id):
708
return self.get_revision_xml_file(revision_id).read()
526
527
tmprhname = self.controlfilename('revision-history.tmp')
528
rhname = self.controlfilename('revision-history')
529
530
f = file(tmprhname, 'wt')
531
rev_history.append(revision_id)
532
f.write('\n'.join(rev_history))
533
f.write('\n')
534
f.close()
535
536
if sys.platform == 'win32':
537
os.remove(rhname)
538
os.rename(tmprhname, rhname)
539
709
540
710
541
711
542
def get_revision(self, revision_id):
712
543
"""Return the Revision object for a named revision"""
713
xml_file = self.get_revision_xml_file(revision_id)
714
715
try:
716
r = bzrlib.xml5.serializer_v5.read_revision(xml_file)
717
except SyntaxError, e:
718
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
719
[revision_id,
720
str(e)])
721
544
if not revision_id or not isinstance(revision_id, basestring):
545
raise ValueError('invalid revision-id: %r' % revision_id)
546
r = Revision.read_xml(self.revision_store[revision_id])
722
547
assert r.revision_id == revision_id
723
548
return r
724
549
725
def get_revision_delta(self, revno):
726
"""Return the delta for one revision.
727
728
The delta is relative to its mainline predecessor, or the
729
empty tree for revision 1.
730
"""
731
assert isinstance(revno, int)
732
rh = self.revision_history()
733
if not (1 <= revno <= len(rh)):
734
raise InvalidRevisionNumber(revno)
735
736
# revno is 1-based; list is 0-based
737
738
new_tree = self.revision_tree(rh[revno-1])
739
if revno == 1:
740
old_tree = EmptyTree()
741
else:
742
old_tree = self.revision_tree(rh[revno-2])
743
744
return compare_trees(old_tree, new_tree)
745
746
550
def get_revision_sha1(self, revision_id):
747
551
"""Hash the stored value of a revision, and return it."""
748
552
# In the future, revision entries will be signed. At that
751
555
# the revision, (add signatures/remove signatures) and still
752
556
# have all hash pointers stay consistent.
753
557
# But for now, just hash the contents.
754
return bzrlib.osutils.sha_file(self.get_revision_xml_file(revision_id))
755
756
def get_ancestry(self, revision_id):
757
"""Return a list of revision-ids integrated by a revision.
758
759
This currently returns a list, but the ordering is not guaranteed:
760
treat it as a set.
761
"""
762
if revision_id is None:
763
return [None]
764
w = self.get_inventory_weave()
765
return [None] + map(w.idx_to_name,
766
w.inclusions([w.lookup(revision_id)]))
767
768
def get_inventory_weave(self):
769
return self.control_weaves.get_weave('inventory',
770
self.get_transaction())
771
772
def get_inventory(self, revision_id):
773
"""Get Inventory object by hash."""
774
xml = self.get_inventory_xml(revision_id)
775
return bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
776
777
def get_inventory_xml(self, revision_id):
778
"""Get inventory XML as a file object."""
779
try:
780
assert isinstance(revision_id, basestring), type(revision_id)
781
iw = self.get_inventory_weave()
782
return iw.get_text(iw.lookup(revision_id))
783
except IndexError:
784
raise bzrlib.errors.HistoryMissing(self, 'inventory', revision_id)
785
786
def get_inventory_sha1(self, revision_id):
558
return sha_file(self.revision_store[revision_id])
559
560
561
def get_inventory(self, inventory_id):
562
"""Get Inventory object by hash.
563
564
TODO: Perhaps for this and similar methods, take a revision
565
parameter which can be either an integer revno or a
566
string hash."""
567
i = Inventory.read_xml(self.inventory_store[inventory_id])
568
return i
569
570
def get_inventory_sha1(self, inventory_id):
787
571
"""Return the sha1 hash of the inventory entry
788
572
"""
789
return self.get_revision(revision_id).inventory_sha1
573
return sha_file(self.inventory_store[inventory_id])
574
790
575
791
576
def get_revision_inventory(self, revision_id):
792
577
"""Return inventory of a past revision."""
793
# TODO: Unify this with get_inventory()
794
# bzr 0.0.6 and later imposes the constraint that the inventory_id
795
# must be the same as its revision, so this is trivial.
796
578
if revision_id == None:
797
return Inventory(self.get_root_id())
579
return Inventory()
798
580
else:
799
return self.get_inventory(revision_id)
800
801
@needs_read_lock
581
return self.get_inventory(self.get_revision(revision_id).inventory_id)
582
583
802
584
def revision_history(self):
803
"""Return sequence of revision hashes on to this branch."""
804
transaction = self.get_transaction()
805
history = transaction.map.find_revision_history()
806
if history is not None:
807
mutter("cache hit for revision-history in %s", self)
808
return list(history)
809
history = [l.rstrip('\r\n') for l in
810
self.controlfile('revision-history', 'r').readlines()]
811
transaction.map.add_revision_history(history)
812
# this call is disabled because revision_history is
813
# not really an object yet, and the transaction is for objects.
814
# transaction.register_clean(history, precious=True)
815
return list(history)
585
"""Return sequence of revision hashes on to this branch.
586
587
>>> ScratchBranch().revision_history()
588
[]
589
"""
590
self.lock_read()
591
try:
592
return [l.rstrip('\r\n') for l in
593
self.controlfile('revision-history', 'r').readlines()]
594
finally:
595
self.unlock()
596
597
598
def common_ancestor(self, other, self_revno=None, other_revno=None):
599
"""
600
>>> import commit
601
>>> sb = ScratchBranch(files=['foo', 'foo~'])
602
>>> sb.common_ancestor(sb) == (None, None)
603
True
604
>>> commit.commit(sb, "Committing first revision", verbose=False)
605
>>> sb.common_ancestor(sb)[0]
606
1
607
>>> clone = sb.clone()
608
>>> commit.commit(sb, "Committing second revision", verbose=False)
609
>>> sb.common_ancestor(sb)[0]
610
2
611
>>> sb.common_ancestor(clone)[0]
612
1
613
>>> commit.commit(clone, "Committing divergent second revision",
614
... verbose=False)
615
>>> sb.common_ancestor(clone)[0]
616
1
617
>>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
618
True
619
>>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
620
True
621
>>> clone2 = sb.clone()
622
>>> sb.common_ancestor(clone2)[0]
623
2
624
>>> sb.common_ancestor(clone2, self_revno=1)[0]
625
1
626
>>> sb.common_ancestor(clone2, other_revno=1)[0]
627
1
628
"""
629
my_history = self.revision_history()
630
other_history = other.revision_history()
631
if self_revno is None:
632
self_revno = len(my_history)
633
if other_revno is None:
634
other_revno = len(other_history)
635
indices = range(min((self_revno, other_revno)))
636
indices.reverse()
637
for r in indices:
638
if my_history[r] == other_history[r]:
639
return r+1, my_history[r]
640
return None, None
641
642
def enum_history(self, direction):
643
"""Return (revno, revision_id) for history of branch.
644
645
direction
646
'forward' is from earliest to latest
647
'reverse' is from latest to earliest
648
"""
649
rh = self.revision_history()
650
if direction == 'forward':
651
i = 1
652
for rid in rh:
653
yield i, rid
654
i += 1
655
elif direction == 'reverse':
656
i = len(rh)
657
while i > 0:
658
yield i, rh[i-1]
659
i -= 1
660
else:
661
raise ValueError('invalid history direction', direction)
662
816
663
817
664
def revno(self):
818
665
"""Return current revision number for this branch.
822
669
"""
823
670
return len(self.revision_history())
824
671
825
def last_revision(self):
672
673
def last_patch(self):
826
674
"""Return last patch hash, or None if no history.
827
675
"""
828
676
ph = self.revision_history()
831
679
else:
832
680
return None
833
681
834
def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
835
"""Return a list of new revisions that would perfectly fit.
836
682
683
def missing_revisions(self, other, stop_revision=None):
684
"""
837
685
If self and other have not diverged, return a list of the revisions
838
686
present in other, but missing from self.
839
687
870
718
871
719
if stop_revision is None:
872
720
stop_revision = other_len
873
else:
874
assert isinstance(stop_revision, int)
875
if stop_revision > other_len:
876
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
721
elif stop_revision > other_len:
722
raise NoSuchRevision(self, stop_revision)
723
877
724
return other_history[self_len:stop_revision]
878
725
726
879
727
def update_revisions(self, other, stop_revision=None):
880
"""Pull in new perfect-fit revisions."""
881
from bzrlib.fetch import greedy_fetch
882
if stop_revision is None:
883
stop_revision = other.last_revision()
884
### Should this be checking is_ancestor instead of revision_history?
885
if (stop_revision is not None and
886
stop_revision in self.revision_history()):
887
return
888
greedy_fetch(to_branch=self, from_branch=other,
889
revision=stop_revision)
890
pullable_revs = self.pullable_revisions(other, stop_revision)
891
if len(pullable_revs) > 0:
892
self.append_revision(*pullable_revs)
893
894
def pullable_revisions(self, other, stop_revision):
895
other_revno = other.revision_id_to_revno(stop_revision)
896
try:
897
return self.missing_revisions(other, other_revno)
898
except DivergedBranches, e:
899
try:
900
pullable_revs = get_intervening_revisions(self.last_revision(),
901
stop_revision, self)
902
assert self.last_revision() not in pullable_revs
903
return pullable_revs
904
except bzrlib.errors.NotAncestor:
905
if is_ancestor(self.last_revision(), stop_revision, self):
906
return []
907
else:
908
raise e
728
"""Pull in all new revisions from other branch.
729
730
>>> from bzrlib.commit import commit
731
>>> bzrlib.trace.silent = True
732
>>> br1 = ScratchBranch(files=['foo', 'bar'])
733
>>> br1.add('foo')
734
>>> br1.add('bar')
735
>>> commit(br1, "lala!", rev_id="REVISION-ID-1", verbose=False)
736
>>> br2 = ScratchBranch()
737
>>> br2.update_revisions(br1)
738
Added 2 texts.
739
Added 1 inventories.
740
Added 1 revisions.
741
>>> br2.revision_history()
742
[u'REVISION-ID-1']
743
>>> br2.update_revisions(br1)
744
Added 0 texts.
745
Added 0 inventories.
746
Added 0 revisions.
747
>>> br1.text_store.total_size() == br2.text_store.total_size()
748
True
749
"""
750
from bzrlib.progress import ProgressBar
751
752
pb = ProgressBar()
753
754
pb.update('comparing histories')
755
revision_ids = self.missing_revisions(other, stop_revision)
756
revisions = []
757
needed_texts = sets.Set()
758
i = 0
759
for rev_id in revision_ids:
760
i += 1
761
pb.update('fetching revision', i, len(revision_ids))
762
rev = other.get_revision(rev_id)
763
revisions.append(rev)
764
inv = other.get_inventory(str(rev.inventory_id))
765
for key, entry in inv.iter_entries():
766
if entry.text_id is None:
767
continue
768
if entry.text_id not in self.text_store:
769
needed_texts.add(entry.text_id)
770
771
pb.clear()
772
773
count = self.text_store.copy_multi(other.text_store, needed_texts)
774
print "Added %d texts." % count
775
inventory_ids = [ f.inventory_id for f in revisions ]
776
count = self.inventory_store.copy_multi(other.inventory_store,
777
inventory_ids)
778
print "Added %d inventories." % count
779
revision_ids = [ f.revision_id for f in revisions]
780
count = self.revision_store.copy_multi(other.revision_store,
781
revision_ids)
782
for revision_id in revision_ids:
783
self.append_revision(revision_id)
784
print "Added %d revisions." % count
785
909
786
910
787
def commit(self, *args, **kw):
911
from bzrlib.commit import Commit
912
Commit().commit(self, *args, **kw)
913
914
def revision_id_to_revno(self, revision_id):
915
"""Given a revision id, return its revno"""
916
if revision_id is None:
917
return 0
918
history = self.revision_history()
919
try:
920
return history.index(revision_id) + 1
921
except ValueError:
922
raise bzrlib.errors.NoSuchRevision(self, revision_id)
788
"""Deprecated"""
789
from bzrlib.commit import commit
790
commit(self, *args, **kw)
791
923
792
924
def get_rev_id(self, revno, history=None):
925
"""Find the revision id of the specified revno."""
793
def lookup_revision(self, revno):
794
"""Return revision hash for revision number."""
926
795
if revno == 0:
927
796
return None
928
if history is None:
929
history = self.revision_history()
930
elif revno <= 0 or revno > len(history):
931
raise bzrlib.errors.NoSuchRevision(self, revno)
932
return history[revno - 1]
797
798
try:
799
# list is 0-based; revisions are 1-based
800
return self.revision_history()[revno-1]
801
except IndexError:
802
raise BzrError("no such revision %s" % revno)
803
933
804
934
805
def revision_tree(self, revision_id):
935
806
"""Return Tree for a revision on this branch.
938
809
an `EmptyTree` is returned."""
939
810
# TODO: refactor this to use an existing revision object
940
811
# so we don't need to read it in twice.
941
if revision_id == None or revision_id == NULL_REVISION:
812
if revision_id == None:
942
813
return EmptyTree()
943
814
else:
944
815
inv = self.get_revision_inventory(revision_id)
945
return RevisionTree(self.weave_store, inv, revision_id)
816
return RevisionTree(self.text_store, inv)
817
946
818
947
819
def working_tree(self):
948
820
"""Return a `Tree` for the working copy."""
949
from bzrlib.workingtree import WorkingTree
950
# TODO: In the future, perhaps WorkingTree should utilize Transport
951
# RobertCollins 20051003 - I don't think it should - working trees are
952
# much more complex to keep consistent than our careful .bzr subset.
953
# instead, we should say that working trees are local only, and optimise
954
# for that.
955
return WorkingTree(self.base, branch=self)
821
from workingtree import WorkingTree
822
return WorkingTree(self.base, self.read_working_inventory())
956
823
957
@needs_write_lock
958
def pull(self, source, overwrite=False):
959
source.lock_read()
960
try:
961
try:
962
self.update_revisions(source)
963
except DivergedBranches:
964
if not overwrite:
965
raise
966
self.set_revision_history(source.revision_history())
967
finally:
968
source.unlock()
969
824
970
825
def basis_tree(self):
971
826
"""Return `Tree` object for last revision.
972
827
973
828
If there are no revisions yet, return an `EmptyTree`.
974
829
"""
975
return self.revision_tree(self.last_revision())
976
977
@needs_write_lock
830
r = self.last_patch()
831
if r == None:
832
return EmptyTree()
833
else:
834
return RevisionTree(self.text_store, self.get_revision_inventory(r))
835
836
837
978
838
def rename_one(self, from_rel, to_rel):
979
839
"""Rename one file.
980
840
981
841
This can change the directory or the filename or both.
982
842
"""
983
tree = self.working_tree()
984
inv = tree.inventory
985
if not tree.has_filename(from_rel):
986
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
987
if tree.has_filename(to_rel):
988
raise BzrError("can't rename: new working file %r already exists" % to_rel)
989
990
file_id = inv.path2id(from_rel)
991
if file_id == None:
992
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
993
994
if inv.path2id(to_rel):
995
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
996
997
to_dir, to_tail = os.path.split(to_rel)
998
to_dir_id = inv.path2id(to_dir)
999
if to_dir_id == None and to_dir != '':
1000
raise BzrError("can't determine destination directory id for %r" % to_dir)
1001
1002
mutter("rename_one:")
1003
mutter(" file_id {%s}" % file_id)
1004
mutter(" from_rel %r" % from_rel)
1005
mutter(" to_rel %r" % to_rel)
1006
mutter(" to_dir %r" % to_dir)
1007
mutter(" to_dir_id {%s}" % to_dir_id)
1008
1009
inv.rename(file_id, to_dir_id, to_tail)
1010
1011
from_abs = self.abspath(from_rel)
1012
to_abs = self.abspath(to_rel)
843
self.lock_write()
1013
844
try:
1014
rename(from_abs, to_abs)
1015
except OSError, e:
1016
raise BzrError("failed to rename %r to %r: %s"
1017
% (from_abs, to_abs, e[1]),
1018
["rename rolled back"])
1019
1020
self._write_inventory(inv)
1021
1022
@needs_write_lock
845
tree = self.working_tree()
846
inv = tree.inventory
847
if not tree.has_filename(from_rel):
848
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
849
if tree.has_filename(to_rel):
850
raise BzrError("can't rename: new working file %r already exists" % to_rel)
851
852
file_id = inv.path2id(from_rel)
853
if file_id == None:
854
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
855
856
if inv.path2id(to_rel):
857
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
858
859
to_dir, to_tail = os.path.split(to_rel)
860
to_dir_id = inv.path2id(to_dir)
861
if to_dir_id == None and to_dir != '':
862
raise BzrError("can't determine destination directory id for %r" % to_dir)
863
864
mutter("rename_one:")
865
mutter(" file_id {%s}" % file_id)
866
mutter(" from_rel %r" % from_rel)
867
mutter(" to_rel %r" % to_rel)
868
mutter(" to_dir %r" % to_dir)
869
mutter(" to_dir_id {%s}" % to_dir_id)
870
871
inv.rename(file_id, to_dir_id, to_tail)
872
873
print "%s => %s" % (from_rel, to_rel)
874
875
from_abs = self.abspath(from_rel)
876
to_abs = self.abspath(to_rel)
877
try:
878
os.rename(from_abs, to_abs)
879
except OSError, e:
880
raise BzrError("failed to rename %r to %r: %s"
881
% (from_abs, to_abs, e[1]),
882
["rename rolled back"])
883
884
self._write_inventory(inv)
885
finally:
886
self.unlock()
887
888
1023
889
def move(self, from_paths, to_name):
1024
890
"""Rename files.
1025
891
1030
896
1031
897
Note that to_name is only the last component of the new name;
1032
898
this doesn't change the directory.
1033
1034
This returns a list of (from_path, to_path) pairs for each
1035
entry that is moved.
1036
"""
1037
result = []
1038
## TODO: Option to move IDs only
1039
assert not isinstance(from_paths, basestring)
1040
tree = self.working_tree()
1041
inv = tree.inventory
1042
to_abs = self.abspath(to_name)
1043
if not isdir(to_abs):
1044
raise BzrError("destination %r is not a directory" % to_abs)
1045
if not tree.has_filename(to_name):
1046
raise BzrError("destination %r not in working directory" % to_abs)
1047
to_dir_id = inv.path2id(to_name)
1048
if to_dir_id == None and to_name != '':
1049
raise BzrError("destination %r is not a versioned directory" % to_name)
1050
to_dir_ie = inv[to_dir_id]
1051
if to_dir_ie.kind not in ('directory', 'root_directory'):
1052
raise BzrError("destination %r is not a directory" % to_abs)
1053
1054
to_idpath = inv.get_idpath(to_dir_id)
1055
1056
for f in from_paths:
1057
if not tree.has_filename(f):
1058
raise BzrError("%r does not exist in working tree" % f)
1059
f_id = inv.path2id(f)
1060
if f_id == None:
1061
raise BzrError("%r is not versioned" % f)
1062
name_tail = splitpath(f)[-1]
1063
dest_path = appendpath(to_name, name_tail)
1064
if tree.has_filename(dest_path):
1065
raise BzrError("destination %r already exists" % dest_path)
1066
if f_id in to_idpath:
1067
raise BzrError("can't move %r to a subdirectory of itself" % f)
1068
1069
# OK, so there's a race here, it's possible that someone will
1070
# create a file in this interval and then the rename might be
1071
# left half-done. But we should have caught most problems.
1072
1073
for f in from_paths:
1074
name_tail = splitpath(f)[-1]
1075
dest_path = appendpath(to_name, name_tail)
1076
result.append((f, dest_path))
1077
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1078
try:
1079
rename(self.abspath(f), self.abspath(dest_path))
1080
except OSError, e:
1081
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1082
["rename rolled back"])
1083
1084
self._write_inventory(inv)
1085
return result
1086
1087
1088
def revert(self, filenames, old_tree=None, backups=True):
1089
"""Restore selected files to the versions from a previous tree.
1090
1091
backups
1092
If true (default) backups are made of files before
1093
they're renamed.
1094
"""
1095
from bzrlib.atomicfile import AtomicFile
1096
from bzrlib.osutils import backup_file
1097
1098
inv = self.read_working_inventory()
1099
if old_tree is None:
1100
old_tree = self.basis_tree()
1101
old_inv = old_tree.inventory
1102
1103
nids = []
1104
for fn in filenames:
1105
file_id = inv.path2id(fn)
1106
if not file_id:
1107
raise NotVersionedError(path=fn)
1108
if not old_inv.has_id(file_id):
1109
raise BzrError("file not present in old tree", fn, file_id)
1110
nids.append((fn, file_id))
1111
1112
# TODO: Rename back if it was previously at a different location
1113
1114
# TODO: If given a directory, restore the entire contents from
1115
# the previous version.
1116
1117
# TODO: Make a backup to a temporary file.
1118
1119
# TODO: If the file previously didn't exist, delete it?
1120
for fn, file_id in nids:
1121
backup_file(fn)
1122
1123
f = AtomicFile(fn, 'wb')
1124
try:
1125
f.write(old_tree.get_file(file_id).read())
1126
f.commit()
1127
finally:
1128
f.close()
1129
1130
1131
def pending_merges(self):
1132
"""Return a list of pending merges.
1133
1134
These are revisions that have been merged into the working
1135
directory but not yet committed.
1136
"""
1137
cfn = self._rel_controlfilename('pending-merges')
1138
if not self._transport.has(cfn):
1139
return []
1140
p = []
1141
for l in self.controlfile('pending-merges', 'r').readlines():
1142
p.append(l.rstrip('\n'))
1143
return p
1144
1145
1146
def add_pending_merge(self, *revision_ids):
1147
# TODO: Perhaps should check at this point that the
1148
# history of the revision is actually present?
1149
p = self.pending_merges()
1150
updated = False
1151
for rev_id in revision_ids:
1152
if rev_id in p:
1153
continue
1154
p.append(rev_id)
1155
updated = True
1156
if updated:
1157
self.set_pending_merges(p)
1158
1159
@needs_write_lock
1160
def set_pending_merges(self, rev_list):
1161
self.put_controlfile('pending-merges', '\n'.join(rev_list))
1162
1163
def get_parent(self):
1164
"""Return the parent location of the branch.
1165
1166
This is the default location for push/pull/missing. The usual
1167
pattern is that the user can override it by specifying a
1168
location.
1169
"""
1170
import errno
1171
_locs = ['parent', 'pull', 'x-pull']
1172
for l in _locs:
1173
try:
1174
return self.controlfile(l, 'r').read().strip('\n')
1175
except IOError, e:
1176
if e.errno != errno.ENOENT:
1177
raise
1178
return None
1179
1180
def get_push_location(self):
1181
"""Return the None or the location to push this branch to."""
1182
config = bzrlib.config.BranchConfig(self)
1183
push_loc = config.get_user_option('push_location')
1184
return push_loc
1185
1186
def set_push_location(self, location):
1187
"""Set a new push location for this branch."""
1188
config = bzrlib.config.LocationConfig(self.base)
1189
config.set_user_option('push_location', location)
1190
1191
@needs_write_lock
1192
def set_parent(self, url):
1193
# TODO: Maybe delete old location files?
1194
from bzrlib.atomicfile import AtomicFile
1195
f = AtomicFile(self.controlfilename('parent'))
899
"""
900
self.lock_write()
1196
901
try:
1197
f.write(url + '\n')
1198
f.commit()
902
## TODO: Option to move IDs only
903
assert not isinstance(from_paths, basestring)
904
tree = self.working_tree()
905
inv = tree.inventory
906
to_abs = self.abspath(to_name)
907
if not isdir(to_abs):
908
raise BzrError("destination %r is not a directory" % to_abs)
909
if not tree.has_filename(to_name):
910
raise BzrError("destination %r not in working directory" % to_abs)
911
to_dir_id = inv.path2id(to_name)
912
if to_dir_id == None and to_name != '':
913
raise BzrError("destination %r is not a versioned directory" % to_name)
914
to_dir_ie = inv[to_dir_id]
915
if to_dir_ie.kind not in ('directory', 'root_directory'):
916
raise BzrError("destination %r is not a directory" % to_abs)
917
918
to_idpath = inv.get_idpath(to_dir_id)
919
920
for f in from_paths:
921
if not tree.has_filename(f):
922
raise BzrError("%r does not exist in working tree" % f)
923
f_id = inv.path2id(f)
924
if f_id == None:
925
raise BzrError("%r is not versioned" % f)
926
name_tail = splitpath(f)[-1]
927
dest_path = appendpath(to_name, name_tail)
928
if tree.has_filename(dest_path):
929
raise BzrError("destination %r already exists" % dest_path)
930
if f_id in to_idpath:
931
raise BzrError("can't move %r to a subdirectory of itself" % f)
932
933
# OK, so there's a race here, it's possible that someone will
934
# create a file in this interval and then the rename might be
935
# left half-done. But we should have caught most problems.
936
937
for f in from_paths:
938
name_tail = splitpath(f)[-1]
939
dest_path = appendpath(to_name, name_tail)
940
print "%s => %s" % (f, dest_path)
941
inv.rename(inv.path2id(f), to_dir_id, name_tail)
942
try:
943
os.rename(self.abspath(f), self.abspath(dest_path))
944
except OSError, e:
945
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
946
["rename rolled back"])
947
948
self._write_inventory(inv)
1199
949
finally:
1200
f.close()
1201
1202
def check_revno(self, revno):
1203
"""\
1204
Check whether a revno corresponds to any revision.
1205
Zero (the NULL revision) is considered valid.
1206
"""
1207
if revno != 0:
1208
self.check_real_revno(revno)
1209
1210
def check_real_revno(self, revno):
1211
"""\
1212
Check whether a revno corresponds to a real revision.
1213
Zero (the NULL revision) is considered invalid
1214
"""
1215
if revno < 1 or revno > self.revno():
1216
raise InvalidRevisionNumber(revno)
1217
1218
def sign_revision(self, revision_id, gpg_strategy):
1219
plaintext = Testament.from_revision(self, revision_id).as_short_text()
1220
self.store_revision_signature(gpg_strategy, plaintext, revision_id)
1221
1222
@needs_write_lock
1223
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1224
self.revision_store.add(StringIO(gpg_strategy.sign(plaintext)),
1225
revision_id, "sig")
1226
1227
1228
class ScratchBranch(_Branch):
950
self.unlock()
951
952
953
954
class ScratchBranch(Branch):
1229
955
"""Special test class: a branch that cleans up after itself.
1230
956
1231
957
>>> b = ScratchBranch()
1232
958
>>> isdir(b.base)
1233
959
True
1234
960
>>> bd = b.base
1235
>>> b._transport.__del__()
961
>>> b.destroy()
1236
962
>>> isdir(bd)
1237
963
False
1238
964
"""
1239
1240
def __init__(self, files=[], dirs=[], transport=None):
965
def __init__(self, files=[], dirs=[], base=None):
1241
966
"""Make a test branch.
1242
967
1243
968
This creates a temporary directory and runs init-tree in it.
1244
969
1245
970
If any files are listed, they are created in the working copy.
1246
971
"""
1247
if transport is None:
1248
transport = bzrlib.transport.local.ScratchTransport()
1249
super(ScratchBranch, self).__init__(transport, init=True)
1250
else:
1251
super(ScratchBranch, self).__init__(transport)
1252
972
init = False
973
if base is None:
974
base = tempfile.mkdtemp()
975
init = True
976
Branch.__init__(self, base, init=init)
1253
977
for d in dirs:
1254
self._transport.mkdir(d)
978
os.mkdir(self.abspath(d))
1255
979
1256
980
for f in files:
1257
self._transport.put(f, 'content of %s' % f)
981
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
1258
982
1259
983
1260
984
def clone(self):
1261
985
"""
1262
986
>>> orig = ScratchBranch(files=["file1", "file2"])
1263
987
>>> clone = orig.clone()
1264
>>> if os.name != 'nt':
1265
... os.path.samefile(orig.base, clone.base)
1266
... else:
1267
... orig.base == clone.base
1268
...
988
>>> os.path.samefile(orig.base, clone.base)
1269
989
False
1270
990
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1271
991
True
1272
992
"""
1273
from shutil import copytree
1274
from tempfile import mkdtemp
1275
base = mkdtemp()
993
base = tempfile.mkdtemp()
1276
994
os.rmdir(base)
1277
copytree(self.base, base, symlinks=True)
1278
return ScratchBranch(
1279
transport=bzrlib.transport.local.ScratchTransport(base))
995
shutil.copytree(self.base, base, symlinks=True)
996
return ScratchBranch(base=base)
997
998
def __del__(self):
999
self.destroy()
1000
1001
def destroy(self):
1002
"""Destroy the test branch, removing the scratch directory."""
1003
try:
1004
if self.base:
1005
mutter("delete ScratchBranch %s" % self.base)
1006
shutil.rmtree(self.base)
1007
except OSError, e:
1008
# Work around for shutil.rmtree failing on Windows when
1009
# readonly files are encountered
1010
mutter("hit exception in destroying ScratchBranch: %s" % e)
1011
for root, dirs, files in os.walk(self.base, topdown=False):
1012
for name in files:
1013
os.chmod(os.path.join(root, name), 0700)
1014
shutil.rmtree(self.base)
1015
self.base = None
1016
1280
1017
1281
1018
1282
1019
######################################################################
1305
1042
cope with just randomness because running uuidgen every time is
1306
1043
slow."""
1307
1044
import re
1308
from binascii import hexlify
1309
from time import time
1310
1045
1311
1046
# get last component
1312
1047
idx = name.rfind('/')
1324
1059
name = re.sub(r'[^\w.]', '', name)
1325
1060
1326
1061
s = hexlify(rand_bytes(8))
1327
return '-'.join((name, compact_date(time()), s))
1328
1329
1330
def gen_root_id():
1331
"""Return a new tree-root file id."""
1332
return gen_file_id('TREE_ROOT')
1333
1334
1062
return '-'.join((name, compact_date(time.time()), s))
Loggerhead is a web-based interface for Breezy
Version: 2.0.1