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