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