« back to all changes in this revision
Viewing changes to bzrlib/branch.py
- browse files at revision 1
- compare with another revision
- download diff
- download tarball
- view history from revision 1
- Committer: Bazaar Package Importer
- Author(s): Jeff Bailey
- Date: 2005-11-07 13:17:53 UTC
- Revision ID: james.westby@ubuntu.com-20051107131753-qsy145z1rfug5i27
Tags: upstream-0.6.2
Import upstream version 0.6.2
- files added:
- bzrlib
- bzrlib/plugins
- bzrlib/selftest
- bzrlib/store
- bzrlib/transport
- bzrlib/util
- bzrlib/util/configobj
- bzrlib/util/configobj/docs
- bzrlib/util/effbot
- bzrlib/util/effbot/org
- bzrlib/util/elementtree
- bzrlib/util/urlgrabber
- contrib
- contrib/bash
- contrib/emacs
- contrib/zsh
- doc
- notes
- patches
- tools
added
removed
bzrlib/branch.py
1
# Copyright (C) 2005 Canonical Ltd
2
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
7
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
12
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16
17
18
import sys
19
import os
20
import errno
21
from warnings import warn
22
from cStringIO import StringIO
23
24
25
import bzrlib
26
from bzrlib.inventory import InventoryEntry
27
import bzrlib.inventory as inventory
28
from bzrlib.trace import mutter, note
29
from bzrlib.osutils import (isdir, quotefn, compact_date, rand_bytes,
30
rename, splitpath, sha_file, appendpath,
31
file_kind, abspath)
32
import bzrlib.errors as errors
33
from bzrlib.errors import (BzrError, InvalidRevisionNumber, InvalidRevisionId,
34
NoSuchRevision, HistoryMissing, NotBranchError,
35
DivergedBranches, LockError, UnlistableStore,
36
UnlistableBranch, NoSuchFile, NotVersionedError)
37
from bzrlib.textui import show_status
38
from bzrlib.revision import (Revision, is_ancestor, get_intervening_revisions,
39
NULL_REVISION)
40
41
from bzrlib.delta import compare_trees
42
from bzrlib.tree import EmptyTree, RevisionTree
43
from bzrlib.inventory import Inventory
44
from bzrlib.store import copy_all
45
from bzrlib.store.compressed_text import CompressedTextStore
46
from bzrlib.store.text import TextStore
47
from bzrlib.store.weave import WeaveStore
48
from bzrlib.testament import Testament
49
import bzrlib.transactions as transactions
50
from bzrlib.transport import Transport, get_transport
51
import bzrlib.xml5
52
import bzrlib.ui
53
54
55
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
56
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
57
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
58
## TODO: Maybe include checks for common corruption of newlines, etc?
59
60
61
# TODO: Some operations like log might retrieve the same revisions
62
# repeatedly to calculate deltas. We could perhaps have a weakref
63
# cache in memory to make this faster. In general anything can be
64
# cached in memory between lock and unlock operations.
65
66
def find_branch(*ignored, **ignored_too):
67
# XXX: leave this here for about one release, then remove it
68
raise NotImplementedError('find_branch() is not supported anymore, '
69
'please use one of the new branch constructors')
70
71
72
def needs_read_lock(unbound):
73
"""Decorate unbound to take out and release a read lock."""
74
def decorated(self, *args, **kwargs):
75
self.lock_read()
76
try:
77
return unbound(self, *args, **kwargs)
78
finally:
79
self.unlock()
80
return decorated
81
82
83
def needs_write_lock(unbound):
84
"""Decorate unbound to take out and release a write lock."""
85
def decorated(self, *args, **kwargs):
86
self.lock_write()
87
try:
88
return unbound(self, *args, **kwargs)
89
finally:
90
self.unlock()
91
return decorated
92
93
######################################################################
94
# branch objects
95
96
class Branch(object):
97
"""Branch holding a history of revisions.
98
99
base
100
Base directory/url of the branch.
101
"""
102
base = None
103
104
def __init__(self, *ignored, **ignored_too):
105
raise NotImplementedError('The Branch class is abstract')
106
107
@staticmethod
108
def open_downlevel(base):
109
"""Open a branch which may be of an old format.
110
111
Only local branches are supported."""
112
return _Branch(get_transport(base), relax_version_check=True)
113
114
@staticmethod
115
def open(base):
116
"""Open an existing branch, rooted at 'base' (url)"""
117
t = get_transport(base)
118
mutter("trying to open %r with transport %r", base, t)
119
return _Branch(t)
120
121
@staticmethod
122
def open_containing(url):
123
"""Open an existing branch which contains url.
124
125
This probes for a branch at url, and searches upwards from there.
126
127
Basically we keep looking up until we find the control directory or
128
run into the root. If there isn't one, raises NotBranchError.
129
If there is one, it is returned, along with the unused portion of url.
130
"""
131
t = get_transport(url)
132
while True:
133
try:
134
return _Branch(t), t.relpath(url)
135
except NotBranchError:
136
pass
137
new_t = t.clone('..')
138
if new_t.base == t.base:
139
# reached the root, whatever that may be
140
raise NotBranchError(path=url)
141
t = new_t
142
143
@staticmethod
144
def initialize(base):
145
"""Create a new branch, rooted at 'base' (url)"""
146
t = get_transport(base)
147
return _Branch(t, init=True)
148
149
def setup_caching(self, cache_root):
150
"""Subclasses that care about caching should override this, and set
151
up cached stores located under cache_root.
152
"""
153
self.cache_root = cache_root
154
155
156
class _Branch(Branch):
157
"""A branch stored in the actual filesystem.
158
159
Note that it's "local" in the context of the filesystem; it doesn't
160
really matter if it's on an nfs/smb/afs/coda/... share, as long as
161
it's writable, and can be accessed via the normal filesystem API.
162
163
_lock_mode
164
None, or 'r' or 'w'
165
166
_lock_count
167
If _lock_mode is true, a positive count of the number of times the
168
lock has been taken.
169
170
_lock
171
Lock object from bzrlib.lock.
172
"""
173
# We actually expect this class to be somewhat short-lived; part of its
174
# purpose is to try to isolate what bits of the branch logic are tied to
175
# filesystem access, so that in a later step, we can extricate them to
176
# a separarte ("storage") class.
177
_lock_mode = None
178
_lock_count = None
179
_lock = None
180
_inventory_weave = None
181
182
# Map some sort of prefix into a namespace
183
# stuff like "revno:10", "revid:", etc.
184
# This should match a prefix with a function which accepts
185
REVISION_NAMESPACES = {}
186
187
def push_stores(self, branch_to):
188
"""Copy the content of this branches store to branch_to."""
189
if (self._branch_format != branch_to._branch_format
190
or self._branch_format != 4):
191
from bzrlib.fetch import greedy_fetch
192
mutter("falling back to fetch logic to push between %s(%s) and %s(%s)",
193
self, self._branch_format, branch_to, branch_to._branch_format)
194
greedy_fetch(to_branch=branch_to, from_branch=self,
195
revision=self.last_revision())
196
return
197
198
store_pairs = ((self.text_store, branch_to.text_store),
199
(self.inventory_store, branch_to.inventory_store),
200
(self.revision_store, branch_to.revision_store))
201
try:
202
for from_store, to_store in store_pairs:
203
copy_all(from_store, to_store)
204
except UnlistableStore:
205
raise UnlistableBranch(from_store)
206
207
def __init__(self, transport, init=False,
208
relax_version_check=False):
209
"""Create new branch object at a particular location.
210
211
transport -- A Transport object, defining how to access files.
212
213
init -- If True, create new control files in a previously
214
unversioned directory. If False, the branch must already
215
be versioned.
216
217
relax_version_check -- If true, the usual check for the branch
218
version is not applied. This is intended only for
219
upgrade/recovery type use; it's not guaranteed that
220
all operations will work on old format branches.
221
222
In the test suite, creation of new trees is tested using the
223
`ScratchBranch` class.
224
"""
225
assert isinstance(transport, Transport), \
226
"%r is not a Transport" % transport
227
self._transport = transport
228
if init:
229
self._make_control()
230
self._check_format(relax_version_check)
231
232
def get_store(name, compressed=True, prefixed=False):
233
# FIXME: This approach of assuming stores are all entirely compressed
234
# or entirely uncompressed is tidy, but breaks upgrade from
235
# some existing branches where there's a mixture; we probably
236
# still want the option to look for both.
237
relpath = self._rel_controlfilename(name)
238
if compressed:
239
store = CompressedTextStore(self._transport.clone(relpath),
240
prefixed=prefixed)
241
else:
242
store = TextStore(self._transport.clone(relpath),
243
prefixed=prefixed)
244
#if self._transport.should_cache():
245
# cache_path = os.path.join(self.cache_root, name)
246
# os.mkdir(cache_path)
247
# store = bzrlib.store.CachedStore(store, cache_path)
248
return store
249
def get_weave(name, prefixed=False):
250
relpath = self._rel_controlfilename(name)
251
ws = WeaveStore(self._transport.clone(relpath), prefixed=prefixed)
252
if self._transport.should_cache():
253
ws.enable_cache = True
254
return ws
255
256
if self._branch_format == 4:
257
self.inventory_store = get_store('inventory-store')
258
self.text_store = get_store('text-store')
259
self.revision_store = get_store('revision-store')
260
elif self._branch_format == 5:
261
self.control_weaves = get_weave('')
262
self.weave_store = get_weave('weaves')
263
self.revision_store = get_store('revision-store', compressed=False)
264
elif self._branch_format == 6:
265
self.control_weaves = get_weave('')
266
self.weave_store = get_weave('weaves', prefixed=True)
267
self.revision_store = get_store('revision-store', compressed=False,
268
prefixed=True)
269
self.revision_store.register_suffix('sig')
270
self._transaction = None
271
272
def __str__(self):
273
return '%s(%r)' % (self.__class__.__name__, self._transport.base)
274
275
276
__repr__ = __str__
277
278
279
def __del__(self):
280
if self._lock_mode or self._lock:
281
# XXX: This should show something every time, and be suitable for
282
# headless operation and embedding
283
warn("branch %r was not explicitly unlocked" % self)
284
self._lock.unlock()
285
286
# TODO: It might be best to do this somewhere else,
287
# but it is nice for a Branch object to automatically
288
# cache it's information.
289
# Alternatively, we could have the Transport objects cache requests
290
# See the earlier discussion about how major objects (like Branch)
291
# should never expect their __del__ function to run.
292
if hasattr(self, 'cache_root') and self.cache_root is not None:
293
try:
294
import shutil
295
shutil.rmtree(self.cache_root)
296
except:
297
pass
298
self.cache_root = None
299
300
def _get_base(self):
301
if self._transport:
302
return self._transport.base
303
return None
304
305
base = property(_get_base, doc="The URL for the root of this branch.")
306
307
def _finish_transaction(self):
308
"""Exit the current transaction."""
309
if self._transaction is None:
310
raise errors.LockError('Branch %s is not in a transaction' %
311
self)
312
transaction = self._transaction
313
self._transaction = None
314
transaction.finish()
315
316
def get_transaction(self):
317
"""Return the current active transaction.
318
319
If no transaction is active, this returns a passthrough object
320
for which all data is immediately flushed and no caching happens.
321
"""
322
if self._transaction is None:
323
return transactions.PassThroughTransaction()
324
else:
325
return self._transaction
326
327
def _set_transaction(self, new_transaction):
328
"""Set a new active transaction."""
329
if self._transaction is not None:
330
raise errors.LockError('Branch %s is in a transaction already.' %
331
self)
332
self._transaction = new_transaction
333
334
def lock_write(self):
335
mutter("lock write: %s (%s)", self, self._lock_count)
336
# TODO: Upgrade locking to support using a Transport,
337
# and potentially a remote locking protocol
338
if self._lock_mode:
339
if self._lock_mode != 'w':
340
raise LockError("can't upgrade to a write lock from %r" %
341
self._lock_mode)
342
self._lock_count += 1
343
else:
344
self._lock = self._transport.lock_write(
345
self._rel_controlfilename('branch-lock'))
346
self._lock_mode = 'w'
347
self._lock_count = 1
348
self._set_transaction(transactions.PassThroughTransaction())
349
350
def lock_read(self):
351
mutter("lock read: %s (%s)", self, self._lock_count)
352
if self._lock_mode:
353
assert self._lock_mode in ('r', 'w'), \
354
"invalid lock mode %r" % self._lock_mode
355
self._lock_count += 1
356
else:
357
self._lock = self._transport.lock_read(
358
self._rel_controlfilename('branch-lock'))
359
self._lock_mode = 'r'
360
self._lock_count = 1
361
self._set_transaction(transactions.ReadOnlyTransaction())
362
# 5K may be excessive, but hey, its a knob.
363
self.get_transaction().set_cache_size(5000)
364
365
def unlock(self):
366
mutter("unlock: %s (%s)", self, self._lock_count)
367
if not self._lock_mode:
368
raise LockError('branch %r is not locked' % (self))
369
370
if self._lock_count > 1:
371
self._lock_count -= 1
372
else:
373
self._finish_transaction()
374
self._lock.unlock()
375
self._lock = None
376
self._lock_mode = self._lock_count = None
377
378
def abspath(self, name):
379
"""Return absolute filename for something in the branch
380
381
XXX: Robert Collins 20051017 what is this used for? why is it a branch
382
method and not a tree method.
383
"""
384
return self._transport.abspath(name)
385
386
def _rel_controlfilename(self, file_or_path):
387
if not isinstance(file_or_path, basestring):
388
file_or_path = '/'.join(file_or_path)
389
if file_or_path == '':
390
return bzrlib.BZRDIR
391
return bzrlib.transport.urlescape(bzrlib.BZRDIR + '/' + file_or_path)
392
393
def controlfilename(self, file_or_path):
394
"""Return location relative to branch."""
395
return self._transport.abspath(self._rel_controlfilename(file_or_path))
396
397
def controlfile(self, file_or_path, mode='r'):
398
"""Open a control file for this branch.
399
400
There are two classes of file in the control directory: text
401
and binary. binary files are untranslated byte streams. Text
402
control files are stored with Unix newlines and in UTF-8, even
403
if the platform or locale defaults are different.
404
405
Controlfiles should almost never be opened in write mode but
406
rather should be atomically copied and replaced using atomicfile.
407
"""
408
import codecs
409
410
relpath = self._rel_controlfilename(file_or_path)
411
#TODO: codecs.open() buffers linewise, so it was overloaded with
412
# a much larger buffer, do we need to do the same for getreader/getwriter?
413
if mode == 'rb':
414
return self._transport.get(relpath)
415
elif mode == 'wb':
416
raise BzrError("Branch.controlfile(mode='wb') is not supported, use put_controlfiles")
417
elif mode == 'r':
418
return codecs.getreader('utf-8')(self._transport.get(relpath), errors='replace')
419
elif mode == 'w':
420
raise BzrError("Branch.controlfile(mode='w') is not supported, use put_controlfiles")
421
else:
422
raise BzrError("invalid controlfile mode %r" % mode)
423
424
def put_controlfile(self, path, f, encode=True):
425
"""Write an entry as a controlfile.
426
427
:param path: The path to put the file, relative to the .bzr control
428
directory
429
:param f: A file-like or string object whose contents should be copied.
430
:param encode: If true, encode the contents as utf-8
431
"""
432
self.put_controlfiles([(path, f)], encode=encode)
433
434
def put_controlfiles(self, files, encode=True):
435
"""Write several entries as controlfiles.
436
437
:param files: A list of [(path, file)] pairs, where the path is the directory
438
underneath the bzr control directory
439
:param encode: If true, encode the contents as utf-8
440
"""
441
import codecs
442
ctrl_files = []
443
for path, f in files:
444
if encode:
445
if isinstance(f, basestring):
446
f = f.encode('utf-8', 'replace')
447
else:
448
f = codecs.getwriter('utf-8')(f, errors='replace')
449
path = self._rel_controlfilename(path)
450
ctrl_files.append((path, f))
451
self._transport.put_multi(ctrl_files)
452
453
def _make_control(self):
454
from bzrlib.inventory import Inventory
455
from bzrlib.weavefile import write_weave_v5
456
from bzrlib.weave import Weave
457
458
# Create an empty inventory
459
sio = StringIO()
460
# if we want per-tree root ids then this is the place to set
461
# them; they're not needed for now and so ommitted for
462
# simplicity.
463
bzrlib.xml5.serializer_v5.write_inventory(Inventory(), sio)
464
empty_inv = sio.getvalue()
465
sio = StringIO()
466
bzrlib.weavefile.write_weave_v5(Weave(), sio)
467
empty_weave = sio.getvalue()
468
469
dirs = [[], 'revision-store', 'weaves']
470
files = [('README',
471
"This is a Bazaar-NG control directory.\n"
472
"Do not change any files in this directory.\n"),
473
('branch-format', BZR_BRANCH_FORMAT_6),
474
('revision-history', ''),
475
('branch-name', ''),
476
('branch-lock', ''),
477
('pending-merges', ''),
478
('inventory', empty_inv),
479
('inventory.weave', empty_weave),
480
('ancestry.weave', empty_weave)
481
]
482
cfn = self._rel_controlfilename
483
self._transport.mkdir_multi([cfn(d) for d in dirs])
484
self.put_controlfiles(files)
485
mutter('created control directory in ' + self._transport.base)
486
487
def _check_format(self, relax_version_check):
488
"""Check this branch format is supported.
489
490
The format level is stored, as an integer, in
491
self._branch_format for code that needs to check it later.
492
493
In the future, we might need different in-memory Branch
494
classes to support downlevel branches. But not yet.
495
"""
496
try:
497
fmt = self.controlfile('branch-format', 'r').read()
498
except NoSuchFile:
499
raise NotBranchError(path=self.base)
500
mutter("got branch format %r", fmt)
501
if fmt == BZR_BRANCH_FORMAT_6:
502
self._branch_format = 6
503
elif fmt == BZR_BRANCH_FORMAT_5:
504
self._branch_format = 5
505
elif fmt == BZR_BRANCH_FORMAT_4:
506
self._branch_format = 4
507
508
if (not relax_version_check
509
and self._branch_format not in (5, 6)):
510
raise errors.UnsupportedFormatError(
511
'sorry, branch format %r not supported' % fmt,
512
['use a different bzr version',
513
'or remove the .bzr directory'
514
' and "bzr init" again'])
515
516
def get_root_id(self):
517
"""Return the id of this branches root"""
518
inv = self.read_working_inventory()
519
return inv.root.file_id
520
521
def set_root_id(self, file_id):
522
inv = self.read_working_inventory()
523
orig_root_id = inv.root.file_id
524
del inv._byid[inv.root.file_id]
525
inv.root.file_id = file_id
526
inv._byid[inv.root.file_id] = inv.root
527
for fid in inv:
528
entry = inv[fid]
529
if entry.parent_id in (None, orig_root_id):
530
entry.parent_id = inv.root.file_id
531
self._write_inventory(inv)
532
533
@needs_read_lock
534
def read_working_inventory(self):
535
"""Read the working inventory."""
536
# ElementTree does its own conversion from UTF-8, so open in
537
# binary.
538
f = self.controlfile('inventory', 'rb')
539
return bzrlib.xml5.serializer_v5.read_inventory(f)
540
541
@needs_write_lock
542
def _write_inventory(self, inv):
543
"""Update the working inventory.
544
545
That is to say, the inventory describing changes underway, that
546
will be committed to the next revision.
547
"""
548
from cStringIO import StringIO
549
sio = StringIO()
550
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
551
sio.seek(0)
552
# Transport handles atomicity
553
self.put_controlfile('inventory', sio)
554
555
mutter('wrote working inventory')
556
557
inventory = property(read_working_inventory, _write_inventory, None,
558
"""Inventory for the working copy.""")
559
560
@needs_write_lock
561
def add(self, files, ids=None):
562
"""Make files versioned.
563
564
Note that the command line normally calls smart_add instead,
565
which can automatically recurse.
566
567
This puts the files in the Added state, so that they will be
568
recorded by the next commit.
569
570
files
571
List of paths to add, relative to the base of the tree.
572
573
ids
574
If set, use these instead of automatically generated ids.
575
Must be the same length as the list of files, but may
576
contain None for ids that are to be autogenerated.
577
578
TODO: Perhaps have an option to add the ids even if the files do
579
not (yet) exist.
580
581
TODO: Perhaps yield the ids and paths as they're added.
582
"""
583
# TODO: Re-adding a file that is removed in the working copy
584
# should probably put it back with the previous ID.
585
if isinstance(files, basestring):
586
assert(ids is None or isinstance(ids, basestring))
587
files = [files]
588
if ids is not None:
589
ids = [ids]
590
591
if ids is None:
592
ids = [None] * len(files)
593
else:
594
assert(len(ids) == len(files))
595
596
inv = self.read_working_inventory()
597
for f,file_id in zip(files, ids):
598
if is_control_file(f):
599
raise BzrError("cannot add control file %s" % quotefn(f))
600
601
fp = splitpath(f)
602
603
if len(fp) == 0:
604
raise BzrError("cannot add top-level %r" % f)
605
606
fullpath = os.path.normpath(self.abspath(f))
607
608
try:
609
kind = file_kind(fullpath)
610
except OSError:
611
# maybe something better?
612
raise BzrError('cannot add: not a regular file, symlink or directory: %s' % quotefn(f))
613
614
if not InventoryEntry.versionable_kind(kind):
615
raise BzrError('cannot add: not a versionable file ('
616
'i.e. regular file, symlink or directory): %s' % quotefn(f))
617
618
if file_id is None:
619
file_id = gen_file_id(f)
620
inv.add_path(f, kind=kind, file_id=file_id)
621
622
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
623
624
self._write_inventory(inv)
625
626
@needs_read_lock
627
def print_file(self, file, revno):
628
"""Print `file` to stdout."""
629
tree = self.revision_tree(self.get_rev_id(revno))
630
# use inventory as it was in that revision
631
file_id = tree.inventory.path2id(file)
632
if not file_id:
633
raise BzrError("%r is not present in revision %s" % (file, revno))
634
tree.print_file(file_id)
635
636
# FIXME: this doesn't need to be a branch method
637
def set_inventory(self, new_inventory_list):
638
from bzrlib.inventory import Inventory, InventoryEntry
639
inv = Inventory(self.get_root_id())
640
for path, file_id, parent, kind in new_inventory_list:
641
name = os.path.basename(path)
642
if name == "":
643
continue
644
# fixme, there should be a factory function inv,add_??
645
if kind == 'directory':
646
inv.add(inventory.InventoryDirectory(file_id, name, parent))
647
elif kind == 'file':
648
inv.add(inventory.InventoryFile(file_id, name, parent))
649
elif kind == 'symlink':
650
inv.add(inventory.InventoryLink(file_id, name, parent))
651
else:
652
raise BzrError("unknown kind %r" % kind)
653
self._write_inventory(inv)
654
655
def unknowns(self):
656
"""Return all unknown files.
657
658
These are files in the working directory that are not versioned or
659
control files or ignored.
660
661
>>> from bzrlib.workingtree import WorkingTree
662
>>> b = ScratchBranch(files=['foo', 'foo~'])
663
>>> map(str, b.unknowns())
664
['foo']
665
>>> b.add('foo')
666
>>> list(b.unknowns())
667
[]
668
>>> WorkingTree(b.base, b).remove('foo')
669
>>> list(b.unknowns())
670
[u'foo']
671
"""
672
return self.working_tree().unknowns()
673
674
@needs_write_lock
675
def append_revision(self, *revision_ids):
676
for revision_id in revision_ids:
677
mutter("add {%s} to revision-history" % revision_id)
678
rev_history = self.revision_history()
679
rev_history.extend(revision_ids)
680
self.set_revision_history(rev_history)
681
682
@needs_write_lock
683
def set_revision_history(self, rev_history):
684
self.put_controlfile('revision-history', '\n'.join(rev_history))
685
686
def has_revision(self, revision_id):
687
"""True if this branch has a copy of the revision.
688
689
This does not necessarily imply the revision is merge
690
or on the mainline."""
691
return (revision_id is None
692
or self.revision_store.has_id(revision_id))
693
694
@needs_read_lock
695
def get_revision_xml_file(self, revision_id):
696
"""Return XML file object for revision object."""
697
if not revision_id or not isinstance(revision_id, basestring):
698
raise InvalidRevisionId(revision_id=revision_id, branch=self)
699
try:
700
return self.revision_store.get(revision_id)
701
except (IndexError, KeyError):
702
raise bzrlib.errors.NoSuchRevision(self, revision_id)
703
704
#deprecated
705
get_revision_xml = get_revision_xml_file
706
707
def get_revision_xml(self, revision_id):
708
return self.get_revision_xml_file(revision_id).read()
709
710
711
def get_revision(self, revision_id):
712
"""Return the Revision object for a named revision"""
713
xml_file = self.get_revision_xml_file(revision_id)
714
715
try:
716
r = bzrlib.xml5.serializer_v5.read_revision(xml_file)
717
except SyntaxError, e:
718
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
719
[revision_id,
720
str(e)])
721
722
assert r.revision_id == revision_id
723
return r
724
725
def get_revision_delta(self, revno):
726
"""Return the delta for one revision.
727
728
The delta is relative to its mainline predecessor, or the
729
empty tree for revision 1.
730
"""
731
assert isinstance(revno, int)
732
rh = self.revision_history()
733
if not (1 <= revno <= len(rh)):
734
raise InvalidRevisionNumber(revno)
735
736
# revno is 1-based; list is 0-based
737
738
new_tree = self.revision_tree(rh[revno-1])
739
if revno == 1:
740
old_tree = EmptyTree()
741
else:
742
old_tree = self.revision_tree(rh[revno-2])
743
744
return compare_trees(old_tree, new_tree)
745
746
def get_revision_sha1(self, revision_id):
747
"""Hash the stored value of a revision, and return it."""
748
# In the future, revision entries will be signed. At that
749
# point, it is probably best *not* to include the signature
750
# in the revision hash. Because that lets you re-sign
751
# the revision, (add signatures/remove signatures) and still
752
# have all hash pointers stay consistent.
753
# But for now, just hash the contents.
754
return bzrlib.osutils.sha_file(self.get_revision_xml_file(revision_id))
755
756
def get_ancestry(self, revision_id):
757
"""Return a list of revision-ids integrated by a revision.
758
759
This currently returns a list, but the ordering is not guaranteed:
760
treat it as a set.
761
"""
762
if revision_id is None:
763
return [None]
764
w = self.get_inventory_weave()
765
return [None] + map(w.idx_to_name,
766
w.inclusions([w.lookup(revision_id)]))
767
768
def get_inventory_weave(self):
769
return self.control_weaves.get_weave('inventory',
770
self.get_transaction())
771
772
def get_inventory(self, revision_id):
773
"""Get Inventory object by hash."""
774
xml = self.get_inventory_xml(revision_id)
775
return bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
776
777
def get_inventory_xml(self, revision_id):
778
"""Get inventory XML as a file object."""
779
try:
780
assert isinstance(revision_id, basestring), type(revision_id)
781
iw = self.get_inventory_weave()
782
return iw.get_text(iw.lookup(revision_id))
783
except IndexError:
784
raise bzrlib.errors.HistoryMissing(self, 'inventory', revision_id)
785
786
def get_inventory_sha1(self, revision_id):
787
"""Return the sha1 hash of the inventory entry
788
"""
789
return self.get_revision(revision_id).inventory_sha1
790
791
def get_revision_inventory(self, revision_id):
792
"""Return inventory of a past revision."""
793
# TODO: Unify this with get_inventory()
794
# bzr 0.0.6 and later imposes the constraint that the inventory_id
795
# must be the same as its revision, so this is trivial.
796
if revision_id == None:
797
return Inventory(self.get_root_id())
798
else:
799
return self.get_inventory(revision_id)
800
801
@needs_read_lock
802
def revision_history(self):
803
"""Return sequence of revision hashes on to this branch."""
804
transaction = self.get_transaction()
805
history = transaction.map.find_revision_history()
806
if history is not None:
807
mutter("cache hit for revision-history in %s", self)
808
return list(history)
809
history = [l.rstrip('\r\n') for l in
810
self.controlfile('revision-history', 'r').readlines()]
811
transaction.map.add_revision_history(history)
812
# this call is disabled because revision_history is
813
# not really an object yet, and the transaction is for objects.
814
# transaction.register_clean(history, precious=True)
815
return list(history)
816
817
def revno(self):
818
"""Return current revision number for this branch.
819
820
That is equivalent to the number of revisions committed to
821
this branch.
822
"""
823
return len(self.revision_history())
824
825
def last_revision(self):
826
"""Return last patch hash, or None if no history.
827
"""
828
ph = self.revision_history()
829
if ph:
830
return ph[-1]
831
else:
832
return None
833
834
def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
835
"""Return a list of new revisions that would perfectly fit.
836
837
If self and other have not diverged, return a list of the revisions
838
present in other, but missing from self.
839
840
>>> from bzrlib.commit import commit
841
>>> bzrlib.trace.silent = True
842
>>> br1 = ScratchBranch()
843
>>> br2 = ScratchBranch()
844
>>> br1.missing_revisions(br2)
845
[]
846
>>> commit(br2, "lala!", rev_id="REVISION-ID-1")
847
>>> br1.missing_revisions(br2)
848
[u'REVISION-ID-1']
849
>>> br2.missing_revisions(br1)
850
[]
851
>>> commit(br1, "lala!", rev_id="REVISION-ID-1")
852
>>> br1.missing_revisions(br2)
853
[]
854
>>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
855
>>> br1.missing_revisions(br2)
856
[u'REVISION-ID-2A']
857
>>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
858
>>> br1.missing_revisions(br2)
859
Traceback (most recent call last):
860
DivergedBranches: These branches have diverged.
861
"""
862
self_history = self.revision_history()
863
self_len = len(self_history)
864
other_history = other.revision_history()
865
other_len = len(other_history)
866
common_index = min(self_len, other_len) -1
867
if common_index >= 0 and \
868
self_history[common_index] != other_history[common_index]:
869
raise DivergedBranches(self, other)
870
871
if stop_revision is None:
872
stop_revision = other_len
873
else:
874
assert isinstance(stop_revision, int)
875
if stop_revision > other_len:
876
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
877
return other_history[self_len:stop_revision]
878
879
def update_revisions(self, other, stop_revision=None):
880
"""Pull in new perfect-fit revisions."""
881
from bzrlib.fetch import greedy_fetch
882
if stop_revision is None:
883
stop_revision = other.last_revision()
884
### Should this be checking is_ancestor instead of revision_history?
885
if (stop_revision is not None and
886
stop_revision in self.revision_history()):
887
return
888
greedy_fetch(to_branch=self, from_branch=other,
889
revision=stop_revision)
890
pullable_revs = self.pullable_revisions(other, stop_revision)
891
if len(pullable_revs) > 0:
892
self.append_revision(*pullable_revs)
893
894
def pullable_revisions(self, other, stop_revision):
895
other_revno = other.revision_id_to_revno(stop_revision)
896
try:
897
return self.missing_revisions(other, other_revno)
898
except DivergedBranches, e:
899
try:
900
pullable_revs = get_intervening_revisions(self.last_revision(),
901
stop_revision, self)
902
assert self.last_revision() not in pullable_revs
903
return pullable_revs
904
except bzrlib.errors.NotAncestor:
905
if is_ancestor(self.last_revision(), stop_revision, self):
906
return []
907
else:
908
raise e
909
910
def commit(self, *args, **kw):
911
from bzrlib.commit import Commit
912
Commit().commit(self, *args, **kw)
913
914
def revision_id_to_revno(self, revision_id):
915
"""Given a revision id, return its revno"""
916
if revision_id is None:
917
return 0
918
history = self.revision_history()
919
try:
920
return history.index(revision_id) + 1
921
except ValueError:
922
raise bzrlib.errors.NoSuchRevision(self, revision_id)
923
924
def get_rev_id(self, revno, history=None):
925
"""Find the revision id of the specified revno."""
926
if revno == 0:
927
return None
928
if history is None:
929
history = self.revision_history()
930
elif revno <= 0 or revno > len(history):
931
raise bzrlib.errors.NoSuchRevision(self, revno)
932
return history[revno - 1]
933
934
def revision_tree(self, revision_id):
935
"""Return Tree for a revision on this branch.
936
937
`revision_id` may be None for the null revision, in which case
938
an `EmptyTree` is returned."""
939
# TODO: refactor this to use an existing revision object
940
# so we don't need to read it in twice.
941
if revision_id == None or revision_id == NULL_REVISION:
942
return EmptyTree()
943
else:
944
inv = self.get_revision_inventory(revision_id)
945
return RevisionTree(self.weave_store, inv, revision_id)
946
947
def working_tree(self):
948
"""Return a `Tree` for the working copy."""
949
from bzrlib.workingtree import WorkingTree
950
# TODO: In the future, perhaps WorkingTree should utilize Transport
951
# RobertCollins 20051003 - I don't think it should - working trees are
952
# much more complex to keep consistent than our careful .bzr subset.
953
# instead, we should say that working trees are local only, and optimise
954
# for that.
955
return WorkingTree(self.base, branch=self)
956
957
958
def basis_tree(self):
959
"""Return `Tree` object for last revision.
960
961
If there are no revisions yet, return an `EmptyTree`.
962
"""
963
return self.revision_tree(self.last_revision())
964
965
@needs_write_lock
966
def rename_one(self, from_rel, to_rel):
967
"""Rename one file.
968
969
This can change the directory or the filename or both.
970
"""
971
tree = self.working_tree()
972
inv = tree.inventory
973
if not tree.has_filename(from_rel):
974
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
975
if tree.has_filename(to_rel):
976
raise BzrError("can't rename: new working file %r already exists" % to_rel)
977
978
file_id = inv.path2id(from_rel)
979
if file_id == None:
980
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
981
982
if inv.path2id(to_rel):
983
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
984
985
to_dir, to_tail = os.path.split(to_rel)
986
to_dir_id = inv.path2id(to_dir)
987
if to_dir_id == None and to_dir != '':
988
raise BzrError("can't determine destination directory id for %r" % to_dir)
989
990
mutter("rename_one:")
991
mutter(" file_id {%s}" % file_id)
992
mutter(" from_rel %r" % from_rel)
993
mutter(" to_rel %r" % to_rel)
994
mutter(" to_dir %r" % to_dir)
995
mutter(" to_dir_id {%s}" % to_dir_id)
996
997
inv.rename(file_id, to_dir_id, to_tail)
998
999
from_abs = self.abspath(from_rel)
1000
to_abs = self.abspath(to_rel)
1001
try:
1002
rename(from_abs, to_abs)
1003
except OSError, e:
1004
raise BzrError("failed to rename %r to %r: %s"
1005
% (from_abs, to_abs, e[1]),
1006
["rename rolled back"])
1007
1008
self._write_inventory(inv)
1009
1010
@needs_write_lock
1011
def move(self, from_paths, to_name):
1012
"""Rename files.
1013
1014
to_name must exist as a versioned directory.
1015
1016
If to_name exists and is a directory, the files are moved into
1017
it, keeping their old names. If it is a directory,
1018
1019
Note that to_name is only the last component of the new name;
1020
this doesn't change the directory.
1021
1022
This returns a list of (from_path, to_path) pairs for each
1023
entry that is moved.
1024
"""
1025
result = []
1026
## TODO: Option to move IDs only
1027
assert not isinstance(from_paths, basestring)
1028
tree = self.working_tree()
1029
inv = tree.inventory
1030
to_abs = self.abspath(to_name)
1031
if not isdir(to_abs):
1032
raise BzrError("destination %r is not a directory" % to_abs)
1033
if not tree.has_filename(to_name):
1034
raise BzrError("destination %r not in working directory" % to_abs)
1035
to_dir_id = inv.path2id(to_name)
1036
if to_dir_id == None and to_name != '':
1037
raise BzrError("destination %r is not a versioned directory" % to_name)
1038
to_dir_ie = inv[to_dir_id]
1039
if to_dir_ie.kind not in ('directory', 'root_directory'):
1040
raise BzrError("destination %r is not a directory" % to_abs)
1041
1042
to_idpath = inv.get_idpath(to_dir_id)
1043
1044
for f in from_paths:
1045
if not tree.has_filename(f):
1046
raise BzrError("%r does not exist in working tree" % f)
1047
f_id = inv.path2id(f)
1048
if f_id == None:
1049
raise BzrError("%r is not versioned" % f)
1050
name_tail = splitpath(f)[-1]
1051
dest_path = appendpath(to_name, name_tail)
1052
if tree.has_filename(dest_path):
1053
raise BzrError("destination %r already exists" % dest_path)
1054
if f_id in to_idpath:
1055
raise BzrError("can't move %r to a subdirectory of itself" % f)
1056
1057
# OK, so there's a race here, it's possible that someone will
1058
# create a file in this interval and then the rename might be
1059
# left half-done. But we should have caught most problems.
1060
1061
for f in from_paths:
1062
name_tail = splitpath(f)[-1]
1063
dest_path = appendpath(to_name, name_tail)
1064
result.append((f, dest_path))
1065
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1066
try:
1067
rename(self.abspath(f), self.abspath(dest_path))
1068
except OSError, e:
1069
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1070
["rename rolled back"])
1071
1072
self._write_inventory(inv)
1073
return result
1074
1075
1076
def revert(self, filenames, old_tree=None, backups=True):
1077
"""Restore selected files to the versions from a previous tree.
1078
1079
backups
1080
If true (default) backups are made of files before
1081
they're renamed.
1082
"""
1083
from bzrlib.atomicfile import AtomicFile
1084
from bzrlib.osutils import backup_file
1085
1086
inv = self.read_working_inventory()
1087
if old_tree is None:
1088
old_tree = self.basis_tree()
1089
old_inv = old_tree.inventory
1090
1091
nids = []
1092
for fn in filenames:
1093
file_id = inv.path2id(fn)
1094
if not file_id:
1095
raise NotVersionedError(path=fn)
1096
if not old_inv.has_id(file_id):
1097
raise BzrError("file not present in old tree", fn, file_id)
1098
nids.append((fn, file_id))
1099
1100
# TODO: Rename back if it was previously at a different location
1101
1102
# TODO: If given a directory, restore the entire contents from
1103
# the previous version.
1104
1105
# TODO: Make a backup to a temporary file.
1106
1107
# TODO: If the file previously didn't exist, delete it?
1108
for fn, file_id in nids:
1109
backup_file(fn)
1110
1111
f = AtomicFile(fn, 'wb')
1112
try:
1113
f.write(old_tree.get_file(file_id).read())
1114
f.commit()
1115
finally:
1116
f.close()
1117
1118
1119
def pending_merges(self):
1120
"""Return a list of pending merges.
1121
1122
These are revisions that have been merged into the working
1123
directory but not yet committed.
1124
"""
1125
cfn = self._rel_controlfilename('pending-merges')
1126
if not self._transport.has(cfn):
1127
return []
1128
p = []
1129
for l in self.controlfile('pending-merges', 'r').readlines():
1130
p.append(l.rstrip('\n'))
1131
return p
1132
1133
1134
def add_pending_merge(self, *revision_ids):
1135
# TODO: Perhaps should check at this point that the
1136
# history of the revision is actually present?
1137
p = self.pending_merges()
1138
updated = False
1139
for rev_id in revision_ids:
1140
if rev_id in p:
1141
continue
1142
p.append(rev_id)
1143
updated = True
1144
if updated:
1145
self.set_pending_merges(p)
1146
1147
@needs_write_lock
1148
def set_pending_merges(self, rev_list):
1149
self.put_controlfile('pending-merges', '\n'.join(rev_list))
1150
1151
def get_parent(self):
1152
"""Return the parent location of the branch.
1153
1154
This is the default location for push/pull/missing. The usual
1155
pattern is that the user can override it by specifying a
1156
location.
1157
"""
1158
import errno
1159
_locs = ['parent', 'pull', 'x-pull']
1160
for l in _locs:
1161
try:
1162
return self.controlfile(l, 'r').read().strip('\n')
1163
except IOError, e:
1164
if e.errno != errno.ENOENT:
1165
raise
1166
return None
1167
1168
@needs_write_lock
1169
def set_parent(self, url):
1170
# TODO: Maybe delete old location files?
1171
from bzrlib.atomicfile import AtomicFile
1172
f = AtomicFile(self.controlfilename('parent'))
1173
try:
1174
f.write(url + '\n')
1175
f.commit()
1176
finally:
1177
f.close()
1178
1179
def check_revno(self, revno):
1180
"""\
1181
Check whether a revno corresponds to any revision.
1182
Zero (the NULL revision) is considered valid.
1183
"""
1184
if revno != 0:
1185
self.check_real_revno(revno)
1186
1187
def check_real_revno(self, revno):
1188
"""\
1189
Check whether a revno corresponds to a real revision.
1190
Zero (the NULL revision) is considered invalid
1191
"""
1192
if revno < 1 or revno > self.revno():
1193
raise InvalidRevisionNumber(revno)
1194
1195
def sign_revision(self, revision_id, gpg_strategy):
1196
plaintext = Testament.from_revision(self, revision_id).as_short_text()
1197
self.store_revision_signature(gpg_strategy, plaintext, revision_id)
1198
1199
@needs_write_lock
1200
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1201
self.revision_store.add(StringIO(gpg_strategy.sign(plaintext)),
1202
revision_id, "sig")
1203
1204
1205
class ScratchBranch(_Branch):
1206
"""Special test class: a branch that cleans up after itself.
1207
1208
>>> b = ScratchBranch()
1209
>>> isdir(b.base)
1210
True
1211
>>> bd = b.base
1212
>>> b._transport.__del__()
1213
>>> isdir(bd)
1214
False
1215
"""
1216
1217
def __init__(self, files=[], dirs=[], transport=None):
1218
"""Make a test branch.
1219
1220
This creates a temporary directory and runs init-tree in it.
1221
1222
If any files are listed, they are created in the working copy.
1223
"""
1224
if transport is None:
1225
transport = bzrlib.transport.local.ScratchTransport()
1226
super(ScratchBranch, self).__init__(transport, init=True)
1227
else:
1228
super(ScratchBranch, self).__init__(transport)
1229
1230
for d in dirs:
1231
self._transport.mkdir(d)
1232
1233
for f in files:
1234
self._transport.put(f, 'content of %s' % f)
1235
1236
1237
def clone(self):
1238
"""
1239
>>> orig = ScratchBranch(files=["file1", "file2"])
1240
>>> clone = orig.clone()
1241
>>> if os.name != 'nt':
1242
... os.path.samefile(orig.base, clone.base)
1243
... else:
1244
... orig.base == clone.base
1245
...
1246
False
1247
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1248
True
1249
"""
1250
from shutil import copytree
1251
from tempfile import mkdtemp
1252
base = mkdtemp()
1253
os.rmdir(base)
1254
copytree(self.base, base, symlinks=True)
1255
return ScratchBranch(
1256
transport=bzrlib.transport.local.ScratchTransport(base))
1257
1258
1259
######################################################################
1260
# predicates
1261
1262
1263
def is_control_file(filename):
1264
## FIXME: better check
1265
filename = os.path.normpath(filename)
1266
while filename != '':
1267
head, tail = os.path.split(filename)
1268
## mutter('check %r for control file' % ((head, tail), ))
1269
if tail == bzrlib.BZRDIR:
1270
return True
1271
if filename == head:
1272
break
1273
filename = head
1274
return False
1275
1276
1277
1278
def gen_file_id(name):
1279
"""Return new file id.
1280
1281
This should probably generate proper UUIDs, but for the moment we
1282
cope with just randomness because running uuidgen every time is
1283
slow."""
1284
import re
1285
from binascii import hexlify
1286
from time import time
1287
1288
# get last component
1289
idx = name.rfind('/')
1290
if idx != -1:
1291
name = name[idx+1 : ]
1292
idx = name.rfind('\\')
1293
if idx != -1:
1294
name = name[idx+1 : ]
1295
1296
# make it not a hidden file
1297
name = name.lstrip('.')
1298
1299
# remove any wierd characters; we don't escape them but rather
1300
# just pull them out
1301
name = re.sub(r'[^\w.]', '', name)
1302
1303
s = hexlify(rand_bytes(8))
1304
return '-'.join((name, compact_date(time()), s))
1305
1306
1307
def gen_root_id():
1308
"""Return a new tree-root file id."""
1309
return gen_file_id('TREE_ROOT')
1310
1311
Loggerhead is a web-based interface for Breezy
Version: 2.0.1