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