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