« back to all changes in this revision
Viewing changes to bzrlib/branch.py
- browse files at revision 558
- compare with another revision
- download diff
- download tarball
- view history from revision 558
- Committer: Martin Pool
- Date: 2005-05-26 02:13:57 UTC
- Revision ID: mbp@sourcefrog.net-20050526021357-9a56decdca0c174f
- All top-level classes inherit from object
(Python new-style classes)
(Python new-style classes)
- files added:
- .rsyncexclude
- contrib
- contrib/bash
- contrib/zsh
- patches
- urlgrabber
- files removed:
- bzrlib/tests.py
- files modified:
- .bzrignore
added
removed
bzrlib/branch.py
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16
16
17
17
18
from sets import Set
19
20
18
import sys, os, os.path, random, time, sha, sets, types, re, shutil, tempfile
21
19
import traceback, socket, fnmatch, difflib, time
22
20
from binascii import hexlify
24
22
import bzrlib
25
23
from inventory import Inventory
26
24
from trace import mutter, note
27
from tree import Tree, EmptyTree, RevisionTree, WorkingTree
25
from tree import Tree, EmptyTree, RevisionTree
28
26
from inventory import InventoryEntry, Inventory
29
from osutils import isdir, quotefn, isfile, uuid, sha_file, username, chomp, \
27
from osutils import isdir, quotefn, isfile, uuid, sha_file, username, \
30
28
format_date, compact_date, pumpfile, user_email, rand_bytes, splitpath, \
31
joinpath, sha_string, file_kind, local_time_offset
29
joinpath, sha_string, file_kind, local_time_offset, appendpath
32
30
from store import ImmutableStore
33
31
from revision import Revision
34
from errors import bailout
32
from errors import bailout, BzrError
35
33
from textui import show_status
36
from diff import diff_trees
37
34
38
35
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
39
36
## TODO: Maybe include checks for common corruption of newlines, etc?
40
37
41
38
42
39
40
def find_branch(f, **args):
41
if f and (f.startswith('http://') or f.startswith('https://')):
42
import remotebranch
43
return remotebranch.RemoteBranch(f, **args)
44
else:
45
return Branch(f, **args)
46
47
43
48
def find_branch_root(f=None):
44
49
"""Find the branch root enclosing f, or pwd.
45
50
51
f may be a filename or a URL.
52
46
53
It is not necessary that f exists.
47
54
48
55
Basically we keep looking up until we find the control directory or
49
56
run into the root."""
50
if f is None:
57
if f == None:
51
58
f = os.getcwd()
52
59
elif hasattr(os.path, 'realpath'):
53
60
f = os.path.realpath(f)
54
61
else:
55
62
f = os.path.abspath(f)
63
if not os.path.exists(f):
64
raise BzrError('%r does not exist' % f)
65
56
66
57
67
orig_f = f
58
68
59
last_f = f
60
69
while True:
61
70
if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
62
71
return f
63
72
head, tail = os.path.split(f)
64
73
if head == f:
65
74
# reached the root, whatever that may be
66
bailout('%r is not in a branch' % orig_f)
75
raise BzrError('%r is not in a branch' % orig_f)
67
76
f = head
68
77
69
78
71
80
######################################################################
72
81
# branch objects
73
82
74
class Branch:
83
class Branch(object):
75
84
"""Branch holding a history of revisions.
76
85
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.
86
base
87
Base directory of the branch.
89
88
"""
90
def __init__(self, base, init=False, find_root=True):
89
_lockmode = None
90
91
def __init__(self, base, init=False, find_root=True, lock_mode='w'):
91
92
"""Create new branch object at a particular location.
92
93
93
:param base: Base directory for the branch.
94
base -- Base directory for the branch.
94
95
95
:param init: If True, create new control files in a previously
96
init -- If True, create new control files in a previously
96
97
unversioned directory. If False, the branch must already
97
98
be versioned.
98
99
99
:param find_root: If true and init is false, find the root of the
100
find_root -- If true and init is false, find the root of the
100
101
existing branch containing base.
101
102
102
103
In the test suite, creation of new trees is tested using the
114
115
['use "bzr init" to initialize a new working tree',
115
116
'current bzr can only operate from top-of-tree'])
116
117
self._check_format()
118
self.lock(lock_mode)
117
119
118
120
self.text_store = ImmutableStore(self.controlfilename('text-store'))
119
121
self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
127
129
__repr__ = __str__
128
130
129
131
132
133
def lock(self, mode='w'):
134
"""Lock the on-disk branch, excluding other processes."""
135
try:
136
import fcntl, errno
137
138
if mode == 'w':
139
lm = fcntl.LOCK_EX
140
om = os.O_WRONLY | os.O_CREAT
141
elif mode == 'r':
142
lm = fcntl.LOCK_SH
143
om = os.O_RDONLY
144
else:
145
raise BzrError("invalid locking mode %r" % mode)
146
147
try:
148
lockfile = os.open(self.controlfilename('branch-lock'), om)
149
except OSError, e:
150
if e.errno == errno.ENOENT:
151
# might not exist on branches from <0.0.4
152
self.controlfile('branch-lock', 'w').close()
153
lockfile = os.open(self.controlfilename('branch-lock'), om)
154
else:
155
raise e
156
157
fcntl.lockf(lockfile, lm)
158
def unlock():
159
fcntl.lockf(lockfile, fcntl.LOCK_UN)
160
os.close(lockfile)
161
self._lockmode = None
162
self.unlock = unlock
163
self._lockmode = mode
164
except ImportError:
165
warning("please write a locking method for platform %r" % sys.platform)
166
def unlock():
167
self._lockmode = None
168
self.unlock = unlock
169
self._lockmode = mode
170
171
172
def _need_readlock(self):
173
if self._lockmode not in ['r', 'w']:
174
raise BzrError('need read lock on branch, only have %r' % self._lockmode)
175
176
def _need_writelock(self):
177
if self._lockmode not in ['w']:
178
raise BzrError('need write lock on branch, only have %r' % self._lockmode)
179
180
130
181
def abspath(self, name):
131
182
"""Return absolute filename for something in the branch"""
132
183
return os.path.join(self.base, name)
153
204
154
205
155
206
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)
207
"""Open a control file for this branch.
208
209
There are two classes of file in the control directory: text
210
and binary. binary files are untranslated byte streams. Text
211
control files are stored with Unix newlines and in UTF-8, even
212
if the platform or locale defaults are different.
213
214
Controlfiles should almost never be opened in write mode but
215
rather should be atomically copied and replaced using atomicfile.
216
"""
217
218
fn = self.controlfilename(file_or_path)
219
220
if mode == 'rb' or mode == 'wb':
221
return file(fn, mode)
222
elif mode == 'r' or mode == 'w':
223
# open in binary mode anyhow so there's no newline translation;
224
# codecs uses line buffering by default; don't want that.
225
import codecs
226
return codecs.open(fn, mode + 'b', 'utf-8',
227
buffering=60000)
228
else:
229
raise BzrError("invalid controlfile mode %r" % mode)
230
158
231
159
232
160
233
def _make_control(self):
166
239
for d in ('text-store', 'inventory-store', 'revision-store'):
167
240
os.mkdir(self.controlfilename(d))
168
241
for f in ('revision-history', 'merged-patches',
169
'pending-merged-patches', 'branch-name'):
242
'pending-merged-patches', 'branch-name',
243
'branch-lock'):
170
244
self.controlfile(f, 'w').write('')
171
245
mutter('created control directory in ' + self.base)
172
246
Inventory().write_xml(self.controlfile('inventory','w'))
179
253
180
254
In the future, we might need different in-memory Branch
181
255
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()
256
"""
257
# This ignores newlines so that we can open branches created
258
# on Windows from Linux and so on. I think it might be better
259
# to always make all internal files in unix format.
260
fmt = self.controlfile('branch-format', 'r').read()
261
fmt.replace('\r\n', '')
185
262
if fmt != BZR_BRANCH_FORMAT:
186
263
bailout('sorry, branch format %r not supported' % fmt,
187
264
['use a different bzr version',
190
267
191
268
def read_working_inventory(self):
192
269
"""Read the working inventory."""
270
self._need_readlock()
193
271
before = time.time()
194
inv = Inventory.read_xml(self.controlfile('inventory', 'r'))
272
# ElementTree does its own conversion from UTF-8, so open in
273
# binary.
274
inv = Inventory.read_xml(self.controlfile('inventory', 'rb'))
195
275
mutter("loaded inventory of %d items in %f"
196
276
% (len(inv), time.time() - before))
197
277
return inv
203
283
That is to say, the inventory describing changes underway, that
204
284
will be committed to the next revision.
205
285
"""
286
self._need_writelock()
206
287
## TODO: factor out to atomicfile? is rename safe on windows?
207
288
## TODO: Maybe some kind of clean/dirty marker on inventory?
208
289
tmpfname = self.controlfilename('inventory.tmp')
209
tmpf = file(tmpfname, 'w')
290
tmpf = file(tmpfname, 'wb')
210
291
inv.write_xml(tmpf)
211
292
tmpf.close()
212
os.rename(tmpfname, self.controlfilename('inventory'))
293
inv_fname = self.controlfilename('inventory')
294
if sys.platform == 'win32':
295
os.remove(inv_fname)
296
os.rename(tmpfname, inv_fname)
213
297
mutter('wrote working inventory')
214
298
215
299
217
301
"""Inventory for the working copy.""")
218
302
219
303
220
def add(self, files, verbose=False):
304
def add(self, files, verbose=False, ids=None):
221
305
"""Make files versioned.
222
306
307
Note that the command line normally calls smart_add instead.
308
223
309
This puts the files in the Added state, so that they will be
224
310
recorded by the next commit.
225
311
226
:todo: Perhaps have an option to add the ids even if the files do
312
TODO: Perhaps have an option to add the ids even if the files do
227
313
not (yet) exist.
228
314
229
:todo: Perhaps return the ids of the files? But then again it
315
TODO: Perhaps return the ids of the files? But then again it
230
316
is easy to retrieve them if they're needed.
231
317
232
:todo: Option to specify file id.
318
TODO: Option to specify file id.
233
319
234
:todo: Adding a directory should optionally recurse down and
320
TODO: Adding a directory should optionally recurse down and
235
321
add all non-ignored children. Perhaps do that in a
236
322
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', [])
259
323
"""
324
self._need_writelock()
260
325
261
326
# TODO: Re-adding a file that is removed in the working copy
262
327
# should probably put it back with the previous ID.
263
328
if isinstance(files, types.StringTypes):
329
assert(ids is None or isinstance(ids, types.StringTypes))
264
330
files = [files]
331
if ids is not None:
332
ids = [ids]
333
334
if ids is None:
335
ids = [None] * len(files)
336
else:
337
assert(len(ids) == len(files))
265
338
266
339
inv = self.read_working_inventory()
267
for f in files:
340
for f,file_id in zip(files, ids):
268
341
if is_control_file(f):
269
342
bailout("cannot add control file %s" % quotefn(f))
270
343
284
357
if kind != 'file' and kind != 'directory':
285
358
bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
286
359
287
file_id = gen_file_id(f)
360
if file_id is None:
361
file_id = gen_file_id(f)
288
362
inv.add_path(f, kind=kind, file_id=file_id)
289
363
290
364
if verbose:
295
369
self._write_inventory(inv)
296
370
297
371
372
def print_file(self, file, revno):
373
"""Print `file` to stdout."""
374
self._need_readlock()
375
tree = self.revision_tree(self.lookup_revision(revno))
376
# use inventory as it was in that revision
377
file_id = tree.inventory.path2id(file)
378
if not file_id:
379
bailout("%r is not present in revision %d" % (file, revno))
380
tree.print_file(file_id)
381
298
382
299
383
def remove(self, files, verbose=False):
300
384
"""Mark nominated files for removal from the inventory.
301
385
302
386
This does not remove their text. This does not run on
303
387
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
388
TODO: Refuse to remove modified files unless --force is given?
389
390
TODO: Do something useful with directories.
391
392
TODO: Should this remove the text or not? Tough call; not
331
393
removing may be useful and the user can just use use rm, and
332
394
is the opposite of add. Removing it is consistent with most
333
395
other tools. Maybe an option.
334
396
"""
335
397
## TODO: Normalize names
336
398
## TODO: Remove nested loops; better scalability
399
self._need_writelock()
337
400
338
401
if isinstance(files, types.StringTypes):
339
402
files = [files]
358
421
359
422
self._write_inventory(inv)
360
423
424
def set_inventory(self, new_inventory_list):
425
inv = Inventory()
426
for path, file_id, parent, kind in new_inventory_list:
427
name = os.path.basename(path)
428
if name == "":
429
continue
430
inv.add(InventoryEntry(file_id, name, kind, parent))
431
self._write_inventory(inv)
432
361
433
362
434
def unknowns(self):
363
435
"""Return all unknown files.
378
450
return self.working_tree().unknowns()
379
451
380
452
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!")
453
def append_revision(self, revision_id):
454
mutter("add {%s} to revision-history" % revision_id)
455
rev_history = self.revision_history()
456
457
tmprhname = self.controlfilename('revision-history.tmp')
458
rhname = self.controlfilename('revision-history')
459
460
f = file(tmprhname, 'wt')
461
rev_history.append(revision_id)
462
f.write('\n'.join(rev_history))
463
f.write('\n')
464
f.close()
465
466
if sys.platform == 'win32':
467
os.remove(rhname)
468
os.rename(tmprhname, rhname)
469
548
470
549
471
550
472
def get_revision(self, revision_id):
551
473
"""Return the Revision object for a named revision"""
474
self._need_readlock()
552
475
r = Revision.read_xml(self.revision_store[revision_id])
553
476
assert r.revision_id == revision_id
554
477
return r
557
480
def get_inventory(self, inventory_id):
558
481
"""Get Inventory object by hash.
559
482
560
:todo: Perhaps for this and similar methods, take a revision
483
TODO: Perhaps for this and similar methods, take a revision
561
484
parameter which can be either an integer revno or a
562
485
string hash."""
486
self._need_readlock()
563
487
i = Inventory.read_xml(self.inventory_store[inventory_id])
564
488
return i
565
489
566
490
567
491
def get_revision_inventory(self, revision_id):
568
492
"""Return inventory of a past revision."""
493
self._need_readlock()
569
494
if revision_id == None:
570
495
return Inventory()
571
496
else:
578
503
>>> ScratchBranch().revision_history()
579
504
[]
580
505
"""
581
return [chomp(l) for l in self.controlfile('revision-history').readlines()]
506
self._need_readlock()
507
return [l.rstrip('\r\n') for l in self.controlfile('revision-history', 'r').readlines()]
508
509
510
def enum_history(self, direction):
511
"""Return (revno, revision_id) for history of branch.
512
513
direction
514
'forward' is from earliest to latest
515
'reverse' is from latest to earliest
516
"""
517
rh = self.revision_history()
518
if direction == 'forward':
519
i = 1
520
for rid in rh:
521
yield i, rid
522
i += 1
523
elif direction == 'reverse':
524
i = len(rh)
525
while i > 0:
526
yield i, rh[i-1]
527
i -= 1
528
else:
529
raise ValueError('invalid history direction', direction)
582
530
583
531
584
532
def revno(self):
586
534
587
535
That is equivalent to the number of revisions committed to
588
536
this branch.
589
590
>>> b = ScratchBranch()
591
>>> b.revno()
592
0
593
>>> b.commit('no foo')
594
>>> b.revno()
595
1
596
537
"""
597
538
return len(self.revision_history())
598
539
599
540
600
541
def last_patch(self):
601
542
"""Return last patch hash, or None if no history.
602
603
>>> ScratchBranch().last_patch() == None
604
True
605
543
"""
606
544
ph = self.revision_history()
607
545
if ph:
608
546
return ph[-1]
609
547
else:
548
return None
549
550
551
def commit(self, *args, **kw):
552
"""Deprecated"""
553
from bzrlib.commit import commit
554
commit(self, *args, **kw)
555
610
556
611
557
def lookup_revision(self, revno):
612
558
"""Return revision hash for revision number."""
617
563
# list is 0-based; revisions are 1-based
618
564
return self.revision_history()[revno-1]
619
565
except IndexError:
620
bailout("no such revision %s" % revno)
566
raise BzrError("no such revision %s" % revno)
621
567
622
568
623
569
def revision_tree(self, revision_id):
625
571
626
572
`revision_id` may be None for the null revision, in which case
627
573
an `EmptyTree` is returned."""
628
574
# TODO: refactor this to use an existing revision object
575
# so we don't need to read it in twice.
576
self._need_readlock()
629
577
if revision_id == None:
630
578
return EmptyTree()
631
579
else:
635
583
636
584
def working_tree(self):
637
585
"""Return a `Tree` for the working copy."""
586
from workingtree import WorkingTree
638
587
return WorkingTree(self.base, self.read_working_inventory())
639
588
640
589
642
591
"""Return `Tree` object for last revision.
643
592
644
593
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
594
"""
656
595
r = self.last_patch()
657
596
if r == None:
661
600
662
601
663
602
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
603
def rename_one(self, from_rel, to_rel):
604
"""Rename one file.
605
606
This can change the directory or the filename or both.
607
"""
608
self._need_writelock()
609
tree = self.working_tree()
610
inv = tree.inventory
611
if not tree.has_filename(from_rel):
612
bailout("can't rename: old working file %r does not exist" % from_rel)
613
if tree.has_filename(to_rel):
614
bailout("can't rename: new working file %r already exists" % to_rel)
615
616
file_id = inv.path2id(from_rel)
617
if file_id == None:
618
bailout("can't rename: old name %r is not versioned" % from_rel)
619
620
if inv.path2id(to_rel):
621
bailout("can't rename: new name %r is already versioned" % to_rel)
622
623
to_dir, to_tail = os.path.split(to_rel)
624
to_dir_id = inv.path2id(to_dir)
625
if to_dir_id == None and to_dir != '':
626
bailout("can't determine destination directory id for %r" % to_dir)
627
628
mutter("rename_one:")
629
mutter(" file_id {%s}" % file_id)
630
mutter(" from_rel %r" % from_rel)
631
mutter(" to_rel %r" % to_rel)
632
mutter(" to_dir %r" % to_dir)
633
mutter(" to_dir_id {%s}" % to_dir_id)
634
635
inv.rename(file_id, to_dir_id, to_tail)
636
637
print "%s => %s" % (from_rel, to_rel)
713
638
714
715
:todo: Get state for single files.
716
717
:todo: Perhaps show a slash at the end of directory names.
718
639
from_abs = self.abspath(from_rel)
640
to_abs = self.abspath(to_rel)
641
try:
642
os.rename(from_abs, to_abs)
643
except OSError, e:
644
bailout("failed to rename %r to %r: %s"
645
% (from_abs, to_abs, e[1]),
646
["rename rolled back"])
647
648
self._write_inventory(inv)
649
650
651
652
def move(self, from_paths, to_name):
653
"""Rename files.
654
655
to_name must exist as a versioned directory.
656
657
If to_name exists and is a directory, the files are moved into
658
it, keeping their old names. If it is a directory,
659
660
Note that to_name is only the last component of the new name;
661
this doesn't change the directory.
719
662
"""
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
663
self._need_writelock()
664
## TODO: Option to move IDs only
665
assert not isinstance(from_paths, basestring)
666
tree = self.working_tree()
667
inv = tree.inventory
668
to_abs = self.abspath(to_name)
669
if not isdir(to_abs):
670
bailout("destination %r is not a directory" % to_abs)
671
if not tree.has_filename(to_name):
672
bailout("destination %r not in working directory" % to_abs)
673
to_dir_id = inv.path2id(to_name)
674
if to_dir_id == None and to_name != '':
675
bailout("destination %r is not a versioned directory" % to_name)
676
to_dir_ie = inv[to_dir_id]
677
if to_dir_ie.kind not in ('directory', 'root_directory'):
678
bailout("destination %r is not a directory" % to_abs)
679
680
to_idpath = inv.get_idpath(to_dir_id)
681
682
for f in from_paths:
683
if not tree.has_filename(f):
684
bailout("%r does not exist in working tree" % f)
685
f_id = inv.path2id(f)
686
if f_id == None:
687
bailout("%r is not versioned" % f)
688
name_tail = splitpath(f)[-1]
689
dest_path = appendpath(to_name, name_tail)
690
if tree.has_filename(dest_path):
691
bailout("destination %r already exists" % dest_path)
692
if f_id in to_idpath:
693
bailout("can't move %r to a subdirectory of itself" % f)
694
695
# OK, so there's a race here, it's possible that someone will
696
# create a file in this interval and then the rename might be
697
# left half-done. But we should have caught most problems.
698
699
for f in from_paths:
700
name_tail = splitpath(f)[-1]
701
dest_path = appendpath(to_name, name_tail)
702
print "%s => %s" % (f, dest_path)
703
inv.rename(inv.path2id(f), to_dir_id, name_tail)
704
try:
705
os.rename(self.abspath(f), self.abspath(dest_path))
706
except OSError, e:
707
bailout("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
708
["rename rolled back"])
709
710
self._write_inventory(inv)
711
712
754
713
755
714
756
715
class ScratchBranch(Branch):
760
719
>>> isdir(b.base)
761
720
True
762
721
>>> bd = b.base
763
>>> del b
722
>>> b.destroy()
764
723
>>> isdir(bd)
765
724
False
766
725
"""
767
def __init__(self, files = []):
726
def __init__(self, files=[], dirs=[]):
768
727
"""Make a test branch.
769
728
770
729
This creates a temporary directory and runs init-tree in it.
772
731
If any files are listed, they are created in the working copy.
773
732
"""
774
733
Branch.__init__(self, tempfile.mkdtemp(), init=True)
734
for d in dirs:
735
os.mkdir(self.abspath(d))
736
775
737
for f in files:
776
738
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
777
739
778
740
779
741
def __del__(self):
742
self.destroy()
743
744
def destroy(self):
780
745
"""Destroy the test branch, removing the scratch directory."""
781
shutil.rmtree(self.base)
746
try:
747
mutter("delete ScratchBranch %s" % self.base)
748
shutil.rmtree(self.base)
749
except OSError, e:
750
# Work around for shutil.rmtree failing on Windows when
751
# readonly files are encountered
752
mutter("hit exception in destroying ScratchBranch: %s" % e)
753
for root, dirs, files in os.walk(self.base, topdown=False):
754
for name in files:
755
os.chmod(os.path.join(root, name), 0700)
756
shutil.rmtree(self.base)
757
self.base = None
782
758
783
759
784
760
801
777
802
778
803
779
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
780
def gen_file_id(name):
812
781
"""Return new file id.
813
782
814
783
This should probably generate proper UUIDs, but for the moment we
815
784
cope with just randomness because running uuidgen every time is
816
785
slow."""
786
import re
787
788
# get last component
817
789
idx = name.rfind('/')
818
790
if idx != -1:
819
791
name = name[idx+1 : ]
792
idx = name.rfind('\\')
793
if idx != -1:
794
name = name[idx+1 : ]
820
795
796
# make it not a hidden file
821
797
name = name.lstrip('.')
822
798
799
# remove any wierd characters; we don't escape them but rather
800
# just pull them out
801
name = re.sub(r'[^\w.]', '', name)
802
823
803
s = hexlify(rand_bytes(8))
824
804
return '-'.join((name, compact_date(time.time()), s))
825
826
Loggerhead is a web-based interface for Breezy
Version: 2.0.1