« back to all changes in this revision
Viewing changes to bzrlib/branch.py
- browse files at revision 363
- compare with another revision
- download diff
- download tarball
- view history from revision 363
- Committer: Martin Pool
- Date: 2005-05-05 06:38:18 UTC
- Revision ID: mbp@sourcefrog.net-20050505063818-3eb3260343878325
- do upload CHANGELOG to web server, even though it's autogenerated
- files added:
- bzrlib/cache.py
- files removed:
- HACKING
- bzrlib/plugins
- bzrlib/selftest
- bzrlib/util
- bzrlib/util/effbot
- bzrlib/util/effbot/org
- contrib/emacs
- patches
- tools
- files renamed:
- contrib/bash/bzr.simple => contrib/bash/bzr
- bzrlib/util/elementtree/ => elementtree/
- bzrlib/util/urlgrabber/ => urlgrabber/
- files modified:
- .bzrignore
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
18
from sets import Set
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
20
23
21
24
import bzrlib
22
from bzrlib.trace import mutter, note
23
from bzrlib.osutils import isdir, quotefn, compact_date, rand_bytes, \
24
splitpath, \
25
sha_file, appendpath, file_kind
26
27
from bzrlib.errors import BzrError, InvalidRevisionNumber, InvalidRevisionId, \
28
DivergedBranches, NotBranchError
29
from bzrlib.textui import show_status
30
from bzrlib.revision import Revision
31
from bzrlib.delta import compare_trees
32
from bzrlib.tree import EmptyTree, RevisionTree
33
import bzrlib.xml
34
import bzrlib.ui
35
36
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
37
38
38
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
39
39
## TODO: Maybe include checks for common corruption of newlines, etc?
40
40
41
41
42
# TODO: Some operations like log might retrieve the same revisions
43
# repeatedly to calculate deltas. We could perhaps have a weakref
44
# cache in memory to make this faster.
45
46
# TODO: please move the revision-string syntax stuff out of the branch
47
# object; it's clutter
48
49
50
def find_branch(f, **args):
51
if f and (f.startswith('http://') or f.startswith('https://')):
52
from bzrlib.remotebranch import RemoteBranch
53
return RemoteBranch(f, **args)
54
else:
55
return Branch(f, **args)
56
57
58
def find_cached_branch(f, cache_root, **args):
59
from bzrlib.remotebranch import RemoteBranch
60
br = find_branch(f, **args)
61
def cacheify(br, store_name):
62
from bzrlib.meta_store import CachedStore
63
cache_path = os.path.join(cache_root, store_name)
64
os.mkdir(cache_path)
65
new_store = CachedStore(getattr(br, store_name), cache_path)
66
setattr(br, store_name, new_store)
67
68
if isinstance(br, RemoteBranch):
69
cacheify(br, 'inventory_store')
70
cacheify(br, 'text_store')
71
cacheify(br, 'revision_store')
72
return br
73
74
75
def _relpath(base, path):
76
"""Return path relative to base, or raise exception.
77
78
The path may be either an absolute path or a path relative to the
79
current working directory.
80
81
Lifted out of Branch.relpath for ease of testing.
82
83
os.path.commonprefix (python2.4) has a bad bug that it works just
84
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
85
avoids that problem."""
86
rp = os.path.abspath(path)
87
88
s = []
89
head = rp
90
while len(head) >= len(base):
91
if head == base:
92
break
93
head, tail = os.path.split(head)
94
if tail:
95
s.insert(0, tail)
96
else:
97
raise NotBranchError("path %r is not within branch %r" % (rp, base))
98
99
return os.sep.join(s)
100
101
42
102
43
def find_branch_root(f=None):
103
44
"""Find the branch root enclosing f, or pwd.
104
45
105
f may be a filename or a URL.
106
107
46
It is not necessary that f exists.
108
47
109
48
Basically we keep looking up until we find the control directory or
110
run into the root. If there isn't one, raises NotBranchError.
111
"""
49
run into the root."""
112
50
if f == None:
113
51
f = os.getcwd()
114
52
elif hasattr(os.path, 'realpath'):
115
53
f = os.path.realpath(f)
116
54
else:
117
55
f = os.path.abspath(f)
118
if not os.path.exists(f):
119
raise BzrError('%r does not exist' % f)
120
121
56
122
57
orig_f = f
123
58
127
62
head, tail = os.path.split(f)
128
63
if head == f:
129
64
# reached the root, whatever that may be
130
raise NotBranchError('%s is not in a branch' % orig_f)
65
raise BzrError('%r is not in a branch' % orig_f)
131
66
f = head
132
133
67
134
68
135
69
136
70
######################################################################
137
71
# branch objects
138
72
139
class Branch(object):
73
class Branch:
140
74
"""Branch holding a history of revisions.
141
75
142
76
base
143
77
Base directory of the branch.
144
145
_lock_mode
146
None, or 'r' or 'w'
147
148
_lock_count
149
If _lock_mode is true, a positive count of the number of times the
150
lock has been taken.
151
152
_lock
153
Lock object from bzrlib.lock.
154
78
"""
155
base = None
156
_lock_mode = None
157
_lock_count = None
158
_lock = None
79
_lockmode = None
159
80
160
# Map some sort of prefix into a namespace
161
# stuff like "revno:10", "revid:", etc.
162
# This should match a prefix with a function which accepts
163
REVISION_NAMESPACES = {}
164
165
def __init__(self, base, init=False, find_root=True):
81
def __init__(self, base, init=False, find_root=True, lock_mode='w'):
166
82
"""Create new branch object at a particular location.
167
83
168
base -- Base directory for the branch. May be a file:// url.
84
base -- Base directory for the branch.
169
85
170
86
init -- If True, create new control files in a previously
171
87
unversioned directory. If False, the branch must already
177
93
In the test suite, creation of new trees is tested using the
178
94
`ScratchBranch` class.
179
95
"""
180
from bzrlib.store import ImmutableStore
181
96
if init:
182
97
self.base = os.path.realpath(base)
183
98
self._make_control()
184
99
elif find_root:
185
100
self.base = find_branch_root(base)
186
101
else:
187
if base.startswith("file://"):
188
base = base[7:]
189
102
self.base = os.path.realpath(base)
190
103
if not isdir(self.controlfilename('.')):
191
raise NotBranchError("not a bzr branch: %s" % quotefn(base),
192
['use "bzr init" to initialize a new working tree',
193
'current bzr can only operate from top-of-tree'])
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'])
194
107
self._check_format()
108
self.lock(lock_mode)
195
109
196
110
self.text_store = ImmutableStore(self.controlfilename('text-store'))
197
111
self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
205
119
__repr__ = __str__
206
120
207
121
208
def __del__(self):
209
if self._lock_mode or self._lock:
210
from bzrlib.warnings import warn
211
warn("branch %r was not explicitly unlocked" % self)
212
self._lock.unlock()
213
214
def lock_write(self):
215
if self._lock_mode:
216
if self._lock_mode != 'w':
217
from bzrlib.errors import LockError
218
raise LockError("can't upgrade to a write lock from %r" %
219
self._lock_mode)
220
self._lock_count += 1
221
else:
222
from bzrlib.lock import WriteLock
223
224
self._lock = WriteLock(self.controlfilename('branch-lock'))
225
self._lock_mode = 'w'
226
self._lock_count = 1
227
228
229
def lock_read(self):
230
if self._lock_mode:
231
assert self._lock_mode in ('r', 'w'), \
232
"invalid lock mode %r" % self._lock_mode
233
self._lock_count += 1
234
else:
235
from bzrlib.lock import ReadLock
236
237
self._lock = ReadLock(self.controlfilename('branch-lock'))
238
self._lock_mode = 'r'
239
self._lock_count = 1
240
241
def unlock(self):
242
if not self._lock_mode:
243
from bzrlib.errors import LockError
244
raise LockError('branch %r is not locked' % (self))
245
246
if self._lock_count > 1:
247
self._lock_count -= 1
248
else:
249
self._lock.unlock()
250
self._lock = None
251
self._lock_mode = self._lock_count = None
122
123
def lock(self, mode='w'):
124
"""Lock the on-disk branch, excluding other processes."""
125
try:
126
import fcntl
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
137
# XXX: Old branches might not have the lock file, and
138
# won't get one until someone does a write-mode command on
139
# them or creates it by hand.
140
141
lockfile = os.open(self.controlfilename('branch-lock'), om)
142
fcntl.lockf(lockfile, lm)
143
def unlock():
144
fcntl.lockf(lockfile, fcntl.LOCK_UN)
145
os.close(lockfile)
146
self._lockmode = None
147
self.unlock = unlock
148
self._lockmode = mode
149
except ImportError:
150
warning("please write a locking method for platform %r" % sys.platform)
151
def unlock():
152
self._lockmode = None
153
self.unlock = unlock
154
self._lockmode = mode
155
156
157
def _need_readlock(self):
158
if self._lockmode not in ['r', 'w']:
159
raise BzrError('need read lock on branch, only have %r' % self._lockmode)
160
161
def _need_writelock(self):
162
if self._lockmode not in ['w']:
163
raise BzrError('need write lock on branch, only have %r' % self._lockmode)
164
252
165
253
166
def abspath(self, name):
254
167
"""Return absolute filename for something in the branch"""
255
168
return os.path.join(self.base, name)
256
169
170
257
171
def relpath(self, path):
258
172
"""Return path relative to this branch of something inside it.
259
173
260
174
Raises an error if path is not in this branch."""
261
return _relpath(self.base, path)
175
rp = os.path.realpath(path)
176
# FIXME: windows
177
if not rp.startswith(self.base):
178
bailout("path %r is not within branch %r" % (rp, self.base))
179
rp = rp[len(self.base):]
180
rp = rp.lstrip(os.sep)
181
return rp
182
262
183
263
184
def controlfilename(self, file_or_path):
264
185
"""Return location relative to branch."""
265
if isinstance(file_or_path, basestring):
186
if isinstance(file_or_path, types.StringTypes):
266
187
file_or_path = [file_or_path]
267
188
return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
268
189
274
195
and binary. binary files are untranslated byte streams. Text
275
196
control files are stored with Unix newlines and in UTF-8, even
276
197
if the platform or locale defaults are different.
277
278
Controlfiles should almost never be opened in write mode but
279
rather should be atomically copied and replaced using atomicfile.
280
198
"""
281
199
282
200
fn = self.controlfilename(file_or_path)
292
210
else:
293
211
raise BzrError("invalid controlfile mode %r" % mode)
294
212
213
214
295
215
def _make_control(self):
296
from bzrlib.inventory import Inventory
297
298
216
os.mkdir(self.controlfilename([]))
299
217
self.controlfile('README', 'w').write(
300
218
"This is a Bazaar-NG control directory.\n"
301
"Do not change any files in this directory.\n")
219
"Do not change any files in this directory.")
302
220
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
303
221
for d in ('text-store', 'inventory-store', 'revision-store'):
304
222
os.mkdir(self.controlfilename(d))
305
223
for f in ('revision-history', 'merged-patches',
306
224
'pending-merged-patches', 'branch-name',
307
'branch-lock',
308
'pending-merges'):
225
'branch-lock'):
309
226
self.controlfile(f, 'w').write('')
310
227
mutter('created control directory in ' + self.base)
311
312
# if we want per-tree root ids then this is the place to set
313
# them; they're not needed for now and so ommitted for
314
# simplicity.
315
f = self.controlfile('inventory','w')
316
bzrlib.xml.serializer_v4.write_inventory(Inventory(), f)
228
Inventory().write_xml(self.controlfile('inventory','w'))
317
229
318
230
319
231
def _check_format(self):
328
240
# on Windows from Linux and so on. I think it might be better
329
241
# to always make all internal files in unix format.
330
242
fmt = self.controlfile('branch-format', 'r').read()
331
fmt = fmt.replace('\r\n', '\n')
243
fmt.replace('\r\n', '')
332
244
if fmt != BZR_BRANCH_FORMAT:
333
raise BzrError('sorry, branch format %r not supported' % fmt,
334
['use a different bzr version',
335
'or remove the .bzr directory and "bzr init" again'])
336
337
def get_root_id(self):
338
"""Return the id of this branches root"""
339
inv = self.read_working_inventory()
340
return inv.root.file_id
341
342
def set_root_id(self, file_id):
343
inv = self.read_working_inventory()
344
orig_root_id = inv.root.file_id
345
del inv._byid[inv.root.file_id]
346
inv.root.file_id = file_id
347
inv._byid[inv.root.file_id] = inv.root
348
for fid in inv:
349
entry = inv[fid]
350
if entry.parent_id in (None, orig_root_id):
351
entry.parent_id = inv.root.file_id
352
self._write_inventory(inv)
245
bailout('sorry, branch format %r not supported' % fmt,
246
['use a different bzr version',
247
'or remove the .bzr directory and "bzr init" again'])
248
353
249
354
250
def read_working_inventory(self):
355
251
"""Read the working inventory."""
356
from bzrlib.inventory import Inventory
357
self.lock_read()
358
try:
359
# ElementTree does its own conversion from UTF-8, so open in
360
# binary.
361
f = self.controlfile('inventory', 'rb')
362
return bzrlib.xml.serializer_v4.read_inventory(f)
363
finally:
364
self.unlock()
365
252
self._need_readlock()
253
before = time.time()
254
# ElementTree does its own conversion from UTF-8, so open in
255
# binary.
256
inv = Inventory.read_xml(self.controlfile('inventory', 'rb'))
257
mutter("loaded inventory of %d items in %f"
258
% (len(inv), time.time() - before))
259
return inv
260
366
261
367
262
def _write_inventory(self, inv):
368
263
"""Update the working inventory.
370
265
That is to say, the inventory describing changes underway, that
371
266
will be committed to the next revision.
372
267
"""
373
from bzrlib.atomicfile import AtomicFile
374
375
self.lock_write()
376
try:
377
f = AtomicFile(self.controlfilename('inventory'), 'wb')
378
try:
379
bzrlib.xml.serializer_v4.write_inventory(inv, f)
380
f.commit()
381
finally:
382
f.close()
383
finally:
384
self.unlock()
385
268
self._need_writelock()
269
## TODO: factor out to atomicfile? is rename safe on windows?
270
## TODO: Maybe some kind of clean/dirty marker on inventory?
271
tmpfname = self.controlfilename('inventory.tmp')
272
tmpf = file(tmpfname, 'wb')
273
inv.write_xml(tmpf)
274
tmpf.close()
275
inv_fname = self.controlfilename('inventory')
276
if sys.platform == 'win32':
277
os.remove(inv_fname)
278
os.rename(tmpfname, inv_fname)
386
279
mutter('wrote working inventory')
387
280
388
281
389
282
inventory = property(read_working_inventory, _write_inventory, None,
390
283
"""Inventory for the working copy.""")
391
284
392
285
393
def add(self, files, ids=None):
286
def add(self, files, verbose=False):
394
287
"""Make files versioned.
395
288
396
Note that the command line normally calls smart_add instead,
397
which can automatically recurse.
289
Note that the command line normally calls smart_add instead.
398
290
399
291
This puts the files in the Added state, so that they will be
400
292
recorded by the next commit.
401
293
402
files
403
List of paths to add, relative to the base of the tree.
404
405
ids
406
If set, use these instead of automatically generated ids.
407
Must be the same length as the list of files, but may
408
contain None for ids that are to be autogenerated.
409
410
294
TODO: Perhaps have an option to add the ids even if the files do
411
not (yet) exist.
412
413
TODO: Perhaps yield the ids and paths as they're added.
295
not (yet) exist.
296
297
TODO: Perhaps return the ids of the files? But then again it
298
is easy to retrieve them if they're needed.
299
300
TODO: Option to specify file id.
301
302
TODO: Adding a directory should optionally recurse down and
303
add all non-ignored children. Perhaps do that in a
304
higher-level method.
305
306
>>> b = ScratchBranch(files=['foo'])
307
>>> 'foo' in b.unknowns()
308
True
309
>>> b.show_status()
310
? foo
311
>>> b.add('foo')
312
>>> 'foo' in b.unknowns()
313
False
314
>>> bool(b.inventory.path2id('foo'))
315
True
316
>>> b.show_status()
317
A foo
318
319
>>> b.add('foo')
320
Traceback (most recent call last):
321
...
322
BzrError: ('foo is already versioned', [])
323
324
>>> b.add(['nothere'])
325
Traceback (most recent call last):
326
BzrError: ('cannot add: not a regular file or directory: nothere', [])
414
327
"""
328
self._need_writelock()
329
415
330
# TODO: Re-adding a file that is removed in the working copy
416
331
# should probably put it back with the previous ID.
417
if isinstance(files, basestring):
418
assert(ids is None or isinstance(ids, basestring))
332
if isinstance(files, types.StringTypes):
419
333
files = [files]
420
if ids is not None:
421
ids = [ids]
422
423
if ids is None:
424
ids = [None] * len(files)
425
else:
426
assert(len(ids) == len(files))
427
428
self.lock_write()
429
try:
430
inv = self.read_working_inventory()
431
for f,file_id in zip(files, ids):
432
if is_control_file(f):
433
raise BzrError("cannot add control file %s" % quotefn(f))
434
435
fp = splitpath(f)
436
437
if len(fp) == 0:
438
raise BzrError("cannot add top-level %r" % f)
439
440
fullpath = os.path.normpath(self.abspath(f))
441
442
try:
443
kind = file_kind(fullpath)
444
except OSError:
445
# maybe something better?
446
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
447
448
if kind != 'file' and kind != 'directory':
449
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
450
451
if file_id is None:
452
file_id = gen_file_id(f)
453
inv.add_path(f, kind=kind, file_id=file_id)
454
455
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
456
457
self._write_inventory(inv)
458
finally:
459
self.unlock()
460
334
335
inv = self.read_working_inventory()
336
for f in files:
337
if is_control_file(f):
338
bailout("cannot add control file %s" % quotefn(f))
339
340
fp = splitpath(f)
341
342
if len(fp) == 0:
343
bailout("cannot add top-level %r" % f)
344
345
fullpath = os.path.normpath(self.abspath(f))
346
347
try:
348
kind = file_kind(fullpath)
349
except OSError:
350
# maybe something better?
351
bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
352
353
if kind != 'file' and kind != 'directory':
354
bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
355
356
file_id = gen_file_id(f)
357
inv.add_path(f, kind=kind, file_id=file_id)
358
359
if verbose:
360
show_status('A', kind, quotefn(f))
361
362
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
363
364
self._write_inventory(inv)
365
461
366
462
367
def print_file(self, file, revno):
463
368
"""Print `file` to stdout."""
464
self.lock_read()
465
try:
466
tree = self.revision_tree(self.lookup_revision(revno))
467
# use inventory as it was in that revision
468
file_id = tree.inventory.path2id(file)
469
if not file_id:
470
raise BzrError("%r is not present in revision %s" % (file, revno))
471
tree.print_file(file_id)
472
finally:
473
self.unlock()
474
369
self._need_readlock()
370
tree = self.revision_tree(self.lookup_revision(revno))
371
# use inventory as it was in that revision
372
file_id = tree.inventory.path2id(file)
373
if not file_id:
374
bailout("%r is not present in revision %d" % (file, revno))
375
tree.print_file(file_id)
376
475
377
476
378
def remove(self, files, verbose=False):
477
379
"""Mark nominated files for removal from the inventory.
480
382
481
383
TODO: Refuse to remove modified files unless --force is given?
482
384
385
>>> b = ScratchBranch(files=['foo'])
386
>>> b.add('foo')
387
>>> b.inventory.has_filename('foo')
388
True
389
>>> b.remove('foo')
390
>>> b.working_tree().has_filename('foo')
391
True
392
>>> b.inventory.has_filename('foo')
393
False
394
395
>>> b = ScratchBranch(files=['foo'])
396
>>> b.add('foo')
397
>>> b.commit('one')
398
>>> b.remove('foo')
399
>>> b.commit('two')
400
>>> b.inventory.has_filename('foo')
401
False
402
>>> b.basis_tree().has_filename('foo')
403
False
404
>>> b.working_tree().has_filename('foo')
405
True
406
483
407
TODO: Do something useful with directories.
484
408
485
409
TODO: Should this remove the text or not? Tough call; not
489
413
"""
490
414
## TODO: Normalize names
491
415
## TODO: Remove nested loops; better scalability
492
if isinstance(files, basestring):
416
self._need_writelock()
417
418
if isinstance(files, types.StringTypes):
493
419
files = [files]
494
495
self.lock_write()
496
497
try:
498
tree = self.working_tree()
499
inv = tree.inventory
500
501
# do this before any modifications
502
for f in files:
503
fid = inv.path2id(f)
504
if not fid:
505
raise BzrError("cannot remove unversioned file %s" % quotefn(f))
506
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
507
if verbose:
508
# having remove it, it must be either ignored or unknown
509
if tree.is_ignored(f):
510
new_status = 'I'
511
else:
512
new_status = '?'
513
show_status(new_status, inv[fid].kind, quotefn(f))
514
del inv[fid]
515
516
self._write_inventory(inv)
517
finally:
518
self.unlock()
519
520
521
# FIXME: this doesn't need to be a branch method
522
def set_inventory(self, new_inventory_list):
523
from bzrlib.inventory import Inventory, InventoryEntry
524
inv = Inventory(self.get_root_id())
525
for path, file_id, parent, kind in new_inventory_list:
526
name = os.path.basename(path)
527
if name == "":
528
continue
529
inv.add(InventoryEntry(file_id, name, kind, parent))
420
421
tree = self.working_tree()
422
inv = tree.inventory
423
424
# do this before any modifications
425
for f in files:
426
fid = inv.path2id(f)
427
if not fid:
428
bailout("cannot remove unversioned file %s" % quotefn(f))
429
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
430
if verbose:
431
# having remove it, it must be either ignored or unknown
432
if tree.is_ignored(f):
433
new_status = 'I'
434
else:
435
new_status = '?'
436
show_status(new_status, inv[fid].kind, quotefn(f))
437
del inv[fid]
438
530
439
self._write_inventory(inv)
531
440
532
441
549
458
return self.working_tree().unknowns()
550
459
551
460
552
def append_revision(self, *revision_ids):
553
from bzrlib.atomicfile import AtomicFile
554
555
for revision_id in revision_ids:
556
mutter("add {%s} to revision-history" % revision_id)
557
461
def commit(self, message, timestamp=None, timezone=None,
462
committer=None,
463
verbose=False):
464
"""Commit working copy as a new revision.
465
466
The basic approach is to add all the file texts into the
467
store, then the inventory, then make a new revision pointing
468
to that inventory and store that.
469
470
This is not quite safe if the working copy changes during the
471
commit; for the moment that is simply not allowed. A better
472
approach is to make a temporary copy of the files before
473
computing their hashes, and then add those hashes in turn to
474
the inventory. This should mean at least that there are no
475
broken hash pointers. There is no way we can get a snapshot
476
of the whole directory at an instant. This would also have to
477
be robust against files disappearing, moving, etc. So the
478
whole thing is a bit hard.
479
480
timestamp -- if not None, seconds-since-epoch for a
481
postdated/predated commit.
482
"""
483
self._need_writelock()
484
485
## TODO: Show branch names
486
487
# TODO: Don't commit if there are no changes, unless forced?
488
489
# First walk over the working inventory; and both update that
490
# and also build a new revision inventory. The revision
491
# inventory needs to hold the text-id, sha1 and size of the
492
# actual file versions committed in the revision. (These are
493
# not present in the working inventory.) We also need to
494
# detect missing/deleted files, and remove them from the
495
# working inventory.
496
497
work_inv = self.read_working_inventory()
498
inv = Inventory()
499
basis = self.basis_tree()
500
basis_inv = basis.inventory
501
missing_ids = []
502
for path, entry in work_inv.iter_entries():
503
## TODO: Cope with files that have gone missing.
504
505
## TODO: Check that the file kind has not changed from the previous
506
## revision of this file (if any).
507
508
entry = entry.copy()
509
510
p = self.abspath(path)
511
file_id = entry.file_id
512
mutter('commit prep file %s, id %r ' % (p, file_id))
513
514
if not os.path.exists(p):
515
mutter(" file is missing, removing from inventory")
516
if verbose:
517
show_status('D', entry.kind, quotefn(path))
518
missing_ids.append(file_id)
519
continue
520
521
# TODO: Handle files that have been deleted
522
523
# TODO: Maybe a special case for empty files? Seems a
524
# waste to store them many times.
525
526
inv.add(entry)
527
528
if basis_inv.has_id(file_id):
529
old_kind = basis_inv[file_id].kind
530
if old_kind != entry.kind:
531
bailout("entry %r changed kind from %r to %r"
532
% (file_id, old_kind, entry.kind))
533
534
if entry.kind == 'directory':
535
if not isdir(p):
536
bailout("%s is entered as directory but not a directory" % quotefn(p))
537
elif entry.kind == 'file':
538
if not isfile(p):
539
bailout("%s is entered as file but is not a file" % quotefn(p))
540
541
content = file(p, 'rb').read()
542
543
entry.text_sha1 = sha_string(content)
544
entry.text_size = len(content)
545
546
old_ie = basis_inv.has_id(file_id) and basis_inv[file_id]
547
if (old_ie
548
and (old_ie.text_size == entry.text_size)
549
and (old_ie.text_sha1 == entry.text_sha1)):
550
## assert content == basis.get_file(file_id).read()
551
entry.text_id = basis_inv[file_id].text_id
552
mutter(' unchanged from previous text_id {%s}' %
553
entry.text_id)
554
555
else:
556
entry.text_id = gen_file_id(entry.name)
557
self.text_store.add(content, entry.text_id)
558
mutter(' stored with text_id {%s}' % entry.text_id)
559
if verbose:
560
if not old_ie:
561
state = 'A'
562
elif (old_ie.name == entry.name
563
and old_ie.parent_id == entry.parent_id):
564
state = 'M'
565
else:
566
state = 'R'
567
568
show_status(state, entry.kind, quotefn(path))
569
570
for file_id in missing_ids:
571
# have to do this later so we don't mess up the iterator.
572
# since parents may be removed before their children we
573
# have to test.
574
575
# FIXME: There's probably a better way to do this; perhaps
576
# the workingtree should know how to filter itself.
577
if work_inv.has_id(file_id):
578
del work_inv[file_id]
579
580
581
inv_id = rev_id = _gen_revision_id(time.time())
582
583
inv_tmp = tempfile.TemporaryFile()
584
inv.write_xml(inv_tmp)
585
inv_tmp.seek(0)
586
self.inventory_store.add(inv_tmp, inv_id)
587
mutter('new inventory_id is {%s}' % inv_id)
588
589
self._write_inventory(work_inv)
590
591
if timestamp == None:
592
timestamp = time.time()
593
594
if committer == None:
595
committer = username()
596
597
if timezone == None:
598
timezone = local_time_offset()
599
600
mutter("building commit log message")
601
rev = Revision(timestamp=timestamp,
602
timezone=timezone,
603
committer=committer,
604
precursor = self.last_patch(),
605
message = message,
606
inventory_id=inv_id,
607
revision_id=rev_id)
608
609
rev_tmp = tempfile.TemporaryFile()
610
rev.write_xml(rev_tmp)
611
rev_tmp.seek(0)
612
self.revision_store.add(rev_tmp, rev_id)
613
mutter("new revision_id is {%s}" % rev_id)
614
615
## XXX: Everything up to here can simply be orphaned if we abort
616
## the commit; it will leave junk files behind but that doesn't
617
## matter.
618
619
## TODO: Read back the just-generated changeset, and make sure it
620
## applies and recreates the right state.
621
622
## TODO: Also calculate and store the inventory SHA1
623
mutter("committing patch r%d" % (self.revno() + 1))
624
625
626
self.append_revision(rev_id)
627
628
if verbose:
629
note("commited r%d" % self.revno())
630
631
632
def append_revision(self, revision_id):
633
mutter("add {%s} to revision-history" % revision_id)
558
634
rev_history = self.revision_history()
559
rev_history.extend(revision_ids)
560
561
f = AtomicFile(self.controlfilename('revision-history'))
562
try:
563
for rev_id in rev_history:
564
print >>f, rev_id
565
f.commit()
566
finally:
567
f.close()
568
569
570
def get_revision_xml_file(self, revision_id):
571
"""Return XML file object for revision object."""
572
if not revision_id or not isinstance(revision_id, basestring):
573
raise InvalidRevisionId(revision_id)
574
575
self.lock_read()
576
try:
577
try:
578
return self.revision_store[revision_id]
579
except IndexError:
580
raise bzrlib.errors.NoSuchRevision(self, revision_id)
581
finally:
582
self.unlock()
583
584
585
#deprecated
586
get_revision_xml = get_revision_xml_file
635
636
tmprhname = self.controlfilename('revision-history.tmp')
637
rhname = self.controlfilename('revision-history')
638
639
f = file(tmprhname, 'wt')
640
rev_history.append(revision_id)
641
f.write('\n'.join(rev_history))
642
f.write('\n')
643
f.close()
644
645
if sys.platform == 'win32':
646
os.remove(rhname)
647
os.rename(tmprhname, rhname)
648
587
649
588
650
589
651
def get_revision(self, revision_id):
590
652
"""Return the Revision object for a named revision"""
591
xml_file = self.get_revision_xml_file(revision_id)
592
593
try:
594
r = bzrlib.xml.serializer_v4.read_revision(xml_file)
595
except SyntaxError, e:
596
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
597
[revision_id,
598
str(e)])
599
653
self._need_readlock()
654
r = Revision.read_xml(self.revision_store[revision_id])
600
655
assert r.revision_id == revision_id
601
656
return r
602
657
603
658
604
def get_revision_delta(self, revno):
605
"""Return the delta for one revision.
606
607
The delta is relative to its mainline predecessor, or the
608
empty tree for revision 1.
609
"""
610
assert isinstance(revno, int)
611
rh = self.revision_history()
612
if not (1 <= revno <= len(rh)):
613
raise InvalidRevisionNumber(revno)
614
615
# revno is 1-based; list is 0-based
616
617
new_tree = self.revision_tree(rh[revno-1])
618
if revno == 1:
619
old_tree = EmptyTree()
620
else:
621
old_tree = self.revision_tree(rh[revno-2])
622
623
return compare_trees(old_tree, new_tree)
624
625
626
627
def get_revision_sha1(self, revision_id):
628
"""Hash the stored value of a revision, and return it."""
629
# In the future, revision entries will be signed. At that
630
# point, it is probably best *not* to include the signature
631
# in the revision hash. Because that lets you re-sign
632
# the revision, (add signatures/remove signatures) and still
633
# have all hash pointers stay consistent.
634
# But for now, just hash the contents.
635
return bzrlib.osutils.sha_file(self.get_revision_xml(revision_id))
636
637
638
659
def get_inventory(self, inventory_id):
639
660
"""Get Inventory object by hash.
640
661
641
662
TODO: Perhaps for this and similar methods, take a revision
642
663
parameter which can be either an integer revno or a
643
664
string hash."""
644
from bzrlib.inventory import Inventory
645
646
f = self.get_inventory_xml_file(inventory_id)
647
return bzrlib.xml.serializer_v4.read_inventory(f)
648
649
650
def get_inventory_xml(self, inventory_id):
651
"""Get inventory XML as a file object."""
652
return self.inventory_store[inventory_id]
653
654
get_inventory_xml_file = get_inventory_xml
655
656
657
def get_inventory_sha1(self, inventory_id):
658
"""Return the sha1 hash of the inventory entry
659
"""
660
return sha_file(self.get_inventory_xml(inventory_id))
665
self._need_readlock()
666
i = Inventory.read_xml(self.inventory_store[inventory_id])
667
return i
661
668
662
669
663
670
def get_revision_inventory(self, revision_id):
664
671
"""Return inventory of a past revision."""
665
# bzr 0.0.6 imposes the constraint that the inventory_id
666
# must be the same as its revision, so this is trivial.
672
self._need_readlock()
667
673
if revision_id == None:
668
from bzrlib.inventory import Inventory
669
return Inventory(self.get_root_id())
674
return Inventory()
670
675
else:
671
return self.get_inventory(revision_id)
676
return self.get_inventory(self.get_revision(revision_id).inventory_id)
672
677
673
678
674
679
def revision_history(self):
677
682
>>> ScratchBranch().revision_history()
678
683
[]
679
684
"""
680
self.lock_read()
681
try:
682
return [l.rstrip('\r\n') for l in
683
self.controlfile('revision-history', 'r').readlines()]
684
finally:
685
self.unlock()
686
687
688
def common_ancestor(self, other, self_revno=None, other_revno=None):
689
"""
690
>>> from bzrlib.commit import commit
691
>>> sb = ScratchBranch(files=['foo', 'foo~'])
692
>>> sb.common_ancestor(sb) == (None, None)
693
True
694
>>> commit(sb, "Committing first revision", verbose=False)
695
>>> sb.common_ancestor(sb)[0]
696
1
697
>>> clone = sb.clone()
698
>>> commit(sb, "Committing second revision", verbose=False)
699
>>> sb.common_ancestor(sb)[0]
700
2
701
>>> sb.common_ancestor(clone)[0]
702
1
703
>>> commit(clone, "Committing divergent second revision",
704
... verbose=False)
705
>>> sb.common_ancestor(clone)[0]
706
1
707
>>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
708
True
709
>>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
710
True
711
>>> clone2 = sb.clone()
712
>>> sb.common_ancestor(clone2)[0]
713
2
714
>>> sb.common_ancestor(clone2, self_revno=1)[0]
715
1
716
>>> sb.common_ancestor(clone2, other_revno=1)[0]
717
1
718
"""
719
my_history = self.revision_history()
720
other_history = other.revision_history()
721
if self_revno is None:
722
self_revno = len(my_history)
723
if other_revno is None:
724
other_revno = len(other_history)
725
indices = range(min((self_revno, other_revno)))
726
indices.reverse()
727
for r in indices:
728
if my_history[r] == other_history[r]:
729
return r+1, my_history[r]
730
return None, None
685
self._need_readlock()
686
return [l.rstrip('\r\n') for l in self.controlfile('revision-history', 'r').readlines()]
731
687
732
688
733
689
def revno(self):
735
691
736
692
That is equivalent to the number of revisions committed to
737
693
this branch.
694
695
>>> b = ScratchBranch()
696
>>> b.revno()
697
0
698
>>> b.commit('no foo')
699
>>> b.revno()
700
1
738
701
"""
739
702
return len(self.revision_history())
740
703
741
704
742
705
def last_patch(self):
743
706
"""Return last patch hash, or None if no history.
707
708
>>> ScratchBranch().last_patch() == None
709
True
744
710
"""
745
711
ph = self.revision_history()
746
712
if ph:
747
713
return ph[-1]
748
714
else:
749
715
return None
750
751
752
def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
753
"""
754
If self and other have not diverged, return a list of the revisions
755
present in other, but missing from self.
756
757
>>> from bzrlib.commit import commit
758
>>> bzrlib.trace.silent = True
759
>>> br1 = ScratchBranch()
760
>>> br2 = ScratchBranch()
761
>>> br1.missing_revisions(br2)
762
[]
763
>>> commit(br2, "lala!", rev_id="REVISION-ID-1")
764
>>> br1.missing_revisions(br2)
765
[u'REVISION-ID-1']
766
>>> br2.missing_revisions(br1)
767
[]
768
>>> commit(br1, "lala!", rev_id="REVISION-ID-1")
769
>>> br1.missing_revisions(br2)
770
[]
771
>>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
772
>>> br1.missing_revisions(br2)
773
[u'REVISION-ID-2A']
774
>>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
775
>>> br1.missing_revisions(br2)
776
Traceback (most recent call last):
777
DivergedBranches: These branches have diverged.
778
"""
779
self_history = self.revision_history()
780
self_len = len(self_history)
781
other_history = other.revision_history()
782
other_len = len(other_history)
783
common_index = min(self_len, other_len) -1
784
if common_index >= 0 and \
785
self_history[common_index] != other_history[common_index]:
786
raise DivergedBranches(self, other)
787
788
if stop_revision is None:
789
stop_revision = other_len
790
elif stop_revision > other_len:
791
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
792
793
return other_history[self_len:stop_revision]
794
795
796
def update_revisions(self, other, stop_revision=None):
797
"""Pull in all new revisions from other branch.
798
"""
799
from bzrlib.fetch import greedy_fetch
800
from bzrlib.revision import get_intervening_revisions
801
802
pb = bzrlib.ui.ui_factory.progress_bar()
803
pb.update('comparing histories')
804
805
try:
806
revision_ids = self.missing_revisions(other, stop_revision)
807
except DivergedBranches, e:
808
try:
809
if stop_revision is None:
810
end_revision = other.last_patch()
811
revision_ids = get_intervening_revisions(self.last_patch(),
812
end_revision, other)
813
assert self.last_patch() not in revision_ids
814
except bzrlib.errors.NotAncestor:
815
raise e
816
817
if len(revision_ids) > 0:
818
count = greedy_fetch(self, other, revision_ids[-1], pb)[0]
819
else:
820
count = 0
821
self.append_revision(*revision_ids)
822
## note("Added %d revisions." % count)
823
pb.clear()
824
825
def install_revisions(self, other, revision_ids, pb):
826
if hasattr(other.revision_store, "prefetch"):
827
other.revision_store.prefetch(revision_ids)
828
if hasattr(other.inventory_store, "prefetch"):
829
inventory_ids = [other.get_revision(r).inventory_id
830
for r in revision_ids]
831
other.inventory_store.prefetch(inventory_ids)
832
833
if pb is None:
834
pb = bzrlib.ui.ui_factory.progress_bar()
835
836
revisions = []
837
needed_texts = set()
838
i = 0
839
840
failures = set()
841
for i, rev_id in enumerate(revision_ids):
842
pb.update('fetching revision', i+1, len(revision_ids))
843
try:
844
rev = other.get_revision(rev_id)
845
except bzrlib.errors.NoSuchRevision:
846
failures.add(rev_id)
847
continue
848
849
revisions.append(rev)
850
inv = other.get_inventory(str(rev.inventory_id))
851
for key, entry in inv.iter_entries():
852
if entry.text_id is None:
853
continue
854
if entry.text_id not in self.text_store:
855
needed_texts.add(entry.text_id)
856
857
pb.clear()
858
859
count, cp_fail = self.text_store.copy_multi(other.text_store,
860
needed_texts)
861
#print "Added %d texts." % count
862
inventory_ids = [ f.inventory_id for f in revisions ]
863
count, cp_fail = self.inventory_store.copy_multi(other.inventory_store,
864
inventory_ids)
865
#print "Added %d inventories." % count
866
revision_ids = [ f.revision_id for f in revisions]
867
868
count, cp_fail = self.revision_store.copy_multi(other.revision_store,
869
revision_ids,
870
permit_failure=True)
871
assert len(cp_fail) == 0
872
return count, failures
873
874
875
def commit(self, *args, **kw):
876
from bzrlib.commit import commit
877
commit(self, *args, **kw)
878
879
880
def lookup_revision(self, revision):
881
"""Return the revision identifier for a given revision information."""
882
revno, info = self._get_revision_info(revision)
883
return info
884
885
886
def revision_id_to_revno(self, revision_id):
887
"""Given a revision id, return its revno"""
888
history = self.revision_history()
889
try:
890
return history.index(revision_id) + 1
891
except ValueError:
892
raise bzrlib.errors.NoSuchRevision(self, revision_id)
893
894
895
def get_revision_info(self, revision):
896
"""Return (revno, revision id) for revision identifier.
897
898
revision can be an integer, in which case it is assumed to be revno (though
899
this will translate negative values into positive ones)
900
revision can also be a string, in which case it is parsed for something like
901
'date:' or 'revid:' etc.
902
"""
903
revno, rev_id = self._get_revision_info(revision)
904
if revno is None:
905
raise bzrlib.errors.NoSuchRevision(self, revision)
906
return revno, rev_id
907
908
def get_rev_id(self, revno, history=None):
909
"""Find the revision id of the specified revno."""
716
717
718
def lookup_revision(self, revno):
719
"""Return revision hash for revision number."""
910
720
if revno == 0:
911
721
return None
912
if history is None:
913
history = self.revision_history()
914
elif revno <= 0 or revno > len(history):
915
raise bzrlib.errors.NoSuchRevision(self, revno)
916
return history[revno - 1]
917
918
def _get_revision_info(self, revision):
919
"""Return (revno, revision id) for revision specifier.
920
921
revision can be an integer, in which case it is assumed to be revno
922
(though this will translate negative values into positive ones)
923
revision can also be a string, in which case it is parsed for something
924
like 'date:' or 'revid:' etc.
925
926
A revid is always returned. If it is None, the specifier referred to
927
the null revision. If the revid does not occur in the revision
928
history, revno will be None.
929
"""
930
931
if revision is None:
932
return 0, None
933
revno = None
934
try:# Convert to int if possible
935
revision = int(revision)
936
except ValueError:
937
pass
938
revs = self.revision_history()
939
if isinstance(revision, int):
940
if revision < 0:
941
revno = len(revs) + revision + 1
942
else:
943
revno = revision
944
rev_id = self.get_rev_id(revno, revs)
945
elif isinstance(revision, basestring):
946
for prefix, func in Branch.REVISION_NAMESPACES.iteritems():
947
if revision.startswith(prefix):
948
result = func(self, revs, revision)
949
if len(result) > 1:
950
revno, rev_id = result
951
else:
952
revno = result[0]
953
rev_id = self.get_rev_id(revno, revs)
954
break
955
else:
956
raise BzrError('No namespace registered for string: %r' %
957
revision)
958
else:
959
raise TypeError('Unhandled revision type %s' % revision)
960
961
if revno is None:
962
if rev_id is None:
963
raise bzrlib.errors.NoSuchRevision(self, revision)
964
return revno, rev_id
965
966
def _namespace_revno(self, revs, revision):
967
"""Lookup a revision by revision number"""
968
assert revision.startswith('revno:')
969
try:
970
return (int(revision[6:]),)
971
except ValueError:
972
return None
973
REVISION_NAMESPACES['revno:'] = _namespace_revno
974
975
def _namespace_revid(self, revs, revision):
976
assert revision.startswith('revid:')
977
rev_id = revision[len('revid:'):]
978
try:
979
return revs.index(rev_id) + 1, rev_id
980
except ValueError:
981
return None, rev_id
982
REVISION_NAMESPACES['revid:'] = _namespace_revid
983
984
def _namespace_last(self, revs, revision):
985
assert revision.startswith('last:')
986
try:
987
offset = int(revision[5:])
988
except ValueError:
989
return (None,)
990
else:
991
if offset <= 0:
992
raise BzrError('You must supply a positive value for --revision last:XXX')
993
return (len(revs) - offset + 1,)
994
REVISION_NAMESPACES['last:'] = _namespace_last
995
996
def _namespace_tag(self, revs, revision):
997
assert revision.startswith('tag:')
998
raise BzrError('tag: namespace registered, but not implemented.')
999
REVISION_NAMESPACES['tag:'] = _namespace_tag
1000
1001
def _namespace_date(self, revs, revision):
1002
assert revision.startswith('date:')
1003
import datetime
1004
# Spec for date revisions:
1005
# date:value
1006
# value can be 'yesterday', 'today', 'tomorrow' or a YYYY-MM-DD string.
1007
# it can also start with a '+/-/='. '+' says match the first
1008
# entry after the given date. '-' is match the first entry before the date
1009
# '=' is match the first entry after, but still on the given date.
1010
#
1011
# +2005-05-12 says find the first matching entry after May 12th, 2005 at 0:00
1012
# -2005-05-12 says find the first matching entry before May 12th, 2005 at 0:00
1013
# =2005-05-12 says find the first match after May 12th, 2005 at 0:00 but before
1014
# May 13th, 2005 at 0:00
1015
#
1016
# So the proper way of saying 'give me all entries for today' is:
1017
# -r {date:+today}:{date:-tomorrow}
1018
# The default is '=' when not supplied
1019
val = revision[5:]
1020
match_style = '='
1021
if val[:1] in ('+', '-', '='):
1022
match_style = val[:1]
1023
val = val[1:]
1024
1025
today = datetime.datetime.today().replace(hour=0,minute=0,second=0,microsecond=0)
1026
if val.lower() == 'yesterday':
1027
dt = today - datetime.timedelta(days=1)
1028
elif val.lower() == 'today':
1029
dt = today
1030
elif val.lower() == 'tomorrow':
1031
dt = today + datetime.timedelta(days=1)
1032
else:
1033
import re
1034
# This should be done outside the function to avoid recompiling it.
1035
_date_re = re.compile(
1036
r'(?P<date>(?P<year>\d\d\d\d)-(?P<month>\d\d)-(?P<day>\d\d))?'
1037
r'(,|T)?\s*'
1038
r'(?P<time>(?P<hour>\d\d):(?P<minute>\d\d)(:(?P<second>\d\d))?)?'
1039
)
1040
m = _date_re.match(val)
1041
if not m or (not m.group('date') and not m.group('time')):
1042
raise BzrError('Invalid revision date %r' % revision)
1043
1044
if m.group('date'):
1045
year, month, day = int(m.group('year')), int(m.group('month')), int(m.group('day'))
1046
else:
1047
year, month, day = today.year, today.month, today.day
1048
if m.group('time'):
1049
hour = int(m.group('hour'))
1050
minute = int(m.group('minute'))
1051
if m.group('second'):
1052
second = int(m.group('second'))
1053
else:
1054
second = 0
1055
else:
1056
hour, minute, second = 0,0,0
1057
1058
dt = datetime.datetime(year=year, month=month, day=day,
1059
hour=hour, minute=minute, second=second)
1060
first = dt
1061
last = None
1062
reversed = False
1063
if match_style == '-':
1064
reversed = True
1065
elif match_style == '=':
1066
last = dt + datetime.timedelta(days=1)
1067
1068
if reversed:
1069
for i in range(len(revs)-1, -1, -1):
1070
r = self.get_revision(revs[i])
1071
# TODO: Handle timezone.
1072
dt = datetime.datetime.fromtimestamp(r.timestamp)
1073
if first >= dt and (last is None or dt >= last):
1074
return (i+1,)
1075
else:
1076
for i in range(len(revs)):
1077
r = self.get_revision(revs[i])
1078
# TODO: Handle timezone.
1079
dt = datetime.datetime.fromtimestamp(r.timestamp)
1080
if first <= dt and (last is None or dt <= last):
1081
return (i+1,)
1082
REVISION_NAMESPACES['date:'] = _namespace_date
722
723
try:
724
# list is 0-based; revisions are 1-based
725
return self.revision_history()[revno-1]
726
except IndexError:
727
raise BzrError("no such revision %s" % revno)
728
1083
729
1084
730
def revision_tree(self, revision_id):
1085
731
"""Return Tree for a revision on this branch.
1086
732
1087
733
`revision_id` may be None for the null revision, in which case
1088
734
an `EmptyTree` is returned."""
1089
# TODO: refactor this to use an existing revision object
1090
# so we don't need to read it in twice.
735
self._need_readlock()
1091
736
if revision_id == None:
1092
737
return EmptyTree()
1093
738
else:
1097
742
1098
743
def working_tree(self):
1099
744
"""Return a `Tree` for the working copy."""
1100
from bzrlib.workingtree import WorkingTree
1101
745
return WorkingTree(self.base, self.read_working_inventory())
1102
746
1103
747
1105
749
"""Return `Tree` object for last revision.
1106
750
1107
751
If there are no revisions yet, return an `EmptyTree`.
752
753
>>> b = ScratchBranch(files=['foo'])
754
>>> b.basis_tree().has_filename('foo')
755
False
756
>>> b.working_tree().has_filename('foo')
757
True
758
>>> b.add('foo')
759
>>> b.commit('add foo')
760
>>> b.basis_tree().has_filename('foo')
761
True
1108
762
"""
1109
763
r = self.last_patch()
1110
764
if r == None:
1114
768
1115
769
1116
770
771
def write_log(self, show_timezone='original', verbose=False):
772
"""Write out human-readable log of commits to this branch
773
774
utc -- If true, show dates in universal time, not local time."""
775
self._need_readlock()
776
## TODO: Option to choose either original, utc or local timezone
777
revno = 1
778
precursor = None
779
for p in self.revision_history():
780
print '-' * 40
781
print 'revno:', revno
782
## TODO: Show hash if --id is given.
783
##print 'revision-hash:', p
784
rev = self.get_revision(p)
785
print 'committer:', rev.committer
786
print 'timestamp: %s' % (format_date(rev.timestamp, rev.timezone or 0,
787
show_timezone))
788
789
## opportunistic consistency check, same as check_patch_chaining
790
if rev.precursor != precursor:
791
bailout("mismatched precursor!")
792
793
print 'message:'
794
if not rev.message:
795
print ' (no message)'
796
else:
797
for l in rev.message.split('\n'):
798
print ' ' + l
799
800
if verbose == True and precursor != None:
801
print 'changed files:'
802
tree = self.revision_tree(p)
803
prevtree = self.revision_tree(precursor)
804
805
for file_state, fid, old_name, new_name, kind in \
806
diff_trees(prevtree, tree, ):
807
if file_state == 'A' or file_state == 'M':
808
show_status(file_state, kind, new_name)
809
elif file_state == 'D':
810
show_status(file_state, kind, old_name)
811
elif file_state == 'R':
812
show_status(file_state, kind,
813
old_name + ' => ' + new_name)
814
815
revno += 1
816
precursor = p
817
818
1117
819
def rename_one(self, from_rel, to_rel):
1118
820
"""Rename one file.
1119
821
1120
822
This can change the directory or the filename or both.
1121
823
"""
1122
self.lock_write()
824
self._need_writelock()
825
tree = self.working_tree()
826
inv = tree.inventory
827
if not tree.has_filename(from_rel):
828
bailout("can't rename: old working file %r does not exist" % from_rel)
829
if tree.has_filename(to_rel):
830
bailout("can't rename: new working file %r already exists" % to_rel)
831
832
file_id = inv.path2id(from_rel)
833
if file_id == None:
834
bailout("can't rename: old name %r is not versioned" % from_rel)
835
836
if inv.path2id(to_rel):
837
bailout("can't rename: new name %r is already versioned" % to_rel)
838
839
to_dir, to_tail = os.path.split(to_rel)
840
to_dir_id = inv.path2id(to_dir)
841
if to_dir_id == None and to_dir != '':
842
bailout("can't determine destination directory id for %r" % to_dir)
843
844
mutter("rename_one:")
845
mutter(" file_id {%s}" % file_id)
846
mutter(" from_rel %r" % from_rel)
847
mutter(" to_rel %r" % to_rel)
848
mutter(" to_dir %r" % to_dir)
849
mutter(" to_dir_id {%s}" % to_dir_id)
850
851
inv.rename(file_id, to_dir_id, to_tail)
852
853
print "%s => %s" % (from_rel, to_rel)
854
855
from_abs = self.abspath(from_rel)
856
to_abs = self.abspath(to_rel)
1123
857
try:
1124
tree = self.working_tree()
1125
inv = tree.inventory
1126
if not tree.has_filename(from_rel):
1127
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1128
if tree.has_filename(to_rel):
1129
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1130
1131
file_id = inv.path2id(from_rel)
1132
if file_id == None:
1133
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1134
1135
if inv.path2id(to_rel):
1136
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1137
1138
to_dir, to_tail = os.path.split(to_rel)
1139
to_dir_id = inv.path2id(to_dir)
1140
if to_dir_id == None and to_dir != '':
1141
raise BzrError("can't determine destination directory id for %r" % to_dir)
1142
1143
mutter("rename_one:")
1144
mutter(" file_id {%s}" % file_id)
1145
mutter(" from_rel %r" % from_rel)
1146
mutter(" to_rel %r" % to_rel)
1147
mutter(" to_dir %r" % to_dir)
1148
mutter(" to_dir_id {%s}" % to_dir_id)
1149
1150
inv.rename(file_id, to_dir_id, to_tail)
1151
1152
from_abs = self.abspath(from_rel)
1153
to_abs = self.abspath(to_rel)
1154
try:
1155
os.rename(from_abs, to_abs)
1156
except OSError, e:
1157
raise BzrError("failed to rename %r to %r: %s"
1158
% (from_abs, to_abs, e[1]),
1159
["rename rolled back"])
1160
1161
self._write_inventory(inv)
1162
finally:
1163
self.unlock()
858
os.rename(from_abs, to_abs)
859
except OSError, e:
860
bailout("failed to rename %r to %r: %s"
861
% (from_abs, to_abs, e[1]),
862
["rename rolled back"])
863
864
self._write_inventory(inv)
865
1164
866
1165
867
1166
868
def move(self, from_paths, to_name):
1173
875
1174
876
Note that to_name is only the last component of the new name;
1175
877
this doesn't change the directory.
1176
1177
This returns a list of (from_path, to_path) pairs for each
1178
entry that is moved.
1179
"""
1180
result = []
1181
self.lock_write()
1182
try:
1183
## TODO: Option to move IDs only
1184
assert not isinstance(from_paths, basestring)
1185
tree = self.working_tree()
1186
inv = tree.inventory
1187
to_abs = self.abspath(to_name)
1188
if not isdir(to_abs):
1189
raise BzrError("destination %r is not a directory" % to_abs)
1190
if not tree.has_filename(to_name):
1191
raise BzrError("destination %r not in working directory" % to_abs)
1192
to_dir_id = inv.path2id(to_name)
1193
if to_dir_id == None and to_name != '':
1194
raise BzrError("destination %r is not a versioned directory" % to_name)
1195
to_dir_ie = inv[to_dir_id]
1196
if to_dir_ie.kind not in ('directory', 'root_directory'):
1197
raise BzrError("destination %r is not a directory" % to_abs)
1198
1199
to_idpath = inv.get_idpath(to_dir_id)
1200
1201
for f in from_paths:
1202
if not tree.has_filename(f):
1203
raise BzrError("%r does not exist in working tree" % f)
1204
f_id = inv.path2id(f)
1205
if f_id == None:
1206
raise BzrError("%r is not versioned" % f)
1207
name_tail = splitpath(f)[-1]
1208
dest_path = appendpath(to_name, name_tail)
1209
if tree.has_filename(dest_path):
1210
raise BzrError("destination %r already exists" % dest_path)
1211
if f_id in to_idpath:
1212
raise BzrError("can't move %r to a subdirectory of itself" % f)
1213
1214
# OK, so there's a race here, it's possible that someone will
1215
# create a file in this interval and then the rename might be
1216
# left half-done. But we should have caught most problems.
1217
1218
for f in from_paths:
1219
name_tail = splitpath(f)[-1]
1220
dest_path = appendpath(to_name, name_tail)
1221
result.append((f, dest_path))
1222
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1223
try:
1224
os.rename(self.abspath(f), self.abspath(dest_path))
1225
except OSError, e:
1226
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1227
["rename rolled back"])
1228
1229
self._write_inventory(inv)
1230
finally:
1231
self.unlock()
1232
1233
return result
1234
1235
1236
def revert(self, filenames, old_tree=None, backups=True):
1237
"""Restore selected files to the versions from a previous tree.
1238
1239
backups
1240
If true (default) backups are made of files before
1241
they're renamed.
1242
"""
1243
from bzrlib.errors import NotVersionedError, BzrError
1244
from bzrlib.atomicfile import AtomicFile
1245
from bzrlib.osutils import backup_file
1246
1247
inv = self.read_working_inventory()
1248
if old_tree is None:
1249
old_tree = self.basis_tree()
1250
old_inv = old_tree.inventory
1251
1252
nids = []
1253
for fn in filenames:
1254
file_id = inv.path2id(fn)
1255
if not file_id:
1256
raise NotVersionedError("not a versioned file", fn)
1257
if not old_inv.has_id(file_id):
1258
raise BzrError("file not present in old tree", fn, file_id)
1259
nids.append((fn, file_id))
1260
1261
# TODO: Rename back if it was previously at a different location
1262
1263
# TODO: If given a directory, restore the entire contents from
1264
# the previous version.
1265
1266
# TODO: Make a backup to a temporary file.
1267
1268
# TODO: If the file previously didn't exist, delete it?
1269
for fn, file_id in nids:
1270
backup_file(fn)
1271
1272
f = AtomicFile(fn, 'wb')
1273
try:
1274
f.write(old_tree.get_file(file_id).read())
1275
f.commit()
1276
finally:
1277
f.close()
1278
1279
1280
def pending_merges(self):
1281
"""Return a list of pending merges.
1282
1283
These are revisions that have been merged into the working
1284
directory but not yet committed.
1285
"""
1286
cfn = self.controlfilename('pending-merges')
1287
if not os.path.exists(cfn):
1288
return []
1289
p = []
1290
for l in self.controlfile('pending-merges', 'r').readlines():
1291
p.append(l.rstrip('\n'))
1292
return p
1293
1294
1295
def add_pending_merge(self, revision_id):
1296
from bzrlib.revision import validate_revision_id
1297
1298
validate_revision_id(revision_id)
1299
1300
p = self.pending_merges()
1301
if revision_id in p:
1302
return
1303
p.append(revision_id)
1304
self.set_pending_merges(p)
1305
1306
1307
def set_pending_merges(self, rev_list):
1308
from bzrlib.atomicfile import AtomicFile
1309
self.lock_write()
1310
try:
1311
f = AtomicFile(self.controlfilename('pending-merges'))
1312
try:
1313
for l in rev_list:
1314
print >>f, l
1315
f.commit()
1316
finally:
1317
f.close()
1318
finally:
1319
self.unlock()
1320
1321
1322
def get_parent(self):
1323
"""Return the parent location of the branch.
1324
1325
This is the default location for push/pull/missing. The usual
1326
pattern is that the user can override it by specifying a
1327
location.
1328
"""
1329
import errno
1330
_locs = ['parent', 'pull', 'x-pull']
1331
for l in _locs:
1332
try:
1333
return self.controlfile(l, 'r').read().strip('\n')
1334
except IOError, e:
1335
if e.errno != errno.ENOENT:
1336
raise
1337
return None
1338
1339
1340
def set_parent(self, url):
1341
# TODO: Maybe delete old location files?
1342
from bzrlib.atomicfile import AtomicFile
1343
self.lock_write()
1344
try:
1345
f = AtomicFile(self.controlfilename('parent'))
1346
try:
1347
f.write(url + '\n')
1348
f.commit()
1349
finally:
1350
f.close()
1351
finally:
1352
self.unlock()
1353
1354
def check_revno(self, revno):
1355
"""\
1356
Check whether a revno corresponds to any revision.
1357
Zero (the NULL revision) is considered valid.
1358
"""
1359
if revno != 0:
1360
self.check_real_revno(revno)
1361
1362
def check_real_revno(self, revno):
1363
"""\
1364
Check whether a revno corresponds to a real revision.
1365
Zero (the NULL revision) is considered invalid
1366
"""
1367
if revno < 1 or revno > self.revno():
1368
raise InvalidRevisionNumber(revno)
1369
1370
878
"""
879
self._need_writelock()
880
## TODO: Option to move IDs only
881
assert not isinstance(from_paths, basestring)
882
tree = self.working_tree()
883
inv = tree.inventory
884
to_abs = self.abspath(to_name)
885
if not isdir(to_abs):
886
bailout("destination %r is not a directory" % to_abs)
887
if not tree.has_filename(to_name):
888
bailout("destination %r not in working directory" % to_abs)
889
to_dir_id = inv.path2id(to_name)
890
if to_dir_id == None and to_name != '':
891
bailout("destination %r is not a versioned directory" % to_name)
892
to_dir_ie = inv[to_dir_id]
893
if to_dir_ie.kind not in ('directory', 'root_directory'):
894
bailout("destination %r is not a directory" % to_abs)
895
896
to_idpath = Set(inv.get_idpath(to_dir_id))
897
898
for f in from_paths:
899
if not tree.has_filename(f):
900
bailout("%r does not exist in working tree" % f)
901
f_id = inv.path2id(f)
902
if f_id == None:
903
bailout("%r is not versioned" % f)
904
name_tail = splitpath(f)[-1]
905
dest_path = appendpath(to_name, name_tail)
906
if tree.has_filename(dest_path):
907
bailout("destination %r already exists" % dest_path)
908
if f_id in to_idpath:
909
bailout("can't move %r to a subdirectory of itself" % f)
910
911
# OK, so there's a race here, it's possible that someone will
912
# create a file in this interval and then the rename might be
913
# left half-done. But we should have caught most problems.
914
915
for f in from_paths:
916
name_tail = splitpath(f)[-1]
917
dest_path = appendpath(to_name, name_tail)
918
print "%s => %s" % (f, dest_path)
919
inv.rename(inv.path2id(f), to_dir_id, name_tail)
920
try:
921
os.rename(self.abspath(f), self.abspath(dest_path))
922
except OSError, e:
923
bailout("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
924
["rename rolled back"])
925
926
self._write_inventory(inv)
927
928
929
930
def show_status(self, show_all=False):
931
"""Display single-line status for non-ignored working files.
932
933
The list is show sorted in order by file name.
934
935
>>> b = ScratchBranch(files=['foo', 'foo~'])
936
>>> b.show_status()
937
? foo
938
>>> b.add('foo')
939
>>> b.show_status()
940
A foo
941
>>> b.commit("add foo")
942
>>> b.show_status()
943
>>> os.unlink(b.abspath('foo'))
944
>>> b.show_status()
945
D foo
946
947
TODO: Get state for single files.
948
"""
949
self._need_readlock()
950
951
# We have to build everything into a list first so that it can
952
# sorted by name, incorporating all the different sources.
953
954
# FIXME: Rather than getting things in random order and then sorting,
955
# just step through in order.
956
957
# Interesting case: the old ID for a file has been removed,
958
# but a new file has been created under that name.
959
960
old = self.basis_tree()
961
new = self.working_tree()
962
963
for fs, fid, oldname, newname, kind in diff_trees(old, new):
964
if fs == 'R':
965
show_status(fs, kind,
966
oldname + ' => ' + newname)
967
elif fs == 'A' or fs == 'M':
968
show_status(fs, kind, newname)
969
elif fs == 'D':
970
show_status(fs, kind, oldname)
971
elif fs == '.':
972
if show_all:
973
show_status(fs, kind, newname)
974
elif fs == 'I':
975
if show_all:
976
show_status(fs, kind, newname)
977
elif fs == '?':
978
show_status(fs, kind, newname)
979
else:
980
bailout("weird file state %r" % ((fs, fid),))
981
1371
982
1372
983
1373
984
class ScratchBranch(Branch):
1377
988
>>> isdir(b.base)
1378
989
True
1379
990
>>> bd = b.base
1380
>>> b.destroy()
991
>>> del b
1381
992
>>> isdir(bd)
1382
993
False
1383
994
"""
1384
def __init__(self, files=[], dirs=[], base=None):
995
def __init__(self, files=[], dirs=[]):
1385
996
"""Make a test branch.
1386
997
1387
998
This creates a temporary directory and runs init-tree in it.
1388
999
1389
1000
If any files are listed, they are created in the working copy.
1390
1001
"""
1391
from tempfile import mkdtemp
1392
init = False
1393
if base is None:
1394
base = mkdtemp()
1395
init = True
1396
Branch.__init__(self, base, init=init)
1002
Branch.__init__(self, tempfile.mkdtemp(), init=True)
1397
1003
for d in dirs:
1398
1004
os.mkdir(self.abspath(d))
1399
1005
1401
1007
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
1402
1008
1403
1009
1404
def clone(self):
1405
"""
1406
>>> orig = ScratchBranch(files=["file1", "file2"])
1407
>>> clone = orig.clone()
1408
>>> os.path.samefile(orig.base, clone.base)
1409
False
1410
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1411
True
1412
"""
1413
from shutil import copytree
1414
from tempfile import mkdtemp
1415
base = mkdtemp()
1416
os.rmdir(base)
1417
copytree(self.base, base, symlinks=True)
1418
return ScratchBranch(base=base)
1419
1420
1421
1422
1010
def __del__(self):
1423
self.destroy()
1424
1425
def destroy(self):
1426
1011
"""Destroy the test branch, removing the scratch directory."""
1427
from shutil import rmtree
1428
1012
try:
1429
if self.base:
1430
mutter("delete ScratchBranch %s" % self.base)
1431
rmtree(self.base)
1432
except OSError, e:
1013
shutil.rmtree(self.base)
1014
except OSError:
1433
1015
# Work around for shutil.rmtree failing on Windows when
1434
1016
# readonly files are encountered
1435
mutter("hit exception in destroying ScratchBranch: %s" % e)
1436
1017
for root, dirs, files in os.walk(self.base, topdown=False):
1437
1018
for name in files:
1438
1019
os.chmod(os.path.join(root, name), 0700)
1439
rmtree(self.base)
1440
self.base = None
1020
shutil.rmtree(self.base)
1441
1021
1442
1022
1443
1023
1460
1040
1461
1041
1462
1042
1043
def _gen_revision_id(when):
1044
"""Return new revision-id."""
1045
s = '%s-%s-' % (user_email(), compact_date(when))
1046
s += hexlify(rand_bytes(8))
1047
return s
1048
1049
1463
1050
def gen_file_id(name):
1464
1051
"""Return new file id.
1465
1052
1466
1053
This should probably generate proper UUIDs, but for the moment we
1467
1054
cope with just randomness because running uuidgen every time is
1468
1055
slow."""
1469
import re
1470
from binascii import hexlify
1471
from time import time
1472
1473
# get last component
1474
1056
idx = name.rfind('/')
1475
1057
if idx != -1:
1476
1058
name = name[idx+1 : ]
1478
1060
if idx != -1:
1479
1061
name = name[idx+1 : ]
1480
1062
1481
# make it not a hidden file
1482
1063
name = name.lstrip('.')
1483
1064
1484
# remove any wierd characters; we don't escape them but rather
1485
# just pull them out
1486
name = re.sub(r'[^\w.]', '', name)
1487
1488
1065
s = hexlify(rand_bytes(8))
1489
return '-'.join((name, compact_date(time()), s))
1490
1491
1492
def gen_root_id():
1493
"""Return a new tree-root file id."""
1494
return gen_file_id('TREE_ROOT')
1495
1496
1497
def copy_branch(branch_from, to_location, revision=None):
1498
"""Copy branch_from into the existing directory to_location.
1499
1500
revision
1501
If not None, only revisions up to this point will be copied.
1502
The head of the new branch will be that revision.
1503
1504
to_location
1505
The name of a local directory that exists but is empty.
1506
"""
1507
from bzrlib.merge import merge
1508
1509
assert isinstance(branch_from, Branch)
1510
assert isinstance(to_location, basestring)
1511
1512
br_to = Branch(to_location, init=True)
1513
br_to.set_root_id(branch_from.get_root_id())
1514
if revision is None:
1515
revno = branch_from.revno()
1516
else:
1517
revno, rev_id = branch_from.get_revision_info(revision)
1518
br_to.update_revisions(branch_from, stop_revision=revno)
1519
merge((to_location, -1), (to_location, 0), this_dir=to_location,
1520
check_clean=False, ignore_zero=True)
1521
1522
br_to.set_parent(branch_from.base)
1066
return '-'.join((name, compact_date(time.time()), s))
Loggerhead is a web-based interface for Breezy
Version: 2.0.1