1
# Copyright (C) 2005 Canonical Ltd
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.
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.
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
22
from warnings import warn
23
from cStringIO import StringIO
27
import bzrlib.inventory as inventory
28
from bzrlib.trace import mutter, note
29
from bzrlib.osutils import (isdir, quotefn,
30
rename, splitpath, sha_file, appendpath,
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,
38
from bzrlib.textui import show_status
39
from bzrlib.revision import (Revision, is_ancestor, get_intervening_revisions,
42
from bzrlib.delta import compare_trees
43
from bzrlib.tree import EmptyTree, RevisionTree
44
from bzrlib.inventory import Inventory
45
from bzrlib.store import copy_all
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
53
from config import TreeConfig
56
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
57
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
58
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
59
## TODO: Maybe include checks for common corruption of newlines, etc?
62
# TODO: Some operations like log might retrieve the same revisions
63
# repeatedly to calculate deltas. We could perhaps have a weakref
64
# cache in memory to make this faster. In general anything can be
65
# cached in memory between lock and unlock operations.
67
def find_branch(*ignored, **ignored_too):
68
# XXX: leave this here for about one release, then remove it
69
raise NotImplementedError('find_branch() is not supported anymore, '
70
'please use one of the new branch constructors')
73
def needs_read_lock(unbound):
74
"""Decorate unbound to take out and release a read lock."""
75
def decorated(self, *args, **kwargs):
78
return unbound(self, *args, **kwargs)
84
def needs_write_lock(unbound):
85
"""Decorate unbound to take out and release a write lock."""
86
def decorated(self, *args, **kwargs):
89
return unbound(self, *args, **kwargs)
94
######################################################################
98
"""Branch holding a history of revisions.
101
Base directory/url of the branch.
105
def __init__(self, *ignored, **ignored_too):
106
raise NotImplementedError('The Branch class is abstract')
109
def open_downlevel(base):
110
"""Open a branch which may be of an old format.
112
Only local branches are supported."""
113
return BzrBranch(get_transport(base), relax_version_check=True)
117
"""Open an existing branch, rooted at 'base' (url)"""
118
t = get_transport(base)
119
mutter("trying to open %r with transport %r", base, t)
123
def open_containing(url):
124
"""Open an existing branch which contains url.
126
This probes for a branch at url, and searches upwards from there.
128
Basically we keep looking up until we find the control directory or
129
run into the root. If there isn't one, raises NotBranchError.
130
If there is one, it is returned, along with the unused portion of url.
132
t = get_transport(url)
135
return BzrBranch(t), t.relpath(url)
136
except NotBranchError:
138
new_t = t.clone('..')
139
if new_t.base == t.base:
140
# reached the root, whatever that may be
141
raise NotBranchError(path=url)
145
def initialize(base):
146
"""Create a new branch, rooted at 'base' (url)"""
147
t = get_transport(base)
148
return BzrBranch(t, init=True)
150
def setup_caching(self, cache_root):
151
"""Subclasses that care about caching should override this, and set
152
up cached stores located under cache_root.
154
self.cache_root = cache_root
157
cfg = self.tree_config()
158
return cfg.get_option(u"nickname", default=self.base.split('/')[-1])
160
def _set_nick(self, nick):
161
cfg = self.tree_config()
162
cfg.set_option(nick, "nickname")
163
assert cfg.get_option("nickname") == nick
165
nick = property(_get_nick, _set_nick)
167
def push_stores(self, branch_to):
168
"""Copy the content of this branches store to branch_to."""
169
raise NotImplementedError('push_stores is abstract')
171
def get_transaction(self):
172
"""Return the current active transaction.
174
If no transaction is active, this returns a passthrough object
175
for which all data is immediately flushed and no caching happens.
177
raise NotImplementedError('get_transaction is abstract')
179
def lock_write(self):
180
raise NotImplementedError('lock_write is abstract')
183
raise NotImplementedError('lock_read is abstract')
186
raise NotImplementedError('unlock is abstract')
188
def abspath(self, name):
189
"""Return absolute filename for something in the branch
191
XXX: Robert Collins 20051017 what is this used for? why is it a branch
192
method and not a tree method.
194
raise NotImplementedError('abspath is abstract')
196
def controlfilename(self, file_or_path):
197
"""Return location relative to branch."""
198
raise NotImplementedError('controlfilename is abstract')
200
def controlfile(self, file_or_path, mode='r'):
201
"""Open a control file for this branch.
203
There are two classes of file in the control directory: text
204
and binary. binary files are untranslated byte streams. Text
205
control files are stored with Unix newlines and in UTF-8, even
206
if the platform or locale defaults are different.
208
Controlfiles should almost never be opened in write mode but
209
rather should be atomically copied and replaced using atomicfile.
211
raise NotImplementedError('controlfile is abstract')
213
def put_controlfile(self, path, f, encode=True):
214
"""Write an entry as a controlfile.
216
:param path: The path to put the file, relative to the .bzr control
218
:param f: A file-like or string object whose contents should be copied.
219
:param encode: If true, encode the contents as utf-8
221
raise NotImplementedError('put_controlfile is abstract')
223
def put_controlfiles(self, files, encode=True):
224
"""Write several entries as controlfiles.
226
:param files: A list of [(path, file)] pairs, where the path is the directory
227
underneath the bzr control directory
228
:param encode: If true, encode the contents as utf-8
230
raise NotImplementedError('put_controlfiles is abstract')
232
def get_root_id(self):
233
"""Return the id of this branches root"""
234
raise NotImplementedError('get_root_id is abstract')
236
def set_root_id(self, file_id):
237
raise NotImplementedError('set_root_id is abstract')
239
def print_file(self, file, revision_id):
240
"""Print `file` to stdout."""
241
raise NotImplementedError('print_file is abstract')
243
def append_revision(self, *revision_ids):
244
raise NotImplementedError('append_revision is abstract')
246
def set_revision_history(self, rev_history):
247
raise NotImplementedError('set_revision_history is abstract')
249
def has_revision(self, revision_id):
250
"""True if this branch has a copy of the revision.
252
This does not necessarily imply the revision is merge
253
or on the mainline."""
254
raise NotImplementedError('has_revision is abstract')
256
def get_revision_xml(self, revision_id):
257
raise NotImplementedError('get_revision_xml is abstract')
259
def get_revision(self, revision_id):
260
"""Return the Revision object for a named revision"""
261
raise NotImplementedError('get_revision is abstract')
263
def get_revision_delta(self, revno):
264
"""Return the delta for one revision.
266
The delta is relative to its mainline predecessor, or the
267
empty tree for revision 1.
269
assert isinstance(revno, int)
270
rh = self.revision_history()
271
if not (1 <= revno <= len(rh)):
272
raise InvalidRevisionNumber(revno)
274
# revno is 1-based; list is 0-based
276
new_tree = self.revision_tree(rh[revno-1])
278
old_tree = EmptyTree()
280
old_tree = self.revision_tree(rh[revno-2])
282
return compare_trees(old_tree, new_tree)
284
def get_revision_sha1(self, revision_id):
285
"""Hash the stored value of a revision, and return it."""
286
raise NotImplementedError('get_revision_sha1 is abstract')
288
def get_ancestry(self, revision_id):
289
"""Return a list of revision-ids integrated by a revision.
291
This currently returns a list, but the ordering is not guaranteed:
294
raise NotImplementedError('get_ancestry is abstract')
296
def get_inventory(self, revision_id):
297
"""Get Inventory object by hash."""
298
raise NotImplementedError('get_inventory is abstract')
300
def get_inventory_xml(self, revision_id):
301
"""Get inventory XML as a file object."""
302
raise NotImplementedError('get_inventory_xml is abstract')
304
def get_inventory_sha1(self, revision_id):
305
"""Return the sha1 hash of the inventory entry."""
306
raise NotImplementedError('get_inventory_sha1 is abstract')
308
def get_revision_inventory(self, revision_id):
309
"""Return inventory of a past revision."""
310
raise NotImplementedError('get_revision_inventory is abstract')
312
def revision_history(self):
313
"""Return sequence of revision hashes on to this branch."""
314
raise NotImplementedError('revision_history is abstract')
317
"""Return current revision number for this branch.
319
That is equivalent to the number of revisions committed to
322
return len(self.revision_history())
324
def last_revision(self):
325
"""Return last patch hash, or None if no history."""
326
ph = self.revision_history()
332
def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
333
"""Return a list of new revisions that would perfectly fit.
335
If self and other have not diverged, return a list of the revisions
336
present in other, but missing from self.
338
>>> from bzrlib.commit import commit
339
>>> bzrlib.trace.silent = True
340
>>> br1 = ScratchBranch()
341
>>> br2 = ScratchBranch()
342
>>> br1.missing_revisions(br2)
344
>>> commit(br2, "lala!", rev_id="REVISION-ID-1")
345
>>> br1.missing_revisions(br2)
347
>>> br2.missing_revisions(br1)
349
>>> commit(br1, "lala!", rev_id="REVISION-ID-1")
350
>>> br1.missing_revisions(br2)
352
>>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
353
>>> br1.missing_revisions(br2)
355
>>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
356
>>> br1.missing_revisions(br2)
357
Traceback (most recent call last):
358
DivergedBranches: These branches have diverged.
360
self_history = self.revision_history()
361
self_len = len(self_history)
362
other_history = other.revision_history()
363
other_len = len(other_history)
364
common_index = min(self_len, other_len) -1
365
if common_index >= 0 and \
366
self_history[common_index] != other_history[common_index]:
367
raise DivergedBranches(self, other)
369
if stop_revision is None:
370
stop_revision = other_len
372
assert isinstance(stop_revision, int)
373
if stop_revision > other_len:
374
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
375
return other_history[self_len:stop_revision]
377
def update_revisions(self, other, stop_revision=None):
378
"""Pull in new perfect-fit revisions."""
379
raise NotImplementedError('update_revisions is abstract')
381
def pullable_revisions(self, other, stop_revision):
382
raise NotImplementedError('pullable_revisions is abstract')
384
def revision_id_to_revno(self, revision_id):
385
"""Given a revision id, return its revno"""
386
if revision_id is None:
388
history = self.revision_history()
390
return history.index(revision_id) + 1
392
raise bzrlib.errors.NoSuchRevision(self, revision_id)
394
def get_rev_id(self, revno, history=None):
395
"""Find the revision id of the specified revno."""
399
history = self.revision_history()
400
elif revno <= 0 or revno > len(history):
401
raise bzrlib.errors.NoSuchRevision(self, revno)
402
return history[revno - 1]
404
def revision_tree(self, revision_id):
405
"""Return Tree for a revision on this branch.
407
`revision_id` may be None for the null revision, in which case
408
an `EmptyTree` is returned."""
409
raise NotImplementedError('revision_tree is abstract')
411
def working_tree(self):
412
"""Return a `Tree` for the working copy if this is a local branch."""
413
raise NotImplementedError('working_tree is abstract')
415
def pull(self, source, overwrite=False):
416
raise NotImplementedError('pull is abstract')
418
def basis_tree(self):
419
"""Return `Tree` object for last revision.
421
If there are no revisions yet, return an `EmptyTree`.
423
return self.revision_tree(self.last_revision())
425
def rename_one(self, from_rel, to_rel):
428
This can change the directory or the filename or both.
430
raise NotImplementedError('rename_one is abstract')
432
def move(self, from_paths, to_name):
435
to_name must exist as a versioned directory.
437
If to_name exists and is a directory, the files are moved into
438
it, keeping their old names. If it is a directory,
440
Note that to_name is only the last component of the new name;
441
this doesn't change the directory.
443
This returns a list of (from_path, to_path) pairs for each
446
raise NotImplementedError('move is abstract')
448
def get_parent(self):
449
"""Return the parent location of the branch.
451
This is the default location for push/pull/missing. The usual
452
pattern is that the user can override it by specifying a
455
raise NotImplementedError('get_parent is abstract')
457
def get_push_location(self):
458
"""Return the None or the location to push this branch to."""
459
raise NotImplementedError('get_push_location is abstract')
461
def set_push_location(self, location):
462
"""Set a new push location for this branch."""
463
raise NotImplementedError('set_push_location is abstract')
465
def set_parent(self, url):
466
raise NotImplementedError('set_parent is abstract')
468
def check_revno(self, revno):
470
Check whether a revno corresponds to any revision.
471
Zero (the NULL revision) is considered valid.
474
self.check_real_revno(revno)
476
def check_real_revno(self, revno):
478
Check whether a revno corresponds to a real revision.
479
Zero (the NULL revision) is considered invalid
481
if revno < 1 or revno > self.revno():
482
raise InvalidRevisionNumber(revno)
484
def sign_revision(self, revision_id, gpg_strategy):
485
raise NotImplementedError('sign_revision is abstract')
487
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
488
raise NotImplementedError('store_revision_signature is abstract')
490
def fileid_involved_between_revs(self, from_revid, to_revid):
491
""" This function returns the file_id(s) involved in the
492
changese between the from_revid revision and the to_revid
495
raise NotImplementedError('fileid_involved_between_revs is abstract')
497
def fileid_involved(self, last_revid=None):
498
""" This function returns the file_id(s) involved in the
499
changese up to the revision last_revid
500
If no parametr is passed, then all file_id[s] present in the
501
repository are returned
503
raise NotImplementedError('fileid_involved is abstract')
505
def fileid_involved_by_set(self, changes):
506
""" This function returns the file_id(s) involved in the
507
changes present in the set 'changes'
509
raise NotImplementedError('fileid_involved_by_set is abstract')
511
class BzrBranch(Branch):
512
"""A branch stored in the actual filesystem.
514
Note that it's "local" in the context of the filesystem; it doesn't
515
really matter if it's on an nfs/smb/afs/coda/... share, as long as
516
it's writable, and can be accessed via the normal filesystem API.
522
If _lock_mode is true, a positive count of the number of times the
526
Lock object from bzrlib.lock.
528
# We actually expect this class to be somewhat short-lived; part of its
529
# purpose is to try to isolate what bits of the branch logic are tied to
530
# filesystem access, so that in a later step, we can extricate them to
531
# a separarte ("storage") class.
535
_inventory_weave = None
537
# Map some sort of prefix into a namespace
538
# stuff like "revno:10", "revid:", etc.
539
# This should match a prefix with a function which accepts
540
REVISION_NAMESPACES = {}
542
def push_stores(self, branch_to):
543
"""See Branch.push_stores."""
544
if (self._branch_format != branch_to._branch_format
545
or self._branch_format != 4):
546
from bzrlib.fetch import greedy_fetch
547
mutter("falling back to fetch logic to push between %s(%s) and %s(%s)",
548
self, self._branch_format, branch_to, branch_to._branch_format)
549
greedy_fetch(to_branch=branch_to, from_branch=self,
550
revision=self.last_revision())
553
store_pairs = ((self.text_store, branch_to.text_store),
554
(self.inventory_store, branch_to.inventory_store),
555
(self.revision_store, branch_to.revision_store))
557
for from_store, to_store in store_pairs:
558
copy_all(from_store, to_store)
559
except UnlistableStore:
560
raise UnlistableBranch(from_store)
562
def __init__(self, transport, init=False,
563
relax_version_check=False):
564
"""Create new branch object at a particular location.
566
transport -- A Transport object, defining how to access files.
568
init -- If True, create new control files in a previously
569
unversioned directory. If False, the branch must already
572
relax_version_check -- If true, the usual check for the branch
573
version is not applied. This is intended only for
574
upgrade/recovery type use; it's not guaranteed that
575
all operations will work on old format branches.
577
In the test suite, creation of new trees is tested using the
578
`ScratchBranch` class.
580
assert isinstance(transport, Transport), \
581
"%r is not a Transport" % transport
582
self._transport = transport
585
self._check_format(relax_version_check)
587
def get_store(name, compressed=True, prefixed=False):
588
# FIXME: This approach of assuming stores are all entirely compressed
589
# or entirely uncompressed is tidy, but breaks upgrade from
590
# some existing branches where there's a mixture; we probably
591
# still want the option to look for both.
592
relpath = self._rel_controlfilename(unicode(name))
593
store = TextStore(self._transport.clone(relpath),
595
compressed=compressed)
596
#if self._transport.should_cache():
597
# cache_path = os.path.join(self.cache_root, name)
598
# os.mkdir(cache_path)
599
# store = bzrlib.store.CachedStore(store, cache_path)
602
def get_weave(name, prefixed=False):
603
relpath = self._rel_controlfilename(unicode(name))
604
ws = WeaveStore(self._transport.clone(relpath), prefixed=prefixed)
605
if self._transport.should_cache():
606
ws.enable_cache = True
609
if self._branch_format == 4:
610
self.inventory_store = get_store('inventory-store')
611
self.text_store = get_store('text-store')
612
self.revision_store = get_store('revision-store')
613
elif self._branch_format == 5:
614
self.control_weaves = get_weave(u'')
615
self.weave_store = get_weave(u'weaves')
616
self.revision_store = get_store(u'revision-store', compressed=False)
617
elif self._branch_format == 6:
618
self.control_weaves = get_weave(u'')
619
self.weave_store = get_weave(u'weaves', prefixed=True)
620
self.revision_store = get_store(u'revision-store', compressed=False,
622
self.revision_store.register_suffix('sig')
623
self._transaction = None
626
return '%s(%r)' % (self.__class__.__name__, self._transport.base)
631
if self._lock_mode or self._lock:
632
# XXX: This should show something every time, and be suitable for
633
# headless operation and embedding
634
warn("branch %r was not explicitly unlocked" % self)
637
# TODO: It might be best to do this somewhere else,
638
# but it is nice for a Branch object to automatically
639
# cache it's information.
640
# Alternatively, we could have the Transport objects cache requests
641
# See the earlier discussion about how major objects (like Branch)
642
# should never expect their __del__ function to run.
643
if hasattr(self, 'cache_root') and self.cache_root is not None:
645
shutil.rmtree(self.cache_root)
648
self.cache_root = None
652
return self._transport.base
655
base = property(_get_base, doc="The URL for the root of this branch.")
657
def _finish_transaction(self):
658
"""Exit the current transaction."""
659
if self._transaction is None:
660
raise errors.LockError('Branch %s is not in a transaction' %
662
transaction = self._transaction
663
self._transaction = None
666
def get_transaction(self):
667
"""See Branch.get_transaction."""
668
if self._transaction is None:
669
return transactions.PassThroughTransaction()
671
return self._transaction
673
def _set_transaction(self, new_transaction):
674
"""Set a new active transaction."""
675
if self._transaction is not None:
676
raise errors.LockError('Branch %s is in a transaction already.' %
678
self._transaction = new_transaction
680
def lock_write(self):
681
#mutter("lock write: %s (%s)", self, self._lock_count)
682
# TODO: Upgrade locking to support using a Transport,
683
# and potentially a remote locking protocol
685
if self._lock_mode != 'w':
686
raise LockError("can't upgrade to a write lock from %r" %
688
self._lock_count += 1
690
self._lock = self._transport.lock_write(
691
self._rel_controlfilename('branch-lock'))
692
self._lock_mode = 'w'
694
self._set_transaction(transactions.PassThroughTransaction())
697
#mutter("lock read: %s (%s)", self, self._lock_count)
699
assert self._lock_mode in ('r', 'w'), \
700
"invalid lock mode %r" % self._lock_mode
701
self._lock_count += 1
703
self._lock = self._transport.lock_read(
704
self._rel_controlfilename('branch-lock'))
705
self._lock_mode = 'r'
707
self._set_transaction(transactions.ReadOnlyTransaction())
708
# 5K may be excessive, but hey, its a knob.
709
self.get_transaction().set_cache_size(5000)
712
#mutter("unlock: %s (%s)", self, self._lock_count)
713
if not self._lock_mode:
714
raise LockError('branch %r is not locked' % (self))
716
if self._lock_count > 1:
717
self._lock_count -= 1
719
self._finish_transaction()
722
self._lock_mode = self._lock_count = None
724
def abspath(self, name):
725
"""See Branch.abspath."""
726
return self._transport.abspath(name)
728
def _rel_controlfilename(self, file_or_path):
729
if not isinstance(file_or_path, basestring):
730
file_or_path = u'/'.join(file_or_path)
731
if file_or_path == '':
733
return bzrlib.transport.urlescape(bzrlib.BZRDIR + u'/' + file_or_path)
735
def controlfilename(self, file_or_path):
736
"""See Branch.controlfilename."""
737
return self._transport.abspath(self._rel_controlfilename(file_or_path))
739
def controlfile(self, file_or_path, mode='r'):
740
"""See Branch.controlfile."""
743
relpath = self._rel_controlfilename(file_or_path)
744
#TODO: codecs.open() buffers linewise, so it was overloaded with
745
# a much larger buffer, do we need to do the same for getreader/getwriter?
747
return self._transport.get(relpath)
749
raise BzrError("Branch.controlfile(mode='wb') is not supported, use put_controlfiles")
751
# XXX: Do we really want errors='replace'? Perhaps it should be
752
# an error, or at least reported, if there's incorrectly-encoded
753
# data inside a file.
754
# <https://launchpad.net/products/bzr/+bug/3823>
755
return codecs.getreader('utf-8')(self._transport.get(relpath), errors='replace')
757
raise BzrError("Branch.controlfile(mode='w') is not supported, use put_controlfiles")
759
raise BzrError("invalid controlfile mode %r" % mode)
761
def put_controlfile(self, path, f, encode=True):
762
"""See Branch.put_controlfile."""
763
self.put_controlfiles([(path, f)], encode=encode)
765
def put_controlfiles(self, files, encode=True):
766
"""See Branch.put_controlfiles."""
769
for path, f in files:
771
if isinstance(f, basestring):
772
f = f.encode('utf-8', 'replace')
774
f = codecs.getwriter('utf-8')(f, errors='replace')
775
path = self._rel_controlfilename(path)
776
ctrl_files.append((path, f))
777
self._transport.put_multi(ctrl_files)
779
def _make_control(self):
780
from bzrlib.inventory import Inventory
781
from bzrlib.weavefile import write_weave_v5
782
from bzrlib.weave import Weave
784
# Create an empty inventory
786
# if we want per-tree root ids then this is the place to set
787
# them; they're not needed for now and so ommitted for
789
bzrlib.xml5.serializer_v5.write_inventory(Inventory(), sio)
790
empty_inv = sio.getvalue()
792
bzrlib.weavefile.write_weave_v5(Weave(), sio)
793
empty_weave = sio.getvalue()
795
dirs = [[], 'revision-store', 'weaves']
797
"This is a Bazaar-NG control directory.\n"
798
"Do not change any files in this directory.\n"),
799
('branch-format', BZR_BRANCH_FORMAT_6),
800
('revision-history', ''),
803
('pending-merges', ''),
804
('inventory', empty_inv),
805
('inventory.weave', empty_weave),
806
('ancestry.weave', empty_weave)
808
cfn = self._rel_controlfilename
809
self._transport.mkdir_multi([cfn(d) for d in dirs])
810
self.put_controlfiles(files)
811
mutter('created control directory in ' + self._transport.base)
813
def _check_format(self, relax_version_check):
814
"""Check this branch format is supported.
816
The format level is stored, as an integer, in
817
self._branch_format for code that needs to check it later.
819
In the future, we might need different in-memory Branch
820
classes to support downlevel branches. But not yet.
823
fmt = self.controlfile('branch-format', 'r').read()
825
raise NotBranchError(path=self.base)
826
mutter("got branch format %r", fmt)
827
if fmt == BZR_BRANCH_FORMAT_6:
828
self._branch_format = 6
829
elif fmt == BZR_BRANCH_FORMAT_5:
830
self._branch_format = 5
831
elif fmt == BZR_BRANCH_FORMAT_4:
832
self._branch_format = 4
834
if (not relax_version_check
835
and self._branch_format not in (5, 6)):
836
raise errors.UnsupportedFormatError(
837
'sorry, branch format %r not supported' % fmt,
838
['use a different bzr version',
839
'or remove the .bzr directory'
840
' and "bzr init" again'])
843
def get_root_id(self):
844
"""See Branch.get_root_id."""
845
inv = self.get_inventory(self.last_revision())
846
return inv.root.file_id
849
def print_file(self, file, revision_id):
850
"""See Branch.print_file."""
851
tree = self.revision_tree(revision_id)
852
# use inventory as it was in that revision
853
file_id = tree.inventory.path2id(file)
856
revno = self.revision_id_to_revno(revision_id)
857
except errors.NoSuchRevision:
858
# TODO: This should not be BzrError,
859
# but NoSuchFile doesn't fit either
860
raise BzrError('%r is not present in revision %s'
861
% (file, revision_id))
863
raise BzrError('%r is not present in revision %s'
865
tree.print_file(file_id)
868
def append_revision(self, *revision_ids):
869
"""See Branch.append_revision."""
870
for revision_id in revision_ids:
871
mutter("add {%s} to revision-history" % revision_id)
872
rev_history = self.revision_history()
873
rev_history.extend(revision_ids)
874
self.set_revision_history(rev_history)
877
def set_revision_history(self, rev_history):
878
"""See Branch.set_revision_history."""
879
old_revision = self.last_revision()
880
new_revision = rev_history[-1]
881
self.put_controlfile('revision-history', '\n'.join(rev_history))
883
self.working_tree().set_last_revision(new_revision, old_revision)
884
except NoWorkingTree:
885
mutter('Unable to set_last_revision without a working tree.')
887
def has_revision(self, revision_id):
888
"""See Branch.has_revision."""
889
return (revision_id is None
890
or self.revision_store.has_id(revision_id))
893
def _get_revision_xml_file(self, revision_id):
894
if not revision_id or not isinstance(revision_id, basestring):
895
raise InvalidRevisionId(revision_id=revision_id, branch=self)
897
return self.revision_store.get(revision_id)
898
except (IndexError, KeyError):
899
raise bzrlib.errors.NoSuchRevision(self, revision_id)
901
def get_revision_xml(self, revision_id):
902
"""See Branch.get_revision_xml."""
903
return self._get_revision_xml_file(revision_id).read()
905
def get_revision(self, revision_id):
906
"""See Branch.get_revision."""
907
xml_file = self._get_revision_xml_file(revision_id)
910
r = bzrlib.xml5.serializer_v5.read_revision(xml_file)
911
except SyntaxError, e:
912
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
916
assert r.revision_id == revision_id
919
def get_revision_sha1(self, revision_id):
920
"""See Branch.get_revision_sha1."""
921
# In the future, revision entries will be signed. At that
922
# point, it is probably best *not* to include the signature
923
# in the revision hash. Because that lets you re-sign
924
# the revision, (add signatures/remove signatures) and still
925
# have all hash pointers stay consistent.
926
# But for now, just hash the contents.
927
return bzrlib.osutils.sha_file(self.get_revision_xml_file(revision_id))
929
def get_ancestry(self, revision_id):
930
"""See Branch.get_ancestry."""
931
if revision_id is None:
933
w = self._get_inventory_weave()
934
return [None] + map(w.idx_to_name,
935
w.inclusions([w.lookup(revision_id)]))
937
def _get_inventory_weave(self):
938
return self.control_weaves.get_weave('inventory',
939
self.get_transaction())
941
def get_inventory(self, revision_id):
942
"""See Branch.get_inventory."""
943
xml = self.get_inventory_xml(revision_id)
944
return bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
946
def get_inventory_xml(self, revision_id):
947
"""See Branch.get_inventory_xml."""
949
assert isinstance(revision_id, basestring), type(revision_id)
950
iw = self._get_inventory_weave()
951
return iw.get_text(iw.lookup(revision_id))
953
raise bzrlib.errors.HistoryMissing(self, 'inventory', revision_id)
955
def get_inventory_sha1(self, revision_id):
956
"""See Branch.get_inventory_sha1."""
957
return self.get_revision(revision_id).inventory_sha1
959
def get_revision_inventory(self, revision_id):
960
"""See Branch.get_revision_inventory."""
961
# TODO: Unify this with get_inventory()
962
# bzr 0.0.6 and later imposes the constraint that the inventory_id
963
# must be the same as its revision, so this is trivial.
964
if revision_id == None:
965
# This does not make sense: if there is no revision,
966
# then it is the current tree inventory surely ?!
967
# and thus get_root_id() is something that looks at the last
968
# commit on the branch, and the get_root_id is an inventory check.
969
raise NotImplementedError
970
# return Inventory(self.get_root_id())
972
return self.get_inventory(revision_id)
975
def revision_history(self):
976
"""See Branch.revision_history."""
977
transaction = self.get_transaction()
978
history = transaction.map.find_revision_history()
979
if history is not None:
980
mutter("cache hit for revision-history in %s", self)
982
history = [l.rstrip('\r\n') for l in
983
self.controlfile('revision-history', 'r').readlines()]
984
transaction.map.add_revision_history(history)
985
# this call is disabled because revision_history is
986
# not really an object yet, and the transaction is for objects.
987
# transaction.register_clean(history, precious=True)
990
def update_revisions(self, other, stop_revision=None):
991
"""See Branch.update_revisions."""
992
from bzrlib.fetch import greedy_fetch
993
if stop_revision is None:
994
stop_revision = other.last_revision()
995
### Should this be checking is_ancestor instead of revision_history?
996
if (stop_revision is not None and
997
stop_revision in self.revision_history()):
999
greedy_fetch(to_branch=self, from_branch=other,
1000
revision=stop_revision)
1001
pullable_revs = self.pullable_revisions(other, stop_revision)
1002
if len(pullable_revs) > 0:
1003
self.append_revision(*pullable_revs)
1005
def pullable_revisions(self, other, stop_revision):
1006
"""See Branch.pullable_revisions."""
1007
other_revno = other.revision_id_to_revno(stop_revision)
1009
return self.missing_revisions(other, other_revno)
1010
except DivergedBranches, e:
1012
pullable_revs = get_intervening_revisions(self.last_revision(),
1013
stop_revision, self)
1014
assert self.last_revision() not in pullable_revs
1015
return pullable_revs
1016
except bzrlib.errors.NotAncestor:
1017
if is_ancestor(self.last_revision(), stop_revision, self):
1022
def revision_tree(self, revision_id):
1023
"""See Branch.revision_tree."""
1024
# TODO: refactor this to use an existing revision object
1025
# so we don't need to read it in twice.
1026
if revision_id == None or revision_id == NULL_REVISION:
1029
inv = self.get_revision_inventory(revision_id)
1030
return RevisionTree(self.weave_store, inv, revision_id)
1032
def basis_tree(self):
1033
"""See Branch.basis_tree."""
1035
revision_id = self.revision_history()[-1]
1036
xml = self.working_tree().read_basis_inventory(revision_id)
1037
inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
1038
return RevisionTree(self.weave_store, inv, revision_id)
1039
except (IndexError, NoSuchFile, NoWorkingTree), e:
1040
return self.revision_tree(self.last_revision())
1042
def working_tree(self):
1043
"""See Branch.working_tree."""
1044
from bzrlib.workingtree import WorkingTree
1045
if self._transport.base.find('://') != -1:
1046
raise NoWorkingTree(self.base)
1047
return WorkingTree(self.base, branch=self)
1050
def pull(self, source, overwrite=False):
1051
"""See Branch.pull."""
1054
old_count = len(self.revision_history())
1056
self.update_revisions(source)
1057
except DivergedBranches:
1061
self.set_revision_history(source.revision_history())
1062
new_count = len(self.revision_history())
1063
return new_count - old_count
1067
def get_parent(self):
1068
"""See Branch.get_parent."""
1070
_locs = ['parent', 'pull', 'x-pull']
1073
return self.controlfile(l, 'r').read().strip('\n')
1078
def get_push_location(self):
1079
"""See Branch.get_push_location."""
1080
config = bzrlib.config.BranchConfig(self)
1081
push_loc = config.get_user_option('push_location')
1084
def set_push_location(self, location):
1085
"""See Branch.set_push_location."""
1086
config = bzrlib.config.LocationConfig(self.base)
1087
config.set_user_option('push_location', location)
1090
def set_parent(self, url):
1091
"""See Branch.set_parent."""
1092
# TODO: Maybe delete old location files?
1093
from bzrlib.atomicfile import AtomicFile
1094
f = AtomicFile(self.controlfilename('parent'))
1101
def tree_config(self):
1102
return TreeConfig(self)
1104
def sign_revision(self, revision_id, gpg_strategy):
1105
"""See Branch.sign_revision."""
1106
plaintext = Testament.from_revision(self, revision_id).as_short_text()
1107
self.store_revision_signature(gpg_strategy, plaintext, revision_id)
1110
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1111
"""See Branch.store_revision_signature."""
1112
self.revision_store.add(StringIO(gpg_strategy.sign(plaintext)),
1115
def fileid_involved_between_revs(self, from_revid, to_revid):
1116
""" This function returns the file_id(s) involved in the
1117
changese between the from_revid revision and the to_revid
1120
w = self._get_inventory_weave( )
1121
from_set = set(w.inclusions([w.lookup(from_revid)]))
1122
to_set = set(w.inclusions([w.lookup(to_revid)]))
1123
included = to_set.difference(from_set)
1124
changed = map(w.idx_to_name,included)
1125
return self._fileid_involved_by_set(changed)
1127
def fileid_involved(self, last_revid=None):
1128
""" This function returns the file_id(s) involved in the
1129
changese up to the revision last_revid
1130
If no parametr is passed, then all file_id[s] present in the
1131
repository are returned
1133
w = self._get_inventory_weave( )
1135
changed = set(w._names)
1137
included = w.inclusions([w.lookup(last_revid)])
1138
changed = map(w.idx_to_name, included)
1139
return self._fileid_involved_by_set(changed)
1141
def fileid_involved_by_set(self, changes):
1142
""" This function returns the file_id(s) involved in the
1143
changese present in the set changes
1145
w = self._get_inventory_weave( )
1146
return self._fileid_involved_by_set(changes)
1148
def _fileid_involved_by_set(self, changes):
1149
w = self._get_inventory_weave( )
1151
for line in w._weave:
1153
# it is ugly, but it is due to the weave structure
1154
if not isinstance(line,basestring): continue
1156
start = line.find('file_id="')+9
1157
if start < 9: continue
1158
end = line.find('"',start)
1160
file_id = line[start:end]
1162
# check if file_id is already present
1163
if file_id in file_ids: continue
1165
start = line.find('revision="')+10
1166
if start < 10: continue
1167
end = line.find('"',start)
1169
revision_id = line[start:end]
1171
if revision_id in changes:
1172
file_ids.add(file_id)
1177
class ScratchBranch(BzrBranch):
1178
"""Special test class: a branch that cleans up after itself.
1180
>>> b = ScratchBranch()
1184
>>> b._transport.__del__()
1189
def __init__(self, files=[], dirs=[], transport=None):
1190
"""Make a test branch.
1192
This creates a temporary directory and runs init-tree in it.
1194
If any files are listed, they are created in the working copy.
1196
if transport is None:
1197
transport = bzrlib.transport.local.ScratchTransport()
1198
super(ScratchBranch, self).__init__(transport, init=True)
1200
super(ScratchBranch, self).__init__(transport)
1203
self._transport.mkdir(d)
1206
self._transport.put(f, 'content of %s' % f)
1211
>>> orig = ScratchBranch(files=["file1", "file2"])
1212
>>> clone = orig.clone()
1213
>>> if os.name != 'nt':
1214
... os.path.samefile(orig.base, clone.base)
1216
... orig.base == clone.base
1219
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1222
from shutil import copytree
1223
from tempfile import mkdtemp
1226
copytree(self.base, base, symlinks=True)
1227
return ScratchBranch(
1228
transport=bzrlib.transport.local.ScratchTransport(base))
1231
######################################################################
1235
def is_control_file(filename):
1236
## FIXME: better check
1237
filename = os.path.normpath(filename)
1238
while filename != '':
1239
head, tail = os.path.split(filename)
1240
## mutter('check %r for control file' % ((head, tail), ))
1241
if tail == bzrlib.BZRDIR:
1243
if filename == head:
added
removed
bzrlib/branch.py
