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