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