« back to all changes in this revision
Viewing changes to bzrlib/branch.py
- browse files at revision 478
- compare with another revision
- download diff
- download tarball
- view history from revision 478
- Committer: Martin Pool
- Date: 2005-05-11 08:01:27 UTC
- Revision ID: mbp@sourcefrog.net-20050511080127-4829697fc2ac64f1
- put back support for running diff or status on
only selected files.
only selected files.
- files added:
- bzrlib/remotebranch.py
- files removed:
- HACKING
- bzrlib/plugins
- bzrlib/selftest
- bzrlib/store
- bzrlib/transport
- bzrlib/util
- bzrlib/util/configobj
- bzrlib/util/configobj/docs
- bzrlib/util/effbot
- bzrlib/util/effbot/org
- contrib/emacs
- patches
- tools
- files renamed:
- contrib/newinventory.py => bzrlib/newinventory.py
- bzrlib/store/__init__.py => bzrlib/store.py
- contrib/bash/bzr.simple => contrib/bash/bzr
- 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
18
from sets import Set
23
19
20
import sys, os, os.path, random, time, sha, sets, types, re, shutil, tempfile
21
import traceback, socket, fnmatch, difflib, time
22
from binascii import hexlify
24
23
25
24
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"
25
from inventory import Inventory
26
from trace import mutter, note
27
from tree import Tree, EmptyTree, RevisionTree
28
from inventory import InventoryEntry, Inventory
29
from osutils import isdir, quotefn, isfile, uuid, sha_file, username, \
30
format_date, compact_date, pumpfile, user_email, rand_bytes, splitpath, \
31
joinpath, sha_string, file_kind, local_time_offset, appendpath
32
from store import ImmutableStore
33
from revision import Revision
34
from errors import bailout, BzrError
35
from textui import show_status
36
37
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
58
38
## TODO: Maybe include checks for common corruption of newlines, etc?
59
39
60
40
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
41
42
def find_branch(f, **args):
43
if f and (f.startswith('http://') or f.startswith('https://')):
44
import remotebranch
45
return remotebranch.RemoteBranch(f, **args)
46
else:
47
return Branch(f, **args)
48
49
50
def find_branch_root(f=None):
51
"""Find the branch root enclosing f, or pwd.
52
53
f may be a filename or a URL.
54
55
It is not necessary that f exists.
56
57
Basically we keep looking up until we find the control directory or
58
run into the root."""
59
if f == None:
60
f = os.getcwd()
61
elif hasattr(os.path, 'realpath'):
62
f = os.path.realpath(f)
63
else:
64
f = os.path.abspath(f)
65
if not os.path.exists(f):
66
raise BzrError('%r does not exist' % f)
67
68
69
orig_f = f
70
71
while True:
72
if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
73
return f
74
head, tail = os.path.split(f)
75
if head == f:
76
# reached the root, whatever that may be
77
raise BzrError('%r is not in a branch' % orig_f)
78
f = head
79
80
92
81
93
82
######################################################################
94
83
# branch objects
95
84
96
class Branch(object):
85
class Branch:
97
86
"""Branch holding a history of revisions.
98
87
99
88
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.
162
163
_lock_mode
164
None, or 'r' or 'w'
165
166
_lock_count
167
If _lock_mode is true, a positive count of the number of times the
168
lock has been taken.
169
170
_lock
171
Lock object from bzrlib.lock.
172
"""
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.
177
_lock_mode = None
178
_lock_count = None
179
_lock = None
180
_inventory_weave = None
89
Base directory of the branch.
90
"""
91
_lockmode = None
181
92
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):
93
def __init__(self, base, init=False, find_root=True, lock_mode='w'):
209
94
"""Create new branch object at a particular location.
210
95
211
transport -- A Transport object, defining how to access files.
96
base -- Base directory for the branch.
212
97
213
98
init -- If True, create new control files in a previously
214
99
unversioned directory. If False, the branch must already
215
100
be versioned.
216
101
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.
102
find_root -- If true and init is false, find the root of the
103
existing branch containing base.
221
104
222
105
In the test suite, creation of new trees is tested using the
223
106
`ScratchBranch` class.
224
107
"""
225
assert isinstance(transport, Transport), \
226
"%r is not a Transport" % transport
227
self._transport = transport
228
108
if init:
109
self.base = os.path.realpath(base)
229
110
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
111
elif find_root:
112
self.base = find_branch_root(base)
113
else:
114
self.base = os.path.realpath(base)
115
if not isdir(self.controlfilename('.')):
116
bailout("not a bzr branch: %s" % quotefn(base),
117
['use "bzr init" to initialize a new working tree',
118
'current bzr can only operate from top-of-tree'])
119
self._check_format()
120
self.lock(lock_mode)
121
122
self.text_store = ImmutableStore(self.controlfilename('text-store'))
123
self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
124
self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
125
271
126
272
127
def __str__(self):
273
return '%s(%r)' % (self.__class__.__name__, self._transport.base)
128
return '%s(%r)' % (self.__class__.__name__, self.base)
274
129
275
130
276
131
__repr__ = __str__
277
132
278
133
279
def __del__(self):
280
if self._lock_mode or self._lock:
281
# XXX: This should show something every time, and be suitable for
282
# headless operation and embedding
283
warn("branch %r was not explicitly unlocked" % self)
284
self._lock.unlock()
285
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:
134
135
def lock(self, mode='w'):
136
"""Lock the on-disk branch, excluding other processes."""
137
try:
138
import fcntl, errno
139
140
if mode == 'w':
141
lm = fcntl.LOCK_EX
142
om = os.O_WRONLY | os.O_CREAT
143
elif mode == 'r':
144
lm = fcntl.LOCK_SH
145
om = os.O_RDONLY
146
else:
147
raise BzrError("invalid locking mode %r" % mode)
148
293
149
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
333
334
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
if self._lock_mode:
339
if self._lock_mode != 'w':
340
raise LockError("can't upgrade to a write lock from %r" %
341
self._lock_mode)
342
self._lock_count += 1
343
else:
344
self._lock = self._transport.lock_write(
345
self._rel_controlfilename('branch-lock'))
346
self._lock_mode = 'w'
347
self._lock_count = 1
348
self._set_transaction(transactions.PassThroughTransaction())
349
350
def lock_read(self):
351
mutter("lock read: %s (%s)", self, self._lock_count)
352
if self._lock_mode:
353
assert self._lock_mode in ('r', 'w'), \
354
"invalid lock mode %r" % self._lock_mode
355
self._lock_count += 1
356
else:
357
self._lock = self._transport.lock_read(
358
self._rel_controlfilename('branch-lock'))
359
self._lock_mode = 'r'
360
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
365
def unlock(self):
366
mutter("unlock: %s (%s)", self, self._lock_count)
367
if not self._lock_mode:
368
raise LockError('branch %r is not locked' % (self))
369
370
if self._lock_count > 1:
371
self._lock_count -= 1
372
else:
373
self._finish_transaction()
374
self._lock.unlock()
375
self._lock = None
376
self._lock_mode = self._lock_count = None
150
lockfile = os.open(self.controlfilename('branch-lock'), om)
151
except OSError, e:
152
if e.errno == errno.ENOENT:
153
# might not exist on branches from <0.0.4
154
self.controlfile('branch-lock', 'w').close()
155
lockfile = os.open(self.controlfilename('branch-lock'), om)
156
else:
157
raise e
158
159
fcntl.lockf(lockfile, lm)
160
def unlock():
161
fcntl.lockf(lockfile, fcntl.LOCK_UN)
162
os.close(lockfile)
163
self._lockmode = None
164
self.unlock = unlock
165
self._lockmode = mode
166
except ImportError:
167
warning("please write a locking method for platform %r" % sys.platform)
168
def unlock():
169
self._lockmode = None
170
self.unlock = unlock
171
self._lockmode = mode
172
173
174
def _need_readlock(self):
175
if self._lockmode not in ['r', 'w']:
176
raise BzrError('need read lock on branch, only have %r' % self._lockmode)
177
178
def _need_writelock(self):
179
if self._lockmode not in ['w']:
180
raise BzrError('need write lock on branch, only have %r' % self._lockmode)
181
377
182
378
183
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)
184
"""Return absolute filename for something in the branch"""
185
return os.path.join(self.base, name)
186
187
188
def relpath(self, path):
189
"""Return path relative to this branch of something inside it.
190
191
Raises an error if path is not in this branch."""
192
rp = os.path.realpath(path)
193
# FIXME: windows
194
if not rp.startswith(self.base):
195
bailout("path %r is not within branch %r" % (rp, self.base))
196
rp = rp[len(self.base):]
197
rp = rp.lstrip(os.sep)
198
return rp
199
392
200
393
201
def controlfilename(self, file_or_path):
394
202
"""Return location relative to branch."""
395
return self._transport.abspath(self._rel_controlfilename(file_or_path))
203
if isinstance(file_or_path, types.StringTypes):
204
file_or_path = [file_or_path]
205
return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
206
396
207
397
208
def controlfile(self, file_or_path, mode='r'):
398
209
"""Open a control file for this branch.
405
216
Controlfiles should almost never be opened in write mode but
406
217
rather should be atomically copied and replaced using atomicfile.
407
218
"""
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")
219
220
fn = self.controlfilename(file_or_path)
221
222
if mode == 'rb' or mode == 'wb':
223
return file(fn, mode)
224
elif mode == 'r' or mode == 'w':
225
# open in binary mode anyhow so there's no newline translation;
226
# codecs uses line buffering by default; don't want that.
227
import codecs
228
return codecs.open(fn, mode + 'b', 'utf-8',
229
buffering=60000)
421
230
else:
422
231
raise BzrError("invalid controlfile mode %r" % mode)
423
232
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)
233
452
234
453
235
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',
236
os.mkdir(self.controlfilename([]))
237
self.controlfile('README', 'w').write(
471
238
"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):
239
"Do not change any files in this directory.")
240
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
241
for d in ('text-store', 'inventory-store', 'revision-store'):
242
os.mkdir(self.controlfilename(d))
243
for f in ('revision-history', 'merged-patches',
244
'pending-merged-patches', 'branch-name',
245
'branch-lock'):
246
self.controlfile(f, 'w').write('')
247
mutter('created control directory in ' + self.base)
248
Inventory().write_xml(self.controlfile('inventory','w'))
249
250
251
def _check_format(self):
488
252
"""Check this branch format is supported.
489
253
490
The format level is stored, as an integer, in
491
self._branch_format for code that needs to check it later.
254
The current tool only supports the current unstable format.
492
255
493
256
In the future, we might need different in-memory Branch
494
257
classes to support downlevel branches. But not yet.
495
258
"""
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,
512
['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
259
# This ignores newlines so that we can open branches created
260
# on Windows from Linux and so on. I think it might be better
261
# to always make all internal files in unix format.
262
fmt = self.controlfile('branch-format', 'r').read()
263
fmt.replace('\r\n', '')
264
if fmt != BZR_BRANCH_FORMAT:
265
bailout('sorry, branch format %r not supported' % fmt,
266
['use a different bzr version',
267
'or remove the .bzr directory and "bzr init" again'])
268
269
534
270
def read_working_inventory(self):
535
271
"""Read the working inventory."""
272
self._need_readlock()
273
before = time.time()
536
274
# ElementTree does its own conversion from UTF-8, so open in
537
275
# binary.
538
f = self.controlfile('inventory', 'rb')
539
return bzrlib.xml5.serializer_v5.read_inventory(f)
540
541
@needs_write_lock
276
inv = Inventory.read_xml(self.controlfile('inventory', 'rb'))
277
mutter("loaded inventory of %d items in %f"
278
% (len(inv), time.time() - before))
279
return inv
280
281
542
282
def _write_inventory(self, inv):
543
283
"""Update the working inventory.
544
284
545
285
That is to say, the inventory describing changes underway, that
546
286
will be committed to the next revision.
547
287
"""
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
288
self._need_writelock()
289
## TODO: factor out to atomicfile? is rename safe on windows?
290
## TODO: Maybe some kind of clean/dirty marker on inventory?
291
tmpfname = self.controlfilename('inventory.tmp')
292
tmpf = file(tmpfname, 'wb')
293
inv.write_xml(tmpf)
294
tmpf.close()
295
inv_fname = self.controlfilename('inventory')
296
if sys.platform == 'win32':
297
os.remove(inv_fname)
298
os.rename(tmpfname, inv_fname)
555
299
mutter('wrote working inventory')
556
300
301
557
302
inventory = property(read_working_inventory, _write_inventory, None,
558
303
"""Inventory for the working copy.""")
559
304
560
@needs_write_lock
561
def add(self, files, ids=None):
305
306
def add(self, files, verbose=False):
562
307
"""Make files versioned.
563
308
564
Note that the command line normally calls smart_add instead,
565
which can automatically recurse.
309
Note that the command line normally calls smart_add instead.
566
310
567
311
This puts the files in the Added state, so that they will be
568
312
recorded by the next commit.
569
313
570
files
571
List of paths to add, relative to the base of the tree.
572
573
ids
574
If set, use these instead of automatically generated ids.
575
Must be the same length as the list of files, but may
576
contain None for ids that are to be autogenerated.
577
578
314
TODO: Perhaps have an option to add the ids even if the files do
579
not (yet) exist.
580
581
TODO: Perhaps yield the ids and paths as they're added.
315
not (yet) exist.
316
317
TODO: Perhaps return the ids of the files? But then again it
318
is easy to retrieve them if they're needed.
319
320
TODO: Option to specify file id.
321
322
TODO: Adding a directory should optionally recurse down and
323
add all non-ignored children. Perhaps do that in a
324
higher-level method.
325
326
>>> b = ScratchBranch(files=['foo'])
327
>>> 'foo' in b.unknowns()
328
True
329
>>> b.show_status()
330
? foo
331
>>> b.add('foo')
332
>>> 'foo' in b.unknowns()
333
False
334
>>> bool(b.inventory.path2id('foo'))
335
True
336
>>> b.show_status()
337
A foo
338
339
>>> b.add('foo')
340
Traceback (most recent call last):
341
...
342
BzrError: ('foo is already versioned', [])
343
344
>>> b.add(['nothere'])
345
Traceback (most recent call last):
346
BzrError: ('cannot add: not a regular file or directory: nothere', [])
582
347
"""
348
self._need_writelock()
349
583
350
# TODO: Re-adding a file that is removed in the working copy
584
351
# should probably put it back with the previous ID.
585
if isinstance(files, basestring):
586
assert(ids is None or isinstance(ids, basestring))
352
if isinstance(files, types.StringTypes):
587
353
files = [files]
588
if ids is not None:
589
ids = [ids]
590
591
if ids is None:
592
ids = [None] * len(files)
593
else:
594
assert(len(ids) == len(files))
595
354
596
355
inv = self.read_working_inventory()
597
for f,file_id in zip(files, ids):
356
for f in files:
598
357
if is_control_file(f):
599
raise BzrError("cannot add control file %s" % quotefn(f))
358
bailout("cannot add control file %s" % quotefn(f))
600
359
601
360
fp = splitpath(f)
602
361
603
362
if len(fp) == 0:
604
raise BzrError("cannot add top-level %r" % f)
605
363
bailout("cannot add top-level %r" % f)
364
606
365
fullpath = os.path.normpath(self.abspath(f))
607
366
608
367
try:
609
368
kind = file_kind(fullpath)
610
369
except OSError:
611
370
# 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)
371
bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
372
373
if kind != 'file' and kind != 'directory':
374
bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
375
376
file_id = gen_file_id(f)
620
377
inv.add_path(f, kind=kind, file_id=file_id)
621
378
379
if verbose:
380
show_status('A', kind, quotefn(f))
381
622
382
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
623
383
624
384
self._write_inventory(inv)
625
385
626
@needs_read_lock
386
627
387
def print_file(self, file, revno):
628
388
"""Print `file` to stdout."""
629
tree = self.revision_tree(self.get_rev_id(revno))
389
self._need_readlock()
390
tree = self.revision_tree(self.lookup_revision(revno))
630
391
# use inventory as it was in that revision
631
392
file_id = tree.inventory.path2id(file)
632
393
if not file_id:
633
raise BzrError("%r is not present in revision %s" % (file, revno))
394
bailout("%r is not present in revision %d" % (file, revno))
634
395
tree.print_file(file_id)
635
636
# FIXME: this doesn't need to be a branch method
637
def set_inventory(self, new_inventory_list):
638
from bzrlib.inventory import Inventory, InventoryEntry
639
inv = Inventory(self.get_root_id())
640
for path, file_id, parent, kind in new_inventory_list:
641
name = os.path.basename(path)
642
if name == "":
643
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)
396
397
398
def remove(self, files, verbose=False):
399
"""Mark nominated files for removal from the inventory.
400
401
This does not remove their text. This does not run on
402
403
TODO: Refuse to remove modified files unless --force is given?
404
405
>>> b = ScratchBranch(files=['foo'])
406
>>> b.add('foo')
407
>>> b.inventory.has_filename('foo')
408
True
409
>>> b.remove('foo')
410
>>> b.working_tree().has_filename('foo')
411
True
412
>>> b.inventory.has_filename('foo')
413
False
414
415
>>> b = ScratchBranch(files=['foo'])
416
>>> b.add('foo')
417
>>> b.commit('one')
418
>>> b.remove('foo')
419
>>> b.commit('two')
420
>>> b.inventory.has_filename('foo')
421
False
422
>>> b.basis_tree().has_filename('foo')
423
False
424
>>> b.working_tree().has_filename('foo')
425
True
426
427
TODO: Do something useful with directories.
428
429
TODO: Should this remove the text or not? Tough call; not
430
removing may be useful and the user can just use use rm, and
431
is the opposite of add. Removing it is consistent with most
432
other tools. Maybe an option.
433
"""
434
## TODO: Normalize names
435
## TODO: Remove nested loops; better scalability
436
self._need_writelock()
437
438
if isinstance(files, types.StringTypes):
439
files = [files]
440
441
tree = self.working_tree()
442
inv = tree.inventory
443
444
# do this before any modifications
445
for f in files:
446
fid = inv.path2id(f)
447
if not fid:
448
bailout("cannot remove unversioned file %s" % quotefn(f))
449
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
450
if verbose:
451
# having remove it, it must be either ignored or unknown
452
if tree.is_ignored(f):
453
new_status = 'I'
454
else:
455
new_status = '?'
456
show_status(new_status, inv[fid].kind, quotefn(f))
457
del inv[fid]
458
653
459
self._write_inventory(inv)
654
460
461
655
462
def unknowns(self):
656
463
"""Return all unknown files.
657
464
658
465
These are files in the working directory that are not versioned or
659
466
control files or ignored.
660
467
661
>>> from bzrlib.workingtree import WorkingTree
662
468
>>> b = ScratchBranch(files=['foo', 'foo~'])
663
>>> map(str, b.unknowns())
469
>>> list(b.unknowns())
664
470
['foo']
665
471
>>> b.add('foo')
666
472
>>> list(b.unknowns())
667
473
[]
668
>>> WorkingTree(b.base, b).remove('foo')
474
>>> b.remove('foo')
669
475
>>> list(b.unknowns())
670
[u'foo']
476
['foo']
671
477
"""
672
478
return self.working_tree().unknowns()
673
479
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)
480
481
def commit(self, message, timestamp=None, timezone=None,
482
committer=None,
483
verbose=False):
484
"""Commit working copy as a new revision.
485
486
The basic approach is to add all the file texts into the
487
store, then the inventory, then make a new revision pointing
488
to that inventory and store that.
489
490
This is not quite safe if the working copy changes during the
491
commit; for the moment that is simply not allowed. A better
492
approach is to make a temporary copy of the files before
493
computing their hashes, and then add those hashes in turn to
494
the inventory. This should mean at least that there are no
495
broken hash pointers. There is no way we can get a snapshot
496
of the whole directory at an instant. This would also have to
497
be robust against files disappearing, moving, etc. So the
498
whole thing is a bit hard.
499
500
timestamp -- if not None, seconds-since-epoch for a
501
postdated/predated commit.
502
"""
503
self._need_writelock()
504
505
## TODO: Show branch names
506
507
# TODO: Don't commit if there are no changes, unless forced?
508
509
# First walk over the working inventory; and both update that
510
# and also build a new revision inventory. The revision
511
# inventory needs to hold the text-id, sha1 and size of the
512
# actual file versions committed in the revision. (These are
513
# not present in the working inventory.) We also need to
514
# detect missing/deleted files, and remove them from the
515
# working inventory.
516
517
work_inv = self.read_working_inventory()
518
inv = Inventory()
519
basis = self.basis_tree()
520
basis_inv = basis.inventory
521
missing_ids = []
522
for path, entry in work_inv.iter_entries():
523
## TODO: Cope with files that have gone missing.
524
525
## TODO: Check that the file kind has not changed from the previous
526
## revision of this file (if any).
527
528
entry = entry.copy()
529
530
p = self.abspath(path)
531
file_id = entry.file_id
532
mutter('commit prep file %s, id %r ' % (p, file_id))
533
534
if not os.path.exists(p):
535
mutter(" file is missing, removing from inventory")
536
if verbose:
537
show_status('D', entry.kind, quotefn(path))
538
missing_ids.append(file_id)
539
continue
540
541
# TODO: Handle files that have been deleted
542
543
# TODO: Maybe a special case for empty files? Seems a
544
# waste to store them many times.
545
546
inv.add(entry)
547
548
if basis_inv.has_id(file_id):
549
old_kind = basis_inv[file_id].kind
550
if old_kind != entry.kind:
551
bailout("entry %r changed kind from %r to %r"
552
% (file_id, old_kind, entry.kind))
553
554
if entry.kind == 'directory':
555
if not isdir(p):
556
bailout("%s is entered as directory but not a directory" % quotefn(p))
557
elif entry.kind == 'file':
558
if not isfile(p):
559
bailout("%s is entered as file but is not a file" % quotefn(p))
560
561
content = file(p, 'rb').read()
562
563
entry.text_sha1 = sha_string(content)
564
entry.text_size = len(content)
565
566
old_ie = basis_inv.has_id(file_id) and basis_inv[file_id]
567
if (old_ie
568
and (old_ie.text_size == entry.text_size)
569
and (old_ie.text_sha1 == entry.text_sha1)):
570
## assert content == basis.get_file(file_id).read()
571
entry.text_id = basis_inv[file_id].text_id
572
mutter(' unchanged from previous text_id {%s}' %
573
entry.text_id)
574
575
else:
576
entry.text_id = gen_file_id(entry.name)
577
self.text_store.add(content, entry.text_id)
578
mutter(' stored with text_id {%s}' % entry.text_id)
579
if verbose:
580
if not old_ie:
581
state = 'A'
582
elif (old_ie.name == entry.name
583
and old_ie.parent_id == entry.parent_id):
584
state = 'M'
585
else:
586
state = 'R'
587
588
show_status(state, entry.kind, quotefn(path))
589
590
for file_id in missing_ids:
591
# have to do this later so we don't mess up the iterator.
592
# since parents may be removed before their children we
593
# have to test.
594
595
# FIXME: There's probably a better way to do this; perhaps
596
# the workingtree should know how to filter itself.
597
if work_inv.has_id(file_id):
598
del work_inv[file_id]
599
600
601
inv_id = rev_id = _gen_revision_id(time.time())
602
603
inv_tmp = tempfile.TemporaryFile()
604
inv.write_xml(inv_tmp)
605
inv_tmp.seek(0)
606
self.inventory_store.add(inv_tmp, inv_id)
607
mutter('new inventory_id is {%s}' % inv_id)
608
609
self._write_inventory(work_inv)
610
611
if timestamp == None:
612
timestamp = time.time()
613
614
if committer == None:
615
committer = username()
616
617
if timezone == None:
618
timezone = local_time_offset()
619
620
mutter("building commit log message")
621
rev = Revision(timestamp=timestamp,
622
timezone=timezone,
623
committer=committer,
624
precursor = self.last_patch(),
625
message = message,
626
inventory_id=inv_id,
627
revision_id=rev_id)
628
629
rev_tmp = tempfile.TemporaryFile()
630
rev.write_xml(rev_tmp)
631
rev_tmp.seek(0)
632
self.revision_store.add(rev_tmp, rev_id)
633
mutter("new revision_id is {%s}" % rev_id)
634
635
## XXX: Everything up to here can simply be orphaned if we abort
636
## the commit; it will leave junk files behind but that doesn't
637
## matter.
638
639
## TODO: Read back the just-generated changeset, and make sure it
640
## applies and recreates the right state.
641
642
## TODO: Also calculate and store the inventory SHA1
643
mutter("committing patch r%d" % (self.revno() + 1))
644
645
646
self.append_revision(rev_id)
647
648
if verbose:
649
note("commited r%d" % self.revno())
650
651
652
def append_revision(self, revision_id):
653
mutter("add {%s} to revision-history" % revision_id)
678
654
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()
655
656
tmprhname = self.controlfilename('revision-history.tmp')
657
rhname = self.controlfilename('revision-history')
658
659
f = file(tmprhname, 'wt')
660
rev_history.append(revision_id)
661
f.write('\n'.join(rev_history))
662
f.write('\n')
663
f.close()
664
665
if sys.platform == 'win32':
666
os.remove(rhname)
667
os.rename(tmprhname, rhname)
668
709
669
710
670
711
671
def get_revision(self, revision_id):
712
672
"""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
673
self._need_readlock()
674
r = Revision.read_xml(self.revision_store[revision_id])
722
675
assert r.revision_id == revision_id
723
676
return r
724
677
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
def get_revision_sha1(self, revision_id):
747
"""Hash the stored value of a revision, and return it."""
748
# In the future, revision entries will be signed. At that
749
# point, it is probably best *not* to include the signature
750
# in the revision hash. Because that lets you re-sign
751
# the revision, (add signatures/remove signatures) and still
752
# have all hash pointers stay consistent.
753
# 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):
787
"""Return the sha1 hash of the inventory entry
788
"""
789
return self.get_revision(revision_id).inventory_sha1
678
679
def get_inventory(self, inventory_id):
680
"""Get Inventory object by hash.
681
682
TODO: Perhaps for this and similar methods, take a revision
683
parameter which can be either an integer revno or a
684
string hash."""
685
self._need_readlock()
686
i = Inventory.read_xml(self.inventory_store[inventory_id])
687
return i
688
790
689
791
690
def get_revision_inventory(self, revision_id):
792
691
"""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.
692
self._need_readlock()
796
693
if revision_id == None:
797
return Inventory(self.get_root_id())
694
return Inventory()
798
695
else:
799
return self.get_inventory(revision_id)
800
801
@needs_read_lock
696
return self.get_inventory(self.get_revision(revision_id).inventory_id)
697
698
802
699
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)
700
"""Return sequence of revision hashes on to this branch.
701
702
>>> ScratchBranch().revision_history()
703
[]
704
"""
705
self._need_readlock()
706
return [l.rstrip('\r\n') for l in self.controlfile('revision-history', 'r').readlines()]
707
708
709
def enum_history(self, direction):
710
"""Return (revno, revision_id) for history of branch.
711
712
direction
713
'forward' is from earliest to latest
714
'reverse' is from latest to earliest
715
"""
716
rh = self.revision_history()
717
if direction == 'forward':
718
i = 1
719
for rid in rh:
720
yield i, rid
721
i += 1
722
elif direction == 'reverse':
723
i = len(rh)
724
while i > 0:
725
yield i, rh[i-1]
726
i -= 1
727
else:
728
raise BzrError('invalid history direction %r' % direction)
729
816
730
817
731
def revno(self):
818
732
"""Return current revision number for this branch.
819
733
820
734
That is equivalent to the number of revisions committed to
821
735
this branch.
736
737
>>> b = ScratchBranch()
738
>>> b.revno()
739
0
740
>>> b.commit('no foo')
741
>>> b.revno()
742
1
822
743
"""
823
744
return len(self.revision_history())
824
745
825
def last_revision(self):
746
747
def last_patch(self):
826
748
"""Return last patch hash, or None if no history.
749
750
>>> ScratchBranch().last_patch() == None
751
True
827
752
"""
828
753
ph = self.revision_history()
829
754
if ph:
830
755
return ph[-1]
831
756
else:
832
757
return None
833
834
def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
835
"""Return a list of new revisions that would perfectly fit.
836
837
If self and other have not diverged, return a list of the revisions
838
present in other, but missing from self.
839
840
>>> from bzrlib.commit import commit
841
>>> bzrlib.trace.silent = True
842
>>> br1 = ScratchBranch()
843
>>> br2 = ScratchBranch()
844
>>> br1.missing_revisions(br2)
845
[]
846
>>> commit(br2, "lala!", rev_id="REVISION-ID-1")
847
>>> br1.missing_revisions(br2)
848
[u'REVISION-ID-1']
849
>>> br2.missing_revisions(br1)
850
[]
851
>>> commit(br1, "lala!", rev_id="REVISION-ID-1")
852
>>> br1.missing_revisions(br2)
853
[]
854
>>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
855
>>> br1.missing_revisions(br2)
856
[u'REVISION-ID-2A']
857
>>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
858
>>> br1.missing_revisions(br2)
859
Traceback (most recent call last):
860
DivergedBranches: These branches have diverged.
861
"""
862
self_history = self.revision_history()
863
self_len = len(self_history)
864
other_history = other.revision_history()
865
other_len = len(other_history)
866
common_index = min(self_len, other_len) -1
867
if common_index >= 0 and \
868
self_history[common_index] != other_history[common_index]:
869
raise DivergedBranches(self, other)
870
871
if stop_revision is None:
872
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)
877
return other_history[self_len:stop_revision]
878
879
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
909
910
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)
923
924
def get_rev_id(self, revno, history=None):
925
"""Find the revision id of the specified revno."""
758
759
760
def lookup_revision(self, revno):
761
"""Return revision hash for revision number."""
926
762
if revno == 0:
927
763
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]
764
765
try:
766
# list is 0-based; revisions are 1-based
767
return self.revision_history()[revno-1]
768
except IndexError:
769
raise BzrError("no such revision %s" % revno)
770
933
771
934
772
def revision_tree(self, revision_id):
935
773
"""Return Tree for a revision on this branch.
936
774
937
775
`revision_id` may be None for the null revision, in which case
938
776
an `EmptyTree` is returned."""
939
# TODO: refactor this to use an existing revision object
940
# so we don't need to read it in twice.
941
if revision_id == None or revision_id == NULL_REVISION:
777
self._need_readlock()
778
if revision_id == None:
942
779
return EmptyTree()
943
780
else:
944
781
inv = self.get_revision_inventory(revision_id)
945
return RevisionTree(self.weave_store, inv, revision_id)
782
return RevisionTree(self.text_store, inv)
783
946
784
947
785
def working_tree(self):
948
786
"""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)
787
from workingtree import WorkingTree
788
return WorkingTree(self.base, self.read_working_inventory())
956
789
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
790
970
791
def basis_tree(self):
971
792
"""Return `Tree` object for last revision.
972
793
973
794
If there are no revisions yet, return an `EmptyTree`.
795
796
>>> b = ScratchBranch(files=['foo'])
797
>>> b.basis_tree().has_filename('foo')
798
False
799
>>> b.working_tree().has_filename('foo')
800
True
801
>>> b.add('foo')
802
>>> b.commit('add foo')
803
>>> b.basis_tree().has_filename('foo')
804
True
974
805
"""
975
return self.revision_tree(self.last_revision())
976
977
@needs_write_lock
806
r = self.last_patch()
807
if r == None:
808
return EmptyTree()
809
else:
810
return RevisionTree(self.text_store, self.get_revision_inventory(r))
811
812
813
978
814
def rename_one(self, from_rel, to_rel):
979
815
"""Rename one file.
980
816
981
817
This can change the directory or the filename or both.
982
818
"""
819
self._need_writelock()
983
820
tree = self.working_tree()
984
821
inv = tree.inventory
985
822
if not tree.has_filename(from_rel):
986
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
823
bailout("can't rename: old working file %r does not exist" % from_rel)
987
824
if tree.has_filename(to_rel):
988
raise BzrError("can't rename: new working file %r already exists" % to_rel)
989
825
bailout("can't rename: new working file %r already exists" % to_rel)
826
990
827
file_id = inv.path2id(from_rel)
991
828
if file_id == None:
992
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
829
bailout("can't rename: old name %r is not versioned" % from_rel)
993
830
994
831
if inv.path2id(to_rel):
995
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
832
bailout("can't rename: new name %r is already versioned" % to_rel)
996
833
997
834
to_dir, to_tail = os.path.split(to_rel)
998
835
to_dir_id = inv.path2id(to_dir)
999
836
if to_dir_id == None and to_dir != '':
1000
raise BzrError("can't determine destination directory id for %r" % to_dir)
837
bailout("can't determine destination directory id for %r" % to_dir)
1001
838
1002
839
mutter("rename_one:")
1003
840
mutter(" file_id {%s}" % file_id)
1005
842
mutter(" to_rel %r" % to_rel)
1006
843
mutter(" to_dir %r" % to_dir)
1007
844
mutter(" to_dir_id {%s}" % to_dir_id)
1008
845
1009
846
inv.rename(file_id, to_dir_id, to_tail)
1010
847
848
print "%s => %s" % (from_rel, to_rel)
849
1011
850
from_abs = self.abspath(from_rel)
1012
851
to_abs = self.abspath(to_rel)
1013
852
try:
1014
rename(from_abs, to_abs)
853
os.rename(from_abs, to_abs)
1015
854
except OSError, e:
1016
raise BzrError("failed to rename %r to %r: %s"
855
bailout("failed to rename %r to %r: %s"
1017
856
% (from_abs, to_abs, e[1]),
1018
857
["rename rolled back"])
1019
858
1020
859
self._write_inventory(inv)
1021
1022
@needs_write_lock
860
861
862
1023
863
def move(self, from_paths, to_name):
1024
864
"""Rename files.
1025
865
1030
870
1031
871
Note that to_name is only the last component of the new name;
1032
872
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
873
"""
1037
result = []
874
self._need_writelock()
1038
875
## TODO: Option to move IDs only
1039
876
assert not isinstance(from_paths, basestring)
1040
877
tree = self.working_tree()
1041
878
inv = tree.inventory
1042
879
to_abs = self.abspath(to_name)
1043
880
if not isdir(to_abs):
1044
raise BzrError("destination %r is not a directory" % to_abs)
881
bailout("destination %r is not a directory" % to_abs)
1045
882
if not tree.has_filename(to_name):
1046
raise BzrError("destination %r not in working directory" % to_abs)
883
bailout("destination %r not in working directory" % to_abs)
1047
884
to_dir_id = inv.path2id(to_name)
1048
885
if to_dir_id == None and to_name != '':
1049
raise BzrError("destination %r is not a versioned directory" % to_name)
886
bailout("destination %r is not a versioned directory" % to_name)
1050
887
to_dir_ie = inv[to_dir_id]
1051
888
if to_dir_ie.kind not in ('directory', 'root_directory'):
1052
raise BzrError("destination %r is not a directory" % to_abs)
889
bailout("destination %r is not a directory" % to_abs)
1053
890
1054
to_idpath = inv.get_idpath(to_dir_id)
891
to_idpath = Set(inv.get_idpath(to_dir_id))
1055
892
1056
893
for f in from_paths:
1057
894
if not tree.has_filename(f):
1058
raise BzrError("%r does not exist in working tree" % f)
895
bailout("%r does not exist in working tree" % f)
1059
896
f_id = inv.path2id(f)
1060
897
if f_id == None:
1061
raise BzrError("%r is not versioned" % f)
898
bailout("%r is not versioned" % f)
1062
899
name_tail = splitpath(f)[-1]
1063
900
dest_path = appendpath(to_name, name_tail)
1064
901
if tree.has_filename(dest_path):
1065
raise BzrError("destination %r already exists" % dest_path)
902
bailout("destination %r already exists" % dest_path)
1066
903
if f_id in to_idpath:
1067
raise BzrError("can't move %r to a subdirectory of itself" % f)
904
bailout("can't move %r to a subdirectory of itself" % f)
1068
905
1069
906
# OK, so there's a race here, it's possible that someone will
1070
907
# create a file in this interval and then the rename might be
1073
910
for f in from_paths:
1074
911
name_tail = splitpath(f)[-1]
1075
912
dest_path = appendpath(to_name, name_tail)
1076
result.append((f, dest_path))
913
print "%s => %s" % (f, dest_path)
1077
914
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1078
915
try:
1079
rename(self.abspath(f), self.abspath(dest_path))
916
os.rename(self.abspath(f), self.abspath(dest_path))
1080
917
except OSError, e:
1081
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
918
bailout("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1082
919
["rename rolled back"])
1083
920
1084
921
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'))
1196
try:
1197
f.write(url + '\n')
1198
f.commit()
1199
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):
922
923
924
925
926
class ScratchBranch(Branch):
1229
927
"""Special test class: a branch that cleans up after itself.
1230
928
1231
929
>>> b = ScratchBranch()
1232
930
>>> isdir(b.base)
1233
931
True
1234
932
>>> bd = b.base
1235
>>> b._transport.__del__()
933
>>> b.destroy()
1236
934
>>> isdir(bd)
1237
935
False
1238
936
"""
1239
1240
def __init__(self, files=[], dirs=[], transport=None):
937
def __init__(self, files=[], dirs=[]):
1241
938
"""Make a test branch.
1242
939
1243
940
This creates a temporary directory and runs init-tree in it.
1244
941
1245
942
If any files are listed, they are created in the working copy.
1246
943
"""
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
944
Branch.__init__(self, tempfile.mkdtemp(), init=True)
1253
945
for d in dirs:
1254
self._transport.mkdir(d)
946
os.mkdir(self.abspath(d))
1255
947
1256
948
for f in files:
1257
self._transport.put(f, 'content of %s' % f)
1258
1259
1260
def clone(self):
1261
"""
1262
>>> orig = ScratchBranch(files=["file1", "file2"])
1263
>>> clone = orig.clone()
1264
>>> if os.name != 'nt':
1265
... os.path.samefile(orig.base, clone.base)
1266
... else:
1267
... orig.base == clone.base
1268
...
1269
False
1270
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1271
True
1272
"""
1273
from shutil import copytree
1274
from tempfile import mkdtemp
1275
base = mkdtemp()
1276
os.rmdir(base)
1277
copytree(self.base, base, symlinks=True)
1278
return ScratchBranch(
1279
transport=bzrlib.transport.local.ScratchTransport(base))
949
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
950
951
952
def __del__(self):
953
self.destroy()
954
955
def destroy(self):
956
"""Destroy the test branch, removing the scratch directory."""
957
try:
958
mutter("delete ScratchBranch %s" % self.base)
959
shutil.rmtree(self.base)
960
except OSError, e:
961
# Work around for shutil.rmtree failing on Windows when
962
# readonly files are encountered
963
mutter("hit exception in destroying ScratchBranch: %s" % e)
964
for root, dirs, files in os.walk(self.base, topdown=False):
965
for name in files:
966
os.chmod(os.path.join(root, name), 0700)
967
shutil.rmtree(self.base)
968
self.base = None
969
1280
970
1281
971
1282
972
######################################################################
1298
988
1299
989
1300
990
991
def _gen_revision_id(when):
992
"""Return new revision-id."""
993
s = '%s-%s-' % (user_email(), compact_date(when))
994
s += hexlify(rand_bytes(8))
995
return s
996
997
1301
998
def gen_file_id(name):
1302
999
"""Return new file id.
1303
1000
1304
1001
This should probably generate proper UUIDs, but for the moment we
1305
1002
cope with just randomness because running uuidgen every time is
1306
1003
slow."""
1307
import re
1308
from binascii import hexlify
1309
from time import time
1310
1311
# get last component
1312
1004
idx = name.rfind('/')
1313
1005
if idx != -1:
1314
1006
name = name[idx+1 : ]
1316
1008
if idx != -1:
1317
1009
name = name[idx+1 : ]
1318
1010
1319
# make it not a hidden file
1320
1011
name = name.lstrip('.')
1321
1012
1322
# remove any wierd characters; we don't escape them but rather
1323
# just pull them out
1324
name = re.sub(r'[^\w.]', '', name)
1325
1326
1013
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
1014
return '-'.join((name, compact_date(time.time()), s))
Loggerhead is a web-based interface for Breezy
Version: 2.0.1