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
43
from bzrlib.tag import (
49
from bzrlib.decorators import needs_read_lock, needs_write_lock
50
from bzrlib.errors import (BzrError, BzrCheckError, DivergedBranches,
51
HistoryMissing, InvalidRevisionId,
52
InvalidRevisionNumber, LockError, NoSuchFile,
53
NoSuchRevision, NoWorkingTree, NotVersionedError,
54
NotBranchError, UninitializableFormat,
55
UnlistableStore, UnlistableBranch,
57
from bzrlib.symbol_versioning import (deprecated_function,
61
zero_eight, zero_nine,
63
from bzrlib.trace import mutter, note
66
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
67
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
68
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
71
# TODO: Maybe include checks for common corruption of newlines, etc?
73
# TODO: Some operations like log might retrieve the same revisions
74
# repeatedly to calculate deltas. We could perhaps have a weakref
75
# cache in memory to make this faster. In general anything can be
76
# cached in memory between lock and unlock operations. .. nb thats
77
# what the transaction identity map provides
80
######################################################################
84
"""Branch holding a history of revisions.
87
Base directory/url of the branch.
89
hooks: An instance of BranchHooks.
91
# this is really an instance variable - FIXME move it there
95
# override this to set the strategy for storing tags
97
return DisabledTags(self)
99
def __init__(self, *ignored, **ignored_too):
100
self.tags = self._make_tags()
102
def break_lock(self):
103
"""Break a lock if one is present from another instance.
105
Uses the ui factory to ask for confirmation if the lock may be from
108
This will probe the repository for its lock as well.
110
self.control_files.break_lock()
111
self.repository.break_lock()
112
master = self.get_master_branch()
113
if master is not None:
117
@deprecated_method(zero_eight)
118
def open_downlevel(base):
119
"""Open a branch which may be of an old format."""
120
return Branch.open(base, _unsupported=True)
123
def open(base, _unsupported=False):
124
"""Open the branch rooted at base.
126
For instance, if the branch is at URL/.bzr/branch,
127
Branch.open(URL) -> a Branch instance.
129
control = bzrdir.BzrDir.open(base, _unsupported)
130
return control.open_branch(_unsupported)
133
def open_containing(url):
134
"""Open an existing branch which contains url.
136
This probes for a branch at url, and searches upwards from there.
138
Basically we keep looking up until we find the control directory or
139
run into the root. If there isn't one, raises NotBranchError.
140
If there is one and it is either an unrecognised format or an unsupported
141
format, UnknownFormatError or UnsupportedFormatError are raised.
142
If there is one, it is returned, along with the unused portion of url.
144
control, relpath = bzrdir.BzrDir.open_containing(url)
145
return control.open_branch(), relpath
148
@deprecated_function(zero_eight)
149
def initialize(base):
150
"""Create a new working tree and branch, rooted at 'base' (url)
152
NOTE: This will soon be deprecated in favour of creation
155
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
157
@deprecated_function(zero_eight)
158
def setup_caching(self, cache_root):
159
"""Subclasses that care about caching should override this, and set
160
up cached stores located under cache_root.
162
NOTE: This is unused.
166
def get_config(self):
167
return BranchConfig(self)
170
return self.get_config().get_nickname()
172
def _set_nick(self, nick):
173
self.get_config().set_user_option('nickname', nick)
175
nick = property(_get_nick, _set_nick)
178
raise NotImplementedError(self.is_locked)
180
def lock_write(self):
181
raise NotImplementedError(self.lock_write)
184
raise NotImplementedError(self.lock_read)
187
raise NotImplementedError(self.unlock)
189
def peek_lock_mode(self):
190
"""Return lock mode for the Branch: 'r', 'w' or None"""
191
raise NotImplementedError(self.peek_lock_mode)
193
def get_physical_lock_status(self):
194
raise NotImplementedError(self.get_physical_lock_status)
196
def abspath(self, name):
197
"""Return absolute filename for something in the branch
199
XXX: Robert Collins 20051017 what is this used for? why is it a branch
200
method and not a tree method.
202
raise NotImplementedError(self.abspath)
204
def bind(self, other):
205
"""Bind the local branch the other branch.
207
:param other: The branch to bind to
210
raise errors.UpgradeRequired(self.base)
213
def fetch(self, from_branch, last_revision=None, pb=None):
214
"""Copy revisions from from_branch into this branch.
216
:param from_branch: Where to copy from.
217
:param last_revision: What revision to stop at (None for at the end
219
:param pb: An optional progress bar to use.
221
Returns the copied revision count and the failed revisions in a tuple:
224
if self.base == from_branch.base:
227
nested_pb = ui.ui_factory.nested_progress_bar()
232
from_branch.lock_read()
234
if last_revision is None:
235
pb.update('get source history')
236
last_revision = from_branch.last_revision()
237
if last_revision is None:
238
last_revision = _mod_revision.NULL_REVISION
239
return self.repository.fetch(from_branch.repository,
240
revision_id=last_revision,
243
if nested_pb is not None:
247
def get_bound_location(self):
248
"""Return the URL of the branch we are bound to.
250
Older format branches cannot bind, please be sure to use a metadir
255
def get_old_bound_location(self):
256
"""Return the URL of the branch we used to be bound to
258
raise errors.UpgradeRequired(self.base)
260
def get_commit_builder(self, parents, config=None, timestamp=None,
261
timezone=None, committer=None, revprops=None,
263
"""Obtain a CommitBuilder for this branch.
265
:param parents: Revision ids of the parents of the new revision.
266
:param config: Optional configuration to use.
267
:param timestamp: Optional timestamp recorded for commit.
268
:param timezone: Optional timezone for timestamp.
269
:param committer: Optional committer to set for commit.
270
:param revprops: Optional dictionary of revision properties.
271
:param revision_id: Optional revision id.
275
config = self.get_config()
277
return self.repository.get_commit_builder(self, parents, config,
278
timestamp, timezone, committer, revprops, revision_id)
280
def get_master_branch(self):
281
"""Return the branch we are bound to.
283
:return: Either a Branch, or None
287
def get_revision_delta(self, revno):
288
"""Return the delta for one revision.
290
The delta is relative to its mainline predecessor, or the
291
empty tree for revision 1.
293
assert isinstance(revno, int)
294
rh = self.revision_history()
295
if not (1 <= revno <= len(rh)):
296
raise InvalidRevisionNumber(revno)
297
return self.repository.get_revision_delta(rh[revno-1])
299
def get_root_id(self):
300
"""Return the id of this branches root"""
301
raise NotImplementedError(self.get_root_id)
303
def print_file(self, file, revision_id):
304
"""Print `file` to stdout."""
305
raise NotImplementedError(self.print_file)
307
def append_revision(self, *revision_ids):
308
raise NotImplementedError(self.append_revision)
310
def set_revision_history(self, rev_history):
311
raise NotImplementedError(self.set_revision_history)
313
def revision_history(self):
314
"""Return sequence of revision hashes on to this branch."""
315
raise NotImplementedError(self.revision_history)
318
"""Return current revision number for this branch.
320
That is equivalent to the number of revisions committed to
323
return len(self.revision_history())
326
"""Older format branches cannot bind or unbind."""
327
raise errors.UpgradeRequired(self.base)
329
def set_append_revisions_only(self, enabled):
330
"""Older format branches are never restricted to append-only"""
331
raise errors.UpgradeRequired(self.base)
333
def last_revision(self):
334
"""Return last revision id, or None"""
335
ph = self.revision_history()
341
def last_revision_info(self):
342
"""Return information about the last revision.
344
:return: A tuple (revno, last_revision_id).
346
rh = self.revision_history()
349
return (revno, rh[-1])
351
return (0, _mod_revision.NULL_REVISION)
353
def missing_revisions(self, other, stop_revision=None):
354
"""Return a list of new revisions that would perfectly fit.
356
If self and other have not diverged, return a list of the revisions
357
present in other, but missing from self.
359
self_history = self.revision_history()
360
self_len = len(self_history)
361
other_history = other.revision_history()
362
other_len = len(other_history)
363
common_index = min(self_len, other_len) -1
364
if common_index >= 0 and \
365
self_history[common_index] != other_history[common_index]:
366
raise DivergedBranches(self, other)
368
if stop_revision is None:
369
stop_revision = other_len
371
assert isinstance(stop_revision, int)
372
if stop_revision > other_len:
373
raise errors.NoSuchRevision(self, stop_revision)
374
return other_history[self_len:stop_revision]
376
def update_revisions(self, other, stop_revision=None):
377
"""Pull in new perfect-fit revisions.
379
:param other: Another Branch to pull from
380
:param stop_revision: Updated until the given revision
383
raise NotImplementedError(self.update_revisions)
385
def revision_id_to_revno(self, revision_id):
386
"""Given a revision id, return its revno"""
387
if revision_id is None:
389
revision_id = osutils.safe_revision_id(revision_id)
390
history = self.revision_history()
392
return history.index(revision_id) + 1
394
raise bzrlib.errors.NoSuchRevision(self, revision_id)
396
def get_rev_id(self, revno, history=None):
397
"""Find the revision id of the specified revno."""
401
history = self.revision_history()
402
if revno <= 0 or revno > len(history):
403
raise bzrlib.errors.NoSuchRevision(self, revno)
404
return history[revno - 1]
406
def pull(self, source, overwrite=False, stop_revision=None):
407
"""Mirror source into this branch.
409
This branch is considered to be 'local', having low latency.
411
:returns: PullResult instance
413
raise NotImplementedError(self.pull)
415
def push(self, target, overwrite=False, stop_revision=None):
416
"""Mirror this branch into target.
418
This branch is considered to be 'local', having low latency.
420
raise NotImplementedError(self.push)
422
def basis_tree(self):
423
"""Return `Tree` object for last revision."""
424
return self.repository.revision_tree(self.last_revision())
426
def rename_one(self, from_rel, to_rel):
429
This can change the directory or the filename or both.
431
raise NotImplementedError(self.rename_one)
433
def move(self, from_paths, to_name):
436
to_name must exist as a versioned directory.
438
If to_name exists and is a directory, the files are moved into
439
it, keeping their old names. If it is a directory,
441
Note that to_name is only the last component of the new name;
442
this doesn't change the directory.
444
This returns a list of (from_path, to_path) pairs for each
447
raise NotImplementedError(self.move)
449
def get_parent(self):
450
"""Return the parent location of the branch.
452
This is the default location for push/pull/missing. The usual
453
pattern is that the user can override it by specifying a
456
raise NotImplementedError(self.get_parent)
458
def _set_config_location(self, name, url, config=None,
459
make_relative=False):
461
config = self.get_config()
465
url = urlutils.relative_url(self.base, url)
466
config.set_user_option(name, url)
468
def _get_config_location(self, name, config=None):
470
config = self.get_config()
471
location = config.get_user_option(name)
476
def get_submit_branch(self):
477
"""Return the submit location of the branch.
479
This is the default location for bundle. The usual
480
pattern is that the user can override it by specifying a
483
return self.get_config().get_user_option('submit_branch')
485
def set_submit_branch(self, location):
486
"""Return the submit location of the branch.
488
This is the default location for bundle. The usual
489
pattern is that the user can override it by specifying a
492
self.get_config().set_user_option('submit_branch', location)
494
def get_public_branch(self):
495
"""Return the public location of the branch.
497
This is is used by merge directives.
499
return self._get_config_location('public_branch')
501
def set_public_branch(self, location):
502
"""Return the submit location of the branch.
504
This is the default location for bundle. The usual
505
pattern is that the user can override it by specifying a
508
self._set_config_location('public_branch', location)
510
def get_push_location(self):
511
"""Return the None or the location to push this branch to."""
512
raise NotImplementedError(self.get_push_location)
514
def set_push_location(self, location):
515
"""Set a new push location for this branch."""
516
raise NotImplementedError(self.set_push_location)
518
def set_parent(self, url):
519
raise NotImplementedError(self.set_parent)
523
"""Synchronise this branch with the master branch if any.
525
:return: None or the last_revision pivoted out during the update.
529
def check_revno(self, revno):
531
Check whether a revno corresponds to any revision.
532
Zero (the NULL revision) is considered valid.
535
self.check_real_revno(revno)
537
def check_real_revno(self, revno):
539
Check whether a revno corresponds to a real revision.
540
Zero (the NULL revision) is considered invalid
542
if revno < 1 or revno > self.revno():
543
raise InvalidRevisionNumber(revno)
546
def clone(self, *args, **kwargs):
547
"""Clone this branch into to_bzrdir preserving all semantic values.
549
revision_id: if not None, the revision history in the new branch will
550
be truncated to end with revision_id.
552
# for API compatibility, until 0.8 releases we provide the old api:
553
# def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
554
# after 0.8 releases, the *args and **kwargs should be changed:
555
# def clone(self, to_bzrdir, revision_id=None):
556
if (kwargs.get('to_location', None) or
557
kwargs.get('revision', None) or
558
kwargs.get('basis_branch', None) or
559
(len(args) and isinstance(args[0], basestring))):
560
# backwards compatibility api:
561
warn("Branch.clone() has been deprecated for BzrDir.clone() from"
562
" bzrlib 0.8.", DeprecationWarning, stacklevel=3)
565
basis_branch = args[2]
567
basis_branch = kwargs.get('basis_branch', None)
569
basis = basis_branch.bzrdir
574
revision_id = args[1]
576
revision_id = kwargs.get('revision', None)
581
# no default to raise if not provided.
582
url = kwargs.get('to_location')
583
return self.bzrdir.clone(url,
584
revision_id=revision_id,
585
basis=basis).open_branch()
587
# generate args by hand
589
revision_id = args[1]
591
revision_id = kwargs.get('revision_id', None)
595
# no default to raise if not provided.
596
to_bzrdir = kwargs.get('to_bzrdir')
597
result = self._format.initialize(to_bzrdir)
598
self.copy_content_into(result, revision_id=revision_id)
602
def sprout(self, to_bzrdir, revision_id=None):
603
"""Create a new line of development from the branch, into to_bzrdir.
605
revision_id: if not None, the revision history in the new branch will
606
be truncated to end with revision_id.
608
result = self._format.initialize(to_bzrdir)
609
self.copy_content_into(result, revision_id=revision_id)
610
result.set_parent(self.bzrdir.root_transport.base)
613
def _synchronize_history(self, destination, revision_id):
614
"""Synchronize last revision and revision history between branches.
616
This version is most efficient when the destination is also a
617
BzrBranch5, but works for BzrBranch6 as long as the revision
618
history is the true lefthand parent history, and all of the revisions
619
are in the destination's repository. If not, set_revision_history
622
:param destination: The branch to copy the history into
623
:param revision_id: The revision-id to truncate history at. May
624
be None to copy complete history.
626
new_history = self.revision_history()
627
if revision_id is not None:
628
revision_id = osutils.safe_revision_id(revision_id)
630
new_history = new_history[:new_history.index(revision_id) + 1]
632
rev = self.repository.get_revision(revision_id)
633
new_history = rev.get_history(self.repository)[1:]
634
destination.set_revision_history(new_history)
637
def copy_content_into(self, destination, revision_id=None):
638
"""Copy the content of self into destination.
640
revision_id: if not None, the revision history in the new branch will
641
be truncated to end with revision_id.
643
self._synchronize_history(destination, revision_id)
645
parent = self.get_parent()
646
except errors.InaccessibleParent, e:
647
mutter('parent was not accessible to copy: %s', e)
650
destination.set_parent(parent)
654
"""Check consistency of the branch.
656
In particular this checks that revisions given in the revision-history
657
do actually match up in the revision graph, and that they're all
658
present in the repository.
660
Callers will typically also want to check the repository.
662
:return: A BranchCheckResult.
664
mainline_parent_id = None
665
for revision_id in self.revision_history():
667
revision = self.repository.get_revision(revision_id)
668
except errors.NoSuchRevision, e:
669
raise errors.BzrCheckError("mainline revision {%s} not in repository"
671
# In general the first entry on the revision history has no parents.
672
# But it's not illegal for it to have parents listed; this can happen
673
# in imports from Arch when the parents weren't reachable.
674
if mainline_parent_id is not None:
675
if mainline_parent_id not in revision.parent_ids:
676
raise errors.BzrCheckError("previous revision {%s} not listed among "
678
% (mainline_parent_id, revision_id))
679
mainline_parent_id = revision_id
680
return BranchCheckResult(self)
682
def _get_checkout_format(self):
683
"""Return the most suitable metadir for a checkout of this branch.
684
Weaves are used if this branch's repostory uses weaves.
686
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
687
from bzrlib.repofmt import weaverepo
688
format = bzrdir.BzrDirMetaFormat1()
689
format.repository_format = weaverepo.RepositoryFormat7()
691
format = self.repository.bzrdir.checkout_metadir()
692
format.branch_format = self._format
695
def create_checkout(self, to_location, revision_id=None,
697
"""Create a checkout of a branch.
699
:param to_location: The url to produce the checkout at
700
:param revision_id: The revision to check out
701
:param lightweight: If True, produce a lightweight checkout, otherwise,
702
produce a bound branch (heavyweight checkout)
703
:return: The tree of the created checkout
705
t = transport.get_transport(to_location)
708
except errors.FileExists:
711
format = self._get_checkout_format()
712
checkout = format.initialize_on_transport(t)
713
BranchReferenceFormat().initialize(checkout, self)
715
format = self._get_checkout_format()
716
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
717
to_location, force_new_tree=False, format=format)
718
checkout = checkout_branch.bzrdir
719
checkout_branch.bind(self)
720
# pull up to the specified revision_id to set the initial
721
# branch tip correctly, and seed it with history.
722
checkout_branch.pull(self, stop_revision=revision_id)
723
tree = checkout.create_workingtree(revision_id)
724
basis_tree = tree.basis_tree()
725
basis_tree.lock_read()
727
for path, file_id in basis_tree.iter_references():
728
reference_parent = self.reference_parent(file_id, path)
729
reference_parent.create_checkout(tree.abspath(path),
730
basis_tree.get_reference_revision(file_id, path),
736
def reference_parent(self, file_id, path):
737
"""Return the parent branch for a tree-reference file_id
738
:param file_id: The file_id of the tree reference
739
:param path: The path of the file_id in the tree
740
:return: A branch associated with the file_id
742
# FIXME should provide multiple branches, based on config
743
return Branch.open(self.bzrdir.root_transport.clone(path).base)
745
def supports_tags(self):
746
return self._format.supports_tags()
749
class BranchFormat(object):
750
"""An encapsulation of the initialization and open routines for a format.
752
Formats provide three things:
753
* An initialization routine,
757
Formats are placed in an dict by their format string for reference
758
during branch opening. Its not required that these be instances, they
759
can be classes themselves with class methods - it simply depends on
760
whether state is needed for a given format or not.
762
Once a format is deprecated, just deprecate the initialize and open
763
methods on the format class. Do not deprecate the object, as the
764
object will be created every time regardless.
767
_default_format = None
768
"""The default format used for new branches."""
771
"""The known formats."""
774
def find_format(klass, a_bzrdir):
775
"""Return the format for the branch object in a_bzrdir."""
777
transport = a_bzrdir.get_branch_transport(None)
778
format_string = transport.get("format").read()
779
return klass._formats[format_string]
781
raise NotBranchError(path=transport.base)
783
raise errors.UnknownFormatError(format=format_string)
786
def get_default_format(klass):
787
"""Return the current default format."""
788
return klass._default_format
790
def get_format_string(self):
791
"""Return the ASCII format string that identifies this format."""
792
raise NotImplementedError(self.get_format_string)
794
def get_format_description(self):
795
"""Return the short format description for this format."""
796
raise NotImplementedError(self.get_format_description)
798
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
800
"""Initialize a branch in a bzrdir, with specified files
802
:param a_bzrdir: The bzrdir to initialize the branch in
803
:param utf8_files: The files to create as a list of
804
(filename, content) tuples
805
:param set_format: If True, set the format with
806
self.get_format_string. (BzrBranch4 has its format set
808
:return: a branch in this format
810
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
811
branch_transport = a_bzrdir.get_branch_transport(self)
813
'metadir': ('lock', lockdir.LockDir),
814
'branch4': ('branch-lock', lockable_files.TransportLock),
816
lock_name, lock_class = lock_map[lock_type]
817
control_files = lockable_files.LockableFiles(branch_transport,
818
lock_name, lock_class)
819
control_files.create_lock()
820
control_files.lock_write()
822
control_files.put_utf8('format', self.get_format_string())
824
for file, content in utf8_files:
825
control_files.put_utf8(file, content)
827
control_files.unlock()
828
return self.open(a_bzrdir, _found=True)
830
def initialize(self, a_bzrdir):
831
"""Create a branch of this format in a_bzrdir."""
832
raise NotImplementedError(self.initialize)
834
def is_supported(self):
835
"""Is this format supported?
837
Supported formats can be initialized and opened.
838
Unsupported formats may not support initialization or committing or
839
some other features depending on the reason for not being supported.
843
def open(self, a_bzrdir, _found=False):
844
"""Return the branch object for a_bzrdir
846
_found is a private parameter, do not use it. It is used to indicate
847
if format probing has already be done.
849
raise NotImplementedError(self.open)
852
def register_format(klass, format):
853
klass._formats[format.get_format_string()] = format
856
def set_default_format(klass, format):
857
klass._default_format = format
860
def unregister_format(klass, format):
861
assert klass._formats[format.get_format_string()] is format
862
del klass._formats[format.get_format_string()]
865
return self.get_format_string().rstrip()
867
def supports_tags(self):
868
"""True if this format supports tags stored in the branch"""
869
return False # by default
871
# XXX: Probably doesn't really belong here -- mbp 20070212
872
def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
874
branch_transport = a_bzrdir.get_branch_transport(self)
875
control_files = lockable_files.LockableFiles(branch_transport,
876
lock_filename, lock_class)
877
control_files.create_lock()
878
control_files.lock_write()
880
for filename, content in utf8_files:
881
control_files.put_utf8(filename, content)
883
control_files.unlock()
886
class BranchHooks(dict):
887
"""A dictionary mapping hook name to a list of callables for branch hooks.
889
e.g. ['set_rh'] Is the list of items to be called when the
890
set_revision_history function is invoked.
894
"""Create the default hooks.
896
These are all empty initially, because by default nothing should get
900
# Introduced in 0.15:
901
# invoked whenever the revision history has been set
902
# with set_revision_history. The api signature is
903
# (branch, revision_history), and the branch will
906
# invoked after a push operation completes.
907
# the api signature is
909
# containing the members
910
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
911
# where local is the local branch or None, master is the target
912
# master branch, and the rest should be self explanatory. The source
913
# is read locked and the target branches write locked. Source will
914
# be the local low-latency branch.
915
self['post_push'] = []
916
# invoked after a pull operation completes.
917
# the api signature is
919
# containing the members
920
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
921
# where local is the local branch or None, master is the target
922
# master branch, and the rest should be self explanatory. The source
923
# is read locked and the target branches write locked. The local
924
# branch is the low-latency branch.
925
self['post_pull'] = []
926
# invoked after a commit operation completes.
927
# the api signature is
928
# (local, master, old_revno, old_revid, new_revno, new_revid)
929
# old_revid is NULL_REVISION for the first commit to a branch.
930
self['post_commit'] = []
931
# invoked after a uncommit operation completes.
932
# the api signature is
933
# (local, master, old_revno, old_revid, new_revno, new_revid) where
934
# local is the local branch or None, master is the target branch,
935
# and an empty branch recieves new_revno of 0, new_revid of None.
936
self['post_uncommit'] = []
938
def install_hook(self, hook_name, a_callable):
939
"""Install a_callable in to the hook hook_name.
941
:param hook_name: A hook name. See the __init__ method of BranchHooks
942
for the complete list of hooks.
943
:param a_callable: The callable to be invoked when the hook triggers.
944
The exact signature will depend on the hook - see the __init__
945
method of BranchHooks for details on each hook.
948
self[hook_name].append(a_callable)
950
raise errors.UnknownHook('branch', hook_name)
953
# install the default hooks into the Branch class.
954
Branch.hooks = BranchHooks()
957
class BzrBranchFormat4(BranchFormat):
958
"""Bzr branch format 4.
961
- a revision-history file.
962
- a branch-lock lock file [ to be shared with the bzrdir ]
965
def get_format_description(self):
966
"""See BranchFormat.get_format_description()."""
967
return "Branch format 4"
969
def initialize(self, a_bzrdir):
970
"""Create a branch of this format in a_bzrdir."""
971
utf8_files = [('revision-history', ''),
974
return self._initialize_helper(a_bzrdir, utf8_files,
975
lock_type='branch4', set_format=False)
978
super(BzrBranchFormat4, self).__init__()
979
self._matchingbzrdir = bzrdir.BzrDirFormat6()
981
def open(self, a_bzrdir, _found=False):
982
"""Return the branch object for a_bzrdir
984
_found is a private parameter, do not use it. It is used to indicate
985
if format probing has already be done.
988
# we are being called directly and must probe.
989
raise NotImplementedError
990
return BzrBranch(_format=self,
991
_control_files=a_bzrdir._control_files,
993
_repository=a_bzrdir.open_repository())
996
return "Bazaar-NG branch format 4"
999
class BzrBranchFormat5(BranchFormat):
1000
"""Bzr branch format 5.
1003
- a revision-history file.
1005
- a lock dir guarding the branch itself
1006
- all of this stored in a branch/ subdirectory
1007
- works with shared repositories.
1009
This format is new in bzr 0.8.
1012
def get_format_string(self):
1013
"""See BranchFormat.get_format_string()."""
1014
return "Bazaar-NG branch format 5\n"
1016
def get_format_description(self):
1017
"""See BranchFormat.get_format_description()."""
1018
return "Branch format 5"
1020
def initialize(self, a_bzrdir):
1021
"""Create a branch of this format in a_bzrdir."""
1022
utf8_files = [('revision-history', ''),
1023
('branch-name', ''),
1025
return self._initialize_helper(a_bzrdir, utf8_files)
1028
super(BzrBranchFormat5, self).__init__()
1029
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1031
def open(self, a_bzrdir, _found=False):
1032
"""Return the branch object for a_bzrdir
1034
_found is a private parameter, do not use it. It is used to indicate
1035
if format probing has already be done.
1038
format = BranchFormat.find_format(a_bzrdir)
1039
assert format.__class__ == self.__class__
1040
transport = a_bzrdir.get_branch_transport(None)
1041
control_files = lockable_files.LockableFiles(transport, 'lock',
1043
return BzrBranch5(_format=self,
1044
_control_files=control_files,
1046
_repository=a_bzrdir.find_repository())
1049
class BzrBranchFormat6(BzrBranchFormat5):
1050
"""Branch format with last-revision
1052
Unlike previous formats, this has no explicit revision history. Instead,
1053
this just stores the last-revision, and the left-hand history leading
1054
up to there is the history.
1056
This format was introduced in bzr 0.15
1059
def get_format_string(self):
1060
"""See BranchFormat.get_format_string()."""
1061
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1063
def get_format_description(self):
1064
"""See BranchFormat.get_format_description()."""
1065
return "Branch format 6"
1067
def initialize(self, a_bzrdir):
1068
"""Create a branch of this format in a_bzrdir."""
1069
utf8_files = [('last-revision', '0 null:\n'),
1070
('branch-name', ''),
1071
('branch.conf', ''),
1074
return self._initialize_helper(a_bzrdir, utf8_files)
1076
def open(self, a_bzrdir, _found=False):
1077
"""Return the branch object for a_bzrdir
1079
_found is a private parameter, do not use it. It is used to indicate
1080
if format probing has already be done.
1083
format = BranchFormat.find_format(a_bzrdir)
1084
assert format.__class__ == self.__class__
1085
transport = a_bzrdir.get_branch_transport(None)
1086
control_files = lockable_files.LockableFiles(transport, 'lock',
1088
return BzrBranch6(_format=self,
1089
_control_files=control_files,
1091
_repository=a_bzrdir.find_repository())
1093
def supports_tags(self):
1097
class BranchReferenceFormat(BranchFormat):
1098
"""Bzr branch reference format.
1100
Branch references are used in implementing checkouts, they
1101
act as an alias to the real branch which is at some other url.
1108
def get_format_string(self):
1109
"""See BranchFormat.get_format_string()."""
1110
return "Bazaar-NG Branch Reference Format 1\n"
1112
def get_format_description(self):
1113
"""See BranchFormat.get_format_description()."""
1114
return "Checkout reference format 1"
1116
def initialize(self, a_bzrdir, target_branch=None):
1117
"""Create a branch of this format in a_bzrdir."""
1118
if target_branch is None:
1119
# this format does not implement branch itself, thus the implicit
1120
# creation contract must see it as uninitializable
1121
raise errors.UninitializableFormat(self)
1122
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1123
branch_transport = a_bzrdir.get_branch_transport(self)
1124
branch_transport.put_bytes('location',
1125
target_branch.bzrdir.root_transport.base)
1126
branch_transport.put_bytes('format', self.get_format_string())
1127
return self.open(a_bzrdir, _found=True)
1130
super(BranchReferenceFormat, self).__init__()
1131
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1133
def _make_reference_clone_function(format, a_branch):
1134
"""Create a clone() routine for a branch dynamically."""
1135
def clone(to_bzrdir, revision_id=None):
1136
"""See Branch.clone()."""
1137
return format.initialize(to_bzrdir, a_branch)
1138
# cannot obey revision_id limits when cloning a reference ...
1139
# FIXME RBC 20060210 either nuke revision_id for clone, or
1140
# emit some sort of warning/error to the caller ?!
1143
def open(self, a_bzrdir, _found=False):
1144
"""Return the branch that the branch reference in a_bzrdir points at.
1146
_found is a private parameter, do not use it. It is used to indicate
1147
if format probing has already be done.
1150
format = BranchFormat.find_format(a_bzrdir)
1151
assert format.__class__ == self.__class__
1152
transport = a_bzrdir.get_branch_transport(None)
1153
real_bzrdir = bzrdir.BzrDir.open(transport.get('location').read())
1154
result = real_bzrdir.open_branch()
1155
# this changes the behaviour of result.clone to create a new reference
1156
# rather than a copy of the content of the branch.
1157
# I did not use a proxy object because that needs much more extensive
1158
# testing, and we are only changing one behaviour at the moment.
1159
# If we decide to alter more behaviours - i.e. the implicit nickname
1160
# then this should be refactored to introduce a tested proxy branch
1161
# and a subclass of that for use in overriding clone() and ....
1163
result.clone = self._make_reference_clone_function(result)
1167
# formats which have no format string are not discoverable
1168
# and not independently creatable, so are not registered.
1169
__default_format = BzrBranchFormat5()
1170
BranchFormat.register_format(__default_format)
1171
BranchFormat.register_format(BranchReferenceFormat())
1172
BranchFormat.register_format(BzrBranchFormat6())
1173
BranchFormat.set_default_format(__default_format)
1174
_legacy_formats = [BzrBranchFormat4(),
1177
class BzrBranch(Branch):
1178
"""A branch stored in the actual filesystem.
1180
Note that it's "local" in the context of the filesystem; it doesn't
1181
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1182
it's writable, and can be accessed via the normal filesystem API.
1185
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
1186
relax_version_check=DEPRECATED_PARAMETER, _format=None,
1187
_control_files=None, a_bzrdir=None, _repository=None):
1188
"""Create new branch object at a particular location.
1190
transport -- A Transport object, defining how to access files.
1192
init -- If True, create new control files in a previously
1193
unversioned directory. If False, the branch must already
1196
relax_version_check -- If true, the usual check for the branch
1197
version is not applied. This is intended only for
1198
upgrade/recovery type use; it's not guaranteed that
1199
all operations will work on old format branches.
1201
Branch.__init__(self)
1202
if a_bzrdir is None:
1203
self.bzrdir = bzrdir.BzrDir.open(transport.base)
1205
self.bzrdir = a_bzrdir
1206
# self._transport used to point to the directory containing the
1207
# control directory, but was not used - now it's just the transport
1208
# for the branch control files. mbp 20070212
1209
self._base = self.bzrdir.transport.clone('..').base
1210
self._format = _format
1211
if _control_files is None:
1212
raise ValueError('BzrBranch _control_files is None')
1213
self.control_files = _control_files
1214
self._transport = _control_files._transport
1215
if deprecated_passed(init):
1216
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
1217
"deprecated as of bzr 0.8. Please use Branch.create().",
1221
# this is slower than before deprecation, oh well never mind.
1222
# -> its deprecated.
1223
self._initialize(transport.base)
1224
self._check_format(_format)
1225
if deprecated_passed(relax_version_check):
1226
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
1227
"relax_version_check parameter is deprecated as of bzr 0.8. "
1228
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
1232
if (not relax_version_check
1233
and not self._format.is_supported()):
1234
raise errors.UnsupportedFormatError(format=fmt)
1235
if deprecated_passed(transport):
1236
warn("BzrBranch.__init__(transport=XXX...): The transport "
1237
"parameter is deprecated as of bzr 0.8. "
1238
"Please use Branch.open, or bzrdir.open_branch().",
1241
self.repository = _repository
1244
return '%s(%r)' % (self.__class__.__name__, self.base)
1248
def _get_base(self):
1249
"""Returns the directory containing the control directory."""
1252
base = property(_get_base, doc="The URL for the root of this branch.")
1254
def _finish_transaction(self):
1255
"""Exit the current transaction."""
1256
return self.control_files._finish_transaction()
1258
def get_transaction(self):
1259
"""Return the current active transaction.
1261
If no transaction is active, this returns a passthrough object
1262
for which all data is immediately flushed and no caching happens.
1264
# this is an explicit function so that we can do tricky stuff
1265
# when the storage in rev_storage is elsewhere.
1266
# we probably need to hook the two 'lock a location' and
1267
# 'have a transaction' together more delicately, so that
1268
# we can have two locks (branch and storage) and one transaction
1269
# ... and finishing the transaction unlocks both, but unlocking
1270
# does not. - RBC 20051121
1271
return self.control_files.get_transaction()
1273
def _set_transaction(self, transaction):
1274
"""Set a new active transaction."""
1275
return self.control_files._set_transaction(transaction)
1277
def abspath(self, name):
1278
"""See Branch.abspath."""
1279
return self.control_files._transport.abspath(name)
1281
def _check_format(self, format):
1282
"""Identify the branch format if needed.
1284
The format is stored as a reference to the format object in
1285
self._format for code that needs to check it later.
1287
The format parameter is either None or the branch format class
1288
used to open this branch.
1290
FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
1293
format = BranchFormat.find_format(self.bzrdir)
1294
self._format = format
1295
mutter("got branch format %s", self._format)
1298
def get_root_id(self):
1299
"""See Branch.get_root_id."""
1300
tree = self.repository.revision_tree(self.last_revision())
1301
return tree.inventory.root.file_id
1303
def is_locked(self):
1304
return self.control_files.is_locked()
1306
def lock_write(self):
1307
self.repository.lock_write()
1309
self.control_files.lock_write()
1311
self.repository.unlock()
1314
def lock_read(self):
1315
self.repository.lock_read()
1317
self.control_files.lock_read()
1319
self.repository.unlock()
1323
# TODO: test for failed two phase locks. This is known broken.
1325
self.control_files.unlock()
1327
self.repository.unlock()
1329
def peek_lock_mode(self):
1330
if self.control_files._lock_count == 0:
1333
return self.control_files._lock_mode
1335
def get_physical_lock_status(self):
1336
return self.control_files.get_physical_lock_status()
1339
def print_file(self, file, revision_id):
1340
"""See Branch.print_file."""
1341
return self.repository.print_file(file, revision_id)
1344
def append_revision(self, *revision_ids):
1345
"""See Branch.append_revision."""
1346
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1347
for revision_id in revision_ids:
1348
_mod_revision.check_not_reserved_id(revision_id)
1349
mutter("add {%s} to revision-history" % revision_id)
1350
rev_history = self.revision_history()
1351
rev_history.extend(revision_ids)
1352
self.set_revision_history(rev_history)
1354
def _write_revision_history(self, history):
1355
"""Factored out of set_revision_history.
1357
This performs the actual writing to disk.
1358
It is intended to be called by BzrBranch5.set_revision_history."""
1359
self.control_files.put_bytes(
1360
'revision-history', '\n'.join(history))
1363
def set_revision_history(self, rev_history):
1364
"""See Branch.set_revision_history."""
1365
rev_history = [osutils.safe_revision_id(r) for r in rev_history]
1366
self._write_revision_history(rev_history)
1367
transaction = self.get_transaction()
1368
history = transaction.map.find_revision_history()
1369
if history is not None:
1370
# update the revision history in the identity map.
1371
history[:] = list(rev_history)
1372
# this call is disabled because revision_history is
1373
# not really an object yet, and the transaction is for objects.
1374
# transaction.register_dirty(history)
1376
transaction.map.add_revision_history(rev_history)
1377
# this call is disabled because revision_history is
1378
# not really an object yet, and the transaction is for objects.
1379
# transaction.register_clean(history)
1380
for hook in Branch.hooks['set_rh']:
1381
hook(self, rev_history)
1384
def set_last_revision_info(self, revno, revision_id):
1385
revision_id = osutils.safe_revision_id(revision_id)
1386
history = self._lefthand_history(revision_id)
1387
assert len(history) == revno, '%d != %d' % (len(history), revno)
1388
self.set_revision_history(history)
1390
def _gen_revision_history(self):
1391
history = self.control_files.get('revision-history').read().split('\n')
1392
if history[-1:] == ['']:
1393
# There shouldn't be a trailing newline, but just in case.
1398
def revision_history(self):
1399
"""See Branch.revision_history."""
1400
transaction = self.get_transaction()
1401
history = transaction.map.find_revision_history()
1402
if history is not None:
1403
# mutter("cache hit for revision-history in %s", self)
1404
return list(history)
1405
history = self._gen_revision_history()
1406
transaction.map.add_revision_history(history)
1407
# this call is disabled because revision_history is
1408
# not really an object yet, and the transaction is for objects.
1409
# transaction.register_clean(history, precious=True)
1410
return list(history)
1412
def _lefthand_history(self, revision_id, last_rev=None,
1414
# stop_revision must be a descendant of last_revision
1415
stop_graph = self.repository.get_revision_graph(revision_id)
1416
if last_rev is not None and last_rev not in stop_graph:
1417
# our previous tip is not merged into stop_revision
1418
raise errors.DivergedBranches(self, other_branch)
1419
# make a new revision history from the graph
1420
current_rev_id = revision_id
1422
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1423
new_history.append(current_rev_id)
1424
current_rev_id_parents = stop_graph[current_rev_id]
1426
current_rev_id = current_rev_id_parents[0]
1428
current_rev_id = None
1429
new_history.reverse()
1433
def generate_revision_history(self, revision_id, last_rev=None,
1435
"""Create a new revision history that will finish with revision_id.
1437
:param revision_id: the new tip to use.
1438
:param last_rev: The previous last_revision. If not None, then this
1439
must be a ancestory of revision_id, or DivergedBranches is raised.
1440
:param other_branch: The other branch that DivergedBranches should
1441
raise with respect to.
1443
revision_id = osutils.safe_revision_id(revision_id)
1444
self.set_revision_history(self._lefthand_history(revision_id,
1445
last_rev, other_branch))
1448
def update_revisions(self, other, stop_revision=None):
1449
"""See Branch.update_revisions."""
1452
if stop_revision is None:
1453
stop_revision = other.last_revision()
1454
if stop_revision is None:
1455
# if there are no commits, we're done.
1458
stop_revision = osutils.safe_revision_id(stop_revision)
1459
# whats the current last revision, before we fetch [and change it
1461
last_rev = self.last_revision()
1462
# we fetch here regardless of whether we need to so that we pickup
1464
self.fetch(other, stop_revision)
1465
my_ancestry = self.repository.get_ancestry(last_rev)
1466
if stop_revision in my_ancestry:
1467
# last_revision is a descendant of stop_revision
1469
self.generate_revision_history(stop_revision, last_rev=last_rev,
1474
def basis_tree(self):
1475
"""See Branch.basis_tree."""
1476
return self.repository.revision_tree(self.last_revision())
1478
@deprecated_method(zero_eight)
1479
def working_tree(self):
1480
"""Create a Working tree object for this branch."""
1482
from bzrlib.transport.local import LocalTransport
1483
if (self.base.find('://') != -1 or
1484
not isinstance(self._transport, LocalTransport)):
1485
raise NoWorkingTree(self.base)
1486
return self.bzrdir.open_workingtree()
1489
def pull(self, source, overwrite=False, stop_revision=None,
1490
_hook_master=None, _run_hooks=True):
1493
:param _hook_master: Private parameter - set the branch to
1494
be supplied as the master to push hooks.
1495
:param _run_hooks: Private parameter - allow disabling of
1496
hooks, used when pushing to a master branch.
1498
result = PullResult()
1499
result.source_branch = source
1500
result.target_branch = self
1503
result.old_revno, result.old_revid = self.last_revision_info()
1505
self.update_revisions(source, stop_revision)
1506
except DivergedBranches:
1510
if stop_revision is None:
1511
stop_revision = source.last_revision()
1512
self.generate_revision_history(stop_revision)
1513
result.tag_conflicts = source.tags.merge_to(self.tags)
1514
result.new_revno, result.new_revid = self.last_revision_info()
1516
result.master_branch = _hook_master
1517
result.local_branch = self
1519
result.master_branch = self
1520
result.local_branch = None
1522
for hook in Branch.hooks['post_pull']:
1528
def _get_parent_location(self):
1529
_locs = ['parent', 'pull', 'x-pull']
1532
return self.control_files.get(l).read().strip('\n')
1538
def push(self, target, overwrite=False, stop_revision=None,
1539
_hook_master=None, _run_hooks=True):
1542
:param _hook_master: Private parameter - set the branch to
1543
be supplied as the master to push hooks.
1544
:param _run_hooks: Private parameter - allow disabling of
1545
hooks, used when pushing to a master branch.
1547
result = PushResult()
1548
result.source_branch = self
1549
result.target_branch = target
1552
result.old_revno, result.old_revid = target.last_revision_info()
1554
target.update_revisions(self, stop_revision)
1555
except DivergedBranches:
1559
target.set_revision_history(self.revision_history())
1560
result.tag_conflicts = self.tags.merge_to(target.tags)
1561
result.new_revno, result.new_revid = target.last_revision_info()
1563
result.master_branch = _hook_master
1564
result.local_branch = target
1566
result.master_branch = target
1567
result.local_branch = None
1569
for hook in Branch.hooks['post_push']:
1575
def get_parent(self):
1576
"""See Branch.get_parent."""
1578
assert self.base[-1] == '/'
1579
parent = self._get_parent_location()
1582
# This is an old-format absolute path to a local branch
1583
# turn it into a url
1584
if parent.startswith('/'):
1585
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1587
return urlutils.join(self.base[:-1], parent)
1588
except errors.InvalidURLJoin, e:
1589
raise errors.InaccessibleParent(parent, self.base)
1591
def get_push_location(self):
1592
"""See Branch.get_push_location."""
1593
push_loc = self.get_config().get_user_option('push_location')
1596
def set_push_location(self, location):
1597
"""See Branch.set_push_location."""
1598
self.get_config().set_user_option(
1599
'push_location', location,
1600
store=_mod_config.STORE_LOCATION_NORECURSE)
1603
def set_parent(self, url):
1604
"""See Branch.set_parent."""
1605
# TODO: Maybe delete old location files?
1606
# URLs should never be unicode, even on the local fs,
1607
# FIXUP this and get_parent in a future branch format bump:
1608
# read and rewrite the file, and have the new format code read
1609
# using .get not .get_utf8. RBC 20060125
1611
if isinstance(url, unicode):
1613
url = url.encode('ascii')
1614
except UnicodeEncodeError:
1615
raise bzrlib.errors.InvalidURL(url,
1616
"Urls must be 7-bit ascii, "
1617
"use bzrlib.urlutils.escape")
1618
url = urlutils.relative_url(self.base, url)
1619
self._set_parent_location(url)
1621
def _set_parent_location(self, url):
1623
self.control_files._transport.delete('parent')
1625
assert isinstance(url, str)
1626
self.control_files.put_bytes('parent', url + '\n')
1628
@deprecated_function(zero_nine)
1629
def tree_config(self):
1630
"""DEPRECATED; call get_config instead.
1631
TreeConfig has become part of BranchConfig."""
1632
return TreeConfig(self)
1635
class BzrBranch5(BzrBranch):
1636
"""A format 5 branch. This supports new features over plan branches.
1638
It has support for a master_branch which is the data for bound branches.
1646
super(BzrBranch5, self).__init__(_format=_format,
1647
_control_files=_control_files,
1649
_repository=_repository)
1652
def pull(self, source, overwrite=False, stop_revision=None,
1654
"""Extends branch.pull to be bound branch aware.
1656
:param _run_hooks: Private parameter used to force hook running
1657
off during bound branch double-pushing.
1659
bound_location = self.get_bound_location()
1660
master_branch = None
1661
if bound_location and source.base != bound_location:
1662
# not pulling from master, so we need to update master.
1663
master_branch = self.get_master_branch()
1664
master_branch.lock_write()
1667
# pull from source into master.
1668
master_branch.pull(source, overwrite, stop_revision,
1670
return super(BzrBranch5, self).pull(source, overwrite,
1671
stop_revision, _hook_master=master_branch,
1672
_run_hooks=_run_hooks)
1675
master_branch.unlock()
1678
def push(self, target, overwrite=False, stop_revision=None):
1679
"""Updates branch.push to be bound branch aware."""
1680
bound_location = target.get_bound_location()
1681
master_branch = None
1682
if bound_location and target.base != bound_location:
1683
# not pushing to master, so we need to update master.
1684
master_branch = target.get_master_branch()
1685
master_branch.lock_write()
1688
# push into the master from this branch.
1689
super(BzrBranch5, self).push(master_branch, overwrite,
1690
stop_revision, _run_hooks=False)
1691
# and push into the target branch from this. Note that we push from
1692
# this branch again, because its considered the highest bandwidth
1694
return super(BzrBranch5, self).push(target, overwrite,
1695
stop_revision, _hook_master=master_branch)
1698
master_branch.unlock()
1700
def get_bound_location(self):
1702
return self.control_files.get_utf8('bound').read()[:-1]
1703
except errors.NoSuchFile:
1707
def get_master_branch(self):
1708
"""Return the branch we are bound to.
1710
:return: Either a Branch, or None
1712
This could memoise the branch, but if thats done
1713
it must be revalidated on each new lock.
1714
So for now we just don't memoise it.
1715
# RBC 20060304 review this decision.
1717
bound_loc = self.get_bound_location()
1721
return Branch.open(bound_loc)
1722
except (errors.NotBranchError, errors.ConnectionError), e:
1723
raise errors.BoundBranchConnectionFailure(
1727
def set_bound_location(self, location):
1728
"""Set the target where this branch is bound to.
1730
:param location: URL to the target branch
1733
self.control_files.put_utf8('bound', location+'\n')
1736
self.control_files._transport.delete('bound')
1742
def bind(self, other):
1743
"""Bind this branch to the branch other.
1745
This does not push or pull data between the branches, though it does
1746
check for divergence to raise an error when the branches are not
1747
either the same, or one a prefix of the other. That behaviour may not
1748
be useful, so that check may be removed in future.
1750
:param other: The branch to bind to
1753
# TODO: jam 20051230 Consider checking if the target is bound
1754
# It is debatable whether you should be able to bind to
1755
# a branch which is itself bound.
1756
# Committing is obviously forbidden,
1757
# but binding itself may not be.
1758
# Since we *have* to check at commit time, we don't
1759
# *need* to check here
1761
# we want to raise diverged if:
1762
# last_rev is not in the other_last_rev history, AND
1763
# other_last_rev is not in our history, and do it without pulling
1765
last_rev = self.last_revision()
1766
if last_rev is not None:
1769
other_last_rev = other.last_revision()
1770
if other_last_rev is not None:
1771
# neither branch is new, we have to do some work to
1772
# ascertain diversion.
1773
remote_graph = other.repository.get_revision_graph(
1775
local_graph = self.repository.get_revision_graph(last_rev)
1776
if (last_rev not in remote_graph and
1777
other_last_rev not in local_graph):
1778
raise errors.DivergedBranches(self, other)
1781
self.set_bound_location(other.base)
1785
"""If bound, unbind"""
1786
return self.set_bound_location(None)
1790
"""Synchronise this branch with the master branch if any.
1792
:return: None or the last_revision that was pivoted out during the
1795
master = self.get_master_branch()
1796
if master is not None:
1797
old_tip = self.last_revision()
1798
self.pull(master, overwrite=True)
1799
if old_tip in self.repository.get_ancestry(self.last_revision()):
1805
class BzrBranchExperimental(BzrBranch5):
1806
"""Bzr experimental branch format
1809
- a revision-history file.
1811
- a lock dir guarding the branch itself
1812
- all of this stored in a branch/ subdirectory
1813
- works with shared repositories.
1814
- a tag dictionary in the branch
1816
This format is new in bzr 0.15, but shouldn't be used for real data,
1819
This class acts as it's own BranchFormat.
1822
_matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1825
def get_format_string(cls):
1826
"""See BranchFormat.get_format_string()."""
1827
return "Bazaar-NG branch format experimental\n"
1830
def get_format_description(cls):
1831
"""See BranchFormat.get_format_description()."""
1832
return "Experimental branch format"
1835
def _initialize_control_files(cls, a_bzrdir, utf8_files, lock_filename,
1837
branch_transport = a_bzrdir.get_branch_transport(cls)
1838
control_files = lockable_files.LockableFiles(branch_transport,
1839
lock_filename, lock_class)
1840
control_files.create_lock()
1841
control_files.lock_write()
1843
for filename, content in utf8_files:
1844
control_files.put_utf8(filename, content)
1846
control_files.unlock()
1849
def initialize(cls, a_bzrdir):
1850
"""Create a branch of this format in a_bzrdir."""
1851
utf8_files = [('format', cls.get_format_string()),
1852
('revision-history', ''),
1853
('branch-name', ''),
1856
cls._initialize_control_files(a_bzrdir, utf8_files,
1857
'lock', lockdir.LockDir)
1858
return cls.open(a_bzrdir, _found=True)
1861
def open(cls, a_bzrdir, _found=False):
1862
"""Return the branch object for a_bzrdir
1864
_found is a private parameter, do not use it. It is used to indicate
1865
if format probing has already be done.
1868
format = BranchFormat.find_format(a_bzrdir)
1869
assert format.__class__ == cls
1870
transport = a_bzrdir.get_branch_transport(None)
1871
control_files = lockable_files.LockableFiles(transport, 'lock',
1873
return cls(_format=cls,
1874
_control_files=control_files,
1876
_repository=a_bzrdir.find_repository())
1879
def is_supported(cls):
1882
def _make_tags(self):
1883
return BasicTags(self)
1886
def supports_tags(cls):
1890
BranchFormat.register_format(BzrBranchExperimental)
1893
class BzrBranch6(BzrBranch5):
1896
def last_revision_info(self):
1897
revision_string = self.control_files.get('last-revision').read()
1898
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1899
revision_id = cache_utf8.get_cached_utf8(revision_id)
1901
return revno, revision_id
1903
def last_revision(self):
1904
"""Return last revision id, or None"""
1905
revision_id = self.last_revision_info()[1]
1906
if revision_id == _mod_revision.NULL_REVISION:
1910
def _write_last_revision_info(self, revno, revision_id):
1911
"""Simply write out the revision id, with no checks.
1913
Use set_last_revision_info to perform this safely.
1915
Does not update the revision_history cache.
1916
Intended to be called by set_last_revision_info and
1917
_write_revision_history.
1919
if revision_id is None:
1920
revision_id = 'null:'
1921
out_string = '%d %s\n' % (revno, revision_id)
1922
self.control_files.put_bytes('last-revision', out_string)
1925
def set_last_revision_info(self, revno, revision_id):
1926
revision_id = osutils.safe_revision_id(revision_id)
1927
if self._get_append_revisions_only():
1928
self._check_history_violation(revision_id)
1929
self._write_last_revision_info(revno, revision_id)
1930
transaction = self.get_transaction()
1931
cached_history = transaction.map.find_revision_history()
1932
if cached_history is not None:
1933
transaction.map.remove_object(cached_history)
1935
def _check_history_violation(self, revision_id):
1936
last_revision = self.last_revision()
1937
if last_revision is None:
1939
if last_revision not in self._lefthand_history(revision_id):
1940
raise errors.AppendRevisionsOnlyViolation(self.base)
1942
def _gen_revision_history(self):
1943
"""Generate the revision history from last revision
1945
history = list(self.repository.iter_reverse_revision_history(
1946
self.last_revision()))
1950
def _write_revision_history(self, history):
1951
"""Factored out of set_revision_history.
1953
This performs the actual writing to disk, with format-specific checks.
1954
It is intended to be called by BzrBranch5.set_revision_history.
1956
if len(history) == 0:
1957
last_revision = 'null:'
1959
if history != self._lefthand_history(history[-1]):
1960
raise errors.NotLefthandHistory(history)
1961
last_revision = history[-1]
1962
if self._get_append_revisions_only():
1963
self._check_history_violation(last_revision)
1964
self._write_last_revision_info(len(history), last_revision)
1967
def append_revision(self, *revision_ids):
1968
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1969
if len(revision_ids) == 0:
1971
prev_revno, prev_revision = self.last_revision_info()
1972
for revision in self.repository.get_revisions(revision_ids):
1973
if prev_revision == _mod_revision.NULL_REVISION:
1974
if revision.parent_ids != []:
1975
raise errors.NotLeftParentDescendant(self, prev_revision,
1976
revision.revision_id)
1978
if revision.parent_ids[0] != prev_revision:
1979
raise errors.NotLeftParentDescendant(self, prev_revision,
1980
revision.revision_id)
1981
prev_revision = revision.revision_id
1982
self.set_last_revision_info(prev_revno + len(revision_ids),
1986
def _set_parent_location(self, url):
1987
"""Set the parent branch"""
1988
self._set_config_location('parent_location', url, make_relative=True)
1991
def _get_parent_location(self):
1992
"""Set the parent branch"""
1993
return self._get_config_location('parent_location')
1995
def set_push_location(self, location):
1996
"""See Branch.set_push_location."""
1997
self._set_config_location('push_location', location)
1999
def set_bound_location(self, location):
2000
"""See Branch.set_push_location."""
2002
config = self.get_config()
2003
if location is None:
2004
if config.get_user_option('bound') != 'True':
2007
config.set_user_option('bound', 'False')
2010
self._set_config_location('bound_location', location,
2012
config.set_user_option('bound', 'True')
2015
def _get_bound_location(self, bound):
2016
"""Return the bound location in the config file.
2018
Return None if the bound parameter does not match"""
2019
config = self.get_config()
2020
config_bound = (config.get_user_option('bound') == 'True')
2021
if config_bound != bound:
2023
return self._get_config_location('bound_location', config=config)
2025
def get_bound_location(self):
2026
"""See Branch.set_push_location."""
2027
return self._get_bound_location(True)
2029
def get_old_bound_location(self):
2030
"""See Branch.get_old_bound_location"""
2031
return self._get_bound_location(False)
2033
def set_append_revisions_only(self, enabled):
2038
self.get_config().set_user_option('append_revisions_only', value)
2040
def _get_append_revisions_only(self):
2041
value = self.get_config().get_user_option('append_revisions_only')
2042
return value == 'True'
2044
def _synchronize_history(self, destination, revision_id):
2045
"""Synchronize last revision and revision history between branches.
2047
This version is most efficient when the destination is also a
2048
BzrBranch6, but works for BzrBranch5, as long as the destination's
2049
repository contains all the lefthand ancestors of the intended
2050
last_revision. If not, set_last_revision_info will fail.
2052
:param destination: The branch to copy the history into
2053
:param revision_id: The revision-id to truncate history at. May
2054
be None to copy complete history.
2056
if revision_id is None:
2057
revno, revision_id = self.last_revision_info()
2059
revno = self.revision_id_to_revno(revision_id)
2060
destination.set_last_revision_info(revno, revision_id)
2062
def _make_tags(self):
2063
return BasicTags(self)
2066
class BranchTestProviderAdapter(object):
2067
"""A tool to generate a suite testing multiple branch formats at once.
2069
This is done by copying the test once for each transport and injecting
2070
the transport_server, transport_readonly_server, and branch_format
2071
classes into each copy. Each copy is also given a new id() to make it
2075
def __init__(self, transport_server, transport_readonly_server, formats):
2076
self._transport_server = transport_server
2077
self._transport_readonly_server = transport_readonly_server
2078
self._formats = formats
2080
def adapt(self, test):
2081
result = TestSuite()
2082
for branch_format, bzrdir_format in self._formats:
2083
new_test = deepcopy(test)
2084
new_test.transport_server = self._transport_server
2085
new_test.transport_readonly_server = self._transport_readonly_server
2086
new_test.bzrdir_format = bzrdir_format
2087
new_test.branch_format = branch_format
2088
def make_new_test_id():
2089
# the format can be either a class or an instance
2090
name = getattr(branch_format, '__name__',
2091
branch_format.__class__.__name__)
2092
new_id = "%s(%s)" % (new_test.id(), name)
2093
return lambda: new_id
2094
new_test.id = make_new_test_id()
2095
result.addTest(new_test)
2099
######################################################################
2100
# results of operations
2103
class _Result(object):
2105
def _show_tag_conficts(self, to_file):
2106
if not getattr(self, 'tag_conflicts', None):
2108
to_file.write('Conflicting tags:\n')
2109
for name, value1, value2 in self.tag_conflicts:
2110
to_file.write(' %s\n' % (name, ))
2113
class PullResult(_Result):
2114
"""Result of a Branch.pull operation.
2116
:ivar old_revno: Revision number before pull.
2117
:ivar new_revno: Revision number after pull.
2118
:ivar old_revid: Tip revision id before pull.
2119
:ivar new_revid: Tip revision id after pull.
2120
:ivar source_branch: Source (local) branch object.
2121
:ivar master_branch: Master branch of the target, or None.
2122
:ivar target_branch: Target/destination branch object.
2126
# DEPRECATED: pull used to return the change in revno
2127
return self.new_revno - self.old_revno
2129
def report(self, to_file):
2130
if self.old_revid == self.new_revid:
2131
to_file.write('No revisions to pull.\n')
2133
to_file.write('Now on revision %d.\n' % self.new_revno)
2134
self._show_tag_conficts(to_file)
2137
class PushResult(_Result):
2138
"""Result of a Branch.push operation.
2140
:ivar old_revno: Revision number before push.
2141
:ivar new_revno: Revision number after push.
2142
:ivar old_revid: Tip revision id before push.
2143
:ivar new_revid: Tip revision id after push.
2144
:ivar source_branch: Source branch object.
2145
:ivar master_branch: Master branch of the target, or None.
2146
:ivar target_branch: Target/destination branch object.
2150
# DEPRECATED: push used to return the change in revno
2151
return self.new_revno - self.old_revno
2153
def report(self, to_file):
2154
"""Write a human-readable description of the result."""
2155
if self.old_revid == self.new_revid:
2156
to_file.write('No new revisions to push.\n')
2158
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2159
self._show_tag_conficts(to_file)
2162
class BranchCheckResult(object):
2163
"""Results of checking branch consistency.
2168
def __init__(self, branch):
2169
self.branch = branch
2171
def report_results(self, verbose):
2172
"""Report the check results via trace.note.
2174
:param verbose: Requests more detailed display of what was checked,
2177
note('checked branch %s format %s',
2179
self.branch._format)
2182
class Converter5to6(object):
2183
"""Perform an in-place upgrade of format 5 to format 6"""
2185
def convert(self, branch):
2186
# Data for 5 and 6 can peacefully coexist.
2187
format = BzrBranchFormat6()
2188
new_branch = format.open(branch.bzrdir, _found=True)
2190
# Copy source data into target
2191
new_branch.set_last_revision_info(*branch.last_revision_info())
2192
new_branch.set_parent(branch.get_parent())
2193
new_branch.set_bound_location(branch.get_bound_location())
2194
new_branch.set_push_location(branch.get_push_location())
2196
# New branch has no tags by default
2197
new_branch.tags._set_tag_dict({})
2199
# Copying done; now update target format
2200
new_branch.control_files.put_utf8('format',
2201
format.get_format_string())
2203
# Clean up old files
2204
new_branch.control_files._transport.delete('revision-history')
2206
branch.set_parent(None)
2209
branch.set_bound_location(None)
added
removed
bzrlib/branch.py
