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