1
# Copyright (C) 2005, 2006 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
18
from cStringIO import StringIO
20
from bzrlib.lazy_import import lazy_import
21
lazy_import(globals(), """
22
from copy import deepcopy
23
from unittest import TestSuite
24
from warnings import warn
34
revision as _mod_revision,
40
from bzrlib.config import BranchConfig, TreeConfig
41
from bzrlib.lockable_files import LockableFiles, TransportLock
44
from bzrlib.decorators import needs_read_lock, needs_write_lock
45
from bzrlib.errors import (BzrError, BzrCheckError, DivergedBranches,
46
HistoryMissing, InvalidRevisionId,
47
InvalidRevisionNumber, LockError, NoSuchFile,
48
NoSuchRevision, NoWorkingTree, NotVersionedError,
49
NotBranchError, UninitializableFormat,
50
UnlistableStore, UnlistableBranch,
52
from bzrlib.symbol_versioning import (deprecated_function,
56
zero_eight, zero_nine,
58
from bzrlib.trace import mutter, note
61
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
62
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
63
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
66
# TODO: Maybe include checks for common corruption of newlines, etc?
68
# TODO: Some operations like log might retrieve the same revisions
69
# repeatedly to calculate deltas. We could perhaps have a weakref
70
# cache in memory to make this faster. In general anything can be
71
# cached in memory between lock and unlock operations. .. nb thats
72
# what the transaction identity map provides
75
######################################################################
79
"""Branch holding a history of revisions.
82
Base directory/url of the branch.
84
# this is really an instance variable - FIXME move it there
88
def __init__(self, *ignored, **ignored_too):
89
raise NotImplementedError('The Branch class is abstract')
92
"""Break a lock if one is present from another instance.
94
Uses the ui factory to ask for confirmation if the lock may be from
97
This will probe the repository for its lock as well.
99
self.control_files.break_lock()
100
self.repository.break_lock()
101
master = self.get_master_branch()
102
if master is not None:
106
@deprecated_method(zero_eight)
107
def open_downlevel(base):
108
"""Open a branch which may be of an old format."""
109
return Branch.open(base, _unsupported=True)
112
def open(base, _unsupported=False):
113
"""Open the branch rooted at base.
115
For instance, if the branch is at URL/.bzr/branch,
116
Branch.open(URL) -> a Branch instance.
118
control = bzrdir.BzrDir.open(base, _unsupported)
119
return control.open_branch(_unsupported)
122
def open_containing(url):
123
"""Open an existing branch which contains url.
125
This probes for a branch at url, and searches upwards from there.
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 and it is either an unrecognised format or an unsupported
130
format, UnknownFormatError or UnsupportedFormatError are raised.
131
If there is one, it is returned, along with the unused portion of url.
133
control, relpath = bzrdir.BzrDir.open_containing(url)
134
return control.open_branch(), relpath
137
@deprecated_function(zero_eight)
138
def initialize(base):
139
"""Create a new working tree and branch, rooted at 'base' (url)
141
NOTE: This will soon be deprecated in favour of creation
144
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
146
@deprecated_function(zero_eight)
147
def setup_caching(self, cache_root):
148
"""Subclasses that care about caching should override this, and set
149
up cached stores located under cache_root.
151
NOTE: This is unused.
155
def get_config(self):
156
return BranchConfig(self)
159
return self.get_config().get_nickname()
161
def _set_nick(self, nick):
162
self.get_config().set_user_option('nickname', nick)
164
nick = property(_get_nick, _set_nick)
167
raise NotImplementedError(self.is_locked)
169
def lock_write(self):
170
raise NotImplementedError(self.lock_write)
173
raise NotImplementedError(self.lock_read)
176
raise NotImplementedError(self.unlock)
178
def peek_lock_mode(self):
179
"""Return lock mode for the Branch: 'r', 'w' or None"""
180
raise NotImplementedError(self.peek_lock_mode)
182
def get_physical_lock_status(self):
183
raise NotImplementedError(self.get_physical_lock_status)
185
def abspath(self, name):
186
"""Return absolute filename for something in the branch
188
XXX: Robert Collins 20051017 what is this used for? why is it a branch
189
method and not a tree method.
191
raise NotImplementedError(self.abspath)
193
def bind(self, other):
194
"""Bind the local branch the other branch.
196
:param other: The branch to bind to
199
raise errors.UpgradeRequired(self.base)
202
def fetch(self, from_branch, last_revision=None, pb=None):
203
"""Copy revisions from from_branch into this branch.
205
:param from_branch: Where to copy from.
206
:param last_revision: What revision to stop at (None for at the end
208
:param pb: An optional progress bar to use.
210
Returns the copied revision count and the failed revisions in a tuple:
213
if self.base == from_branch.base:
216
nested_pb = ui.ui_factory.nested_progress_bar()
221
from_branch.lock_read()
223
if last_revision is None:
224
pb.update('get source history')
225
from_history = from_branch.revision_history()
227
last_revision = from_history[-1]
229
# no history in the source branch
230
last_revision = _mod_revision.NULL_REVISION
231
return self.repository.fetch(from_branch.repository,
232
revision_id=last_revision,
235
if nested_pb is not None:
239
def get_bound_location(self):
240
"""Return the URL of the branch we are bound to.
242
Older format branches cannot bind, please be sure to use a metadir
247
def get_commit_builder(self, parents, config=None, timestamp=None,
248
timezone=None, committer=None, revprops=None,
250
"""Obtain a CommitBuilder for this branch.
252
:param parents: Revision ids of the parents of the new revision.
253
:param config: Optional configuration to use.
254
:param timestamp: Optional timestamp recorded for commit.
255
:param timezone: Optional timezone for timestamp.
256
:param committer: Optional committer to set for commit.
257
:param revprops: Optional dictionary of revision properties.
258
:param revision_id: Optional revision id.
262
config = self.get_config()
264
return self.repository.get_commit_builder(self, parents, config,
265
timestamp, timezone, committer, revprops, revision_id)
267
def get_master_branch(self):
268
"""Return the branch we are bound to.
270
:return: Either a Branch, or None
274
def get_revision_delta(self, revno):
275
"""Return the delta for one revision.
277
The delta is relative to its mainline predecessor, or the
278
empty tree for revision 1.
280
assert isinstance(revno, int)
281
rh = self.revision_history()
282
if not (1 <= revno <= len(rh)):
283
raise InvalidRevisionNumber(revno)
284
return self.repository.get_revision_delta(rh[revno-1])
286
def get_root_id(self):
287
"""Return the id of this branches root"""
288
raise NotImplementedError(self.get_root_id)
290
def print_file(self, file, revision_id):
291
"""Print `file` to stdout."""
292
raise NotImplementedError(self.print_file)
294
def append_revision(self, *revision_ids):
295
raise NotImplementedError(self.append_revision)
297
def set_revision_history(self, rev_history):
298
raise NotImplementedError(self.set_revision_history)
300
def revision_history(self):
301
"""Return sequence of revision hashes on to this branch."""
302
raise NotImplementedError(self.revision_history)
305
"""Return current revision number for this branch.
307
That is equivalent to the number of revisions committed to
310
return len(self.revision_history())
313
"""Older format branches cannot bind or unbind."""
314
raise errors.UpgradeRequired(self.base)
316
def last_revision(self):
317
"""Return last revision id, or None"""
318
ph = self.revision_history()
324
def missing_revisions(self, other, stop_revision=None):
325
"""Return a list of new revisions that would perfectly fit.
327
If self and other have not diverged, return a list of the revisions
328
present in other, but missing from self.
330
self_history = self.revision_history()
331
self_len = len(self_history)
332
other_history = other.revision_history()
333
other_len = len(other_history)
334
common_index = min(self_len, other_len) -1
335
if common_index >= 0 and \
336
self_history[common_index] != other_history[common_index]:
337
raise DivergedBranches(self, other)
339
if stop_revision is None:
340
stop_revision = other_len
342
assert isinstance(stop_revision, int)
343
if stop_revision > other_len:
344
raise errors.NoSuchRevision(self, stop_revision)
345
return other_history[self_len:stop_revision]
347
def update_revisions(self, other, stop_revision=None):
348
"""Pull in new perfect-fit revisions.
350
:param other: Another Branch to pull from
351
:param stop_revision: Updated until the given revision
354
raise NotImplementedError(self.update_revisions)
356
def revision_id_to_revno(self, revision_id):
357
"""Given a revision id, return its revno"""
358
if revision_id is None:
360
history = self.revision_history()
362
return history.index(revision_id) + 1
364
raise bzrlib.errors.NoSuchRevision(self, revision_id)
366
def get_rev_id(self, revno, history=None):
367
"""Find the revision id of the specified revno."""
371
history = self.revision_history()
372
if revno <= 0 or revno > len(history):
373
raise bzrlib.errors.NoSuchRevision(self, revno)
374
return history[revno - 1]
376
def pull(self, source, overwrite=False, stop_revision=None):
377
raise NotImplementedError(self.pull)
379
def basis_tree(self):
380
"""Return `Tree` object for last revision."""
381
return self.repository.revision_tree(self.last_revision())
383
def rename_one(self, from_rel, to_rel):
386
This can change the directory or the filename or both.
388
raise NotImplementedError(self.rename_one)
390
def move(self, from_paths, to_name):
393
to_name must exist as a versioned directory.
395
If to_name exists and is a directory, the files are moved into
396
it, keeping their old names. If it is a directory,
398
Note that to_name is only the last component of the new name;
399
this doesn't change the directory.
401
This returns a list of (from_path, to_path) pairs for each
404
raise NotImplementedError(self.move)
406
def get_parent(self):
407
"""Return the parent location of the branch.
409
This is the default location for push/pull/missing. The usual
410
pattern is that the user can override it by specifying a
413
raise NotImplementedError(self.get_parent)
415
def get_submit_branch(self):
416
"""Return the submit location of the branch.
418
This is the default location for bundle. The usual
419
pattern is that the user can override it by specifying a
422
return self.get_config().get_user_option('submit_branch')
424
def set_submit_branch(self, location):
425
"""Return the submit location of the branch.
427
This is the default location for bundle. The usual
428
pattern is that the user can override it by specifying a
431
self.get_config().set_user_option('submit_branch', location)
433
def get_push_location(self):
434
"""Return the None or the location to push this branch to."""
435
raise NotImplementedError(self.get_push_location)
437
def set_push_location(self, location):
438
"""Set a new push location for this branch."""
439
raise NotImplementedError(self.set_push_location)
441
def set_parent(self, url):
442
raise NotImplementedError(self.set_parent)
446
"""Synchronise this branch with the master branch if any.
448
:return: None or the last_revision pivoted out during the update.
452
def check_revno(self, revno):
454
Check whether a revno corresponds to any revision.
455
Zero (the NULL revision) is considered valid.
458
self.check_real_revno(revno)
460
def check_real_revno(self, revno):
462
Check whether a revno corresponds to a real revision.
463
Zero (the NULL revision) is considered invalid
465
if revno < 1 or revno > self.revno():
466
raise InvalidRevisionNumber(revno)
469
def clone(self, *args, **kwargs):
470
"""Clone this branch into to_bzrdir preserving all semantic values.
472
revision_id: if not None, the revision history in the new branch will
473
be truncated to end with revision_id.
475
# for API compatibility, until 0.8 releases we provide the old api:
476
# def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
477
# after 0.8 releases, the *args and **kwargs should be changed:
478
# def clone(self, to_bzrdir, revision_id=None):
479
if (kwargs.get('to_location', None) or
480
kwargs.get('revision', None) or
481
kwargs.get('basis_branch', None) or
482
(len(args) and isinstance(args[0], basestring))):
483
# backwards compatibility api:
484
warn("Branch.clone() has been deprecated for BzrDir.clone() from"
485
" bzrlib 0.8.", DeprecationWarning, stacklevel=3)
488
basis_branch = args[2]
490
basis_branch = kwargs.get('basis_branch', None)
492
basis = basis_branch.bzrdir
497
revision_id = args[1]
499
revision_id = kwargs.get('revision', None)
504
# no default to raise if not provided.
505
url = kwargs.get('to_location')
506
return self.bzrdir.clone(url,
507
revision_id=revision_id,
508
basis=basis).open_branch()
510
# generate args by hand
512
revision_id = args[1]
514
revision_id = kwargs.get('revision_id', None)
518
# no default to raise if not provided.
519
to_bzrdir = kwargs.get('to_bzrdir')
520
result = self._format.initialize(to_bzrdir)
521
self.copy_content_into(result, revision_id=revision_id)
525
def sprout(self, to_bzrdir, revision_id=None):
526
"""Create a new line of development from the branch, into to_bzrdir.
528
revision_id: if not None, the revision history in the new branch will
529
be truncated to end with revision_id.
531
result = self._format.initialize(to_bzrdir)
532
self.copy_content_into(result, revision_id=revision_id)
533
result.set_parent(self.bzrdir.root_transport.base)
537
def copy_content_into(self, destination, revision_id=None):
538
"""Copy the content of self into destination.
540
revision_id: if not None, the revision history in the new branch will
541
be truncated to end with revision_id.
543
new_history = self.revision_history()
544
if revision_id is not None:
546
new_history = new_history[:new_history.index(revision_id) + 1]
548
rev = self.repository.get_revision(revision_id)
549
new_history = rev.get_history(self.repository)[1:]
550
destination.set_revision_history(new_history)
552
parent = self.get_parent()
553
except errors.InaccessibleParent, e:
554
mutter('parent was not accessible to copy: %s', e)
557
destination.set_parent(parent)
561
"""Check consistency of the branch.
563
In particular this checks that revisions given in the revision-history
564
do actually match up in the revision graph, and that they're all
565
present in the repository.
567
Callers will typically also want to check the repository.
569
:return: A BranchCheckResult.
571
mainline_parent_id = None
572
for revision_id in self.revision_history():
574
revision = self.repository.get_revision(revision_id)
575
except errors.NoSuchRevision, e:
576
raise errors.BzrCheckError("mainline revision {%s} not in repository"
578
# In general the first entry on the revision history has no parents.
579
# But it's not illegal for it to have parents listed; this can happen
580
# in imports from Arch when the parents weren't reachable.
581
if mainline_parent_id is not None:
582
if mainline_parent_id not in revision.parent_ids:
583
raise errors.BzrCheckError("previous revision {%s} not listed among "
585
% (mainline_parent_id, revision_id))
586
mainline_parent_id = revision_id
587
return BranchCheckResult(self)
589
def _get_checkout_format(self):
590
"""Return the most suitable metadir for a checkout of this branch.
591
Weaves are used if this branch's repostory uses weaves.
593
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
594
from bzrlib import repository
595
format = bzrdir.BzrDirMetaFormat1()
596
format.repository_format = repository.RepositoryFormat7()
598
format = self.repository.bzrdir.cloning_metadir()
601
def create_checkout(self, to_location, revision_id=None,
603
"""Create a checkout of a branch.
605
:param to_location: The url to produce the checkout at
606
:param revision_id: The revision to check out
607
:param lightweight: If True, produce a lightweight checkout, otherwise,
608
produce a bound branch (heavyweight checkout)
609
:return: The tree of the created checkout
611
t = transport.get_transport(to_location)
614
except errors.FileExists:
617
checkout = bzrdir.BzrDirMetaFormat1().initialize_on_transport(t)
618
BranchReferenceFormat().initialize(checkout, self)
620
format = self._get_checkout_format()
621
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
622
to_location, force_new_tree=False, format=format)
623
checkout = checkout_branch.bzrdir
624
checkout_branch.bind(self)
625
# pull up to the specified revision_id to set the initial
626
# branch tip correctly, and seed it with history.
627
checkout_branch.pull(self, stop_revision=revision_id)
628
return checkout.create_workingtree(revision_id)
631
class BranchFormat(object):
632
"""An encapsulation of the initialization and open routines for a format.
634
Formats provide three things:
635
* An initialization routine,
639
Formats are placed in an dict by their format string for reference
640
during branch opening. Its not required that these be instances, they
641
can be classes themselves with class methods - it simply depends on
642
whether state is needed for a given format or not.
644
Once a format is deprecated, just deprecate the initialize and open
645
methods on the format class. Do not deprecate the object, as the
646
object will be created every time regardless.
649
_default_format = None
650
"""The default format used for new branches."""
653
"""The known formats."""
656
def find_format(klass, a_bzrdir):
657
"""Return the format for the branch object in a_bzrdir."""
659
transport = a_bzrdir.get_branch_transport(None)
660
format_string = transport.get("format").read()
661
return klass._formats[format_string]
663
raise NotBranchError(path=transport.base)
665
raise errors.UnknownFormatError(format=format_string)
668
def get_default_format(klass):
669
"""Return the current default format."""
670
return klass._default_format
672
def get_format_string(self):
673
"""Return the ASCII format string that identifies this format."""
674
raise NotImplementedError(self.get_format_string)
676
def get_format_description(self):
677
"""Return the short format description for this format."""
678
raise NotImplementedError(self.get_format_string)
680
def initialize(self, a_bzrdir):
681
"""Create a branch of this format in a_bzrdir."""
682
raise NotImplementedError(self.initialize)
684
def is_supported(self):
685
"""Is this format supported?
687
Supported formats can be initialized and opened.
688
Unsupported formats may not support initialization or committing or
689
some other features depending on the reason for not being supported.
693
def open(self, a_bzrdir, _found=False):
694
"""Return the branch object for a_bzrdir
696
_found is a private parameter, do not use it. It is used to indicate
697
if format probing has already be done.
699
raise NotImplementedError(self.open)
702
def register_format(klass, format):
703
klass._formats[format.get_format_string()] = format
706
def set_default_format(klass, format):
707
klass._default_format = format
710
def unregister_format(klass, format):
711
assert klass._formats[format.get_format_string()] is format
712
del klass._formats[format.get_format_string()]
715
return self.get_format_string().rstrip()
718
class BzrBranchFormat4(BranchFormat):
719
"""Bzr branch format 4.
722
- a revision-history file.
723
- a branch-lock lock file [ to be shared with the bzrdir ]
726
def get_format_description(self):
727
"""See BranchFormat.get_format_description()."""
728
return "Branch format 4"
730
def initialize(self, a_bzrdir):
731
"""Create a branch of this format in a_bzrdir."""
732
mutter('creating branch in %s', a_bzrdir.transport.base)
733
branch_transport = a_bzrdir.get_branch_transport(self)
734
utf8_files = [('revision-history', ''),
737
control_files = lockable_files.LockableFiles(branch_transport,
738
'branch-lock', lockable_files.TransportLock)
739
control_files.create_lock()
740
control_files.lock_write()
742
for file, content in utf8_files:
743
control_files.put_utf8(file, content)
745
control_files.unlock()
746
return self.open(a_bzrdir, _found=True)
749
super(BzrBranchFormat4, self).__init__()
750
self._matchingbzrdir = bzrdir.BzrDirFormat6()
752
def open(self, a_bzrdir, _found=False):
753
"""Return the branch object for a_bzrdir
755
_found is a private parameter, do not use it. It is used to indicate
756
if format probing has already be done.
759
# we are being called directly and must probe.
760
raise NotImplementedError
761
return BzrBranch(_format=self,
762
_control_files=a_bzrdir._control_files,
764
_repository=a_bzrdir.open_repository())
767
return "Bazaar-NG branch format 4"
770
class BzrBranchFormat5(BranchFormat):
771
"""Bzr branch format 5.
774
- a revision-history file.
776
- a lock dir guarding the branch itself
777
- all of this stored in a branch/ subdirectory
778
- works with shared repositories.
780
This format is new in bzr 0.8.
783
def get_format_string(self):
784
"""See BranchFormat.get_format_string()."""
785
return "Bazaar-NG branch format 5\n"
787
def get_format_description(self):
788
"""See BranchFormat.get_format_description()."""
789
return "Branch format 5"
791
def initialize(self, a_bzrdir):
792
"""Create a branch of this format in a_bzrdir."""
793
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
794
branch_transport = a_bzrdir.get_branch_transport(self)
795
utf8_files = [('revision-history', ''),
798
control_files = lockable_files.LockableFiles(branch_transport, 'lock',
800
control_files.create_lock()
801
control_files.lock_write()
802
control_files.put_utf8('format', self.get_format_string())
804
for file, content in utf8_files:
805
control_files.put_utf8(file, content)
807
control_files.unlock()
808
return self.open(a_bzrdir, _found=True, )
811
super(BzrBranchFormat5, self).__init__()
812
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
814
def open(self, a_bzrdir, _found=False):
815
"""Return the branch object for a_bzrdir
817
_found is a private parameter, do not use it. It is used to indicate
818
if format probing has already be done.
821
format = BranchFormat.find_format(a_bzrdir)
822
assert format.__class__ == self.__class__
824
transport = a_bzrdir.get_branch_transport(None)
825
control_files = lockable_files.LockableFiles(transport, 'lock',
827
return BzrBranch5(_format=self,
828
_control_files=control_files,
830
_repository=a_bzrdir.find_repository())
832
raise NotBranchError(path=transport.base)
835
return "Bazaar-NG Metadir branch format 5"
838
class BranchReferenceFormat(BranchFormat):
839
"""Bzr branch reference format.
841
Branch references are used in implementing checkouts, they
842
act as an alias to the real branch which is at some other url.
849
def get_format_string(self):
850
"""See BranchFormat.get_format_string()."""
851
return "Bazaar-NG Branch Reference Format 1\n"
853
def get_format_description(self):
854
"""See BranchFormat.get_format_description()."""
855
return "Checkout reference format 1"
857
def initialize(self, a_bzrdir, target_branch=None):
858
"""Create a branch of this format in a_bzrdir."""
859
if target_branch is None:
860
# this format does not implement branch itself, thus the implicit
861
# creation contract must see it as uninitializable
862
raise errors.UninitializableFormat(self)
863
mutter('creating branch reference in %s', a_bzrdir.transport.base)
864
branch_transport = a_bzrdir.get_branch_transport(self)
865
branch_transport.put_bytes('location',
866
target_branch.bzrdir.root_transport.base)
867
branch_transport.put_bytes('format', self.get_format_string())
868
return self.open(a_bzrdir, _found=True)
871
super(BranchReferenceFormat, self).__init__()
872
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
874
def _make_reference_clone_function(format, a_branch):
875
"""Create a clone() routine for a branch dynamically."""
876
def clone(to_bzrdir, revision_id=None):
877
"""See Branch.clone()."""
878
return format.initialize(to_bzrdir, a_branch)
879
# cannot obey revision_id limits when cloning a reference ...
880
# FIXME RBC 20060210 either nuke revision_id for clone, or
881
# emit some sort of warning/error to the caller ?!
884
def open(self, a_bzrdir, _found=False):
885
"""Return the branch that the branch reference in a_bzrdir points at.
887
_found is a private parameter, do not use it. It is used to indicate
888
if format probing has already be done.
891
format = BranchFormat.find_format(a_bzrdir)
892
assert format.__class__ == self.__class__
893
transport = a_bzrdir.get_branch_transport(None)
894
real_bzrdir = bzrdir.BzrDir.open(transport.get('location').read())
895
result = real_bzrdir.open_branch()
896
# this changes the behaviour of result.clone to create a new reference
897
# rather than a copy of the content of the branch.
898
# I did not use a proxy object because that needs much more extensive
899
# testing, and we are only changing one behaviour at the moment.
900
# If we decide to alter more behaviours - i.e. the implicit nickname
901
# then this should be refactored to introduce a tested proxy branch
902
# and a subclass of that for use in overriding clone() and ....
904
result.clone = self._make_reference_clone_function(result)
908
# formats which have no format string are not discoverable
909
# and not independently creatable, so are not registered.
910
__default_format = BzrBranchFormat5()
911
BranchFormat.register_format(__default_format)
912
BranchFormat.register_format(BranchReferenceFormat())
913
BranchFormat.set_default_format(__default_format)
914
_legacy_formats = [BzrBranchFormat4(),
917
class BzrBranch(Branch):
918
"""A branch stored in the actual filesystem.
920
Note that it's "local" in the context of the filesystem; it doesn't
921
really matter if it's on an nfs/smb/afs/coda/... share, as long as
922
it's writable, and can be accessed via the normal filesystem API.
925
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
926
relax_version_check=DEPRECATED_PARAMETER, _format=None,
927
_control_files=None, a_bzrdir=None, _repository=None):
928
"""Create new branch object at a particular location.
930
transport -- A Transport object, defining how to access files.
932
init -- If True, create new control files in a previously
933
unversioned directory. If False, the branch must already
936
relax_version_check -- If true, the usual check for the branch
937
version is not applied. This is intended only for
938
upgrade/recovery type use; it's not guaranteed that
939
all operations will work on old format branches.
942
self.bzrdir = bzrdir.BzrDir.open(transport.base)
944
self.bzrdir = a_bzrdir
945
self._transport = self.bzrdir.transport.clone('..')
946
self._base = self._transport.base
947
self._format = _format
948
if _control_files is None:
949
raise ValueError('BzrBranch _control_files is None')
950
self.control_files = _control_files
951
if deprecated_passed(init):
952
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
953
"deprecated as of bzr 0.8. Please use Branch.create().",
957
# this is slower than before deprecation, oh well never mind.
959
self._initialize(transport.base)
960
self._check_format(_format)
961
if deprecated_passed(relax_version_check):
962
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
963
"relax_version_check parameter is deprecated as of bzr 0.8. "
964
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
968
if (not relax_version_check
969
and not self._format.is_supported()):
970
raise errors.UnsupportedFormatError(format=fmt)
971
if deprecated_passed(transport):
972
warn("BzrBranch.__init__(transport=XXX...): The transport "
973
"parameter is deprecated as of bzr 0.8. "
974
"Please use Branch.open, or bzrdir.open_branch().",
977
self.repository = _repository
980
return '%s(%r)' % (self.__class__.__name__, self.base)
987
base = property(_get_base, doc="The URL for the root of this branch.")
989
def _finish_transaction(self):
990
"""Exit the current transaction."""
991
return self.control_files._finish_transaction()
993
def get_transaction(self):
994
"""Return the current active transaction.
996
If no transaction is active, this returns a passthrough object
997
for which all data is immediately flushed and no caching happens.
999
# this is an explicit function so that we can do tricky stuff
1000
# when the storage in rev_storage is elsewhere.
1001
# we probably need to hook the two 'lock a location' and
1002
# 'have a transaction' together more delicately, so that
1003
# we can have two locks (branch and storage) and one transaction
1004
# ... and finishing the transaction unlocks both, but unlocking
1005
# does not. - RBC 20051121
1006
return self.control_files.get_transaction()
1008
def _set_transaction(self, transaction):
1009
"""Set a new active transaction."""
1010
return self.control_files._set_transaction(transaction)
1012
def abspath(self, name):
1013
"""See Branch.abspath."""
1014
return self.control_files._transport.abspath(name)
1016
def _check_format(self, format):
1017
"""Identify the branch format if needed.
1019
The format is stored as a reference to the format object in
1020
self._format for code that needs to check it later.
1022
The format parameter is either None or the branch format class
1023
used to open this branch.
1025
FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
1028
format = BranchFormat.find_format(self.bzrdir)
1029
self._format = format
1030
mutter("got branch format %s", self._format)
1033
def get_root_id(self):
1034
"""See Branch.get_root_id."""
1035
tree = self.repository.revision_tree(self.last_revision())
1036
return tree.inventory.root.file_id
1038
def is_locked(self):
1039
return self.control_files.is_locked()
1041
def lock_write(self):
1042
self.repository.lock_write()
1044
self.control_files.lock_write()
1046
self.repository.unlock()
1049
def lock_read(self):
1050
self.repository.lock_read()
1052
self.control_files.lock_read()
1054
self.repository.unlock()
1058
# TODO: test for failed two phase locks. This is known broken.
1060
self.control_files.unlock()
1062
self.repository.unlock()
1064
def peek_lock_mode(self):
1065
if self.control_files._lock_count == 0:
1068
return self.control_files._lock_mode
1070
def get_physical_lock_status(self):
1071
return self.control_files.get_physical_lock_status()
1074
def print_file(self, file, revision_id):
1075
"""See Branch.print_file."""
1076
return self.repository.print_file(file, revision_id)
1079
def append_revision(self, *revision_ids):
1080
"""See Branch.append_revision."""
1081
for revision_id in revision_ids:
1082
mutter("add {%s} to revision-history" % revision_id)
1083
rev_history = self.revision_history()
1084
rev_history.extend(revision_ids)
1085
self.set_revision_history(rev_history)
1088
def set_revision_history(self, rev_history):
1089
"""See Branch.set_revision_history."""
1090
self.control_files.put_utf8(
1091
'revision-history', '\n'.join(rev_history))
1092
transaction = self.get_transaction()
1093
history = transaction.map.find_revision_history()
1094
if history is not None:
1095
# update the revision history in the identity map.
1096
history[:] = list(rev_history)
1097
# this call is disabled because revision_history is
1098
# not really an object yet, and the transaction is for objects.
1099
# transaction.register_dirty(history)
1101
transaction.map.add_revision_history(rev_history)
1102
# this call is disabled because revision_history is
1103
# not really an object yet, and the transaction is for objects.
1104
# transaction.register_clean(history)
1107
def revision_history(self):
1108
"""See Branch.revision_history."""
1109
transaction = self.get_transaction()
1110
history = transaction.map.find_revision_history()
1111
if history is not None:
1112
# mutter("cache hit for revision-history in %s", self)
1113
return list(history)
1114
decode_utf8 = cache_utf8.decode
1115
history = [decode_utf8(l.rstrip('\r\n')) for l in
1116
self.control_files.get('revision-history').readlines()]
1117
transaction.map.add_revision_history(history)
1118
# this call is disabled because revision_history is
1119
# not really an object yet, and the transaction is for objects.
1120
# transaction.register_clean(history, precious=True)
1121
return list(history)
1124
def generate_revision_history(self, revision_id, last_rev=None,
1126
"""Create a new revision history that will finish with revision_id.
1128
:param revision_id: the new tip to use.
1129
:param last_rev: The previous last_revision. If not None, then this
1130
must be a ancestory of revision_id, or DivergedBranches is raised.
1131
:param other_branch: The other branch that DivergedBranches should
1132
raise with respect to.
1134
# stop_revision must be a descendant of last_revision
1135
stop_graph = self.repository.get_revision_graph(revision_id)
1136
if last_rev is not None and last_rev not in stop_graph:
1137
# our previous tip is not merged into stop_revision
1138
raise errors.DivergedBranches(self, other_branch)
1139
# make a new revision history from the graph
1140
current_rev_id = revision_id
1142
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1143
new_history.append(current_rev_id)
1144
current_rev_id_parents = stop_graph[current_rev_id]
1146
current_rev_id = current_rev_id_parents[0]
1148
current_rev_id = None
1149
new_history.reverse()
1150
self.set_revision_history(new_history)
1153
def update_revisions(self, other, stop_revision=None):
1154
"""See Branch.update_revisions."""
1157
if stop_revision is None:
1158
stop_revision = other.last_revision()
1159
if stop_revision is None:
1160
# if there are no commits, we're done.
1162
# whats the current last revision, before we fetch [and change it
1164
last_rev = self.last_revision()
1165
# we fetch here regardless of whether we need to so that we pickup
1167
self.fetch(other, stop_revision)
1168
my_ancestry = self.repository.get_ancestry(last_rev)
1169
if stop_revision in my_ancestry:
1170
# last_revision is a descendant of stop_revision
1172
self.generate_revision_history(stop_revision, last_rev=last_rev,
1177
def basis_tree(self):
1178
"""See Branch.basis_tree."""
1179
return self.repository.revision_tree(self.last_revision())
1181
@deprecated_method(zero_eight)
1182
def working_tree(self):
1183
"""Create a Working tree object for this branch."""
1185
from bzrlib.transport.local import LocalTransport
1186
if (self.base.find('://') != -1 or
1187
not isinstance(self._transport, LocalTransport)):
1188
raise NoWorkingTree(self.base)
1189
return self.bzrdir.open_workingtree()
1192
def pull(self, source, overwrite=False, stop_revision=None):
1193
"""See Branch.pull."""
1196
old_count = len(self.revision_history())
1198
self.update_revisions(source, stop_revision)
1199
except DivergedBranches:
1203
self.set_revision_history(source.revision_history())
1204
new_count = len(self.revision_history())
1205
return new_count - old_count
1209
def get_parent(self):
1210
"""See Branch.get_parent."""
1212
_locs = ['parent', 'pull', 'x-pull']
1213
assert self.base[-1] == '/'
1216
parent = self.control_files.get(l).read().strip('\n')
1219
# This is an old-format absolute path to a local branch
1220
# turn it into a url
1221
if parent.startswith('/'):
1222
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1224
return urlutils.join(self.base[:-1], parent)
1225
except errors.InvalidURLJoin, e:
1226
raise errors.InaccessibleParent(parent, self.base)
1229
def get_push_location(self):
1230
"""See Branch.get_push_location."""
1231
push_loc = self.get_config().get_user_option('push_location')
1234
def set_push_location(self, location):
1235
"""See Branch.set_push_location."""
1236
self.get_config().set_user_option('push_location', location,
1240
def set_parent(self, url):
1241
"""See Branch.set_parent."""
1242
# TODO: Maybe delete old location files?
1243
# URLs should never be unicode, even on the local fs,
1244
# FIXUP this and get_parent in a future branch format bump:
1245
# read and rewrite the file, and have the new format code read
1246
# using .get not .get_utf8. RBC 20060125
1248
self.control_files._transport.delete('parent')
1250
if isinstance(url, unicode):
1252
url = url.encode('ascii')
1253
except UnicodeEncodeError:
1254
raise bzrlib.errors.InvalidURL(url,
1255
"Urls must be 7-bit ascii, "
1256
"use bzrlib.urlutils.escape")
1258
url = urlutils.relative_url(self.base, url)
1259
self.control_files.put('parent', StringIO(url + '\n'))
1261
@deprecated_function(zero_nine)
1262
def tree_config(self):
1263
"""DEPRECATED; call get_config instead.
1264
TreeConfig has become part of BranchConfig."""
1265
return TreeConfig(self)
1268
class BzrBranch5(BzrBranch):
1269
"""A format 5 branch. This supports new features over plan branches.
1271
It has support for a master_branch which is the data for bound branches.
1279
super(BzrBranch5, self).__init__(_format=_format,
1280
_control_files=_control_files,
1282
_repository=_repository)
1285
def pull(self, source, overwrite=False, stop_revision=None):
1286
"""Updates branch.pull to be bound branch aware."""
1287
bound_location = self.get_bound_location()
1288
if source.base != bound_location:
1289
# not pulling from master, so we need to update master.
1290
master_branch = self.get_master_branch()
1292
master_branch.pull(source)
1293
source = master_branch
1294
return super(BzrBranch5, self).pull(source, overwrite, stop_revision)
1296
def get_bound_location(self):
1298
return self.control_files.get_utf8('bound').read()[:-1]
1299
except errors.NoSuchFile:
1303
def get_master_branch(self):
1304
"""Return the branch we are bound to.
1306
:return: Either a Branch, or None
1308
This could memoise the branch, but if thats done
1309
it must be revalidated on each new lock.
1310
So for now we just don't memoise it.
1311
# RBC 20060304 review this decision.
1313
bound_loc = self.get_bound_location()
1317
return Branch.open(bound_loc)
1318
except (errors.NotBranchError, errors.ConnectionError), e:
1319
raise errors.BoundBranchConnectionFailure(
1323
def set_bound_location(self, location):
1324
"""Set the target where this branch is bound to.
1326
:param location: URL to the target branch
1329
self.control_files.put_utf8('bound', location+'\n')
1332
self.control_files._transport.delete('bound')
1338
def bind(self, other):
1339
"""Bind this branch to the branch other.
1341
This does not push or pull data between the branches, though it does
1342
check for divergence to raise an error when the branches are not
1343
either the same, or one a prefix of the other. That behaviour may not
1344
be useful, so that check may be removed in future.
1346
:param other: The branch to bind to
1349
# TODO: jam 20051230 Consider checking if the target is bound
1350
# It is debatable whether you should be able to bind to
1351
# a branch which is itself bound.
1352
# Committing is obviously forbidden,
1353
# but binding itself may not be.
1354
# Since we *have* to check at commit time, we don't
1355
# *need* to check here
1357
# we want to raise diverged if:
1358
# last_rev is not in the other_last_rev history, AND
1359
# other_last_rev is not in our history, and do it without pulling
1361
last_rev = self.last_revision()
1362
if last_rev is not None:
1365
other_last_rev = other.last_revision()
1366
if other_last_rev is not None:
1367
# neither branch is new, we have to do some work to
1368
# ascertain diversion.
1369
remote_graph = other.repository.get_revision_graph(
1371
local_graph = self.repository.get_revision_graph(last_rev)
1372
if (last_rev not in remote_graph and
1373
other_last_rev not in local_graph):
1374
raise errors.DivergedBranches(self, other)
1377
self.set_bound_location(other.base)
1381
"""If bound, unbind"""
1382
return self.set_bound_location(None)
1386
"""Synchronise this branch with the master branch if any.
1388
:return: None or the last_revision that was pivoted out during the
1391
master = self.get_master_branch()
1392
if master is not None:
1393
old_tip = self.last_revision()
1394
self.pull(master, overwrite=True)
1395
if old_tip in self.repository.get_ancestry(self.last_revision()):
1401
class BranchTestProviderAdapter(object):
1402
"""A tool to generate a suite testing multiple branch formats at once.
1404
This is done by copying the test once for each transport and injecting
1405
the transport_server, transport_readonly_server, and branch_format
1406
classes into each copy. Each copy is also given a new id() to make it
1410
def __init__(self, transport_server, transport_readonly_server, formats):
1411
self._transport_server = transport_server
1412
self._transport_readonly_server = transport_readonly_server
1413
self._formats = formats
1415
def adapt(self, test):
1416
result = TestSuite()
1417
for branch_format, bzrdir_format in self._formats:
1418
new_test = deepcopy(test)
1419
new_test.transport_server = self._transport_server
1420
new_test.transport_readonly_server = self._transport_readonly_server
1421
new_test.bzrdir_format = bzrdir_format
1422
new_test.branch_format = branch_format
1423
def make_new_test_id():
1424
new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
1425
return lambda: new_id
1426
new_test.id = make_new_test_id()
1427
result.addTest(new_test)
1431
class BranchCheckResult(object):
1432
"""Results of checking branch consistency.
1437
def __init__(self, branch):
1438
self.branch = branch
1440
def report_results(self, verbose):
1441
"""Report the check results via trace.note.
1443
:param verbose: Requests more detailed display of what was checked,
1446
note('checked branch %s format %s',
1448
self.branch._format)
1451
######################################################################
1455
@deprecated_function(zero_eight)
1456
def is_control_file(*args, **kwargs):
1457
"""See bzrlib.workingtree.is_control_file."""
1458
return bzrlib.workingtree.is_control_file(*args, **kwargs)
added
removed
bzrlib/branch.py
