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
30
config as _mod_config,
35
revision as _mod_revision,
41
from bzrlib.config import BranchConfig, TreeConfig
42
from bzrlib.lockable_files import LockableFiles, TransportLock
45
from bzrlib.decorators import needs_read_lock, needs_write_lock
46
from bzrlib.errors import (BzrError, BzrCheckError, DivergedBranches,
47
HistoryMissing, InvalidRevisionId,
48
InvalidRevisionNumber, LockError, NoSuchFile,
49
NoSuchRevision, NoWorkingTree, NotVersionedError,
50
NotBranchError, UninitializableFormat,
51
UnlistableStore, UnlistableBranch,
53
from bzrlib.symbol_versioning import (deprecated_function,
57
zero_eight, zero_nine,
59
from bzrlib.trace import mutter, note
62
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
63
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
64
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
67
# TODO: Maybe include checks for common corruption of newlines, etc?
69
# TODO: Some operations like log might retrieve the same revisions
70
# repeatedly to calculate deltas. We could perhaps have a weakref
71
# cache in memory to make this faster. In general anything can be
72
# cached in memory between lock and unlock operations. .. nb thats
73
# what the transaction identity map provides
76
######################################################################
80
"""Branch holding a history of revisions.
83
Base directory/url of the branch.
85
hooks: An instance of BranchHooks.
87
# this is really an instance variable - FIXME move it there
91
def __init__(self, *ignored, **ignored_too):
92
raise NotImplementedError('The Branch class is abstract')
95
"""Break a lock if one is present from another instance.
97
Uses the ui factory to ask for confirmation if the lock may be from
100
This will probe the repository for its lock as well.
102
self.control_files.break_lock()
103
self.repository.break_lock()
104
master = self.get_master_branch()
105
if master is not None:
109
@deprecated_method(zero_eight)
110
def open_downlevel(base):
111
"""Open a branch which may be of an old format."""
112
return Branch.open(base, _unsupported=True)
115
def open(base, _unsupported=False):
116
"""Open the branch rooted at base.
118
For instance, if the branch is at URL/.bzr/branch,
119
Branch.open(URL) -> a Branch instance.
121
control = bzrdir.BzrDir.open(base, _unsupported)
122
return control.open_branch(_unsupported)
125
def open_containing(url):
126
"""Open an existing branch which contains url.
128
This probes for a branch at url, and searches upwards from there.
130
Basically we keep looking up until we find the control directory or
131
run into the root. If there isn't one, raises NotBranchError.
132
If there is one and it is either an unrecognised format or an unsupported
133
format, UnknownFormatError or UnsupportedFormatError are raised.
134
If there is one, it is returned, along with the unused portion of url.
136
control, relpath = bzrdir.BzrDir.open_containing(url)
137
return control.open_branch(), relpath
140
@deprecated_function(zero_eight)
141
def initialize(base):
142
"""Create a new working tree and branch, rooted at 'base' (url)
144
NOTE: This will soon be deprecated in favour of creation
147
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
149
@deprecated_function(zero_eight)
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
NOTE: This is unused.
158
def get_config(self):
159
return BranchConfig(self)
162
return self.get_config().get_nickname()
164
def _set_nick(self, nick):
165
self.get_config().set_user_option('nickname', nick)
167
nick = property(_get_nick, _set_nick)
170
raise NotImplementedError(self.is_locked)
172
def lock_write(self):
173
raise NotImplementedError(self.lock_write)
176
raise NotImplementedError(self.lock_read)
179
raise NotImplementedError(self.unlock)
181
def peek_lock_mode(self):
182
"""Return lock mode for the Branch: 'r', 'w' or None"""
183
raise NotImplementedError(self.peek_lock_mode)
185
def get_physical_lock_status(self):
186
raise NotImplementedError(self.get_physical_lock_status)
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(self.abspath)
196
def bind(self, other):
197
"""Bind the local branch the other branch.
199
:param other: The branch to bind to
202
raise errors.UpgradeRequired(self.base)
205
def fetch(self, from_branch, last_revision=None, pb=None):
206
"""Copy revisions from from_branch into this branch.
208
:param from_branch: Where to copy from.
209
:param last_revision: What revision to stop at (None for at the end
211
:param pb: An optional progress bar to use.
213
Returns the copied revision count and the failed revisions in a tuple:
216
if self.base == from_branch.base:
219
nested_pb = ui.ui_factory.nested_progress_bar()
224
from_branch.lock_read()
226
if last_revision is None:
227
pb.update('get source history')
228
from_history = from_branch.revision_history()
230
last_revision = from_history[-1]
232
# no history in the source branch
233
last_revision = _mod_revision.NULL_REVISION
234
return self.repository.fetch(from_branch.repository,
235
revision_id=last_revision,
238
if nested_pb is not None:
242
def get_bound_location(self):
243
"""Return the URL of the branch we are bound to.
245
Older format branches cannot bind, please be sure to use a metadir
250
def get_commit_builder(self, parents, config=None, timestamp=None,
251
timezone=None, committer=None, revprops=None,
253
"""Obtain a CommitBuilder for this branch.
255
:param parents: Revision ids of the parents of the new revision.
256
:param config: Optional configuration to use.
257
:param timestamp: Optional timestamp recorded for commit.
258
:param timezone: Optional timezone for timestamp.
259
:param committer: Optional committer to set for commit.
260
:param revprops: Optional dictionary of revision properties.
261
:param revision_id: Optional revision id.
265
config = self.get_config()
267
return self.repository.get_commit_builder(self, parents, config,
268
timestamp, timezone, committer, revprops, revision_id)
270
def get_master_branch(self):
271
"""Return the branch we are bound to.
273
:return: Either a Branch, or None
277
def get_revision_delta(self, revno):
278
"""Return the delta for one revision.
280
The delta is relative to its mainline predecessor, or the
281
empty tree for revision 1.
283
assert isinstance(revno, int)
284
rh = self.revision_history()
285
if not (1 <= revno <= len(rh)):
286
raise InvalidRevisionNumber(revno)
287
return self.repository.get_revision_delta(rh[revno-1])
289
def get_root_id(self):
290
"""Return the id of this branches root"""
291
raise NotImplementedError(self.get_root_id)
293
def print_file(self, file, revision_id):
294
"""Print `file` to stdout."""
295
raise NotImplementedError(self.print_file)
297
def append_revision(self, *revision_ids):
298
raise NotImplementedError(self.append_revision)
300
def set_revision_history(self, rev_history):
301
raise NotImplementedError(self.set_revision_history)
303
def revision_history(self):
304
"""Return sequence of revision hashes on to this branch."""
305
raise NotImplementedError(self.revision_history)
308
"""Return current revision number for this branch.
310
That is equivalent to the number of revisions committed to
313
return len(self.revision_history())
316
"""Older format branches cannot bind or unbind."""
317
raise errors.UpgradeRequired(self.base)
319
def last_revision(self):
320
"""Return last revision id, or None"""
321
ph = self.revision_history()
327
def missing_revisions(self, other, stop_revision=None):
328
"""Return a list of new revisions that would perfectly fit.
330
If self and other have not diverged, return a list of the revisions
331
present in other, but missing from self.
333
self_history = self.revision_history()
334
self_len = len(self_history)
335
other_history = other.revision_history()
336
other_len = len(other_history)
337
common_index = min(self_len, other_len) -1
338
if common_index >= 0 and \
339
self_history[common_index] != other_history[common_index]:
340
raise DivergedBranches(self, other)
342
if stop_revision is None:
343
stop_revision = other_len
345
assert isinstance(stop_revision, int)
346
if stop_revision > other_len:
347
raise errors.NoSuchRevision(self, stop_revision)
348
return other_history[self_len:stop_revision]
350
def update_revisions(self, other, stop_revision=None):
351
"""Pull in new perfect-fit revisions.
353
:param other: Another Branch to pull from
354
:param stop_revision: Updated until the given revision
357
raise NotImplementedError(self.update_revisions)
359
def revision_id_to_revno(self, revision_id):
360
"""Given a revision id, return its revno"""
361
if revision_id is None:
363
history = self.revision_history()
365
return history.index(revision_id) + 1
367
raise bzrlib.errors.NoSuchRevision(self, revision_id)
369
def get_rev_id(self, revno, history=None):
370
"""Find the revision id of the specified revno."""
374
history = self.revision_history()
375
if revno <= 0 or revno > len(history):
376
raise bzrlib.errors.NoSuchRevision(self, revno)
377
return history[revno - 1]
379
def pull(self, source, overwrite=False, stop_revision=None):
380
raise NotImplementedError(self.pull)
382
def basis_tree(self):
383
"""Return `Tree` object for last revision."""
384
return self.repository.revision_tree(self.last_revision())
386
def rename_one(self, from_rel, to_rel):
389
This can change the directory or the filename or both.
391
raise NotImplementedError(self.rename_one)
393
def move(self, from_paths, to_name):
396
to_name must exist as a versioned directory.
398
If to_name exists and is a directory, the files are moved into
399
it, keeping their old names. If it is a directory,
401
Note that to_name is only the last component of the new name;
402
this doesn't change the directory.
404
This returns a list of (from_path, to_path) pairs for each
407
raise NotImplementedError(self.move)
409
def get_parent(self):
410
"""Return the parent location of the branch.
412
This is the default location for push/pull/missing. The usual
413
pattern is that the user can override it by specifying a
416
raise NotImplementedError(self.get_parent)
418
def get_submit_branch(self):
419
"""Return the submit location of the branch.
421
This is the default location for bundle. The usual
422
pattern is that the user can override it by specifying a
425
return self.get_config().get_user_option('submit_branch')
427
def set_submit_branch(self, location):
428
"""Return the submit location of the branch.
430
This is the default location for bundle. The usual
431
pattern is that the user can override it by specifying a
434
self.get_config().set_user_option('submit_branch', location)
436
def get_push_location(self):
437
"""Return the None or the location to push this branch to."""
438
raise NotImplementedError(self.get_push_location)
440
def set_push_location(self, location):
441
"""Set a new push location for this branch."""
442
raise NotImplementedError(self.set_push_location)
444
def set_parent(self, url):
445
raise NotImplementedError(self.set_parent)
449
"""Synchronise this branch with the master branch if any.
451
:return: None or the last_revision pivoted out during the update.
455
def check_revno(self, revno):
457
Check whether a revno corresponds to any revision.
458
Zero (the NULL revision) is considered valid.
461
self.check_real_revno(revno)
463
def check_real_revno(self, revno):
465
Check whether a revno corresponds to a real revision.
466
Zero (the NULL revision) is considered invalid
468
if revno < 1 or revno > self.revno():
469
raise InvalidRevisionNumber(revno)
472
def clone(self, *args, **kwargs):
473
"""Clone this branch into to_bzrdir preserving all semantic values.
475
revision_id: if not None, the revision history in the new branch will
476
be truncated to end with revision_id.
478
# for API compatibility, until 0.8 releases we provide the old api:
479
# def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
480
# after 0.8 releases, the *args and **kwargs should be changed:
481
# def clone(self, to_bzrdir, revision_id=None):
482
if (kwargs.get('to_location', None) or
483
kwargs.get('revision', None) or
484
kwargs.get('basis_branch', None) or
485
(len(args) and isinstance(args[0], basestring))):
486
# backwards compatibility api:
487
warn("Branch.clone() has been deprecated for BzrDir.clone() from"
488
" bzrlib 0.8.", DeprecationWarning, stacklevel=3)
491
basis_branch = args[2]
493
basis_branch = kwargs.get('basis_branch', None)
495
basis = basis_branch.bzrdir
500
revision_id = args[1]
502
revision_id = kwargs.get('revision', None)
507
# no default to raise if not provided.
508
url = kwargs.get('to_location')
509
return self.bzrdir.clone(url,
510
revision_id=revision_id,
511
basis=basis).open_branch()
513
# generate args by hand
515
revision_id = args[1]
517
revision_id = kwargs.get('revision_id', None)
521
# no default to raise if not provided.
522
to_bzrdir = kwargs.get('to_bzrdir')
523
result = self._format.initialize(to_bzrdir)
524
self.copy_content_into(result, revision_id=revision_id)
528
def sprout(self, to_bzrdir, revision_id=None):
529
"""Create a new line of development from the branch, into to_bzrdir.
531
revision_id: if not None, the revision history in the new branch will
532
be truncated to end with revision_id.
534
result = self._format.initialize(to_bzrdir)
535
self.copy_content_into(result, revision_id=revision_id)
536
result.set_parent(self.bzrdir.root_transport.base)
540
def copy_content_into(self, destination, revision_id=None):
541
"""Copy the content of self into destination.
543
revision_id: if not None, the revision history in the new branch will
544
be truncated to end with revision_id.
546
new_history = self.revision_history()
547
if revision_id is not None:
549
new_history = new_history[:new_history.index(revision_id) + 1]
551
rev = self.repository.get_revision(revision_id)
552
new_history = rev.get_history(self.repository)[1:]
553
destination.set_revision_history(new_history)
555
parent = self.get_parent()
556
except errors.InaccessibleParent, e:
557
mutter('parent was not accessible to copy: %s', e)
560
destination.set_parent(parent)
564
"""Check consistency of the branch.
566
In particular this checks that revisions given in the revision-history
567
do actually match up in the revision graph, and that they're all
568
present in the repository.
570
Callers will typically also want to check the repository.
572
:return: A BranchCheckResult.
574
mainline_parent_id = None
575
for revision_id in self.revision_history():
577
revision = self.repository.get_revision(revision_id)
578
except errors.NoSuchRevision, e:
579
raise errors.BzrCheckError("mainline revision {%s} not in repository"
581
# In general the first entry on the revision history has no parents.
582
# But it's not illegal for it to have parents listed; this can happen
583
# in imports from Arch when the parents weren't reachable.
584
if mainline_parent_id is not None:
585
if mainline_parent_id not in revision.parent_ids:
586
raise errors.BzrCheckError("previous revision {%s} not listed among "
588
% (mainline_parent_id, revision_id))
589
mainline_parent_id = revision_id
590
return BranchCheckResult(self)
592
def _get_checkout_format(self):
593
"""Return the most suitable metadir for a checkout of this branch.
594
Weaves are used if this branch's repostory uses weaves.
596
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
597
from bzrlib import repository
598
format = bzrdir.BzrDirMetaFormat1()
599
format.repository_format = repository.RepositoryFormat7()
601
format = self.repository.bzrdir.cloning_metadir()
604
def create_checkout(self, to_location, revision_id=None,
606
"""Create a checkout of a branch.
608
:param to_location: The url to produce the checkout at
609
:param revision_id: The revision to check out
610
:param lightweight: If True, produce a lightweight checkout, otherwise,
611
produce a bound branch (heavyweight checkout)
612
:return: The tree of the created checkout
614
t = transport.get_transport(to_location)
617
except errors.FileExists:
620
checkout = bzrdir.BzrDirMetaFormat1().initialize_on_transport(t)
621
BranchReferenceFormat().initialize(checkout, self)
623
format = self._get_checkout_format()
624
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
625
to_location, force_new_tree=False, format=format)
626
checkout = checkout_branch.bzrdir
627
checkout_branch.bind(self)
628
# pull up to the specified revision_id to set the initial
629
# branch tip correctly, and seed it with history.
630
checkout_branch.pull(self, stop_revision=revision_id)
631
return checkout.create_workingtree(revision_id)
634
class BranchFormat(object):
635
"""An encapsulation of the initialization and open routines for a format.
637
Formats provide three things:
638
* An initialization routine,
642
Formats are placed in an dict by their format string for reference
643
during branch opening. Its not required that these be instances, they
644
can be classes themselves with class methods - it simply depends on
645
whether state is needed for a given format or not.
647
Once a format is deprecated, just deprecate the initialize and open
648
methods on the format class. Do not deprecate the object, as the
649
object will be created every time regardless.
652
_default_format = None
653
"""The default format used for new branches."""
656
"""The known formats."""
659
def find_format(klass, a_bzrdir):
660
"""Return the format for the branch object in a_bzrdir."""
662
transport = a_bzrdir.get_branch_transport(None)
663
format_string = transport.get("format").read()
664
return klass._formats[format_string]
666
raise NotBranchError(path=transport.base)
668
raise errors.UnknownFormatError(format=format_string)
671
def get_default_format(klass):
672
"""Return the current default format."""
673
return klass._default_format
675
def get_format_string(self):
676
"""Return the ASCII format string that identifies this format."""
677
raise NotImplementedError(self.get_format_string)
679
def get_format_description(self):
680
"""Return the short format description for this format."""
681
raise NotImplementedError(self.get_format_string)
683
def get_reference(self, a_bzrdir):
684
"""Get the target reference of the branch in a_bzrdir.
686
format probing must have been completed before calling
687
this method - it is assumed that the format of the branch
688
in a_bzrdir is correct.
690
:param a_bzrdir: The bzrdir to get the branch data from.
691
:return: None if the branch is not a reference branch.
695
def initialize(self, a_bzrdir):
696
"""Create a branch of this format in a_bzrdir."""
697
raise NotImplementedError(self.initialize)
699
def is_supported(self):
700
"""Is this format supported?
702
Supported formats can be initialized and opened.
703
Unsupported formats may not support initialization or committing or
704
some other features depending on the reason for not being supported.
708
def open(self, a_bzrdir, _found=False):
709
"""Return the branch object for a_bzrdir
711
_found is a private parameter, do not use it. It is used to indicate
712
if format probing has already be done.
714
raise NotImplementedError(self.open)
717
def register_format(klass, format):
718
klass._formats[format.get_format_string()] = format
721
def set_default_format(klass, format):
722
klass._default_format = format
725
def unregister_format(klass, format):
726
assert klass._formats[format.get_format_string()] is format
727
del klass._formats[format.get_format_string()]
730
return self.get_format_string().rstrip()
733
class BranchHooks(dict):
734
"""A dictionary mapping hook name to a list of callables for branch hooks.
736
e.g. ['set_rh'] Is the list of items to be called when the
737
set_revision_history function is invoked.
741
"""Create the default hooks.
743
These are all empty initially, because by default nothing should get
747
# invoked whenever the revision history has been set
748
# with set_revision_history. The api signature is
749
# (branch, revision_history), and the branch will
750
# be write-locked. Introduced in 0.15.
753
def install_hook(self, hook_name, a_callable):
754
"""Install a_callable in to the hook hook_name.
756
:param hook_name: A hook name. See the __init__ method of BranchHooks
757
for the complete list of hooks.
758
:param a_callable: The callable to be invoked when the hook triggers.
759
The exact signature will depend on the hook - see the __init__
760
method of BranchHooks for details on each hook.
763
self[hook_name].append(a_callable)
765
raise errors.UnknownHook('branch', hook_name)
768
# install the default hooks into the Branch class.
769
Branch.hooks = BranchHooks()
772
class BzrBranchFormat4(BranchFormat):
773
"""Bzr branch format 4.
776
- a revision-history file.
777
- a branch-lock lock file [ to be shared with the bzrdir ]
780
def get_format_description(self):
781
"""See BranchFormat.get_format_description()."""
782
return "Branch format 4"
784
def initialize(self, a_bzrdir):
785
"""Create a branch of this format in a_bzrdir."""
786
mutter('creating branch in %s', a_bzrdir.transport.base)
787
branch_transport = a_bzrdir.get_branch_transport(self)
788
utf8_files = [('revision-history', ''),
791
control_files = lockable_files.LockableFiles(branch_transport,
792
'branch-lock', lockable_files.TransportLock)
793
control_files.create_lock()
794
control_files.lock_write()
796
for file, content in utf8_files:
797
control_files.put_utf8(file, content)
799
control_files.unlock()
800
return self.open(a_bzrdir, _found=True)
803
super(BzrBranchFormat4, self).__init__()
804
self._matchingbzrdir = bzrdir.BzrDirFormat6()
806
def open(self, a_bzrdir, _found=False):
807
"""Return the branch object for a_bzrdir
809
_found is a private parameter, do not use it. It is used to indicate
810
if format probing has already be done.
813
# we are being called directly and must probe.
814
raise NotImplementedError
815
return BzrBranch(_format=self,
816
_control_files=a_bzrdir._control_files,
818
_repository=a_bzrdir.open_repository())
821
return "Bazaar-NG branch format 4"
824
class BzrBranchFormat5(BranchFormat):
825
"""Bzr branch format 5.
828
- a revision-history file.
830
- a lock dir guarding the branch itself
831
- all of this stored in a branch/ subdirectory
832
- works with shared repositories.
834
This format is new in bzr 0.8.
837
def get_format_string(self):
838
"""See BranchFormat.get_format_string()."""
839
return "Bazaar-NG branch format 5\n"
841
def get_format_description(self):
842
"""See BranchFormat.get_format_description()."""
843
return "Branch format 5"
845
def initialize(self, a_bzrdir):
846
"""Create a branch of this format in a_bzrdir."""
847
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
848
branch_transport = a_bzrdir.get_branch_transport(self)
849
utf8_files = [('revision-history', ''),
852
control_files = lockable_files.LockableFiles(branch_transport, 'lock',
854
control_files.create_lock()
855
control_files.lock_write()
856
control_files.put_utf8('format', self.get_format_string())
858
for file, content in utf8_files:
859
control_files.put_utf8(file, content)
861
control_files.unlock()
862
return self.open(a_bzrdir, _found=True, )
865
super(BzrBranchFormat5, self).__init__()
866
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
868
def open(self, a_bzrdir, _found=False):
869
"""Return the branch object for a_bzrdir
871
_found is a private parameter, do not use it. It is used to indicate
872
if format probing has already be done.
875
format = BranchFormat.find_format(a_bzrdir)
876
assert format.__class__ == self.__class__
878
transport = a_bzrdir.get_branch_transport(None)
879
control_files = lockable_files.LockableFiles(transport, 'lock',
881
return BzrBranch5(_format=self,
882
_control_files=control_files,
884
_repository=a_bzrdir.find_repository())
886
raise NotBranchError(path=transport.base)
889
return "Bazaar-NG Metadir branch format 5"
892
class BranchReferenceFormat(BranchFormat):
893
"""Bzr branch reference format.
895
Branch references are used in implementing checkouts, they
896
act as an alias to the real branch which is at some other url.
903
def get_format_string(self):
904
"""See BranchFormat.get_format_string()."""
905
return "Bazaar-NG Branch Reference Format 1\n"
907
def get_format_description(self):
908
"""See BranchFormat.get_format_description()."""
909
return "Checkout reference format 1"
911
def get_reference(self, a_bzrdir):
912
"""See BranchFormat.get_reference()."""
913
transport = a_bzrdir.get_branch_transport(None)
914
return transport.get('location').read()
916
def initialize(self, a_bzrdir, target_branch=None):
917
"""Create a branch of this format in a_bzrdir."""
918
if target_branch is None:
919
# this format does not implement branch itself, thus the implicit
920
# creation contract must see it as uninitializable
921
raise errors.UninitializableFormat(self)
922
mutter('creating branch reference in %s', a_bzrdir.transport.base)
923
branch_transport = a_bzrdir.get_branch_transport(self)
924
branch_transport.put_bytes('location',
925
target_branch.bzrdir.root_transport.base)
926
branch_transport.put_bytes('format', self.get_format_string())
927
return self.open(a_bzrdir, _found=True)
930
super(BranchReferenceFormat, self).__init__()
931
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
933
def _make_reference_clone_function(format, a_branch):
934
"""Create a clone() routine for a branch dynamically."""
935
def clone(to_bzrdir, revision_id=None):
936
"""See Branch.clone()."""
937
return format.initialize(to_bzrdir, a_branch)
938
# cannot obey revision_id limits when cloning a reference ...
939
# FIXME RBC 20060210 either nuke revision_id for clone, or
940
# emit some sort of warning/error to the caller ?!
943
def open(self, a_bzrdir, _found=False, location=None):
944
"""Return the branch that the branch reference in a_bzrdir points at.
946
_found is a private parameter, do not use it. It is used to indicate
947
if format probing has already be done.
950
format = BranchFormat.find_format(a_bzrdir)
951
assert format.__class__ == self.__class__
953
location = self.get_reference(a_bzrdir)
954
real_bzrdir = bzrdir.BzrDir.open(location)
955
result = real_bzrdir.open_branch()
956
# this changes the behaviour of result.clone to create a new reference
957
# rather than a copy of the content of the branch.
958
# I did not use a proxy object because that needs much more extensive
959
# testing, and we are only changing one behaviour at the moment.
960
# If we decide to alter more behaviours - i.e. the implicit nickname
961
# then this should be refactored to introduce a tested proxy branch
962
# and a subclass of that for use in overriding clone() and ....
964
result.clone = self._make_reference_clone_function(result)
968
# formats which have no format string are not discoverable
969
# and not independently creatable, so are not registered.
970
__default_format = BzrBranchFormat5()
971
BranchFormat.register_format(__default_format)
972
BranchFormat.register_format(BranchReferenceFormat())
973
BranchFormat.set_default_format(__default_format)
974
_legacy_formats = [BzrBranchFormat4(),
977
class BzrBranch(Branch):
978
"""A branch stored in the actual filesystem.
980
Note that it's "local" in the context of the filesystem; it doesn't
981
really matter if it's on an nfs/smb/afs/coda/... share, as long as
982
it's writable, and can be accessed via the normal filesystem API.
985
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
986
relax_version_check=DEPRECATED_PARAMETER, _format=None,
987
_control_files=None, a_bzrdir=None, _repository=None):
988
"""Create new branch object at a particular location.
990
transport -- A Transport object, defining how to access files.
992
init -- If True, create new control files in a previously
993
unversioned directory. If False, the branch must already
996
relax_version_check -- If true, the usual check for the branch
997
version is not applied. This is intended only for
998
upgrade/recovery type use; it's not guaranteed that
999
all operations will work on old format branches.
1001
if a_bzrdir is None:
1002
self.bzrdir = bzrdir.BzrDir.open(transport.base)
1004
self.bzrdir = a_bzrdir
1005
self._transport = self.bzrdir.transport.clone('..')
1006
self._base = self._transport.base
1007
self._format = _format
1008
if _control_files is None:
1009
raise ValueError('BzrBranch _control_files is None')
1010
self.control_files = _control_files
1011
if deprecated_passed(init):
1012
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
1013
"deprecated as of bzr 0.8. Please use Branch.create().",
1017
# this is slower than before deprecation, oh well never mind.
1018
# -> its deprecated.
1019
self._initialize(transport.base)
1020
self._check_format(_format)
1021
if deprecated_passed(relax_version_check):
1022
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
1023
"relax_version_check parameter is deprecated as of bzr 0.8. "
1024
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
1028
if (not relax_version_check
1029
and not self._format.is_supported()):
1030
raise errors.UnsupportedFormatError(format=fmt)
1031
if deprecated_passed(transport):
1032
warn("BzrBranch.__init__(transport=XXX...): The transport "
1033
"parameter is deprecated as of bzr 0.8. "
1034
"Please use Branch.open, or bzrdir.open_branch().",
1037
self.repository = _repository
1040
return '%s(%r)' % (self.__class__.__name__, self.base)
1044
def _get_base(self):
1047
base = property(_get_base, doc="The URL for the root of this branch.")
1049
def _finish_transaction(self):
1050
"""Exit the current transaction."""
1051
return self.control_files._finish_transaction()
1053
def get_transaction(self):
1054
"""Return the current active transaction.
1056
If no transaction is active, this returns a passthrough object
1057
for which all data is immediately flushed and no caching happens.
1059
# this is an explicit function so that we can do tricky stuff
1060
# when the storage in rev_storage is elsewhere.
1061
# we probably need to hook the two 'lock a location' and
1062
# 'have a transaction' together more delicately, so that
1063
# we can have two locks (branch and storage) and one transaction
1064
# ... and finishing the transaction unlocks both, but unlocking
1065
# does not. - RBC 20051121
1066
return self.control_files.get_transaction()
1068
def _set_transaction(self, transaction):
1069
"""Set a new active transaction."""
1070
return self.control_files._set_transaction(transaction)
1072
def abspath(self, name):
1073
"""See Branch.abspath."""
1074
return self.control_files._transport.abspath(name)
1076
def _check_format(self, format):
1077
"""Identify the branch format if needed.
1079
The format is stored as a reference to the format object in
1080
self._format for code that needs to check it later.
1082
The format parameter is either None or the branch format class
1083
used to open this branch.
1085
FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
1088
format = BranchFormat.find_format(self.bzrdir)
1089
self._format = format
1090
mutter("got branch format %s", self._format)
1093
def get_root_id(self):
1094
"""See Branch.get_root_id."""
1095
tree = self.repository.revision_tree(self.last_revision())
1096
return tree.inventory.root.file_id
1098
def is_locked(self):
1099
return self.control_files.is_locked()
1101
def lock_write(self):
1102
self.repository.lock_write()
1104
self.control_files.lock_write()
1106
self.repository.unlock()
1109
def lock_read(self):
1110
self.repository.lock_read()
1112
self.control_files.lock_read()
1114
self.repository.unlock()
1118
# TODO: test for failed two phase locks. This is known broken.
1120
self.control_files.unlock()
1122
self.repository.unlock()
1124
def peek_lock_mode(self):
1125
if self.control_files._lock_count == 0:
1128
return self.control_files._lock_mode
1130
def get_physical_lock_status(self):
1131
return self.control_files.get_physical_lock_status()
1134
def print_file(self, file, revision_id):
1135
"""See Branch.print_file."""
1136
return self.repository.print_file(file, revision_id)
1139
def append_revision(self, *revision_ids):
1140
"""See Branch.append_revision."""
1141
for revision_id in revision_ids:
1142
_mod_revision.check_not_reserved_id(revision_id)
1143
mutter("add {%s} to revision-history" % revision_id)
1144
rev_history = self.revision_history()
1145
rev_history.extend(revision_ids)
1146
self.set_revision_history(rev_history)
1149
def set_revision_history(self, rev_history):
1150
"""See Branch.set_revision_history."""
1151
self.control_files.put_utf8(
1152
'revision-history', '\n'.join(rev_history))
1153
transaction = self.get_transaction()
1154
history = transaction.map.find_revision_history()
1155
if history is not None:
1156
# update the revision history in the identity map.
1157
history[:] = list(rev_history)
1158
# this call is disabled because revision_history is
1159
# not really an object yet, and the transaction is for objects.
1160
# transaction.register_dirty(history)
1162
transaction.map.add_revision_history(rev_history)
1163
# this call is disabled because revision_history is
1164
# not really an object yet, and the transaction is for objects.
1165
# transaction.register_clean(history)
1166
for hook in Branch.hooks['set_rh']:
1167
hook(self, rev_history)
1170
def revision_history(self):
1171
"""See Branch.revision_history."""
1172
transaction = self.get_transaction()
1173
history = transaction.map.find_revision_history()
1174
if history is not None:
1175
# mutter("cache hit for revision-history in %s", self)
1176
return list(history)
1177
decode_utf8 = cache_utf8.decode
1178
history = [decode_utf8(l.rstrip('\r\n')) for l in
1179
self.control_files.get('revision-history').readlines()]
1180
transaction.map.add_revision_history(history)
1181
# this call is disabled because revision_history is
1182
# not really an object yet, and the transaction is for objects.
1183
# transaction.register_clean(history, precious=True)
1184
return list(history)
1187
def generate_revision_history(self, revision_id, last_rev=None,
1189
"""Create a new revision history that will finish with revision_id.
1191
:param revision_id: the new tip to use.
1192
:param last_rev: The previous last_revision. If not None, then this
1193
must be a ancestory of revision_id, or DivergedBranches is raised.
1194
:param other_branch: The other branch that DivergedBranches should
1195
raise with respect to.
1197
# stop_revision must be a descendant of last_revision
1198
stop_graph = self.repository.get_revision_graph(revision_id)
1199
if last_rev is not None and last_rev not in stop_graph:
1200
# our previous tip is not merged into stop_revision
1201
raise errors.DivergedBranches(self, other_branch)
1202
# make a new revision history from the graph
1203
current_rev_id = revision_id
1205
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1206
new_history.append(current_rev_id)
1207
current_rev_id_parents = stop_graph[current_rev_id]
1209
current_rev_id = current_rev_id_parents[0]
1211
current_rev_id = None
1212
new_history.reverse()
1213
self.set_revision_history(new_history)
1216
def update_revisions(self, other, stop_revision=None):
1217
"""See Branch.update_revisions."""
1220
if stop_revision is None:
1221
stop_revision = other.last_revision()
1222
if stop_revision is None:
1223
# if there are no commits, we're done.
1225
# whats the current last revision, before we fetch [and change it
1227
last_rev = self.last_revision()
1228
# we fetch here regardless of whether we need to so that we pickup
1230
self.fetch(other, stop_revision)
1231
my_ancestry = self.repository.get_ancestry(last_rev)
1232
if stop_revision in my_ancestry:
1233
# last_revision is a descendant of stop_revision
1235
self.generate_revision_history(stop_revision, last_rev=last_rev,
1240
def basis_tree(self):
1241
"""See Branch.basis_tree."""
1242
return self.repository.revision_tree(self.last_revision())
1244
@deprecated_method(zero_eight)
1245
def working_tree(self):
1246
"""Create a Working tree object for this branch."""
1248
from bzrlib.transport.local import LocalTransport
1249
if (self.base.find('://') != -1 or
1250
not isinstance(self._transport, LocalTransport)):
1251
raise NoWorkingTree(self.base)
1252
return self.bzrdir.open_workingtree()
1255
def pull(self, source, overwrite=False, stop_revision=None):
1256
"""See Branch.pull."""
1259
old_count = len(self.revision_history())
1261
self.update_revisions(source, stop_revision)
1262
except DivergedBranches:
1266
self.set_revision_history(source.revision_history())
1267
new_count = len(self.revision_history())
1268
return new_count - old_count
1272
def get_parent(self):
1273
"""See Branch.get_parent."""
1275
_locs = ['parent', 'pull', 'x-pull']
1276
assert self.base[-1] == '/'
1279
parent = self.control_files.get(l).read().strip('\n')
1282
# This is an old-format absolute path to a local branch
1283
# turn it into a url
1284
if parent.startswith('/'):
1285
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1287
return urlutils.join(self.base[:-1], parent)
1288
except errors.InvalidURLJoin, e:
1289
raise errors.InaccessibleParent(parent, self.base)
1292
def get_push_location(self):
1293
"""See Branch.get_push_location."""
1294
push_loc = self.get_config().get_user_option('push_location')
1297
def set_push_location(self, location):
1298
"""See Branch.set_push_location."""
1299
self.get_config().set_user_option(
1300
'push_location', location,
1301
store=_mod_config.STORE_LOCATION_NORECURSE)
1304
def set_parent(self, url):
1305
"""See Branch.set_parent."""
1306
# TODO: Maybe delete old location files?
1307
# URLs should never be unicode, even on the local fs,
1308
# FIXUP this and get_parent in a future branch format bump:
1309
# read and rewrite the file, and have the new format code read
1310
# using .get not .get_utf8. RBC 20060125
1312
self.control_files._transport.delete('parent')
1314
if isinstance(url, unicode):
1316
url = url.encode('ascii')
1317
except UnicodeEncodeError:
1318
raise bzrlib.errors.InvalidURL(url,
1319
"Urls must be 7-bit ascii, "
1320
"use bzrlib.urlutils.escape")
1322
url = urlutils.relative_url(self.base, url)
1323
self.control_files.put('parent', StringIO(url + '\n'))
1325
@deprecated_function(zero_nine)
1326
def tree_config(self):
1327
"""DEPRECATED; call get_config instead.
1328
TreeConfig has become part of BranchConfig."""
1329
return TreeConfig(self)
1332
class BzrBranch5(BzrBranch):
1333
"""A format 5 branch. This supports new features over plan branches.
1335
It has support for a master_branch which is the data for bound branches.
1343
super(BzrBranch5, self).__init__(_format=_format,
1344
_control_files=_control_files,
1346
_repository=_repository)
1349
def pull(self, source, overwrite=False, stop_revision=None):
1350
"""Updates branch.pull to be bound branch aware."""
1351
bound_location = self.get_bound_location()
1352
if source.base != bound_location:
1353
# not pulling from master, so we need to update master.
1354
master_branch = self.get_master_branch()
1356
master_branch.pull(source)
1357
source = master_branch
1358
return super(BzrBranch5, self).pull(source, overwrite, stop_revision)
1360
def get_bound_location(self):
1362
return self.control_files.get_utf8('bound').read()[:-1]
1363
except errors.NoSuchFile:
1367
def get_master_branch(self):
1368
"""Return the branch we are bound to.
1370
:return: Either a Branch, or None
1372
This could memoise the branch, but if thats done
1373
it must be revalidated on each new lock.
1374
So for now we just don't memoise it.
1375
# RBC 20060304 review this decision.
1377
bound_loc = self.get_bound_location()
1381
return Branch.open(bound_loc)
1382
except (errors.NotBranchError, errors.ConnectionError), e:
1383
raise errors.BoundBranchConnectionFailure(
1387
def set_bound_location(self, location):
1388
"""Set the target where this branch is bound to.
1390
:param location: URL to the target branch
1393
self.control_files.put_utf8('bound', location+'\n')
1396
self.control_files._transport.delete('bound')
1402
def bind(self, other):
1403
"""Bind this branch to the branch other.
1405
This does not push or pull data between the branches, though it does
1406
check for divergence to raise an error when the branches are not
1407
either the same, or one a prefix of the other. That behaviour may not
1408
be useful, so that check may be removed in future.
1410
:param other: The branch to bind to
1413
# TODO: jam 20051230 Consider checking if the target is bound
1414
# It is debatable whether you should be able to bind to
1415
# a branch which is itself bound.
1416
# Committing is obviously forbidden,
1417
# but binding itself may not be.
1418
# Since we *have* to check at commit time, we don't
1419
# *need* to check here
1421
# we want to raise diverged if:
1422
# last_rev is not in the other_last_rev history, AND
1423
# other_last_rev is not in our history, and do it without pulling
1425
last_rev = self.last_revision()
1426
if last_rev is not None:
1429
other_last_rev = other.last_revision()
1430
if other_last_rev is not None:
1431
# neither branch is new, we have to do some work to
1432
# ascertain diversion.
1433
remote_graph = other.repository.get_revision_graph(
1435
local_graph = self.repository.get_revision_graph(last_rev)
1436
if (last_rev not in remote_graph and
1437
other_last_rev not in local_graph):
1438
raise errors.DivergedBranches(self, other)
1441
self.set_bound_location(other.base)
1445
"""If bound, unbind"""
1446
return self.set_bound_location(None)
1450
"""Synchronise this branch with the master branch if any.
1452
:return: None or the last_revision that was pivoted out during the
1455
master = self.get_master_branch()
1456
if master is not None:
1457
old_tip = self.last_revision()
1458
self.pull(master, overwrite=True)
1459
if old_tip in self.repository.get_ancestry(self.last_revision()):
1465
class BranchTestProviderAdapter(object):
1466
"""A tool to generate a suite testing multiple branch formats at once.
1468
This is done by copying the test once for each transport and injecting
1469
the transport_server, transport_readonly_server, and branch_format
1470
classes into each copy. Each copy is also given a new id() to make it
1474
def __init__(self, transport_server, transport_readonly_server, formats):
1475
self._transport_server = transport_server
1476
self._transport_readonly_server = transport_readonly_server
1477
self._formats = formats
1479
def adapt(self, test):
1480
result = TestSuite()
1481
for branch_format, bzrdir_format in self._formats:
1482
new_test = deepcopy(test)
1483
new_test.transport_server = self._transport_server
1484
new_test.transport_readonly_server = self._transport_readonly_server
1485
new_test.bzrdir_format = bzrdir_format
1486
new_test.branch_format = branch_format
1487
def make_new_test_id():
1488
new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
1489
return lambda: new_id
1490
new_test.id = make_new_test_id()
1491
result.addTest(new_test)
1495
class BranchCheckResult(object):
1496
"""Results of checking branch consistency.
1501
def __init__(self, branch):
1502
self.branch = branch
1504
def report_results(self, verbose):
1505
"""Report the check results via trace.note.
1507
:param verbose: Requests more detailed display of what was checked,
1510
note('checked branch %s format %s',
1512
self.branch._format)
1515
######################################################################
1519
@deprecated_function(zero_eight)
1520
def is_control_file(*args, **kwargs):
1521
"""See bzrlib.workingtree.is_control_file."""
1522
from bzrlib import workingtree
1523
return workingtree.is_control_file(*args, **kwargs)
added
removed
bzrlib/branch.py
