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