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,
31
file_kind, abspath, normpath, pathjoin)
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, e:
137
mutter('not a branch in: %r %s', t.base, e)
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. Try merge.
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
class BzrBranch(Branch):
491
"""A branch stored in the actual filesystem.
493
Note that it's "local" in the context of the filesystem; it doesn't
494
really matter if it's on an nfs/smb/afs/coda/... share, as long as
495
it's writable, and can be accessed via the normal filesystem API.
501
If _lock_mode is true, a positive count of the number of times the
505
Lock object from bzrlib.lock.
507
# We actually expect this class to be somewhat short-lived; part of its
508
# purpose is to try to isolate what bits of the branch logic are tied to
509
# filesystem access, so that in a later step, we can extricate them to
510
# a separarte ("storage") class.
514
_inventory_weave = None
515
# If set to False (by a plugin, etc) BzrBranch will not set the
516
# mode on created files or directories
517
_set_file_mode = True
520
# Map some sort of prefix into a namespace
521
# stuff like "revno:10", "revid:", etc.
522
# This should match a prefix with a function which accepts
523
REVISION_NAMESPACES = {}
525
def push_stores(self, branch_to):
526
"""See Branch.push_stores."""
527
if (self._branch_format != branch_to._branch_format
528
or self._branch_format != 4):
529
from bzrlib.fetch import greedy_fetch
530
mutter("falling back to fetch logic to push between %s(%s) and %s(%s)",
531
self, self._branch_format, branch_to, branch_to._branch_format)
532
greedy_fetch(to_branch=branch_to, from_branch=self,
533
revision=self.last_revision())
536
store_pairs = ((self.text_store, branch_to.text_store),
537
(self.inventory_store, branch_to.inventory_store),
538
(self.revision_store, branch_to.revision_store))
540
for from_store, to_store in store_pairs:
541
copy_all(from_store, to_store)
542
except UnlistableStore:
543
raise UnlistableBranch(from_store)
545
def __init__(self, transport, init=False,
546
relax_version_check=False):
547
"""Create new branch object at a particular location.
549
transport -- A Transport object, defining how to access files.
551
init -- If True, create new control files in a previously
552
unversioned directory. If False, the branch must already
555
relax_version_check -- If true, the usual check for the branch
556
version is not applied. This is intended only for
557
upgrade/recovery type use; it's not guaranteed that
558
all operations will work on old format branches.
560
In the test suite, creation of new trees is tested using the
561
`ScratchBranch` class.
563
assert isinstance(transport, Transport), \
564
"%r is not a Transport" % transport
565
self._transport = transport
568
self._check_format(relax_version_check)
571
def get_store(name, compressed=True, prefixed=False):
572
relpath = self._rel_controlfilename(unicode(name))
573
store = TextStore(self._transport.clone(relpath),
574
dir_mode=self._dir_mode,
575
file_mode=self._file_mode,
577
compressed=compressed)
580
def get_weave(name, prefixed=False):
581
relpath = self._rel_controlfilename(unicode(name))
582
ws = WeaveStore(self._transport.clone(relpath),
584
dir_mode=self._dir_mode,
585
file_mode=self._file_mode)
586
if self._transport.should_cache():
587
ws.enable_cache = True
590
if self._branch_format == 4:
591
self.inventory_store = get_store('inventory-store')
592
self.text_store = get_store('text-store')
593
self.revision_store = get_store('revision-store')
594
elif self._branch_format == 5:
595
self.control_weaves = get_weave(u'')
596
self.weave_store = get_weave(u'weaves')
597
self.revision_store = get_store(u'revision-store', compressed=False)
598
elif self._branch_format == 6:
599
self.control_weaves = get_weave(u'')
600
self.weave_store = get_weave(u'weaves', prefixed=True)
601
self.revision_store = get_store(u'revision-store', compressed=False,
603
self.revision_store.register_suffix('sig')
604
self._transaction = None
607
return '%s(%r)' % (self.__class__.__name__, self._transport.base)
612
if self._lock_mode or self._lock:
613
# XXX: This should show something every time, and be suitable for
614
# headless operation and embedding
615
warn("branch %r was not explicitly unlocked" % self)
618
# TODO: It might be best to do this somewhere else,
619
# but it is nice for a Branch object to automatically
620
# cache it's information.
621
# Alternatively, we could have the Transport objects cache requests
622
# See the earlier discussion about how major objects (like Branch)
623
# should never expect their __del__ function to run.
624
if hasattr(self, 'cache_root') and self.cache_root is not None:
626
shutil.rmtree(self.cache_root)
629
self.cache_root = None
633
return self._transport.base
636
base = property(_get_base, doc="The URL for the root of this branch.")
638
def _finish_transaction(self):
639
"""Exit the current transaction."""
640
if self._transaction is None:
641
raise errors.LockError('Branch %s is not in a transaction' %
643
transaction = self._transaction
644
self._transaction = None
647
def get_transaction(self):
648
"""See Branch.get_transaction."""
649
if self._transaction is None:
650
return transactions.PassThroughTransaction()
652
return self._transaction
654
def _set_transaction(self, new_transaction):
655
"""Set a new active transaction."""
656
if self._transaction is not None:
657
raise errors.LockError('Branch %s is in a transaction already.' %
659
self._transaction = new_transaction
661
def lock_write(self):
662
#mutter("lock write: %s (%s)", self, self._lock_count)
663
# TODO: Upgrade locking to support using a Transport,
664
# and potentially a remote locking protocol
666
if self._lock_mode != 'w':
667
raise LockError("can't upgrade to a write lock from %r" %
669
self._lock_count += 1
671
self._lock = self._transport.lock_write(
672
self._rel_controlfilename('branch-lock'))
673
self._lock_mode = 'w'
675
self._set_transaction(transactions.PassThroughTransaction())
678
#mutter("lock read: %s (%s)", self, self._lock_count)
680
assert self._lock_mode in ('r', 'w'), \
681
"invalid lock mode %r" % self._lock_mode
682
self._lock_count += 1
684
self._lock = self._transport.lock_read(
685
self._rel_controlfilename('branch-lock'))
686
self._lock_mode = 'r'
688
self._set_transaction(transactions.ReadOnlyTransaction())
689
# 5K may be excessive, but hey, its a knob.
690
self.get_transaction().set_cache_size(5000)
693
#mutter("unlock: %s (%s)", self, self._lock_count)
694
if not self._lock_mode:
695
raise LockError('branch %r is not locked' % (self))
697
if self._lock_count > 1:
698
self._lock_count -= 1
700
self._finish_transaction()
703
self._lock_mode = self._lock_count = None
705
def abspath(self, name):
706
"""See Branch.abspath."""
707
return self._transport.abspath(name)
709
def _rel_controlfilename(self, file_or_path):
710
if not isinstance(file_or_path, basestring):
711
file_or_path = u'/'.join(file_or_path)
712
if file_or_path == '':
714
return bzrlib.transport.urlescape(bzrlib.BZRDIR + u'/' + file_or_path)
716
def controlfilename(self, file_or_path):
717
"""See Branch.controlfilename."""
718
return self._transport.abspath(self._rel_controlfilename(file_or_path))
720
def controlfile(self, file_or_path, mode='r'):
721
"""See Branch.controlfile."""
724
relpath = self._rel_controlfilename(file_or_path)
725
#TODO: codecs.open() buffers linewise, so it was overloaded with
726
# a much larger buffer, do we need to do the same for getreader/getwriter?
728
return self._transport.get(relpath)
730
raise BzrError("Branch.controlfile(mode='wb') is not supported, use put_controlfiles")
732
# XXX: Do we really want errors='replace'? Perhaps it should be
733
# an error, or at least reported, if there's incorrectly-encoded
734
# data inside a file.
735
# <https://launchpad.net/products/bzr/+bug/3823>
736
return codecs.getreader('utf-8')(self._transport.get(relpath), errors='replace')
738
raise BzrError("Branch.controlfile(mode='w') is not supported, use put_controlfiles")
740
raise BzrError("invalid controlfile mode %r" % mode)
742
def put_controlfile(self, path, f, encode=True):
743
"""See Branch.put_controlfile."""
744
self.put_controlfiles([(path, f)], encode=encode)
746
def put_controlfiles(self, files, encode=True):
747
"""See Branch.put_controlfiles."""
750
for path, f in files:
752
if isinstance(f, basestring):
753
f = f.encode('utf-8', 'replace')
755
f = codecs.getwriter('utf-8')(f, errors='replace')
756
path = self._rel_controlfilename(path)
757
ctrl_files.append((path, f))
758
self._transport.put_multi(ctrl_files, mode=self._file_mode)
760
def _find_modes(self, path=None):
761
"""Determine the appropriate modes for files and directories."""
764
path = self._rel_controlfilename('')
765
st = self._transport.stat(path)
766
except errors.TransportNotPossible:
767
self._dir_mode = 0755
768
self._file_mode = 0644
770
self._dir_mode = st.st_mode & 07777
771
# Remove the sticky and execute bits for files
772
self._file_mode = self._dir_mode & ~07111
773
if not self._set_dir_mode:
774
self._dir_mode = None
775
if not self._set_file_mode:
776
self._file_mode = None
778
def _make_control(self):
779
from bzrlib.inventory import Inventory
780
from bzrlib.weavefile import write_weave_v5
781
from bzrlib.weave import Weave
783
# Create an empty inventory
785
# if we want per-tree root ids then this is the place to set
786
# them; they're not needed for now and so ommitted for
788
bzrlib.xml5.serializer_v5.write_inventory(Inventory(), sio)
789
empty_inv = sio.getvalue()
791
bzrlib.weavefile.write_weave_v5(Weave(), sio)
792
empty_weave = sio.getvalue()
794
cfn = self._rel_controlfilename
795
# Since we don't have a .bzr directory, inherit the
796
# mode from the root directory
797
self._find_modes(u'.')
799
dirs = ['', 'revision-store', 'weaves']
801
"This is a Bazaar-NG control directory.\n"
802
"Do not change any files in this directory.\n"),
803
('branch-format', BZR_BRANCH_FORMAT_6),
804
('revision-history', ''),
807
('pending-merges', ''),
808
('inventory', empty_inv),
809
('inventory.weave', empty_weave),
811
self._transport.mkdir_multi([cfn(d) for d in dirs], mode=self._dir_mode)
812
self.put_controlfiles(files)
813
mutter('created control directory in ' + self._transport.base)
815
def _check_format(self, relax_version_check):
816
"""Check this branch format is supported.
818
The format level is stored, as an integer, in
819
self._branch_format for code that needs to check it later.
821
In the future, we might need different in-memory Branch
822
classes to support downlevel branches. But not yet.
825
fmt = self.controlfile('branch-format', 'r').read()
827
raise NotBranchError(path=self.base)
828
mutter("got branch format %r", fmt)
829
if fmt == BZR_BRANCH_FORMAT_6:
830
self._branch_format = 6
831
elif fmt == BZR_BRANCH_FORMAT_5:
832
self._branch_format = 5
833
elif fmt == BZR_BRANCH_FORMAT_4:
834
self._branch_format = 4
836
if (not relax_version_check
837
and self._branch_format not in (5, 6)):
838
raise errors.UnsupportedFormatError(
839
'sorry, branch format %r not supported' % fmt,
840
['use a different bzr version',
841
'or remove the .bzr directory'
842
' and "bzr init" again'])
845
def get_root_id(self):
846
"""See Branch.get_root_id."""
847
inv = self.get_inventory(self.last_revision())
848
return inv.root.file_id
851
def print_file(self, file, revision_id):
852
"""See Branch.print_file."""
853
tree = self.revision_tree(revision_id)
854
# use inventory as it was in that revision
855
file_id = tree.inventory.path2id(file)
858
revno = self.revision_id_to_revno(revision_id)
859
except errors.NoSuchRevision:
860
# TODO: This should not be BzrError,
861
# but NoSuchFile doesn't fit either
862
raise BzrError('%r is not present in revision %s'
863
% (file, revision_id))
865
raise BzrError('%r is not present in revision %s'
867
tree.print_file(file_id)
870
def append_revision(self, *revision_ids):
871
"""See Branch.append_revision."""
872
for revision_id in revision_ids:
873
mutter("add {%s} to revision-history" % revision_id)
874
rev_history = self.revision_history()
875
rev_history.extend(revision_ids)
876
self.set_revision_history(rev_history)
879
def set_revision_history(self, rev_history):
880
"""See Branch.set_revision_history."""
881
old_revision = self.last_revision()
882
new_revision = rev_history[-1]
883
self.put_controlfile('revision-history', '\n'.join(rev_history))
885
self.working_tree().set_last_revision(new_revision, old_revision)
886
except NoWorkingTree:
887
mutter('Unable to set_last_revision without a working tree.')
889
def has_revision(self, revision_id):
890
"""See Branch.has_revision."""
891
return (revision_id is None
892
or self.revision_store.has_id(revision_id))
895
def _get_revision_xml_file(self, revision_id):
896
if not revision_id or not isinstance(revision_id, basestring):
897
raise InvalidRevisionId(revision_id=revision_id, branch=self)
899
return self.revision_store.get(revision_id)
900
except (IndexError, KeyError):
901
raise bzrlib.errors.NoSuchRevision(self, revision_id)
903
def get_revision_xml(self, revision_id):
904
"""See Branch.get_revision_xml."""
905
return self._get_revision_xml_file(revision_id).read()
907
def get_revision(self, revision_id):
908
"""See Branch.get_revision."""
909
xml_file = self._get_revision_xml_file(revision_id)
912
r = bzrlib.xml5.serializer_v5.read_revision(xml_file)
913
except SyntaxError, e:
914
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
918
assert r.revision_id == revision_id
921
def get_revision_sha1(self, revision_id):
922
"""See Branch.get_revision_sha1."""
923
# In the future, revision entries will be signed. At that
924
# point, it is probably best *not* to include the signature
925
# in the revision hash. Because that lets you re-sign
926
# the revision, (add signatures/remove signatures) and still
927
# have all hash pointers stay consistent.
928
# But for now, just hash the contents.
929
return bzrlib.osutils.sha_file(self.get_revision_xml_file(revision_id))
931
def get_ancestry(self, revision_id):
932
"""See Branch.get_ancestry."""
933
if revision_id is None:
935
w = self._get_inventory_weave()
936
return [None] + map(w.idx_to_name,
937
w.inclusions([w.lookup(revision_id)]))
939
def _get_inventory_weave(self):
940
return self.control_weaves.get_weave('inventory',
941
self.get_transaction())
943
def get_inventory(self, revision_id):
944
"""See Branch.get_inventory."""
945
xml = self.get_inventory_xml(revision_id)
946
return bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
948
def get_inventory_xml(self, revision_id):
949
"""See Branch.get_inventory_xml."""
951
assert isinstance(revision_id, basestring), type(revision_id)
952
iw = self._get_inventory_weave()
953
return iw.get_text(iw.lookup(revision_id))
955
raise bzrlib.errors.HistoryMissing(self, 'inventory', revision_id)
957
def get_inventory_sha1(self, revision_id):
958
"""See Branch.get_inventory_sha1."""
959
return self.get_revision(revision_id).inventory_sha1
961
def get_revision_inventory(self, revision_id):
962
"""See Branch.get_revision_inventory."""
963
# TODO: Unify this with get_inventory()
964
# bzr 0.0.6 and later imposes the constraint that the inventory_id
965
# must be the same as its revision, so this is trivial.
966
if revision_id == None:
967
# This does not make sense: if there is no revision,
968
# then it is the current tree inventory surely ?!
969
# and thus get_root_id() is something that looks at the last
970
# commit on the branch, and the get_root_id is an inventory check.
971
raise NotImplementedError
972
# return Inventory(self.get_root_id())
974
return self.get_inventory(revision_id)
977
def revision_history(self):
978
"""See Branch.revision_history."""
979
transaction = self.get_transaction()
980
history = transaction.map.find_revision_history()
981
if history is not None:
982
mutter("cache hit for revision-history in %s", self)
984
history = [l.rstrip('\r\n') for l in
985
self.controlfile('revision-history', 'r').readlines()]
986
transaction.map.add_revision_history(history)
987
# this call is disabled because revision_history is
988
# not really an object yet, and the transaction is for objects.
989
# transaction.register_clean(history, precious=True)
992
def update_revisions(self, other, stop_revision=None):
993
"""See Branch.update_revisions."""
994
from bzrlib.fetch import greedy_fetch
995
if stop_revision is None:
996
stop_revision = other.last_revision()
997
### Should this be checking is_ancestor instead of revision_history?
998
if (stop_revision is not None and
999
stop_revision in self.revision_history()):
1001
greedy_fetch(to_branch=self, from_branch=other,
1002
revision=stop_revision)
1003
pullable_revs = self.pullable_revisions(other, stop_revision)
1004
if len(pullable_revs) > 0:
1005
self.append_revision(*pullable_revs)
1007
def pullable_revisions(self, other, stop_revision):
1008
"""See Branch.pullable_revisions."""
1009
other_revno = other.revision_id_to_revno(stop_revision)
1011
return self.missing_revisions(other, other_revno)
1012
except DivergedBranches, e:
1014
pullable_revs = get_intervening_revisions(self.last_revision(),
1015
stop_revision, self)
1016
assert self.last_revision() not in pullable_revs
1017
return pullable_revs
1018
except bzrlib.errors.NotAncestor:
1019
if is_ancestor(self.last_revision(), stop_revision, self):
1024
def revision_tree(self, revision_id):
1025
"""See Branch.revision_tree."""
1026
# TODO: refactor this to use an existing revision object
1027
# so we don't need to read it in twice.
1028
if revision_id == None or revision_id == NULL_REVISION:
1031
inv = self.get_revision_inventory(revision_id)
1032
return RevisionTree(self, inv, revision_id)
1034
def basis_tree(self):
1035
"""See Branch.basis_tree."""
1037
revision_id = self.revision_history()[-1]
1038
xml = self.working_tree().read_basis_inventory(revision_id)
1039
inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
1040
return RevisionTree(self, inv, revision_id)
1041
except (IndexError, NoSuchFile, NoWorkingTree), e:
1042
return self.revision_tree(self.last_revision())
1044
def working_tree(self):
1045
"""See Branch.working_tree."""
1046
from bzrlib.workingtree import WorkingTree
1047
if self._transport.base.find('://') != -1:
1048
raise NoWorkingTree(self.base)
1049
return WorkingTree(self.base, branch=self)
1052
def pull(self, source, overwrite=False):
1053
"""See Branch.pull."""
1056
old_count = len(self.revision_history())
1058
self.update_revisions(source)
1059
except DivergedBranches:
1063
self.set_revision_history(source.revision_history())
1064
new_count = len(self.revision_history())
1065
return new_count - old_count
1069
def get_parent(self):
1070
"""See Branch.get_parent."""
1072
_locs = ['parent', 'pull', 'x-pull']
1075
return self.controlfile(l, 'r').read().strip('\n')
1080
def get_push_location(self):
1081
"""See Branch.get_push_location."""
1082
config = bzrlib.config.BranchConfig(self)
1083
push_loc = config.get_user_option('push_location')
1086
def set_push_location(self, location):
1087
"""See Branch.set_push_location."""
1088
config = bzrlib.config.LocationConfig(self.base)
1089
config.set_user_option('push_location', location)
1092
def set_parent(self, url):
1093
"""See Branch.set_parent."""
1094
# TODO: Maybe delete old location files?
1095
from bzrlib.atomicfile import AtomicFile
1096
f = AtomicFile(self.controlfilename('parent'))
1103
def tree_config(self):
1104
return TreeConfig(self)
1106
def sign_revision(self, revision_id, gpg_strategy):
1107
"""See Branch.sign_revision."""
1108
plaintext = Testament.from_revision(self, revision_id).as_short_text()
1109
self.store_revision_signature(gpg_strategy, plaintext, revision_id)
1112
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1113
"""See Branch.store_revision_signature."""
1114
self.revision_store.add(StringIO(gpg_strategy.sign(plaintext)),
1118
class ScratchBranch(BzrBranch):
1119
"""Special test class: a branch that cleans up after itself.
1121
>>> b = ScratchBranch()
1125
>>> b._transport.__del__()
1130
def __init__(self, files=[], dirs=[], transport=None):
1131
"""Make a test branch.
1133
This creates a temporary directory and runs init-tree in it.
1135
If any files are listed, they are created in the working copy.
1137
if transport is None:
1138
transport = bzrlib.transport.local.ScratchTransport()
1139
super(ScratchBranch, self).__init__(transport, init=True)
1141
super(ScratchBranch, self).__init__(transport)
1144
self._transport.mkdir(d)
1147
self._transport.put(f, 'content of %s' % f)
1152
>>> orig = ScratchBranch(files=["file1", "file2"])
1153
>>> clone = orig.clone()
1154
>>> if os.name != 'nt':
1155
... os.path.samefile(orig.base, clone.base)
1157
... orig.base == clone.base
1160
>>> os.path.isfile(pathjoin(clone.base, "file1"))
1163
from shutil import copytree
1164
from bzrlib.osutils import mkdtemp
1167
copytree(self.base, base, symlinks=True)
1168
return ScratchBranch(
1169
transport=bzrlib.transport.local.ScratchTransport(base))
1172
######################################################################
1176
def is_control_file(filename):
1177
## FIXME: better check
1178
filename = normpath(filename)
1179
while filename != '':
1180
head, tail = os.path.split(filename)
1181
## mutter('check %r for control file' % ((head, tail), ))
1182
if tail == bzrlib.BZRDIR:
1184
if filename == head:
added
removed
bzrlib/branch.py
