1
# Copyright (C) 2005, 2006, 2007 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
last_revision = from_branch.last_revision_info()[1]
229
return self.repository.fetch(from_branch.repository,
230
revision_id=last_revision,
233
if nested_pb is not None:
237
def get_bound_location(self):
238
"""Return the URL of the branch we are bound to.
240
Older format branches cannot bind, please be sure to use a metadir
245
def get_commit_builder(self, parents, config=None, timestamp=None,
246
timezone=None, committer=None, revprops=None,
248
"""Obtain a CommitBuilder for this branch.
250
:param parents: Revision ids of the parents of the new revision.
251
:param config: Optional configuration to use.
252
:param timestamp: Optional timestamp recorded for commit.
253
:param timezone: Optional timezone for timestamp.
254
:param committer: Optional committer to set for commit.
255
:param revprops: Optional dictionary of revision properties.
256
:param revision_id: Optional revision id.
260
config = self.get_config()
262
return self.repository.get_commit_builder(self, parents, config,
263
timestamp, timezone, committer, revprops, revision_id)
265
def get_master_branch(self):
266
"""Return the branch we are bound to.
268
:return: Either a Branch, or None
272
def get_revision_delta(self, revno):
273
"""Return the delta for one revision.
275
The delta is relative to its mainline predecessor, or the
276
empty tree for revision 1.
278
assert isinstance(revno, int)
279
rh = self.revision_history()
280
if not (1 <= revno <= len(rh)):
281
raise InvalidRevisionNumber(revno)
282
return self.repository.get_revision_delta(rh[revno-1])
284
def get_root_id(self):
285
"""Return the id of this branches root"""
286
raise NotImplementedError(self.get_root_id)
288
def print_file(self, file, revision_id):
289
"""Print `file` to stdout."""
290
raise NotImplementedError(self.print_file)
292
def append_revision(self, *revision_ids):
293
raise NotImplementedError(self.append_revision)
295
def set_revision_history(self, rev_history):
296
raise NotImplementedError(self.set_revision_history)
298
def revision_history(self):
299
"""Return sequence of revision hashes on to this branch."""
300
raise NotImplementedError(self.revision_history)
303
"""Return current revision number for this branch.
305
That is equivalent to the number of revisions committed to
308
return len(self.revision_history())
311
"""Older format branches cannot bind or unbind."""
312
raise errors.UpgradeRequired(self.base)
314
def last_revision(self):
315
"""Return last revision id, or None"""
316
ph = self.revision_history()
322
def last_revision_info(self):
323
"""Return information about the last revision.
325
:return: A tuple (revno, last_revision_id).
327
rh = self.revision_history()
330
return (revno, rh[-1])
332
return (0, _mod_revision.NULL_REVISION)
334
def missing_revisions(self, other, stop_revision=None):
335
"""Return a list of new revisions that would perfectly fit.
337
If self and other have not diverged, return a list of the revisions
338
present in other, but missing from self.
340
self_history = self.revision_history()
341
self_len = len(self_history)
342
other_history = other.revision_history()
343
other_len = len(other_history)
344
common_index = min(self_len, other_len) -1
345
if common_index >= 0 and \
346
self_history[common_index] != other_history[common_index]:
347
raise DivergedBranches(self, other)
349
if stop_revision is None:
350
stop_revision = other_len
352
assert isinstance(stop_revision, int)
353
if stop_revision > other_len:
354
raise errors.NoSuchRevision(self, stop_revision)
355
return other_history[self_len:stop_revision]
357
def update_revisions(self, other, stop_revision=None):
358
"""Pull in new perfect-fit revisions.
360
:param other: Another Branch to pull from
361
:param stop_revision: Updated until the given revision
364
raise NotImplementedError(self.update_revisions)
366
def revision_id_to_revno(self, revision_id):
367
"""Given a revision id, return its revno"""
368
if revision_id is None:
370
history = self.revision_history()
372
return history.index(revision_id) + 1
374
raise bzrlib.errors.NoSuchRevision(self, revision_id)
376
def get_rev_id(self, revno, history=None):
377
"""Find the revision id of the specified revno."""
381
history = self.revision_history()
382
if revno <= 0 or revno > len(history):
383
raise bzrlib.errors.NoSuchRevision(self, revno)
384
return history[revno - 1]
386
def pull(self, source, overwrite=False, stop_revision=None):
387
"""Mirror source into this branch.
389
This branch is considered to be 'local', having low latency.
391
raise NotImplementedError(self.pull)
393
def push(self, target, overwrite=False, stop_revision=None):
394
"""Mirror this branch into target.
396
This branch is considered to be 'local', having low latency.
398
raise NotImplementedError(self.push)
400
def basis_tree(self):
401
"""Return `Tree` object for last revision."""
402
return self.repository.revision_tree(self.last_revision())
404
def rename_one(self, from_rel, to_rel):
407
This can change the directory or the filename or both.
409
raise NotImplementedError(self.rename_one)
411
def move(self, from_paths, to_name):
414
to_name must exist as a versioned directory.
416
If to_name exists and is a directory, the files are moved into
417
it, keeping their old names. If it is a directory,
419
Note that to_name is only the last component of the new name;
420
this doesn't change the directory.
422
This returns a list of (from_path, to_path) pairs for each
425
raise NotImplementedError(self.move)
427
def get_parent(self):
428
"""Return the parent location of the branch.
430
This is the default location for push/pull/missing. The usual
431
pattern is that the user can override it by specifying a
434
raise NotImplementedError(self.get_parent)
436
def get_submit_branch(self):
437
"""Return the submit location of the branch.
439
This is the default location for bundle. The usual
440
pattern is that the user can override it by specifying a
443
return self.get_config().get_user_option('submit_branch')
445
def set_submit_branch(self, location):
446
"""Return the submit location of the branch.
448
This is the default location for bundle. The usual
449
pattern is that the user can override it by specifying a
452
self.get_config().set_user_option('submit_branch', location)
454
def get_push_location(self):
455
"""Return the None or the location to push this branch to."""
456
push_loc = self.get_config().get_user_option('push_location')
459
def set_push_location(self, location):
460
"""Set a new push location for this branch."""
461
raise NotImplementedError(self.set_push_location)
463
def set_parent(self, url):
464
raise NotImplementedError(self.set_parent)
468
"""Synchronise this branch with the master branch if any.
470
:return: None or the last_revision pivoted out during the update.
474
def check_revno(self, revno):
476
Check whether a revno corresponds to any revision.
477
Zero (the NULL revision) is considered valid.
480
self.check_real_revno(revno)
482
def check_real_revno(self, revno):
484
Check whether a revno corresponds to a real revision.
485
Zero (the NULL revision) is considered invalid
487
if revno < 1 or revno > self.revno():
488
raise InvalidRevisionNumber(revno)
491
def clone(self, *args, **kwargs):
492
"""Clone this branch into to_bzrdir preserving all semantic values.
494
revision_id: if not None, the revision history in the new branch will
495
be truncated to end with revision_id.
497
# for API compatibility, until 0.8 releases we provide the old api:
498
# def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
499
# after 0.8 releases, the *args and **kwargs should be changed:
500
# def clone(self, to_bzrdir, revision_id=None):
501
if (kwargs.get('to_location', None) or
502
kwargs.get('revision', None) or
503
kwargs.get('basis_branch', None) or
504
(len(args) and isinstance(args[0], basestring))):
505
# backwards compatibility api:
506
warn("Branch.clone() has been deprecated for BzrDir.clone() from"
507
" bzrlib 0.8.", DeprecationWarning, stacklevel=3)
510
basis_branch = args[2]
512
basis_branch = kwargs.get('basis_branch', None)
514
basis = basis_branch.bzrdir
519
revision_id = args[1]
521
revision_id = kwargs.get('revision', None)
526
# no default to raise if not provided.
527
url = kwargs.get('to_location')
528
return self.bzrdir.clone(url,
529
revision_id=revision_id,
530
basis=basis).open_branch()
532
# generate args by hand
534
revision_id = args[1]
536
revision_id = kwargs.get('revision_id', None)
540
# no default to raise if not provided.
541
to_bzrdir = kwargs.get('to_bzrdir')
542
result = self._format.initialize(to_bzrdir)
543
self.copy_content_into(result, revision_id=revision_id)
547
def sprout(self, to_bzrdir, revision_id=None):
548
"""Create a new line of development from the branch, into to_bzrdir.
550
revision_id: if not None, the revision history in the new branch will
551
be truncated to end with revision_id.
553
result = self._format.initialize(to_bzrdir)
554
self.copy_content_into(result, revision_id=revision_id)
555
result.set_parent(self.bzrdir.root_transport.base)
559
def copy_content_into(self, destination, revision_id=None):
560
"""Copy the content of self into destination.
562
revision_id: if not None, the revision history in the new branch will
563
be truncated to end with revision_id.
565
new_history = self.revision_history()
566
if revision_id is not None:
568
new_history = new_history[:new_history.index(revision_id) + 1]
570
rev = self.repository.get_revision(revision_id)
571
new_history = rev.get_history(self.repository)[1:]
572
destination.set_revision_history(new_history)
574
parent = self.get_parent()
575
except errors.InaccessibleParent, e:
576
mutter('parent was not accessible to copy: %s', e)
579
destination.set_parent(parent)
583
"""Check consistency of the branch.
585
In particular this checks that revisions given in the revision-history
586
do actually match up in the revision graph, and that they're all
587
present in the repository.
589
Callers will typically also want to check the repository.
591
:return: A BranchCheckResult.
593
mainline_parent_id = None
594
for revision_id in self.revision_history():
596
revision = self.repository.get_revision(revision_id)
597
except errors.NoSuchRevision, e:
598
raise errors.BzrCheckError("mainline revision {%s} not in repository"
600
# In general the first entry on the revision history has no parents.
601
# But it's not illegal for it to have parents listed; this can happen
602
# in imports from Arch when the parents weren't reachable.
603
if mainline_parent_id is not None:
604
if mainline_parent_id not in revision.parent_ids:
605
raise errors.BzrCheckError("previous revision {%s} not listed among "
607
% (mainline_parent_id, revision_id))
608
mainline_parent_id = revision_id
609
return BranchCheckResult(self)
611
def _get_checkout_format(self):
612
"""Return the most suitable metadir for a checkout of this branch.
613
Weaves are used if this branch's repostory uses weaves.
615
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
616
from bzrlib import repository
617
format = bzrdir.BzrDirMetaFormat1()
618
format.repository_format = repository.RepositoryFormat7()
620
format = self.repository.bzrdir.cloning_metadir()
623
def create_checkout(self, to_location, revision_id=None,
625
"""Create a checkout of a branch.
627
:param to_location: The url to produce the checkout at
628
:param revision_id: The revision to check out
629
:param lightweight: If True, produce a lightweight checkout, otherwise,
630
produce a bound branch (heavyweight checkout)
631
:return: The tree of the created checkout
633
t = transport.get_transport(to_location)
636
except errors.FileExists:
639
checkout = bzrdir.BzrDirMetaFormat1().initialize_on_transport(t)
640
BranchReferenceFormat().initialize(checkout, self)
642
format = self._get_checkout_format()
643
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
644
to_location, force_new_tree=False, format=format)
645
checkout = checkout_branch.bzrdir
646
checkout_branch.bind(self)
647
# pull up to the specified revision_id to set the initial
648
# branch tip correctly, and seed it with history.
649
checkout_branch.pull(self, stop_revision=revision_id)
650
return checkout.create_workingtree(revision_id)
653
class BranchFormat(object):
654
"""An encapsulation of the initialization and open routines for a format.
656
Formats provide three things:
657
* An initialization routine,
661
Formats are placed in an dict by their format string for reference
662
during branch opening. Its not required that these be instances, they
663
can be classes themselves with class methods - it simply depends on
664
whether state is needed for a given format or not.
666
Once a format is deprecated, just deprecate the initialize and open
667
methods on the format class. Do not deprecate the object, as the
668
object will be created every time regardless.
671
_default_format = None
672
"""The default format used for new branches."""
675
"""The known formats."""
678
def find_format(klass, a_bzrdir):
679
"""Return the format for the branch object in a_bzrdir."""
681
transport = a_bzrdir.get_branch_transport(None)
682
format_string = transport.get("format").read()
683
return klass._formats[format_string]
685
raise NotBranchError(path=transport.base)
687
raise errors.UnknownFormatError(format=format_string)
690
def get_default_format(klass):
691
"""Return the current default format."""
692
return klass._default_format
694
def get_format_string(self):
695
"""Return the ASCII format string that identifies this format."""
696
raise NotImplementedError(self.get_format_string)
698
def get_format_description(self):
699
"""Return the short format description for this format."""
700
raise NotImplementedError(self.get_format_description)
702
def get_reference(self, a_bzrdir):
703
"""Get the target reference of the branch in a_bzrdir.
705
format probing must have been completed before calling
706
this method - it is assumed that the format of the branch
707
in a_bzrdir is correct.
709
:param a_bzrdir: The bzrdir to get the branch data from.
710
:return: None if the branch is not a reference branch.
714
def initialize(self, a_bzrdir):
715
"""Create a branch of this format in a_bzrdir."""
716
raise NotImplementedError(self.initialize)
718
def is_supported(self):
719
"""Is this format supported?
721
Supported formats can be initialized and opened.
722
Unsupported formats may not support initialization or committing or
723
some other features depending on the reason for not being supported.
727
def open(self, a_bzrdir, _found=False):
728
"""Return the branch object for a_bzrdir
730
_found is a private parameter, do not use it. It is used to indicate
731
if format probing has already be done.
733
raise NotImplementedError(self.open)
736
def register_format(klass, format):
737
klass._formats[format.get_format_string()] = format
740
def set_default_format(klass, format):
741
klass._default_format = format
744
def unregister_format(klass, format):
745
assert klass._formats[format.get_format_string()] is format
746
del klass._formats[format.get_format_string()]
749
return self.get_format_string().rstrip()
752
class BranchHooks(dict):
753
"""A dictionary mapping hook name to a list of callables for branch hooks.
755
e.g. ['set_rh'] Is the list of items to be called when the
756
set_revision_history function is invoked.
760
"""Create the default hooks.
762
These are all empty initially, because by default nothing should get
766
# Introduced in 0.15:
767
# invoked whenever the revision history has been set
768
# with set_revision_history. The api signature is
769
# (branch, revision_history), and the branch will
772
# invoked after a push operation completes.
773
# the api signature is
774
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
775
# where local is the local branch or None, master is the target
776
# master branch, and the rest should be self explanatory. The source
777
# is read locked and the target branches write locked. Source will
778
# be the local low-latency branch.
779
self['post_push'] = []
780
# invoked after a pull operation completes.
781
# the api signature is
782
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
783
# where local is the local branch or None, master is the target
784
# master branch, and the rest should be self explanatory. The source
785
# is read locked and the target branches write locked. The local
786
# branch is the low-latency branch.
787
self['post_pull'] = []
788
# invoked after a commit operation completes.
789
# the api signature is
790
# (local, master, old_revno, old_revid, new_revno, new_revid)
791
# old_revid is NULL_REVISION for the first commit to a branch.
792
self['post_commit'] = []
793
# invoked after a uncommit operation completes.
794
# the api signature is
795
# (local, master, old_revno, old_revid, new_revno, new_revid) where
796
# local is the local branch or None, master is the target branch,
797
# and an empty branch recieves new_revno of 0, new_revid of None.
798
self['post_uncommit'] = []
800
def install_hook(self, hook_name, a_callable):
801
"""Install a_callable in to the hook hook_name.
803
:param hook_name: A hook name. See the __init__ method of BranchHooks
804
for the complete list of hooks.
805
:param a_callable: The callable to be invoked when the hook triggers.
806
The exact signature will depend on the hook - see the __init__
807
method of BranchHooks for details on each hook.
810
self[hook_name].append(a_callable)
812
raise errors.UnknownHook('branch', hook_name)
815
# install the default hooks into the Branch class.
816
Branch.hooks = BranchHooks()
819
class BzrBranchFormat4(BranchFormat):
820
"""Bzr branch format 4.
823
- a revision-history file.
824
- a branch-lock lock file [ to be shared with the bzrdir ]
827
def get_format_description(self):
828
"""See BranchFormat.get_format_description()."""
829
return "Branch format 4"
831
def initialize(self, a_bzrdir):
832
"""Create a branch of this format in a_bzrdir."""
833
mutter('creating branch in %s', a_bzrdir.transport.base)
834
branch_transport = a_bzrdir.get_branch_transport(self)
835
utf8_files = [('revision-history', ''),
838
control_files = lockable_files.LockableFiles(branch_transport,
839
'branch-lock', lockable_files.TransportLock)
840
control_files.create_lock()
841
control_files.lock_write()
843
for file, content in utf8_files:
844
control_files.put_utf8(file, content)
846
control_files.unlock()
847
return self.open(a_bzrdir, _found=True)
850
super(BzrBranchFormat4, self).__init__()
851
self._matchingbzrdir = bzrdir.BzrDirFormat6()
853
def open(self, a_bzrdir, _found=False):
854
"""Return the branch object for a_bzrdir
856
_found is a private parameter, do not use it. It is used to indicate
857
if format probing has already be done.
860
# we are being called directly and must probe.
861
raise NotImplementedError
862
return BzrBranch(_format=self,
863
_control_files=a_bzrdir._control_files,
865
_repository=a_bzrdir.open_repository())
868
return "Bazaar-NG branch format 4"
871
class BzrBranchFormat5(BranchFormat):
872
"""Bzr branch format 5.
875
- a revision-history file.
877
- a lock dir guarding the branch itself
878
- all of this stored in a branch/ subdirectory
879
- works with shared repositories.
881
This format is new in bzr 0.8.
884
def get_format_string(self):
885
"""See BranchFormat.get_format_string()."""
886
return "Bazaar-NG branch format 5\n"
888
def get_format_description(self):
889
"""See BranchFormat.get_format_description()."""
890
return "Branch format 5"
892
def initialize(self, a_bzrdir):
893
"""Create a branch of this format in a_bzrdir."""
894
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
895
branch_transport = a_bzrdir.get_branch_transport(self)
896
utf8_files = [('revision-history', ''),
899
control_files = lockable_files.LockableFiles(branch_transport, 'lock',
901
control_files.create_lock()
902
control_files.lock_write()
903
control_files.put_utf8('format', self.get_format_string())
905
for file, content in utf8_files:
906
control_files.put_utf8(file, content)
908
control_files.unlock()
909
return self.open(a_bzrdir, _found=True, )
912
super(BzrBranchFormat5, self).__init__()
913
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
915
def open(self, a_bzrdir, _found=False):
916
"""Return the branch object for a_bzrdir
918
_found is a private parameter, do not use it. It is used to indicate
919
if format probing has already be done.
922
format = BranchFormat.find_format(a_bzrdir)
923
assert format.__class__ == self.__class__
925
transport = a_bzrdir.get_branch_transport(None)
926
control_files = lockable_files.LockableFiles(transport, 'lock',
928
return BzrBranch5(_format=self,
929
_control_files=control_files,
931
_repository=a_bzrdir.find_repository())
933
raise NotBranchError(path=transport.base)
936
return "Bazaar-NG Metadir branch format 5"
939
class BranchReferenceFormat(BranchFormat):
940
"""Bzr branch reference format.
942
Branch references are used in implementing checkouts, they
943
act as an alias to the real branch which is at some other url.
950
def get_format_string(self):
951
"""See BranchFormat.get_format_string()."""
952
return "Bazaar-NG Branch Reference Format 1\n"
954
def get_format_description(self):
955
"""See BranchFormat.get_format_description()."""
956
return "Checkout reference format 1"
958
def get_reference(self, a_bzrdir):
959
"""See BranchFormat.get_reference()."""
960
transport = a_bzrdir.get_branch_transport(None)
961
return transport.get('location').read()
963
def initialize(self, a_bzrdir, target_branch=None):
964
"""Create a branch of this format in a_bzrdir."""
965
if target_branch is None:
966
# this format does not implement branch itself, thus the implicit
967
# creation contract must see it as uninitializable
968
raise errors.UninitializableFormat(self)
969
mutter('creating branch reference in %s', a_bzrdir.transport.base)
970
branch_transport = a_bzrdir.get_branch_transport(self)
971
branch_transport.put_bytes('location',
972
target_branch.bzrdir.root_transport.base)
973
branch_transport.put_bytes('format', self.get_format_string())
974
return self.open(a_bzrdir, _found=True)
977
super(BranchReferenceFormat, self).__init__()
978
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
980
def _make_reference_clone_function(format, a_branch):
981
"""Create a clone() routine for a branch dynamically."""
982
def clone(to_bzrdir, revision_id=None):
983
"""See Branch.clone()."""
984
return format.initialize(to_bzrdir, a_branch)
985
# cannot obey revision_id limits when cloning a reference ...
986
# FIXME RBC 20060210 either nuke revision_id for clone, or
987
# emit some sort of warning/error to the caller ?!
990
def open(self, a_bzrdir, _found=False, location=None):
991
"""Return the branch that the branch reference in a_bzrdir points at.
993
_found is a private parameter, do not use it. It is used to indicate
994
if format probing has already be done.
997
format = BranchFormat.find_format(a_bzrdir)
998
assert format.__class__ == self.__class__
1000
location = self.get_reference(a_bzrdir)
1001
real_bzrdir = bzrdir.BzrDir.open(location)
1002
result = real_bzrdir.open_branch()
1003
# this changes the behaviour of result.clone to create a new reference
1004
# rather than a copy of the content of the branch.
1005
# I did not use a proxy object because that needs much more extensive
1006
# testing, and we are only changing one behaviour at the moment.
1007
# If we decide to alter more behaviours - i.e. the implicit nickname
1008
# then this should be refactored to introduce a tested proxy branch
1009
# and a subclass of that for use in overriding clone() and ....
1011
result.clone = self._make_reference_clone_function(result)
1015
# formats which have no format string are not discoverable
1016
# and not independently creatable, so are not registered.
1017
__default_format = BzrBranchFormat5()
1018
BranchFormat.register_format(__default_format)
1019
BranchFormat.register_format(BranchReferenceFormat())
1020
BranchFormat.set_default_format(__default_format)
1021
_legacy_formats = [BzrBranchFormat4(),
1024
class BzrBranch(Branch):
1025
"""A branch stored in the actual filesystem.
1027
Note that it's "local" in the context of the filesystem; it doesn't
1028
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1029
it's writable, and can be accessed via the normal filesystem API.
1032
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
1033
relax_version_check=DEPRECATED_PARAMETER, _format=None,
1034
_control_files=None, a_bzrdir=None, _repository=None):
1035
"""Create new branch object at a particular location.
1037
transport -- A Transport object, defining how to access files.
1039
init -- If True, create new control files in a previously
1040
unversioned directory. If False, the branch must already
1043
relax_version_check -- If true, the usual check for the branch
1044
version is not applied. This is intended only for
1045
upgrade/recovery type use; it's not guaranteed that
1046
all operations will work on old format branches.
1048
if a_bzrdir is None:
1049
self.bzrdir = bzrdir.BzrDir.open(transport.base)
1051
self.bzrdir = a_bzrdir
1052
self._transport = self.bzrdir.transport.clone('..')
1053
self._base = self._transport.base
1054
self._format = _format
1055
if _control_files is None:
1056
raise ValueError('BzrBranch _control_files is None')
1057
self.control_files = _control_files
1058
if deprecated_passed(init):
1059
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
1060
"deprecated as of bzr 0.8. Please use Branch.create().",
1064
# this is slower than before deprecation, oh well never mind.
1065
# -> its deprecated.
1066
self._initialize(transport.base)
1067
self._check_format(_format)
1068
if deprecated_passed(relax_version_check):
1069
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
1070
"relax_version_check parameter is deprecated as of bzr 0.8. "
1071
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
1075
if (not relax_version_check
1076
and not self._format.is_supported()):
1077
raise errors.UnsupportedFormatError(format=fmt)
1078
if deprecated_passed(transport):
1079
warn("BzrBranch.__init__(transport=XXX...): The transport "
1080
"parameter is deprecated as of bzr 0.8. "
1081
"Please use Branch.open, or bzrdir.open_branch().",
1084
self.repository = _repository
1087
return '%s(%r)' % (self.__class__.__name__, self.base)
1091
def _get_base(self):
1094
base = property(_get_base, doc="The URL for the root of this branch.")
1096
def _finish_transaction(self):
1097
"""Exit the current transaction."""
1098
return self.control_files._finish_transaction()
1100
def get_transaction(self):
1101
"""Return the current active transaction.
1103
If no transaction is active, this returns a passthrough object
1104
for which all data is immediately flushed and no caching happens.
1106
# this is an explicit function so that we can do tricky stuff
1107
# when the storage in rev_storage is elsewhere.
1108
# we probably need to hook the two 'lock a location' and
1109
# 'have a transaction' together more delicately, so that
1110
# we can have two locks (branch and storage) and one transaction
1111
# ... and finishing the transaction unlocks both, but unlocking
1112
# does not. - RBC 20051121
1113
return self.control_files.get_transaction()
1115
def _set_transaction(self, transaction):
1116
"""Set a new active transaction."""
1117
return self.control_files._set_transaction(transaction)
1119
def abspath(self, name):
1120
"""See Branch.abspath."""
1121
return self.control_files._transport.abspath(name)
1123
def _check_format(self, format):
1124
"""Identify the branch format if needed.
1126
The format is stored as a reference to the format object in
1127
self._format for code that needs to check it later.
1129
The format parameter is either None or the branch format class
1130
used to open this branch.
1132
FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
1135
format = BranchFormat.find_format(self.bzrdir)
1136
self._format = format
1137
mutter("got branch format %s", self._format)
1140
def get_root_id(self):
1141
"""See Branch.get_root_id."""
1142
tree = self.repository.revision_tree(self.last_revision())
1143
return tree.inventory.root.file_id
1145
def is_locked(self):
1146
return self.control_files.is_locked()
1148
def lock_write(self, token=None):
1149
self.repository.lock_write()
1151
return self.control_files.lock_write(token=token)
1153
self.repository.unlock()
1156
def lock_read(self):
1157
self.repository.lock_read()
1159
self.control_files.lock_read()
1161
self.repository.unlock()
1165
# TODO: test for failed two phase locks. This is known broken.
1167
self.control_files.unlock()
1169
self.repository.unlock()
1171
def peek_lock_mode(self):
1172
if self.control_files._lock_count == 0:
1175
return self.control_files._lock_mode
1177
def get_physical_lock_status(self):
1178
return self.control_files.get_physical_lock_status()
1181
def print_file(self, file, revision_id):
1182
"""See Branch.print_file."""
1183
return self.repository.print_file(file, revision_id)
1186
def append_revision(self, *revision_ids):
1187
"""See Branch.append_revision."""
1188
for revision_id in revision_ids:
1189
_mod_revision.check_not_reserved_id(revision_id)
1190
mutter("add {%s} to revision-history" % revision_id)
1191
rev_history = self.revision_history()
1192
rev_history.extend(revision_ids)
1193
self.set_revision_history(rev_history)
1196
def set_revision_history(self, rev_history):
1197
"""See Branch.set_revision_history."""
1198
self.control_files.put_utf8(
1199
'revision-history', '\n'.join(rev_history))
1200
transaction = self.get_transaction()
1201
history = transaction.map.find_revision_history()
1202
if history is not None:
1203
# update the revision history in the identity map.
1204
history[:] = list(rev_history)
1205
# this call is disabled because revision_history is
1206
# not really an object yet, and the transaction is for objects.
1207
# transaction.register_dirty(history)
1209
transaction.map.add_revision_history(rev_history)
1210
# this call is disabled because revision_history is
1211
# not really an object yet, and the transaction is for objects.
1212
# transaction.register_clean(history)
1213
for hook in Branch.hooks['set_rh']:
1214
hook(self, rev_history)
1217
def revision_history(self):
1218
"""See Branch.revision_history."""
1219
transaction = self.get_transaction()
1220
history = transaction.map.find_revision_history()
1221
if history is not None:
1222
# mutter("cache hit for revision-history in %s", self)
1223
return list(history)
1224
decode_utf8 = cache_utf8.decode
1225
history = [decode_utf8(l.rstrip('\r\n')) for l in
1226
self.control_files.get('revision-history').readlines()]
1227
transaction.map.add_revision_history(history)
1228
# this call is disabled because revision_history is
1229
# not really an object yet, and the transaction is for objects.
1230
# transaction.register_clean(history, precious=True)
1231
return list(history)
1234
def generate_revision_history(self, revision_id, last_rev=None,
1236
"""Create a new revision history that will finish with revision_id.
1238
:param revision_id: the new tip to use.
1239
:param last_rev: The previous last_revision. If not None, then this
1240
must be a ancestory of revision_id, or DivergedBranches is raised.
1241
:param other_branch: The other branch that DivergedBranches should
1242
raise with respect to.
1244
# stop_revision must be a descendant of last_revision
1245
stop_graph = self.repository.get_revision_graph(revision_id)
1246
if last_rev is not None and last_rev not in stop_graph:
1247
# our previous tip is not merged into stop_revision
1248
raise errors.DivergedBranches(self, other_branch)
1249
# make a new revision history from the graph
1250
current_rev_id = revision_id
1252
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1253
new_history.append(current_rev_id)
1254
current_rev_id_parents = stop_graph[current_rev_id]
1256
current_rev_id = current_rev_id_parents[0]
1258
current_rev_id = None
1259
new_history.reverse()
1260
self.set_revision_history(new_history)
1263
def update_revisions(self, other, stop_revision=None):
1264
"""See Branch.update_revisions."""
1267
if stop_revision is None:
1268
stop_revision = other.last_revision()
1269
if stop_revision is None:
1270
# if there are no commits, we're done.
1272
# whats the current last revision, before we fetch [and change it
1274
last_rev = self.last_revision()
1275
# we fetch here regardless of whether we need to so that we pickup
1277
self.fetch(other, stop_revision)
1278
my_ancestry = self.repository.get_ancestry(last_rev)
1279
if stop_revision in my_ancestry:
1280
# last_revision is a descendant of stop_revision
1282
self.generate_revision_history(stop_revision, last_rev=last_rev,
1287
def basis_tree(self):
1288
"""See Branch.basis_tree."""
1289
return self.repository.revision_tree(self.last_revision())
1291
@deprecated_method(zero_eight)
1292
def working_tree(self):
1293
"""Create a Working tree object for this branch."""
1295
from bzrlib.transport.local import LocalTransport
1296
if (self.base.find('://') != -1 or
1297
not isinstance(self._transport, LocalTransport)):
1298
raise NoWorkingTree(self.base)
1299
return self.bzrdir.open_workingtree()
1302
def pull(self, source, overwrite=False, stop_revision=None,
1303
_hook_master=None, _run_hooks=True):
1306
:param _hook_master: Private parameter - set the branch to
1307
be supplied as the master to push hooks.
1308
:param _run_hooks: Private parameter - allow disabling of
1309
hooks, used when pushing to a master branch.
1313
old_count, old_tip = self.last_revision_info()
1315
self.update_revisions(source, stop_revision)
1316
except DivergedBranches:
1320
self.set_revision_history(source.revision_history())
1321
new_count, new_tip = self.last_revision_info()
1328
for hook in Branch.hooks['post_pull']:
1329
hook(source, _hook_local, _hook_master, old_count, old_tip,
1331
return new_count - old_count
1336
def push(self, target, overwrite=False, stop_revision=None,
1337
_hook_master=None, _run_hooks=True):
1340
:param _hook_master: Private parameter - set the branch to
1341
be supplied as the master to push hooks.
1342
:param _run_hooks: Private parameter - allow disabling of
1343
hooks, used when pushing to a master branch.
1347
old_count, old_tip = target.last_revision_info()
1349
target.update_revisions(self, stop_revision)
1350
except DivergedBranches:
1354
target.set_revision_history(self.revision_history())
1355
new_count, new_tip = target.last_revision_info()
1358
_hook_local = target
1360
_hook_master = target
1362
for hook in Branch.hooks['post_push']:
1363
hook(self, _hook_local, _hook_master, old_count, old_tip,
1365
return new_count - old_count
1369
def get_parent(self):
1370
"""See Branch.get_parent."""
1372
_locs = ['parent', 'pull', 'x-pull']
1373
assert self.base[-1] == '/'
1376
parent = self.control_files.get(l).read().strip('\n')
1379
# This is an old-format absolute path to a local branch
1380
# turn it into a url
1381
if parent.startswith('/'):
1382
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1384
return urlutils.join(self.base[:-1], parent)
1385
except errors.InvalidURLJoin, e:
1386
raise errors.InaccessibleParent(parent, self.base)
1389
def set_push_location(self, location):
1390
"""See Branch.set_push_location."""
1391
self.get_config().set_user_option(
1392
'push_location', location,
1393
store=_mod_config.STORE_LOCATION_NORECURSE)
1396
def set_parent(self, url):
1397
"""See Branch.set_parent."""
1398
# TODO: Maybe delete old location files?
1399
# URLs should never be unicode, even on the local fs,
1400
# FIXUP this and get_parent in a future branch format bump:
1401
# read and rewrite the file, and have the new format code read
1402
# using .get not .get_utf8. RBC 20060125
1404
self.control_files._transport.delete('parent')
1406
if isinstance(url, unicode):
1408
url = url.encode('ascii')
1409
except UnicodeEncodeError:
1410
raise bzrlib.errors.InvalidURL(url,
1411
"Urls must be 7-bit ascii, "
1412
"use bzrlib.urlutils.escape")
1414
url = urlutils.relative_url(self.base, url)
1415
self.control_files.put('parent', StringIO(url + '\n'))
1417
@deprecated_function(zero_nine)
1418
def tree_config(self):
1419
"""DEPRECATED; call get_config instead.
1420
TreeConfig has become part of BranchConfig."""
1421
return TreeConfig(self)
1424
class BzrBranch5(BzrBranch):
1425
"""A format 5 branch. This supports new features over plan branches.
1427
It has support for a master_branch which is the data for bound branches.
1435
super(BzrBranch5, self).__init__(_format=_format,
1436
_control_files=_control_files,
1438
_repository=_repository)
1441
def pull(self, source, overwrite=False, stop_revision=None,
1443
"""Extends branch.pull to be bound branch aware.
1445
:param _run_hooks: Private parameter used to force hook running
1446
off during bound branch double-pushing.
1448
bound_location = self.get_bound_location()
1449
master_branch = None
1450
if bound_location and source.base != bound_location:
1451
# not pulling from master, so we need to update master.
1452
master_branch = self.get_master_branch()
1453
master_branch.lock_write()
1456
# pull from source into master.
1457
master_branch.pull(source, overwrite, stop_revision,
1459
return super(BzrBranch5, self).pull(source, overwrite,
1460
stop_revision, _hook_master=master_branch,
1461
_run_hooks=_run_hooks)
1464
master_branch.unlock()
1467
def push(self, target, overwrite=False, stop_revision=None):
1468
"""Updates branch.push to be bound branch aware."""
1469
bound_location = target.get_bound_location()
1470
master_branch = None
1471
if bound_location and target.base != bound_location:
1472
# not pushing to master, so we need to update master.
1473
master_branch = target.get_master_branch()
1474
master_branch.lock_write()
1477
# push into the master from this branch.
1478
super(BzrBranch5, self).push(master_branch, overwrite,
1479
stop_revision, _run_hooks=False)
1480
# and push into the target branch from this. Note that we push from
1481
# this branch again, because its considered the highest bandwidth
1483
return super(BzrBranch5, self).push(target, overwrite,
1484
stop_revision, _hook_master=master_branch)
1487
master_branch.unlock()
1489
def get_bound_location(self):
1491
return self.control_files.get_utf8('bound').read()[:-1]
1492
except errors.NoSuchFile:
1496
def get_master_branch(self):
1497
"""Return the branch we are bound to.
1499
:return: Either a Branch, or None
1501
This could memoise the branch, but if thats done
1502
it must be revalidated on each new lock.
1503
So for now we just don't memoise it.
1504
# RBC 20060304 review this decision.
1506
bound_loc = self.get_bound_location()
1510
return Branch.open(bound_loc)
1511
except (errors.NotBranchError, errors.ConnectionError), e:
1512
raise errors.BoundBranchConnectionFailure(
1516
def set_bound_location(self, location):
1517
"""Set the target where this branch is bound to.
1519
:param location: URL to the target branch
1522
self.control_files.put_utf8('bound', location+'\n')
1525
self.control_files._transport.delete('bound')
1531
def bind(self, other):
1532
"""Bind this branch to the branch other.
1534
This does not push or pull data between the branches, though it does
1535
check for divergence to raise an error when the branches are not
1536
either the same, or one a prefix of the other. That behaviour may not
1537
be useful, so that check may be removed in future.
1539
:param other: The branch to bind to
1542
# TODO: jam 20051230 Consider checking if the target is bound
1543
# It is debatable whether you should be able to bind to
1544
# a branch which is itself bound.
1545
# Committing is obviously forbidden,
1546
# but binding itself may not be.
1547
# Since we *have* to check at commit time, we don't
1548
# *need* to check here
1550
# we want to raise diverged if:
1551
# last_rev is not in the other_last_rev history, AND
1552
# other_last_rev is not in our history, and do it without pulling
1554
last_rev = self.last_revision()
1555
if last_rev is not None:
1558
other_last_rev = other.last_revision()
1559
if other_last_rev is not None:
1560
# neither branch is new, we have to do some work to
1561
# ascertain diversion.
1562
remote_graph = other.repository.get_revision_graph(
1564
local_graph = self.repository.get_revision_graph(last_rev)
1565
if (last_rev not in remote_graph and
1566
other_last_rev not in local_graph):
1567
raise errors.DivergedBranches(self, other)
1570
self.set_bound_location(other.base)
1574
"""If bound, unbind"""
1575
return self.set_bound_location(None)
1579
"""Synchronise this branch with the master branch if any.
1581
:return: None or the last_revision that was pivoted out during the
1584
master = self.get_master_branch()
1585
if master is not None:
1586
old_tip = self.last_revision()
1587
self.pull(master, overwrite=True)
1588
if old_tip in self.repository.get_ancestry(self.last_revision()):
1594
class BranchTestProviderAdapter(object):
1595
"""A tool to generate a suite testing multiple branch formats at once.
1597
This is done by copying the test once for each transport and injecting
1598
the transport_server, transport_readonly_server, and branch_format
1599
classes into each copy. Each copy is also given a new id() to make it
1603
def __init__(self, transport_server, transport_readonly_server, formats,
1604
vfs_transport_factory=None):
1605
self._transport_server = transport_server
1606
self._transport_readonly_server = transport_readonly_server
1607
self._formats = formats
1608
self._vfs_transport_factory = vfs_transport_factory
1610
def adapt(self, test):
1611
result = TestSuite()
1612
for branch_format, bzrdir_format in self._formats:
1613
new_test = deepcopy(test)
1614
new_test.transport_server = self._transport_server
1615
new_test.transport_readonly_server = self._transport_readonly_server
1616
if self._vfs_transport_factory:
1617
new_test.vfs_transport_factory = self._vfs_transport_factory
1618
new_test.bzrdir_format = bzrdir_format
1619
new_test.branch_format = branch_format
1620
def make_new_test_id():
1621
new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
1622
return lambda: new_id
1623
new_test.id = make_new_test_id()
1624
result.addTest(new_test)
1628
class BranchCheckResult(object):
1629
"""Results of checking branch consistency.
1634
def __init__(self, branch):
1635
self.branch = branch
1637
def report_results(self, verbose):
1638
"""Report the check results via trace.note.
1640
:param verbose: Requests more detailed display of what was checked,
1643
note('checked branch %s format %s',
1645
self.branch._format)
1648
######################################################################
1652
@deprecated_function(zero_eight)
1653
def is_control_file(*args, **kwargs):
1654
"""See bzrlib.workingtree.is_control_file."""
1655
from bzrlib import workingtree
1656
return workingtree.is_control_file(*args, **kwargs)
added
removed
bzrlib/branch.py
