« back to all changes in this revision
Viewing changes to bzrlib/branch.py
- browse files at revision 1040
- compare with another revision
- download diff
- download tarball
- view history from revision 1040
- Committer: Martin Pool
- Date: 2005-08-04 22:30:50 UTC
- Revision ID: mbp@sourcefrog.net-20050804223050-01256e5e26a90b1d
- merge patch to take ranges to diff -r option
- files added:
- bzrlib/mdiff.py
- plugins/changeset
- files removed:
- BRANCH.TODO
- bzrlib/export
- bzrlib/store
- bzrlib/tests/blackbox
- bzrlib/transport
- bzrlib/ui
- bzrlib/util
- bzrlib/util/configobj
- bzrlib/util/configobj/docs
- files renamed:
- bzr_man.py => bzr-man.py
- contrib/newinventory.py => bzrlib/newinventory.py
- bzrlib/tests/ => bzrlib/selftest/
- bzrlib/tests/blackbox/test_too_much.py => bzrlib/selftest/blackbox.py
- bzrlib/tests/test_plugins.py => bzrlib/selftest/plugins.py
- bzrlib/tests/test_branch.py => bzrlib/selftest/testbranch.py
- bzrlib/tests/test_diff.py => bzrlib/selftest/testdiff.py
- bzrlib/tests/test_hashcache.py => bzrlib/selftest/testhashcache.py
- bzrlib/tests/test_inv.py => bzrlib/selftest/testinv.py
- bzrlib/tests/test_log.py => bzrlib/selftest/testlog.py
- bzrlib/tests/test_merge3.py => bzrlib/selftest/testmerge3.py
- bzrlib/tests/test_revision.py => bzrlib/selftest/testrevision.py
- bzrlib/tests/test_revisionnamespaces.py => bzrlib/selftest/testrevisionnamespaces.py
- bzrlib/tests/test_status.py => bzrlib/selftest/teststatus.py
- bzrlib/tests/blackbox/test_versioning.py => bzrlib/selftest/versioning.py
- bzrlib/tests/test_whitebox.py => bzrlib/selftest/whitebox.py
- bzrlib/store/__init__.py => bzrlib/store.py
- bzrlib/util/effbot/ => effbot/
- bzrlib/util/elementtree/ => elementtree/
- bzrlib/plugins/ => plugins/
- bzrlib/tests/test_weave.py => tools/testweave.py
- bzrlib/util/urlgrabber/ => urlgrabber/
- files modified:
- .bzrignore
- bzr *
- setup.py *
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 shutil
19
18
import sys
20
19
import os
21
import errno
22
from warnings import warn
23
from cStringIO import StringIO
24
25
20
26
21
import bzrlib
27
22
from bzrlib.trace import mutter, note
28
from bzrlib.osutils import (isdir, quotefn,
29
rename, splitpath, sha_file,
30
file_kind, abspath, normpath, pathjoin)
31
import bzrlib.errors as errors
32
from bzrlib.errors import (BzrError, InvalidRevisionNumber, InvalidRevisionId,
33
NoSuchRevision, HistoryMissing, NotBranchError,
34
DivergedBranches, LockError, UnlistableStore,
35
UnlistableBranch, NoSuchFile, NotVersionedError,
36
NoWorkingTree)
23
from bzrlib.osutils import isdir, quotefn, compact_date, rand_bytes, \
24
splitpath, \
25
sha_file, appendpath, file_kind
26
from bzrlib.errors import BzrError, InvalidRevisionNumber, InvalidRevisionId
27
import bzrlib.errors
37
28
from bzrlib.textui import show_status
38
from bzrlib.config import TreeConfig
29
from bzrlib.revision import Revision
30
from bzrlib.xml import unpack_xml
39
31
from bzrlib.delta import compare_trees
40
import bzrlib.inventory as inventory
41
from bzrlib.inventory import Inventory
42
from bzrlib.lockable_files import LockableFiles
43
from bzrlib.revision import (Revision, is_ancestor, get_intervening_revisions)
44
from bzrlib.repository import Repository
45
from bzrlib.store import copy_all
46
import bzrlib.transactions as transactions
47
from bzrlib.transport import Transport, get_transport
48
32
from bzrlib.tree import EmptyTree, RevisionTree
49
import bzrlib.ui
50
import bzrlib.xml5
51
52
53
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
54
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
55
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
33
34
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
56
35
## TODO: Maybe include checks for common corruption of newlines, etc?
57
36
58
37
59
38
# TODO: Some operations like log might retrieve the same revisions
60
39
# repeatedly to calculate deltas. We could perhaps have a weakref
61
# cache in memory to make this faster. In general anything can be
62
# cached in memory between lock and unlock operations.
63
64
def find_branch(*ignored, **ignored_too):
65
# XXX: leave this here for about one release, then remove it
66
raise NotImplementedError('find_branch() is not supported anymore, '
67
'please use one of the new branch constructors')
68
69
70
def needs_read_lock(unbound):
71
"""Decorate unbound to take out and release a read lock."""
72
def decorated(self, *args, **kwargs):
73
self.lock_read()
74
try:
75
return unbound(self, *args, **kwargs)
76
finally:
77
self.unlock()
78
return decorated
79
80
81
def needs_write_lock(unbound):
82
"""Decorate unbound to take out and release a write lock."""
83
def decorated(self, *args, **kwargs):
84
self.lock_write()
85
try:
86
return unbound(self, *args, **kwargs)
87
finally:
88
self.unlock()
89
return decorated
40
# cache in memory to make this faster.
41
42
43
def find_branch(f, **args):
44
if f and (f.startswith('http://') or f.startswith('https://')):
45
import remotebranch
46
return remotebranch.RemoteBranch(f, **args)
47
else:
48
return Branch(f, **args)
49
50
51
def find_cached_branch(f, cache_root, **args):
52
from remotebranch import RemoteBranch
53
br = find_branch(f, **args)
54
def cacheify(br, store_name):
55
from meta_store import CachedStore
56
cache_path = os.path.join(cache_root, store_name)
57
os.mkdir(cache_path)
58
new_store = CachedStore(getattr(br, store_name), cache_path)
59
setattr(br, store_name, new_store)
60
61
if isinstance(br, RemoteBranch):
62
cacheify(br, 'inventory_store')
63
cacheify(br, 'text_store')
64
cacheify(br, 'revision_store')
65
return br
66
67
68
def _relpath(base, path):
69
"""Return path relative to base, or raise exception.
70
71
The path may be either an absolute path or a path relative to the
72
current working directory.
73
74
Lifted out of Branch.relpath for ease of testing.
75
76
os.path.commonprefix (python2.4) has a bad bug that it works just
77
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
78
avoids that problem."""
79
rp = os.path.abspath(path)
80
81
s = []
82
head = rp
83
while len(head) >= len(base):
84
if head == base:
85
break
86
head, tail = os.path.split(head)
87
if tail:
88
s.insert(0, tail)
89
else:
90
from errors import NotBranchError
91
raise NotBranchError("path %r is not within branch %r" % (rp, base))
92
93
return os.sep.join(s)
94
95
96
def find_branch_root(f=None):
97
"""Find the branch root enclosing f, or pwd.
98
99
f may be a filename or a URL.
100
101
It is not necessary that f exists.
102
103
Basically we keep looking up until we find the control directory or
104
run into the root."""
105
if f == None:
106
f = os.getcwd()
107
elif hasattr(os.path, 'realpath'):
108
f = os.path.realpath(f)
109
else:
110
f = os.path.abspath(f)
111
if not os.path.exists(f):
112
raise BzrError('%r does not exist' % f)
113
114
115
orig_f = f
116
117
while True:
118
if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
119
return f
120
head, tail = os.path.split(f)
121
if head == f:
122
# reached the root, whatever that may be
123
raise BzrError('%r is not in a branch' % orig_f)
124
f = head
125
126
class DivergedBranches(Exception):
127
def __init__(self, branch1, branch2):
128
self.branch1 = branch1
129
self.branch2 = branch2
130
Exception.__init__(self, "These branches have diverged.")
131
90
132
91
133
######################################################################
92
134
# branch objects
95
137
"""Branch holding a history of revisions.
96
138
97
139
base
98
Base directory/url of the branch.
140
Base directory of the branch.
141
142
_lock_mode
143
None, or 'r' or 'w'
144
145
_lock_count
146
If _lock_mode is true, a positive count of the number of times the
147
lock has been taken.
148
149
_lock
150
Lock object from bzrlib.lock.
99
151
"""
100
152
base = None
101
102
def __init__(self, *ignored, **ignored_too):
103
raise NotImplementedError('The Branch class is abstract')
104
105
@staticmethod
106
def open_downlevel(base):
107
"""Open a branch which may be of an old format.
108
109
Only local branches are supported."""
110
return BzrBranch(get_transport(base), relax_version_check=True)
111
112
@staticmethod
113
def open(base):
114
"""Open an existing branch, rooted at 'base' (url)"""
115
t = get_transport(base)
116
mutter("trying to open %r with transport %r", base, t)
117
return BzrBranch(t)
118
119
@staticmethod
120
def open_containing(url):
121
"""Open an existing branch which contains url.
122
123
This probes for a branch at url, and searches upwards from there.
124
125
Basically we keep looking up until we find the control directory or
126
run into the root. If there isn't one, raises NotBranchError.
127
If there is one, it is returned, along with the unused portion of url.
128
"""
129
t = get_transport(url)
130
while True:
131
try:
132
return BzrBranch(t), t.relpath(url)
133
except NotBranchError, e:
134
mutter('not a branch in: %r %s', t.base, e)
135
new_t = t.clone('..')
136
if new_t.base == t.base:
137
# reached the root, whatever that may be
138
raise NotBranchError(path=url)
139
t = new_t
140
141
@staticmethod
142
def initialize(base):
143
"""Create a new branch, rooted at 'base' (url)"""
144
t = get_transport(unicode(base))
145
return BzrBranch(t, init=True)
146
147
def setup_caching(self, cache_root):
148
"""Subclasses that care about caching should override this, and set
149
up cached stores located under cache_root.
150
"""
151
self.cache_root = cache_root
152
153
def _get_nick(self):
154
cfg = self.tree_config()
155
return cfg.get_option(u"nickname", default=self.base.split('/')[-1])
156
157
def _set_nick(self, nick):
158
cfg = self.tree_config()
159
cfg.set_option(nick, "nickname")
160
assert cfg.get_option("nickname") == nick
161
162
nick = property(_get_nick, _set_nick)
163
164
def push_stores(self, branch_to):
165
"""Copy the content of this branches store to branch_to."""
166
raise NotImplementedError('push_stores is abstract')
153
_lock_mode = None
154
_lock_count = None
155
_lock = None
156
157
# Map some sort of prefix into a namespace
158
# stuff like "revno:10", "revid:", etc.
159
# This should match a prefix with a function which accepts
160
REVISION_NAMESPACES = {}
161
162
def __init__(self, base, init=False, find_root=True):
163
"""Create new branch object at a particular location.
164
165
base -- Base directory for the branch.
166
167
init -- If True, create new control files in a previously
168
unversioned directory. If False, the branch must already
169
be versioned.
170
171
find_root -- If true and init is false, find the root of the
172
existing branch containing base.
173
174
In the test suite, creation of new trees is tested using the
175
`ScratchBranch` class.
176
"""
177
from bzrlib.store import ImmutableStore
178
if init:
179
self.base = os.path.realpath(base)
180
self._make_control()
181
elif find_root:
182
self.base = find_branch_root(base)
183
else:
184
self.base = os.path.realpath(base)
185
if not isdir(self.controlfilename('.')):
186
from errors import NotBranchError
187
raise NotBranchError("not a bzr branch: %s" % quotefn(base),
188
['use "bzr init" to initialize a new working tree',
189
'current bzr can only operate from top-of-tree'])
190
self._check_format()
191
192
self.text_store = ImmutableStore(self.controlfilename('text-store'))
193
self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
194
self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
195
196
197
def __str__(self):
198
return '%s(%r)' % (self.__class__.__name__, self.base)
199
200
201
__repr__ = __str__
202
203
204
def __del__(self):
205
if self._lock_mode or self._lock:
206
from warnings import warn
207
warn("branch %r was not explicitly unlocked" % self)
208
self._lock.unlock()
209
210
167
211
168
212
def lock_write(self):
169
raise NotImplementedError('lock_write is abstract')
170
213
if self._lock_mode:
214
if self._lock_mode != 'w':
215
from errors import LockError
216
raise LockError("can't upgrade to a write lock from %r" %
217
self._lock_mode)
218
self._lock_count += 1
219
else:
220
from bzrlib.lock import WriteLock
221
222
self._lock = WriteLock(self.controlfilename('branch-lock'))
223
self._lock_mode = 'w'
224
self._lock_count = 1
225
226
227
171
228
def lock_read(self):
172
raise NotImplementedError('lock_read is abstract')
173
229
if self._lock_mode:
230
assert self._lock_mode in ('r', 'w'), \
231
"invalid lock mode %r" % self._lock_mode
232
self._lock_count += 1
233
else:
234
from bzrlib.lock import ReadLock
235
236
self._lock = ReadLock(self.controlfilename('branch-lock'))
237
self._lock_mode = 'r'
238
self._lock_count = 1
239
240
241
174
242
def unlock(self):
175
raise NotImplementedError('unlock is abstract')
243
if not self._lock_mode:
244
from errors import LockError
245
raise LockError('branch %r is not locked' % (self))
246
247
if self._lock_count > 1:
248
self._lock_count -= 1
249
else:
250
self._lock.unlock()
251
self._lock = None
252
self._lock_mode = self._lock_count = None
253
176
254
177
255
def abspath(self, name):
178
"""Return absolute filename for something in the branch
256
"""Return absolute filename for something in the branch"""
257
return os.path.join(self.base, name)
258
259
260
def relpath(self, path):
261
"""Return path relative to this branch of something inside it.
262
263
Raises an error if path is not in this branch."""
264
return _relpath(self.base, path)
265
266
267
def controlfilename(self, file_or_path):
268
"""Return location relative to branch."""
269
if isinstance(file_or_path, basestring):
270
file_or_path = [file_or_path]
271
return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
272
273
274
def controlfile(self, file_or_path, mode='r'):
275
"""Open a control file for this branch.
276
277
There are two classes of file in the control directory: text
278
and binary. binary files are untranslated byte streams. Text
279
control files are stored with Unix newlines and in UTF-8, even
280
if the platform or locale defaults are different.
281
282
Controlfiles should almost never be opened in write mode but
283
rather should be atomically copied and replaced using atomicfile.
284
"""
285
286
fn = self.controlfilename(file_or_path)
287
288
if mode == 'rb' or mode == 'wb':
289
return file(fn, mode)
290
elif mode == 'r' or mode == 'w':
291
# open in binary mode anyhow so there's no newline translation;
292
# codecs uses line buffering by default; don't want that.
293
import codecs
294
return codecs.open(fn, mode + 'b', 'utf-8',
295
buffering=60000)
296
else:
297
raise BzrError("invalid controlfile mode %r" % mode)
298
299
300
301
def _make_control(self):
302
from bzrlib.inventory import Inventory
303
from bzrlib.xml import pack_xml
179
304
180
XXX: Robert Collins 20051017 what is this used for? why is it a branch
181
method and not a tree method.
305
os.mkdir(self.controlfilename([]))
306
self.controlfile('README', 'w').write(
307
"This is a Bazaar-NG control directory.\n"
308
"Do not change any files in this directory.\n")
309
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
310
for d in ('text-store', 'inventory-store', 'revision-store'):
311
os.mkdir(self.controlfilename(d))
312
for f in ('revision-history', 'merged-patches',
313
'pending-merged-patches', 'branch-name',
314
'branch-lock',
315
'pending-merges'):
316
self.controlfile(f, 'w').write('')
317
mutter('created control directory in ' + self.base)
318
319
# if we want per-tree root ids then this is the place to set
320
# them; they're not needed for now and so ommitted for
321
# simplicity.
322
pack_xml(Inventory(), self.controlfile('inventory','w'))
323
324
325
def _check_format(self):
326
"""Check this branch format is supported.
327
328
The current tool only supports the current unstable format.
329
330
In the future, we might need different in-memory Branch
331
classes to support downlevel branches. But not yet.
182
332
"""
183
raise NotImplementedError('abspath is abstract')
333
# This ignores newlines so that we can open branches created
334
# on Windows from Linux and so on. I think it might be better
335
# to always make all internal files in unix format.
336
fmt = self.controlfile('branch-format', 'r').read()
337
fmt.replace('\r\n', '')
338
if fmt != BZR_BRANCH_FORMAT:
339
raise BzrError('sorry, branch format %r not supported' % fmt,
340
['use a different bzr version',
341
'or remove the .bzr directory and "bzr init" again'])
184
342
185
343
def get_root_id(self):
186
344
"""Return the id of this branches root"""
187
raise NotImplementedError('get_root_id is abstract')
188
189
def print_file(self, file, revision_id):
345
inv = self.read_working_inventory()
346
return inv.root.file_id
347
348
def set_root_id(self, file_id):
349
inv = self.read_working_inventory()
350
orig_root_id = inv.root.file_id
351
del inv._byid[inv.root.file_id]
352
inv.root.file_id = file_id
353
inv._byid[inv.root.file_id] = inv.root
354
for fid in inv:
355
entry = inv[fid]
356
if entry.parent_id in (None, orig_root_id):
357
entry.parent_id = inv.root.file_id
358
self._write_inventory(inv)
359
360
def read_working_inventory(self):
361
"""Read the working inventory."""
362
from bzrlib.inventory import Inventory
363
from bzrlib.xml import unpack_xml
364
from time import time
365
before = time()
366
self.lock_read()
367
try:
368
# ElementTree does its own conversion from UTF-8, so open in
369
# binary.
370
inv = unpack_xml(Inventory,
371
self.controlfile('inventory', 'rb'))
372
mutter("loaded inventory of %d items in %f"
373
% (len(inv), time() - before))
374
return inv
375
finally:
376
self.unlock()
377
378
379
def _write_inventory(self, inv):
380
"""Update the working inventory.
381
382
That is to say, the inventory describing changes underway, that
383
will be committed to the next revision.
384
"""
385
from bzrlib.atomicfile import AtomicFile
386
from bzrlib.xml import pack_xml
387
388
self.lock_write()
389
try:
390
f = AtomicFile(self.controlfilename('inventory'), 'wb')
391
try:
392
pack_xml(inv, f)
393
f.commit()
394
finally:
395
f.close()
396
finally:
397
self.unlock()
398
399
mutter('wrote working inventory')
400
401
402
inventory = property(read_working_inventory, _write_inventory, None,
403
"""Inventory for the working copy.""")
404
405
406
def add(self, files, verbose=False, ids=None):
407
"""Make files versioned.
408
409
Note that the command line normally calls smart_add instead.
410
411
This puts the files in the Added state, so that they will be
412
recorded by the next commit.
413
414
files
415
List of paths to add, relative to the base of the tree.
416
417
ids
418
If set, use these instead of automatically generated ids.
419
Must be the same length as the list of files, but may
420
contain None for ids that are to be autogenerated.
421
422
TODO: Perhaps have an option to add the ids even if the files do
423
not (yet) exist.
424
425
TODO: Perhaps return the ids of the files? But then again it
426
is easy to retrieve them if they're needed.
427
428
TODO: Adding a directory should optionally recurse down and
429
add all non-ignored children. Perhaps do that in a
430
higher-level method.
431
"""
432
# TODO: Re-adding a file that is removed in the working copy
433
# should probably put it back with the previous ID.
434
if isinstance(files, basestring):
435
assert(ids is None or isinstance(ids, basestring))
436
files = [files]
437
if ids is not None:
438
ids = [ids]
439
440
if ids is None:
441
ids = [None] * len(files)
442
else:
443
assert(len(ids) == len(files))
444
445
self.lock_write()
446
try:
447
inv = self.read_working_inventory()
448
for f,file_id in zip(files, ids):
449
if is_control_file(f):
450
raise BzrError("cannot add control file %s" % quotefn(f))
451
452
fp = splitpath(f)
453
454
if len(fp) == 0:
455
raise BzrError("cannot add top-level %r" % f)
456
457
fullpath = os.path.normpath(self.abspath(f))
458
459
try:
460
kind = file_kind(fullpath)
461
except OSError:
462
# maybe something better?
463
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
464
465
if kind != 'file' and kind != 'directory':
466
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
467
468
if file_id is None:
469
file_id = gen_file_id(f)
470
inv.add_path(f, kind=kind, file_id=file_id)
471
472
if verbose:
473
print 'added', quotefn(f)
474
475
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
476
477
self._write_inventory(inv)
478
finally:
479
self.unlock()
480
481
482
def print_file(self, file, revno):
190
483
"""Print `file` to stdout."""
191
raise NotImplementedError('print_file is abstract')
484
self.lock_read()
485
try:
486
tree = self.revision_tree(self.lookup_revision(revno))
487
# use inventory as it was in that revision
488
file_id = tree.inventory.path2id(file)
489
if not file_id:
490
raise BzrError("%r is not present in revision %s" % (file, revno))
491
tree.print_file(file_id)
492
finally:
493
self.unlock()
494
495
496
def remove(self, files, verbose=False):
497
"""Mark nominated files for removal from the inventory.
498
499
This does not remove their text. This does not run on
500
501
TODO: Refuse to remove modified files unless --force is given?
502
503
TODO: Do something useful with directories.
504
505
TODO: Should this remove the text or not? Tough call; not
506
removing may be useful and the user can just use use rm, and
507
is the opposite of add. Removing it is consistent with most
508
other tools. Maybe an option.
509
"""
510
## TODO: Normalize names
511
## TODO: Remove nested loops; better scalability
512
if isinstance(files, basestring):
513
files = [files]
514
515
self.lock_write()
516
517
try:
518
tree = self.working_tree()
519
inv = tree.inventory
520
521
# do this before any modifications
522
for f in files:
523
fid = inv.path2id(f)
524
if not fid:
525
raise BzrError("cannot remove unversioned file %s" % quotefn(f))
526
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
527
if verbose:
528
# having remove it, it must be either ignored or unknown
529
if tree.is_ignored(f):
530
new_status = 'I'
531
else:
532
new_status = '?'
533
show_status(new_status, inv[fid].kind, quotefn(f))
534
del inv[fid]
535
536
self._write_inventory(inv)
537
finally:
538
self.unlock()
539
540
541
# FIXME: this doesn't need to be a branch method
542
def set_inventory(self, new_inventory_list):
543
from bzrlib.inventory import Inventory, InventoryEntry
544
inv = Inventory(self.get_root_id())
545
for path, file_id, parent, kind in new_inventory_list:
546
name = os.path.basename(path)
547
if name == "":
548
continue
549
inv.add(InventoryEntry(file_id, name, kind, parent))
550
self._write_inventory(inv)
551
552
553
def unknowns(self):
554
"""Return all unknown files.
555
556
These are files in the working directory that are not versioned or
557
control files or ignored.
558
559
>>> b = ScratchBranch(files=['foo', 'foo~'])
560
>>> list(b.unknowns())
561
['foo']
562
>>> b.add('foo')
563
>>> list(b.unknowns())
564
[]
565
>>> b.remove('foo')
566
>>> list(b.unknowns())
567
['foo']
568
"""
569
return self.working_tree().unknowns()
570
192
571
193
572
def append_revision(self, *revision_ids):
194
raise NotImplementedError('append_revision is abstract')
195
196
def set_revision_history(self, rev_history):
197
raise NotImplementedError('set_revision_history is abstract')
573
from bzrlib.atomicfile import AtomicFile
574
575
for revision_id in revision_ids:
576
mutter("add {%s} to revision-history" % revision_id)
577
578
rev_history = self.revision_history()
579
rev_history.extend(revision_ids)
580
581
f = AtomicFile(self.controlfilename('revision-history'))
582
try:
583
for rev_id in rev_history:
584
print >>f, rev_id
585
f.commit()
586
finally:
587
f.close()
588
589
590
def get_revision_xml(self, revision_id):
591
"""Return XML file object for revision object."""
592
if not revision_id or not isinstance(revision_id, basestring):
593
raise InvalidRevisionId(revision_id)
594
595
self.lock_read()
596
try:
597
try:
598
return self.revision_store[revision_id]
599
except IndexError:
600
raise bzrlib.errors.NoSuchRevision(revision_id)
601
finally:
602
self.unlock()
603
604
605
def get_revision(self, revision_id):
606
"""Return the Revision object for a named revision"""
607
xml_file = self.get_revision_xml(revision_id)
608
609
try:
610
r = unpack_xml(Revision, xml_file)
611
except SyntaxError, e:
612
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
613
[revision_id,
614
str(e)])
615
616
assert r.revision_id == revision_id
617
return r
618
619
620
def get_revision_delta(self, revno):
621
"""Return the delta for one revision.
622
623
The delta is relative to its mainline predecessor, or the
624
empty tree for revision 1.
625
"""
626
assert isinstance(revno, int)
627
rh = self.revision_history()
628
if not (1 <= revno <= len(rh)):
629
raise InvalidRevisionNumber(revno)
630
631
# revno is 1-based; list is 0-based
632
633
new_tree = self.revision_tree(rh[revno-1])
634
if revno == 1:
635
old_tree = EmptyTree()
636
else:
637
old_tree = self.revision_tree(rh[revno-2])
638
639
return compare_trees(old_tree, new_tree)
640
641
642
643
def get_revision_sha1(self, revision_id):
644
"""Hash the stored value of a revision, and return it."""
645
# In the future, revision entries will be signed. At that
646
# point, it is probably best *not* to include the signature
647
# in the revision hash. Because that lets you re-sign
648
# the revision, (add signatures/remove signatures) and still
649
# have all hash pointers stay consistent.
650
# But for now, just hash the contents.
651
return bzrlib.osutils.sha_file(self.get_revision_xml(revision_id))
652
653
654
def get_inventory(self, inventory_id):
655
"""Get Inventory object by hash.
656
657
TODO: Perhaps for this and similar methods, take a revision
658
parameter which can be either an integer revno or a
659
string hash."""
660
from bzrlib.inventory import Inventory
661
from bzrlib.xml import unpack_xml
662
663
return unpack_xml(Inventory, self.inventory_store[inventory_id])
664
665
666
def get_inventory_sha1(self, inventory_id):
667
"""Return the sha1 hash of the inventory entry
668
"""
669
return sha_file(self.inventory_store[inventory_id])
670
671
672
def get_revision_inventory(self, revision_id):
673
"""Return inventory of a past revision."""
674
# bzr 0.0.6 imposes the constraint that the inventory_id
675
# must be the same as its revision, so this is trivial.
676
if revision_id == None:
677
from bzrlib.inventory import Inventory
678
return Inventory(self.get_root_id())
679
else:
680
return self.get_inventory(revision_id)
681
198
682
199
683
def revision_history(self):
200
"""Return sequence of revision hashes on to this branch."""
201
raise NotImplementedError('revision_history is abstract')
684
"""Return sequence of revision hashes on to this branch.
685
686
>>> ScratchBranch().revision_history()
687
[]
688
"""
689
self.lock_read()
690
try:
691
return [l.rstrip('\r\n') for l in
692
self.controlfile('revision-history', 'r').readlines()]
693
finally:
694
self.unlock()
695
696
697
def common_ancestor(self, other, self_revno=None, other_revno=None):
698
"""
699
>>> import commit
700
>>> sb = ScratchBranch(files=['foo', 'foo~'])
701
>>> sb.common_ancestor(sb) == (None, None)
702
True
703
>>> commit.commit(sb, "Committing first revision", verbose=False)
704
>>> sb.common_ancestor(sb)[0]
705
1
706
>>> clone = sb.clone()
707
>>> commit.commit(sb, "Committing second revision", verbose=False)
708
>>> sb.common_ancestor(sb)[0]
709
2
710
>>> sb.common_ancestor(clone)[0]
711
1
712
>>> commit.commit(clone, "Committing divergent second revision",
713
... verbose=False)
714
>>> sb.common_ancestor(clone)[0]
715
1
716
>>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
717
True
718
>>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
719
True
720
>>> clone2 = sb.clone()
721
>>> sb.common_ancestor(clone2)[0]
722
2
723
>>> sb.common_ancestor(clone2, self_revno=1)[0]
724
1
725
>>> sb.common_ancestor(clone2, other_revno=1)[0]
726
1
727
"""
728
my_history = self.revision_history()
729
other_history = other.revision_history()
730
if self_revno is None:
731
self_revno = len(my_history)
732
if other_revno is None:
733
other_revno = len(other_history)
734
indices = range(min((self_revno, other_revno)))
735
indices.reverse()
736
for r in indices:
737
if my_history[r] == other_history[r]:
738
return r+1, my_history[r]
739
return None, None
740
202
741
203
742
def revno(self):
204
743
"""Return current revision number for this branch.
208
747
"""
209
748
return len(self.revision_history())
210
749
211
def last_revision(self):
212
"""Return last patch hash, or None if no history."""
750
751
def last_patch(self):
752
"""Return last patch hash, or None if no history.
753
"""
213
754
ph = self.revision_history()
214
755
if ph:
215
756
return ph[-1]
216
757
else:
217
758
return None
218
759
219
def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
220
"""Return a list of new revisions that would perfectly fit.
221
760
761
def missing_revisions(self, other, stop_revision=None):
762
"""
222
763
If self and other have not diverged, return a list of the revisions
223
764
present in other, but missing from self.
224
765
242
783
>>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
243
784
>>> br1.missing_revisions(br2)
244
785
Traceback (most recent call last):
245
DivergedBranches: These branches have diverged. Try merge.
786
DivergedBranches: These branches have diverged.
246
787
"""
247
788
self_history = self.revision_history()
248
789
self_len = len(self_history)
255
796
256
797
if stop_revision is None:
257
798
stop_revision = other_len
258
else:
259
assert isinstance(stop_revision, int)
260
if stop_revision > other_len:
261
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
799
elif stop_revision > other_len:
800
raise NoSuchRevision(self, stop_revision)
801
262
802
return other_history[self_len:stop_revision]
263
803
264
804
265
805
def update_revisions(self, other, stop_revision=None):
266
"""Pull in new perfect-fit revisions."""
267
raise NotImplementedError('update_revisions is abstract')
268
269
def pullable_revisions(self, other, stop_revision):
270
raise NotImplementedError('pullable_revisions is abstract')
271
272
def revision_id_to_revno(self, revision_id):
273
"""Given a revision id, return its revno"""
274
if revision_id is None:
275
return 0
276
history = self.revision_history()
277
try:
278
return history.index(revision_id) + 1
279
except ValueError:
280
raise bzrlib.errors.NoSuchRevision(self, revision_id)
281
282
def get_rev_id(self, revno, history=None):
283
"""Find the revision id of the specified revno."""
284
if revno == 0:
285
return None
286
if history is None:
287
history = self.revision_history()
288
elif revno <= 0 or revno > len(history):
289
raise bzrlib.errors.NoSuchRevision(self, revno)
290
return history[revno - 1]
806
"""Pull in all new revisions from other branch.
807
808
>>> from bzrlib.commit import commit
809
>>> bzrlib.trace.silent = True
810
>>> br1 = ScratchBranch(files=['foo', 'bar'])
811
>>> br1.add('foo')
812
>>> br1.add('bar')
813
>>> commit(br1, "lala!", rev_id="REVISION-ID-1", verbose=False)
814
>>> br2 = ScratchBranch()
815
>>> br2.update_revisions(br1)
816
Added 2 texts.
817
Added 1 inventories.
818
Added 1 revisions.
819
>>> br2.revision_history()
820
[u'REVISION-ID-1']
821
>>> br2.update_revisions(br1)
822
Added 0 texts.
823
Added 0 inventories.
824
Added 0 revisions.
825
>>> br1.text_store.total_size() == br2.text_store.total_size()
826
True
827
"""
828
from bzrlib.progress import ProgressBar
829
830
pb = ProgressBar()
831
832
pb.update('comparing histories')
833
revision_ids = self.missing_revisions(other, stop_revision)
834
835
if hasattr(other.revision_store, "prefetch"):
836
other.revision_store.prefetch(revision_ids)
837
if hasattr(other.inventory_store, "prefetch"):
838
inventory_ids = [other.get_revision(r).inventory_id
839
for r in revision_ids]
840
other.inventory_store.prefetch(inventory_ids)
841
842
revisions = []
843
needed_texts = set()
844
i = 0
845
for rev_id in revision_ids:
846
i += 1
847
pb.update('fetching revision', i, len(revision_ids))
848
rev = other.get_revision(rev_id)
849
revisions.append(rev)
850
inv = other.get_inventory(str(rev.inventory_id))
851
for key, entry in inv.iter_entries():
852
if entry.text_id is None:
853
continue
854
if entry.text_id not in self.text_store:
855
needed_texts.add(entry.text_id)
856
857
pb.clear()
858
859
count = self.text_store.copy_multi(other.text_store, needed_texts)
860
print "Added %d texts." % count
861
inventory_ids = [ f.inventory_id for f in revisions ]
862
count = self.inventory_store.copy_multi(other.inventory_store,
863
inventory_ids)
864
print "Added %d inventories." % count
865
revision_ids = [ f.revision_id for f in revisions]
866
count = self.revision_store.copy_multi(other.revision_store,
867
revision_ids)
868
for revision_id in revision_ids:
869
self.append_revision(revision_id)
870
print "Added %d revisions." % count
871
872
873
def commit(self, *args, **kw):
874
from bzrlib.commit import commit
875
commit(self, *args, **kw)
876
877
878
def lookup_revision(self, revision):
879
"""Return the revision identifier for a given revision information."""
880
revno, info = self.get_revision_info(revision)
881
return info
882
883
def get_revision_info(self, revision):
884
"""Return (revno, revision id) for revision identifier.
885
886
revision can be an integer, in which case it is assumed to be revno (though
887
this will translate negative values into positive ones)
888
revision can also be a string, in which case it is parsed for something like
889
'date:' or 'revid:' etc.
890
"""
891
if revision is None:
892
return 0, None
893
revno = None
894
try:# Convert to int if possible
895
revision = int(revision)
896
except ValueError:
897
pass
898
revs = self.revision_history()
899
if isinstance(revision, int):
900
if revision == 0:
901
return 0, None
902
# Mabye we should do this first, but we don't need it if revision == 0
903
if revision < 0:
904
revno = len(revs) + revision + 1
905
else:
906
revno = revision
907
elif isinstance(revision, basestring):
908
for prefix, func in Branch.REVISION_NAMESPACES.iteritems():
909
if revision.startswith(prefix):
910
revno = func(self, revs, revision)
911
break
912
else:
913
raise BzrError('No namespace registered for string: %r' % revision)
914
915
if revno is None or revno <= 0 or revno > len(revs):
916
raise BzrError("no such revision %s" % revision)
917
return revno, revs[revno-1]
918
919
def _namespace_revno(self, revs, revision):
920
"""Lookup a revision by revision number"""
921
assert revision.startswith('revno:')
922
try:
923
return int(revision[6:])
924
except ValueError:
925
return None
926
REVISION_NAMESPACES['revno:'] = _namespace_revno
927
928
def _namespace_revid(self, revs, revision):
929
assert revision.startswith('revid:')
930
try:
931
return revs.index(revision[6:]) + 1
932
except ValueError:
933
return None
934
REVISION_NAMESPACES['revid:'] = _namespace_revid
935
936
def _namespace_last(self, revs, revision):
937
assert revision.startswith('last:')
938
try:
939
offset = int(revision[5:])
940
except ValueError:
941
return None
942
else:
943
if offset <= 0:
944
raise BzrError('You must supply a positive value for --revision last:XXX')
945
return len(revs) - offset + 1
946
REVISION_NAMESPACES['last:'] = _namespace_last
947
948
def _namespace_tag(self, revs, revision):
949
assert revision.startswith('tag:')
950
raise BzrError('tag: namespace registered, but not implemented.')
951
REVISION_NAMESPACES['tag:'] = _namespace_tag
952
953
def _namespace_date(self, revs, revision):
954
assert revision.startswith('date:')
955
import datetime
956
# Spec for date revisions:
957
# date:value
958
# value can be 'yesterday', 'today', 'tomorrow' or a YYYY-MM-DD string.
959
# it can also start with a '+/-/='. '+' says match the first
960
# entry after the given date. '-' is match the first entry before the date
961
# '=' is match the first entry after, but still on the given date.
962
#
963
# +2005-05-12 says find the first matching entry after May 12th, 2005 at 0:00
964
# -2005-05-12 says find the first matching entry before May 12th, 2005 at 0:00
965
# =2005-05-12 says find the first match after May 12th, 2005 at 0:00 but before
966
# May 13th, 2005 at 0:00
967
#
968
# So the proper way of saying 'give me all entries for today' is:
969
# -r {date:+today}:{date:-tomorrow}
970
# The default is '=' when not supplied
971
val = revision[5:]
972
match_style = '='
973
if val[:1] in ('+', '-', '='):
974
match_style = val[:1]
975
val = val[1:]
976
977
today = datetime.datetime.today().replace(hour=0,minute=0,second=0,microsecond=0)
978
if val.lower() == 'yesterday':
979
dt = today - datetime.timedelta(days=1)
980
elif val.lower() == 'today':
981
dt = today
982
elif val.lower() == 'tomorrow':
983
dt = today + datetime.timedelta(days=1)
984
else:
985
import re
986
# This should be done outside the function to avoid recompiling it.
987
_date_re = re.compile(
988
r'(?P<date>(?P<year>\d\d\d\d)-(?P<month>\d\d)-(?P<day>\d\d))?'
989
r'(,|T)?\s*'
990
r'(?P<time>(?P<hour>\d\d):(?P<minute>\d\d)(:(?P<second>\d\d))?)?'
991
)
992
m = _date_re.match(val)
993
if not m or (not m.group('date') and not m.group('time')):
994
raise BzrError('Invalid revision date %r' % revision)
995
996
if m.group('date'):
997
year, month, day = int(m.group('year')), int(m.group('month')), int(m.group('day'))
998
else:
999
year, month, day = today.year, today.month, today.day
1000
if m.group('time'):
1001
hour = int(m.group('hour'))
1002
minute = int(m.group('minute'))
1003
if m.group('second'):
1004
second = int(m.group('second'))
1005
else:
1006
second = 0
1007
else:
1008
hour, minute, second = 0,0,0
1009
1010
dt = datetime.datetime(year=year, month=month, day=day,
1011
hour=hour, minute=minute, second=second)
1012
first = dt
1013
last = None
1014
reversed = False
1015
if match_style == '-':
1016
reversed = True
1017
elif match_style == '=':
1018
last = dt + datetime.timedelta(days=1)
1019
1020
if reversed:
1021
for i in range(len(revs)-1, -1, -1):
1022
r = self.get_revision(revs[i])
1023
# TODO: Handle timezone.
1024
dt = datetime.datetime.fromtimestamp(r.timestamp)
1025
if first >= dt and (last is None or dt >= last):
1026
return i+1
1027
else:
1028
for i in range(len(revs)):
1029
r = self.get_revision(revs[i])
1030
# TODO: Handle timezone.
1031
dt = datetime.datetime.fromtimestamp(r.timestamp)
1032
if first <= dt and (last is None or dt <= last):
1033
return i+1
1034
REVISION_NAMESPACES['date:'] = _namespace_date
1035
1036
def revision_tree(self, revision_id):
1037
"""Return Tree for a revision on this branch.
1038
1039
`revision_id` may be None for the null revision, in which case
1040
an `EmptyTree` is returned."""
1041
# TODO: refactor this to use an existing revision object
1042
# so we don't need to read it in twice.
1043
if revision_id == None:
1044
return EmptyTree()
1045
else:
1046
inv = self.get_revision_inventory(revision_id)
1047
return RevisionTree(self.text_store, inv)
1048
291
1049
292
1050
def working_tree(self):
293
"""Return a `Tree` for the working copy if this is a local branch."""
294
raise NotImplementedError('working_tree is abstract')
1051
"""Return a `Tree` for the working copy."""
1052
from workingtree import WorkingTree
1053
return WorkingTree(self.base, self.read_working_inventory())
295
1054
296
def pull(self, source, overwrite=False):
297
raise NotImplementedError('pull is abstract')
298
1055
299
1056
def basis_tree(self):
300
1057
"""Return `Tree` object for last revision.
301
1058
302
1059
If there are no revisions yet, return an `EmptyTree`.
303
1060
"""
304
return self.repository.revision_tree(self.last_revision())
1061
r = self.last_patch()
1062
if r == None:
1063
return EmptyTree()
1064
else:
1065
return RevisionTree(self.text_store, self.get_revision_inventory(r))
1066
1067
305
1068
306
1069
def rename_one(self, from_rel, to_rel):
307
1070
"""Rename one file.
308
1071
309
1072
This can change the directory or the filename or both.
310
1073
"""
311
raise NotImplementedError('rename_one is abstract')
1074
self.lock_write()
1075
try:
1076
tree = self.working_tree()
1077
inv = tree.inventory
1078
if not tree.has_filename(from_rel):
1079
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1080
if tree.has_filename(to_rel):
1081
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1082
1083
file_id = inv.path2id(from_rel)
1084
if file_id == None:
1085
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1086
1087
if inv.path2id(to_rel):
1088
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1089
1090
to_dir, to_tail = os.path.split(to_rel)
1091
to_dir_id = inv.path2id(to_dir)
1092
if to_dir_id == None and to_dir != '':
1093
raise BzrError("can't determine destination directory id for %r" % to_dir)
1094
1095
mutter("rename_one:")
1096
mutter(" file_id {%s}" % file_id)
1097
mutter(" from_rel %r" % from_rel)
1098
mutter(" to_rel %r" % to_rel)
1099
mutter(" to_dir %r" % to_dir)
1100
mutter(" to_dir_id {%s}" % to_dir_id)
1101
1102
inv.rename(file_id, to_dir_id, to_tail)
1103
1104
print "%s => %s" % (from_rel, to_rel)
1105
1106
from_abs = self.abspath(from_rel)
1107
to_abs = self.abspath(to_rel)
1108
try:
1109
os.rename(from_abs, to_abs)
1110
except OSError, e:
1111
raise BzrError("failed to rename %r to %r: %s"
1112
% (from_abs, to_abs, e[1]),
1113
["rename rolled back"])
1114
1115
self._write_inventory(inv)
1116
finally:
1117
self.unlock()
1118
312
1119
313
1120
def move(self, from_paths, to_name):
314
1121
"""Rename files.
320
1127
321
1128
Note that to_name is only the last component of the new name;
322
1129
this doesn't change the directory.
323
324
This returns a list of (from_path, to_path) pairs for each
325
entry that is moved.
326
"""
327
raise NotImplementedError('move is abstract')
328
329
def get_parent(self):
330
"""Return the parent location of the branch.
331
332
This is the default location for push/pull/missing. The usual
333
pattern is that the user can override it by specifying a
334
location.
335
"""
336
raise NotImplementedError('get_parent is abstract')
337
338
def get_push_location(self):
339
"""Return the None or the location to push this branch to."""
340
raise NotImplementedError('get_push_location is abstract')
341
342
def set_push_location(self, location):
343
"""Set a new push location for this branch."""
344
raise NotImplementedError('set_push_location is abstract')
345
346
def set_parent(self, url):
347
raise NotImplementedError('set_parent is abstract')
348
349
def check_revno(self, revno):
350
"""\
351
Check whether a revno corresponds to any revision.
352
Zero (the NULL revision) is considered valid.
353
"""
354
if revno != 0:
355
self.check_real_revno(revno)
356
357
def check_real_revno(self, revno):
358
"""\
359
Check whether a revno corresponds to a real revision.
360
Zero (the NULL revision) is considered invalid
361
"""
362
if revno < 1 or revno > self.revno():
363
raise InvalidRevisionNumber(revno)
364
365
def sign_revision(self, revision_id, gpg_strategy):
366
raise NotImplementedError('sign_revision is abstract')
367
368
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
369
raise NotImplementedError('store_revision_signature is abstract')
370
371
def clone(self, to_location, revision=None, basis_branch=None, to_branch_type=None):
372
"""Copy this branch into the existing directory to_location.
373
374
Returns the newly created branch object.
375
376
revision
377
If not None, only revisions up to this point will be copied.
378
The head of the new branch will be that revision. Must be a
379
revid or None.
380
381
to_location -- The destination directory; must either exist and be
382
empty, or not exist, in which case it is created.
383
384
basis_branch
385
A local branch to copy revisions from, related to this branch.
386
This is used when branching from a remote (slow) branch, and we have
387
a local branch that might contain some relevant revisions.
388
389
to_branch_type
390
Branch type of destination branch
391
"""
392
assert isinstance(to_location, basestring)
393
if not bzrlib.osutils.lexists(to_location):
394
os.mkdir(to_location)
395
if to_branch_type is None:
396
to_branch_type = BzrBranch
397
br_to = to_branch_type.initialize(to_location)
398
mutter("copy branch from %s to %s", self, br_to)
399
if basis_branch is not None:
400
basis_branch.push_stores(br_to)
401
br_to.working_tree().set_root_id(self.get_root_id())
402
if revision is None:
403
revision = self.last_revision()
404
br_to.update_revisions(self, stop_revision=revision)
405
br_to.set_parent(self.base)
406
# circular import protection
407
from bzrlib.merge import build_working_dir
408
build_working_dir(to_location)
409
mutter("copied")
410
return br_to
411
412
class BzrBranch(Branch):
413
"""A branch stored in the actual filesystem.
414
415
Note that it's "local" in the context of the filesystem; it doesn't
416
really matter if it's on an nfs/smb/afs/coda/... share, as long as
417
it's writable, and can be accessed via the normal filesystem API.
418
419
"""
420
# We actually expect this class to be somewhat short-lived; part of its
421
# purpose is to try to isolate what bits of the branch logic are tied to
422
# filesystem access, so that in a later step, we can extricate them to
423
# a separarte ("storage") class.
424
_inventory_weave = None
425
426
# Map some sort of prefix into a namespace
427
# stuff like "revno:10", "revid:", etc.
428
# This should match a prefix with a function which accepts
429
REVISION_NAMESPACES = {}
430
431
def push_stores(self, branch_to):
432
"""See Branch.push_stores."""
433
if (self._branch_format != branch_to._branch_format
434
or self._branch_format != 4):
435
from bzrlib.fetch import greedy_fetch
436
mutter("falling back to fetch logic to push between %s(%s) and %s(%s)",
437
self, self._branch_format, branch_to, branch_to._branch_format)
438
greedy_fetch(to_branch=branch_to, from_branch=self,
439
revision=self.last_revision())
440
return
441
442
store_pairs = ((self.text_store, branch_to.text_store),
443
(self.inventory_store, branch_to.inventory_store),
444
(self.revision_store, branch_to.revision_store))
445
try:
446
for from_store, to_store in store_pairs:
447
copy_all(from_store, to_store)
448
except UnlistableStore:
449
raise UnlistableBranch(from_store)
450
451
def __init__(self, transport, init=False,
452
relax_version_check=False):
453
"""Create new branch object at a particular location.
454
455
transport -- A Transport object, defining how to access files.
456
457
init -- If True, create new control files in a previously
458
unversioned directory. If False, the branch must already
459
be versioned.
460
461
relax_version_check -- If true, the usual check for the branch
462
version is not applied. This is intended only for
463
upgrade/recovery type use; it's not guaranteed that
464
all operations will work on old format branches.
465
466
In the test suite, creation of new trees is tested using the
467
`ScratchBranch` class.
468
"""
469
assert isinstance(transport, Transport), \
470
"%r is not a Transport" % transport
471
# TODO: jam 20060103 We create a clone of this transport at .bzr/
472
# and then we forget about it, should we keep a handle to it?
473
self._base = transport.base
474
self.control_files = LockableFiles(transport.clone(bzrlib.BZRDIR),
475
'branch-lock')
476
if init:
477
self._make_control()
478
self._check_format(relax_version_check)
479
self.repository = Repository(transport, self._branch_format)
480
481
def __str__(self):
482
return '%s(%r)' % (self.__class__.__name__, self.base)
483
484
__repr__ = __str__
485
486
def __del__(self):
487
# TODO: It might be best to do this somewhere else,
488
# but it is nice for a Branch object to automatically
489
# cache it's information.
490
# Alternatively, we could have the Transport objects cache requests
491
# See the earlier discussion about how major objects (like Branch)
492
# should never expect their __del__ function to run.
493
if hasattr(self, 'cache_root') and self.cache_root is not None:
494
try:
495
shutil.rmtree(self.cache_root)
496
except:
497
pass
498
self.cache_root = None
499
500
def _get_base(self):
501
return self._base
502
503
base = property(_get_base, doc="The URL for the root of this branch.")
504
505
def _finish_transaction(self):
506
"""Exit the current transaction."""
507
return self.control_files._finish_transaction()
508
509
def get_transaction(self):
510
"""Return the current active transaction.
511
512
If no transaction is active, this returns a passthrough object
513
for which all data is immediately flushed and no caching happens.
514
"""
515
# this is an explicit function so that we can do tricky stuff
516
# when the storage in rev_storage is elsewhere.
517
# we probably need to hook the two 'lock a location' and
518
# 'have a transaction' together more delicately, so that
519
# we can have two locks (branch and storage) and one transaction
520
# ... and finishing the transaction unlocks both, but unlocking
521
# does not. - RBC 20051121
522
return self.control_files.get_transaction()
523
524
def _set_transaction(self, transaction):
525
"""Set a new active transaction."""
526
return self.control_files._set_transaction(transaction)
527
528
def abspath(self, name):
529
"""See Branch.abspath."""
530
return self.control_files._transport.abspath(name)
531
532
def _make_control(self):
533
from bzrlib.inventory import Inventory
534
from bzrlib.weavefile import write_weave_v5
535
from bzrlib.weave import Weave
536
537
# Create an empty inventory
538
sio = StringIO()
539
# if we want per-tree root ids then this is the place to set
540
# them; they're not needed for now and so ommitted for
541
# simplicity.
542
bzrlib.xml5.serializer_v5.write_inventory(Inventory(), sio)
543
empty_inv = sio.getvalue()
544
sio = StringIO()
545
bzrlib.weavefile.write_weave_v5(Weave(), sio)
546
empty_weave = sio.getvalue()
547
548
dirs = ['', 'revision-store', 'weaves']
549
files = [('README',
550
"This is a Bazaar-NG control directory.\n"
551
"Do not change any files in this directory.\n"),
552
('branch-format', BZR_BRANCH_FORMAT_6),
553
('revision-history', ''),
554
('branch-name', ''),
555
('branch-lock', ''),
556
('pending-merges', ''),
557
('inventory', empty_inv),
558
('inventory.weave', empty_weave),
559
('ancestry.weave', empty_weave)
560
]
561
cfe = self.control_files._escape
562
self.control_files._transport.mkdir_multi([cfe(d) for d in dirs],
563
mode=self.control_files._dir_mode)
564
self.control_files.lock_write()
565
try:
566
for file, content in files:
567
self.control_files.put_utf8(file, content)
568
mutter('created control directory in ' + self.base)
569
finally:
570
self.control_files.unlock()
571
572
def _check_format(self, relax_version_check):
573
"""Check this branch format is supported.
574
575
The format level is stored, as an integer, in
576
self._branch_format for code that needs to check it later.
577
578
In the future, we might need different in-memory Branch
579
classes to support downlevel branches. But not yet.
580
"""
581
try:
582
fmt = self.control_files.controlfile('branch-format', 'r').read()
583
except NoSuchFile:
584
raise NotBranchError(path=self.base)
585
mutter("got branch format %r", fmt)
586
if fmt == BZR_BRANCH_FORMAT_6:
587
self._branch_format = 6
588
elif fmt == BZR_BRANCH_FORMAT_5:
589
self._branch_format = 5
590
elif fmt == BZR_BRANCH_FORMAT_4:
591
self._branch_format = 4
592
593
if (not relax_version_check
594
and self._branch_format not in (5, 6)):
595
raise errors.UnsupportedFormatError(
596
'sorry, branch format %r not supported' % fmt,
597
['use a different bzr version',
598
'or remove the .bzr directory'
599
' and "bzr init" again'])
600
601
@needs_read_lock
602
def get_root_id(self):
603
"""See Branch.get_root_id."""
604
inv = self.repository.get_inventory(self.last_revision())
605
return inv.root.file_id
606
607
def lock_write(self):
608
# TODO: test for failed two phase locks. This is known broken.
609
self.control_files.lock_write()
610
self.repository.lock_write()
611
612
def lock_read(self):
613
# TODO: test for failed two phase locks. This is known broken.
614
self.control_files.lock_read()
615
self.repository.lock_read()
616
617
def unlock(self):
618
# TODO: test for failed two phase locks. This is known broken.
619
self.repository.unlock()
620
self.control_files.unlock()
621
622
@needs_read_lock
623
def print_file(self, file, revision_id):
624
"""See Branch.print_file."""
625
return self.repository.print_file(file, revision_id)
626
627
@needs_write_lock
628
def append_revision(self, *revision_ids):
629
"""See Branch.append_revision."""
630
for revision_id in revision_ids:
631
mutter("add {%s} to revision-history" % revision_id)
632
rev_history = self.revision_history()
633
rev_history.extend(revision_ids)
634
self.set_revision_history(rev_history)
635
636
@needs_write_lock
637
def set_revision_history(self, rev_history):
638
"""See Branch.set_revision_history."""
639
old_revision = self.last_revision()
640
new_revision = rev_history[-1]
641
self.control_files.put_utf8(
642
'revision-history', '\n'.join(rev_history))
643
try:
644
# FIXME: RBC 20051207 this smells wrong, last_revision in the
645
# working tree may be != to last_revision in the branch - so
646
# why is this passing in the branches last_revision ?
647
self.working_tree().set_last_revision(new_revision, old_revision)
648
except NoWorkingTree:
649
mutter('Unable to set_last_revision without a working tree.')
650
651
def get_revision_delta(self, revno):
652
"""Return the delta for one revision.
653
654
The delta is relative to its mainline predecessor, or the
655
empty tree for revision 1.
656
"""
657
assert isinstance(revno, int)
658
rh = self.revision_history()
659
if not (1 <= revno <= len(rh)):
660
raise InvalidRevisionNumber(revno)
661
662
# revno is 1-based; list is 0-based
663
664
new_tree = self.repository.revision_tree(rh[revno-1])
665
if revno == 1:
666
old_tree = EmptyTree()
667
else:
668
old_tree = self.repository.revision_tree(rh[revno-2])
669
return compare_trees(old_tree, new_tree)
670
671
@needs_read_lock
672
def revision_history(self):
673
"""See Branch.revision_history."""
674
# FIXME are transactions bound to control files ? RBC 20051121
675
transaction = self.get_transaction()
676
history = transaction.map.find_revision_history()
677
if history is not None:
678
mutter("cache hit for revision-history in %s", self)
679
return list(history)
680
history = [l.rstrip('\r\n') for l in
681
self.control_files.controlfile('revision-history', 'r').readlines()]
682
transaction.map.add_revision_history(history)
683
# this call is disabled because revision_history is
684
# not really an object yet, and the transaction is for objects.
685
# transaction.register_clean(history, precious=True)
686
return list(history)
687
688
def update_revisions(self, other, stop_revision=None):
689
"""See Branch.update_revisions."""
690
from bzrlib.fetch import greedy_fetch
691
if stop_revision is None:
692
stop_revision = other.last_revision()
693
### Should this be checking is_ancestor instead of revision_history?
694
if (stop_revision is not None and
695
stop_revision in self.revision_history()):
696
return
697
greedy_fetch(to_branch=self, from_branch=other,
698
revision=stop_revision)
699
pullable_revs = self.pullable_revisions(other, stop_revision)
700
if len(pullable_revs) > 0:
701
self.append_revision(*pullable_revs)
702
703
def pullable_revisions(self, other, stop_revision):
704
"""See Branch.pullable_revisions."""
705
other_revno = other.revision_id_to_revno(stop_revision)
706
try:
707
return self.missing_revisions(other, other_revno)
708
except DivergedBranches, e:
709
try:
710
pullable_revs = get_intervening_revisions(self.last_revision(),
711
stop_revision,
712
self.repository)
713
assert self.last_revision() not in pullable_revs
714
return pullable_revs
715
except bzrlib.errors.NotAncestor:
716
if is_ancestor(self.last_revision(), stop_revision, self):
717
return []
718
else:
719
raise e
720
721
def basis_tree(self):
722
"""See Branch.basis_tree."""
723
try:
724
revision_id = self.revision_history()[-1]
725
# FIXME: This is an abstraction violation, the basis tree
726
# here as defined is on the working tree, the method should
727
# be too. The basis tree for a branch can be different than
728
# that for a working tree. RBC 20051207
729
xml = self.working_tree().read_basis_inventory(revision_id)
730
inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
731
return RevisionTree(self.repository, inv, revision_id)
732
except (IndexError, NoSuchFile, NoWorkingTree), e:
733
return self.repository.revision_tree(self.last_revision())
734
735
def working_tree(self):
736
"""See Branch.working_tree."""
737
from bzrlib.workingtree import WorkingTree
738
if self.base.find('://') != -1:
739
raise NoWorkingTree(self.base)
740
return WorkingTree(self.base, branch=self)
741
742
@needs_write_lock
743
def pull(self, source, overwrite=False):
744
"""See Branch.pull."""
745
source.lock_read()
746
try:
747
old_count = len(self.revision_history())
748
try:
749
self.update_revisions(source)
750
except DivergedBranches:
751
if not overwrite:
752
raise
753
if overwrite:
754
self.set_revision_history(source.revision_history())
755
new_count = len(self.revision_history())
756
return new_count - old_count
757
finally:
758
source.unlock()
759
760
def get_parent(self):
761
"""See Branch.get_parent."""
762
import errno
763
_locs = ['parent', 'pull', 'x-pull']
764
for l in _locs:
765
try:
766
return self.control_files.controlfile(l, 'r').read().strip('\n')
767
except NoSuchFile:
768
pass
769
return None
770
771
def get_push_location(self):
772
"""See Branch.get_push_location."""
773
config = bzrlib.config.BranchConfig(self)
774
push_loc = config.get_user_option('push_location')
775
return push_loc
776
777
def set_push_location(self, location):
778
"""See Branch.set_push_location."""
779
config = bzrlib.config.LocationConfig(self.base)
780
config.set_user_option('push_location', location)
781
782
@needs_write_lock
783
def set_parent(self, url):
784
"""See Branch.set_parent."""
785
# TODO: Maybe delete old location files?
786
from bzrlib.atomicfile import AtomicFile
787
f = AtomicFile(self.control_files.controlfilename('parent'))
788
try:
789
f.write(url + '\n')
790
f.commit()
791
finally:
792
f.close()
793
794
def tree_config(self):
795
return TreeConfig(self)
796
797
def _get_truncated_history(self, revision_id):
798
history = self.revision_history()
799
if revision_id is None:
800
return history
801
try:
802
idx = history.index(revision_id)
803
except ValueError:
804
raise InvalidRevisionId(revision_id=revision, branch=self)
805
return history[:idx+1]
806
807
@needs_read_lock
808
def _clone_weave(self, to_location, revision=None, basis_branch=None):
809
assert isinstance(to_location, basestring)
810
if basis_branch is not None:
811
note("basis_branch is not supported for fast weave copy yet.")
812
813
history = self._get_truncated_history(revision)
814
if not bzrlib.osutils.lexists(to_location):
815
os.mkdir(to_location)
816
branch_to = Branch.initialize(to_location)
817
mutter("copy branch from %s to %s", self, branch_to)
818
branch_to.working_tree().set_root_id(self.get_root_id())
819
820
self.repository.copy(branch_to.repository)
821
822
# must be done *after* history is copied across
823
# FIXME duplicate code with base .clone().
824
# .. would template method be useful here. RBC 20051207
825
branch_to.set_parent(self.base)
826
branch_to.append_revision(*history)
827
# circular import protection
828
from bzrlib.merge import build_working_dir
829
build_working_dir(to_location)
830
mutter("copied")
831
return branch_to
832
833
def clone(self, to_location, revision=None, basis_branch=None, to_branch_type=None):
834
if to_branch_type is None:
835
to_branch_type = BzrBranch
836
837
if to_branch_type == BzrBranch \
838
and self.repository.weave_store.listable() \
839
and self.repository.revision_store.listable():
840
return self._clone_weave(to_location, revision, basis_branch)
841
842
return Branch.clone(self, to_location, revision, basis_branch, to_branch_type)
843
844
845
class ScratchBranch(BzrBranch):
1130
"""
1131
self.lock_write()
1132
try:
1133
## TODO: Option to move IDs only
1134
assert not isinstance(from_paths, basestring)
1135
tree = self.working_tree()
1136
inv = tree.inventory
1137
to_abs = self.abspath(to_name)
1138
if not isdir(to_abs):
1139
raise BzrError("destination %r is not a directory" % to_abs)
1140
if not tree.has_filename(to_name):
1141
raise BzrError("destination %r not in working directory" % to_abs)
1142
to_dir_id = inv.path2id(to_name)
1143
if to_dir_id == None and to_name != '':
1144
raise BzrError("destination %r is not a versioned directory" % to_name)
1145
to_dir_ie = inv[to_dir_id]
1146
if to_dir_ie.kind not in ('directory', 'root_directory'):
1147
raise BzrError("destination %r is not a directory" % to_abs)
1148
1149
to_idpath = inv.get_idpath(to_dir_id)
1150
1151
for f in from_paths:
1152
if not tree.has_filename(f):
1153
raise BzrError("%r does not exist in working tree" % f)
1154
f_id = inv.path2id(f)
1155
if f_id == None:
1156
raise BzrError("%r is not versioned" % f)
1157
name_tail = splitpath(f)[-1]
1158
dest_path = appendpath(to_name, name_tail)
1159
if tree.has_filename(dest_path):
1160
raise BzrError("destination %r already exists" % dest_path)
1161
if f_id in to_idpath:
1162
raise BzrError("can't move %r to a subdirectory of itself" % f)
1163
1164
# OK, so there's a race here, it's possible that someone will
1165
# create a file in this interval and then the rename might be
1166
# left half-done. But we should have caught most problems.
1167
1168
for f in from_paths:
1169
name_tail = splitpath(f)[-1]
1170
dest_path = appendpath(to_name, name_tail)
1171
print "%s => %s" % (f, dest_path)
1172
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1173
try:
1174
os.rename(self.abspath(f), self.abspath(dest_path))
1175
except OSError, e:
1176
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1177
["rename rolled back"])
1178
1179
self._write_inventory(inv)
1180
finally:
1181
self.unlock()
1182
1183
1184
def revert(self, filenames, old_tree=None, backups=True):
1185
"""Restore selected files to the versions from a previous tree.
1186
1187
backups
1188
If true (default) backups are made of files before
1189
they're renamed.
1190
"""
1191
from bzrlib.errors import NotVersionedError, BzrError
1192
from bzrlib.atomicfile import AtomicFile
1193
from bzrlib.osutils import backup_file
1194
1195
inv = self.read_working_inventory()
1196
if old_tree is None:
1197
old_tree = self.basis_tree()
1198
old_inv = old_tree.inventory
1199
1200
nids = []
1201
for fn in filenames:
1202
file_id = inv.path2id(fn)
1203
if not file_id:
1204
raise NotVersionedError("not a versioned file", fn)
1205
if not old_inv.has_id(file_id):
1206
raise BzrError("file not present in old tree", fn, file_id)
1207
nids.append((fn, file_id))
1208
1209
# TODO: Rename back if it was previously at a different location
1210
1211
# TODO: If given a directory, restore the entire contents from
1212
# the previous version.
1213
1214
# TODO: Make a backup to a temporary file.
1215
1216
# TODO: If the file previously didn't exist, delete it?
1217
for fn, file_id in nids:
1218
backup_file(fn)
1219
1220
f = AtomicFile(fn, 'wb')
1221
try:
1222
f.write(old_tree.get_file(file_id).read())
1223
f.commit()
1224
finally:
1225
f.close()
1226
1227
1228
def pending_merges(self):
1229
"""Return a list of pending merges.
1230
1231
These are revisions that have been merged into the working
1232
directory but not yet committed.
1233
"""
1234
cfn = self.controlfilename('pending-merges')
1235
if not os.path.exists(cfn):
1236
return []
1237
p = []
1238
for l in self.controlfile('pending-merges', 'r').readlines():
1239
p.append(l.rstrip('\n'))
1240
return p
1241
1242
1243
def add_pending_merge(self, revision_id):
1244
from bzrlib.revision import validate_revision_id
1245
1246
validate_revision_id(revision_id)
1247
1248
p = self.pending_merges()
1249
if revision_id in p:
1250
return
1251
p.append(revision_id)
1252
self.set_pending_merges(p)
1253
1254
1255
def set_pending_merges(self, rev_list):
1256
from bzrlib.atomicfile import AtomicFile
1257
self.lock_write()
1258
try:
1259
f = AtomicFile(self.controlfilename('pending-merges'))
1260
try:
1261
for l in rev_list:
1262
print >>f, l
1263
f.commit()
1264
finally:
1265
f.close()
1266
finally:
1267
self.unlock()
1268
1269
1270
1271
class ScratchBranch(Branch):
846
1272
"""Special test class: a branch that cleans up after itself.
847
1273
848
1274
>>> b = ScratchBranch()
849
1275
>>> isdir(b.base)
850
1276
True
851
1277
>>> bd = b.base
852
>>> b._transport.__del__()
1278
>>> b.destroy()
853
1279
>>> isdir(bd)
854
1280
False
855
1281
"""
856
857
def __init__(self, files=[], dirs=[], transport=None):
1282
def __init__(self, files=[], dirs=[], base=None):
858
1283
"""Make a test branch.
859
1284
860
1285
This creates a temporary directory and runs init-tree in it.
861
1286
862
1287
If any files are listed, they are created in the working copy.
863
1288
"""
864
if transport is None:
865
transport = bzrlib.transport.local.ScratchTransport()
866
super(ScratchBranch, self).__init__(transport, init=True)
867
else:
868
super(ScratchBranch, self).__init__(transport)
869
870
# BzrBranch creates a clone to .bzr and then forgets about the
871
# original transport. A ScratchTransport() deletes itself and
872
# everything underneath it when it goes away, so we need to
873
# grab a local copy to prevent that from happening
874
self._transport = transport
875
1289
from tempfile import mkdtemp
1290
init = False
1291
if base is None:
1292
base = mkdtemp()
1293
init = True
1294
Branch.__init__(self, base, init=init)
876
1295
for d in dirs:
877
self._transport.mkdir(d)
1296
os.mkdir(self.abspath(d))
878
1297
879
1298
for f in files:
880
self._transport.put(f, 'content of %s' % f)
1299
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
1300
881
1301
882
1302
def clone(self):
883
1303
"""
884
1304
>>> orig = ScratchBranch(files=["file1", "file2"])
885
>>> os.listdir(orig.base)
886
[u'.bzr', u'file1', u'file2']
887
1305
>>> clone = orig.clone()
888
>>> if os.name != 'nt':
889
... os.path.samefile(orig.base, clone.base)
890
... else:
891
... orig.base == clone.base
892
...
1306
>>> os.path.samefile(orig.base, clone.base)
893
1307
False
894
>>> os.listdir(clone.base)
895
[u'.bzr', u'file1', u'file2']
1308
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1309
True
896
1310
"""
897
1311
from shutil import copytree
898
from bzrlib.osutils import mkdtemp
1312
from tempfile import mkdtemp
899
1313
base = mkdtemp()
900
1314
os.rmdir(base)
901
1315
copytree(self.base, base, symlinks=True)
902
return ScratchBranch(
903
transport=bzrlib.transport.local.ScratchTransport(base))
1316
return ScratchBranch(base=base)
1317
1318
def __del__(self):
1319
self.destroy()
1320
1321
def destroy(self):
1322
"""Destroy the test branch, removing the scratch directory."""
1323
from shutil import rmtree
1324
try:
1325
if self.base:
1326
mutter("delete ScratchBranch %s" % self.base)
1327
rmtree(self.base)
1328
except OSError, e:
1329
# Work around for shutil.rmtree failing on Windows when
1330
# readonly files are encountered
1331
mutter("hit exception in destroying ScratchBranch: %s" % e)
1332
for root, dirs, files in os.walk(self.base, topdown=False):
1333
for name in files:
1334
os.chmod(os.path.join(root, name), 0700)
1335
rmtree(self.base)
1336
self.base = None
1337
904
1338
905
1339
906
1340
######################################################################
909
1343
910
1344
def is_control_file(filename):
911
1345
## FIXME: better check
912
filename = normpath(filename)
1346
filename = os.path.normpath(filename)
913
1347
while filename != '':
914
1348
head, tail = os.path.split(filename)
915
1349
## mutter('check %r for control file' % ((head, tail), ))
919
1353
break
920
1354
filename = head
921
1355
return False
1356
1357
1358
1359
def gen_file_id(name):
1360
"""Return new file id.
1361
1362
This should probably generate proper UUIDs, but for the moment we
1363
cope with just randomness because running uuidgen every time is
1364
slow."""
1365
import re
1366
from binascii import hexlify
1367
from time import time
1368
1369
# get last component
1370
idx = name.rfind('/')
1371
if idx != -1:
1372
name = name[idx+1 : ]
1373
idx = name.rfind('\\')
1374
if idx != -1:
1375
name = name[idx+1 : ]
1376
1377
# make it not a hidden file
1378
name = name.lstrip('.')
1379
1380
# remove any wierd characters; we don't escape them but rather
1381
# just pull them out
1382
name = re.sub(r'[^\w.]', '', name)
1383
1384
s = hexlify(rand_bytes(8))
1385
return '-'.join((name, compact_date(time()), s))
1386
1387
1388
def gen_root_id():
1389
"""Return a new tree-root file id."""
1390
return gen_file_id('TREE_ROOT')
1391
Loggerhead is a web-based interface for Breezy
Version: 2.0.1