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 warnings import warn
28
config as _mod_config,
33
revision as _mod_revision,
40
from bzrlib.config import BranchConfig, TreeConfig
41
from bzrlib.lockable_files import LockableFiles, TransportLock
42
from bzrlib.tag import (
48
from bzrlib.decorators import needs_read_lock, needs_write_lock
49
from bzrlib.errors import (BzrError, BzrCheckError, DivergedBranches,
50
HistoryMissing, InvalidRevisionId,
51
InvalidRevisionNumber, LockError, NoSuchFile,
52
NoSuchRevision, NoWorkingTree, NotVersionedError,
53
NotBranchError, UninitializableFormat,
54
UnlistableStore, UnlistableBranch,
56
from bzrlib.hooks import Hooks
57
from bzrlib.symbol_versioning import (deprecated_function,
61
zero_eight, zero_nine, zero_sixteen,
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()
101
self._revision_history_cache = None
102
self._revision_id_to_revno_cache = None
104
def break_lock(self):
105
"""Break a lock if one is present from another instance.
107
Uses the ui factory to ask for confirmation if the lock may be from
110
This will probe the repository for its lock as well.
112
self.control_files.break_lock()
113
self.repository.break_lock()
114
master = self.get_master_branch()
115
if master is not None:
119
@deprecated_method(zero_eight)
120
def open_downlevel(base):
121
"""Open a branch which may be of an old format."""
122
return Branch.open(base, _unsupported=True)
125
def open(base, _unsupported=False):
126
"""Open the branch rooted at base.
128
For instance, if the branch is at URL/.bzr/branch,
129
Branch.open(URL) -> a Branch instance.
131
control = bzrdir.BzrDir.open(base, _unsupported)
132
return control.open_branch(_unsupported)
135
def open_containing(url):
136
"""Open an existing branch which contains url.
138
This probes for a branch at url, and searches upwards from there.
140
Basically we keep looking up until we find the control directory or
141
run into the root. If there isn't one, raises NotBranchError.
142
If there is one and it is either an unrecognised format or an unsupported
143
format, UnknownFormatError or UnsupportedFormatError are raised.
144
If there is one, it is returned, along with the unused portion of url.
146
control, relpath = bzrdir.BzrDir.open_containing(url)
147
return control.open_branch(), relpath
150
@deprecated_function(zero_eight)
151
def initialize(base):
152
"""Create a new working tree and branch, rooted at 'base' (url)
154
NOTE: This will soon be deprecated in favour of creation
157
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
159
@deprecated_function(zero_eight)
160
def setup_caching(self, cache_root):
161
"""Subclasses that care about caching should override this, and set
162
up cached stores located under cache_root.
164
NOTE: This is unused.
168
def get_config(self):
169
return BranchConfig(self)
172
return self.get_config().get_nickname()
174
def _set_nick(self, nick):
175
self.get_config().set_user_option('nickname', nick, warn_masked=True)
177
nick = property(_get_nick, _set_nick)
180
raise NotImplementedError(self.is_locked)
182
def lock_write(self):
183
raise NotImplementedError(self.lock_write)
186
raise NotImplementedError(self.lock_read)
189
raise NotImplementedError(self.unlock)
191
def peek_lock_mode(self):
192
"""Return lock mode for the Branch: 'r', 'w' or None"""
193
raise NotImplementedError(self.peek_lock_mode)
195
def get_physical_lock_status(self):
196
raise NotImplementedError(self.get_physical_lock_status)
199
def get_revision_id_to_revno_map(self):
200
"""Return the revision_id => dotted revno map.
202
This will be regenerated on demand, but will be cached.
204
:return: A dictionary mapping revision_id => dotted revno.
205
This dictionary should not be modified by the caller.
207
if self._revision_id_to_revno_cache is not None:
208
mapping = self._revision_id_to_revno_cache
210
mapping = self._gen_revno_map()
211
self._cache_revision_id_to_revno(mapping)
212
# TODO: jam 20070417 Since this is being cached, should we be returning
214
# I would rather not, and instead just declare that users should not
215
# modify the return value.
218
def _gen_revno_map(self):
219
"""Create a new mapping from revision ids to dotted revnos.
221
Dotted revnos are generated based on the current tip in the revision
223
This is the worker function for get_revision_id_to_revno_map, which
224
just caches the return value.
226
:return: A dictionary mapping revision_id => dotted revno.
228
last_revision = self.last_revision()
229
revision_graph = self.repository.get_revision_graph(last_revision)
230
merge_sorted_revisions = tsort.merge_sort(
235
revision_id_to_revno = dict((rev_id, revno)
236
for seq_num, rev_id, depth, revno, end_of_merge
237
in merge_sorted_revisions)
238
return revision_id_to_revno
240
def leave_lock_in_place(self):
241
"""Tell this branch object not to release the physical lock when this
244
If lock_write doesn't return a token, then this method is not supported.
246
self.control_files.leave_in_place()
248
def dont_leave_lock_in_place(self):
249
"""Tell this branch object to release the physical lock when this
250
object is unlocked, even if it didn't originally acquire it.
252
If lock_write doesn't return a token, then this method is not supported.
254
self.control_files.dont_leave_in_place()
256
def abspath(self, name):
257
"""Return absolute filename for something in the branch
259
XXX: Robert Collins 20051017 what is this used for? why is it a branch
260
method and not a tree method.
262
raise NotImplementedError(self.abspath)
264
def bind(self, other):
265
"""Bind the local branch the other branch.
267
:param other: The branch to bind to
270
raise errors.UpgradeRequired(self.base)
273
def fetch(self, from_branch, last_revision=None, pb=None):
274
"""Copy revisions from from_branch into this branch.
276
:param from_branch: Where to copy from.
277
:param last_revision: What revision to stop at (None for at the end
279
:param pb: An optional progress bar to use.
281
Returns the copied revision count and the failed revisions in a tuple:
284
if self.base == from_branch.base:
287
nested_pb = ui.ui_factory.nested_progress_bar()
292
from_branch.lock_read()
294
if last_revision is None:
295
pb.update('get source history')
296
last_revision = from_branch.last_revision()
297
if last_revision is None:
298
last_revision = _mod_revision.NULL_REVISION
299
return self.repository.fetch(from_branch.repository,
300
revision_id=last_revision,
303
if nested_pb is not None:
307
def get_bound_location(self):
308
"""Return the URL of the branch we are bound to.
310
Older format branches cannot bind, please be sure to use a metadir
315
def get_old_bound_location(self):
316
"""Return the URL of the branch we used to be bound to
318
raise errors.UpgradeRequired(self.base)
320
def get_commit_builder(self, parents, config=None, timestamp=None,
321
timezone=None, committer=None, revprops=None,
323
"""Obtain a CommitBuilder for this branch.
325
:param parents: Revision ids of the parents of the new revision.
326
:param config: Optional configuration to use.
327
:param timestamp: Optional timestamp recorded for commit.
328
:param timezone: Optional timezone for timestamp.
329
:param committer: Optional committer to set for commit.
330
:param revprops: Optional dictionary of revision properties.
331
:param revision_id: Optional revision id.
335
config = self.get_config()
337
return self.repository.get_commit_builder(self, parents, config,
338
timestamp, timezone, committer, revprops, revision_id)
340
def get_master_branch(self):
341
"""Return the branch we are bound to.
343
:return: Either a Branch, or None
347
def get_revision_delta(self, revno):
348
"""Return the delta for one revision.
350
The delta is relative to its mainline predecessor, or the
351
empty tree for revision 1.
353
assert isinstance(revno, int)
354
rh = self.revision_history()
355
if not (1 <= revno <= len(rh)):
356
raise InvalidRevisionNumber(revno)
357
return self.repository.get_revision_delta(rh[revno-1])
359
@deprecated_method(zero_sixteen)
360
def get_root_id(self):
361
"""Return the id of this branches root
363
Deprecated: branches don't have root ids-- trees do.
364
Use basis_tree().get_root_id() instead.
366
raise NotImplementedError(self.get_root_id)
368
def print_file(self, file, revision_id):
369
"""Print `file` to stdout."""
370
raise NotImplementedError(self.print_file)
372
def append_revision(self, *revision_ids):
373
raise NotImplementedError(self.append_revision)
375
def set_revision_history(self, rev_history):
376
raise NotImplementedError(self.set_revision_history)
378
def _cache_revision_history(self, rev_history):
379
"""Set the cached revision history to rev_history.
381
The revision_history method will use this cache to avoid regenerating
382
the revision history.
384
This API is semi-public; it only for use by subclasses, all other code
385
should consider it to be private.
387
self._revision_history_cache = rev_history
389
def _cache_revision_id_to_revno(self, revision_id_to_revno):
390
"""Set the cached revision_id => revno map to revision_id_to_revno.
392
This API is semi-public; it only for use by subclasses, all other code
393
should consider it to be private.
395
self._revision_id_to_revno_cache = revision_id_to_revno
397
def _clear_cached_state(self):
398
"""Clear any cached data on this branch, e.g. cached revision history.
400
This means the next call to revision_history will need to call
401
_gen_revision_history.
403
This API is semi-public; it only for use by subclasses, all other code
404
should consider it to be private.
406
self._revision_history_cache = None
407
self._revision_id_to_revno_cache = None
409
def _gen_revision_history(self):
410
"""Return sequence of revision hashes on to this branch.
412
Unlike revision_history, this method always regenerates or rereads the
413
revision history, i.e. it does not cache the result, so repeated calls
416
Concrete subclasses should override this instead of revision_history so
417
that subclasses do not need to deal with caching logic.
419
This API is semi-public; it only for use by subclasses, all other code
420
should consider it to be private.
422
raise NotImplementedError(self._gen_revision_history)
425
def revision_history(self):
426
"""Return sequence of revision hashes on to this branch.
428
This method will cache the revision history for as long as it is safe to
431
if self._revision_history_cache is not None:
432
history = self._revision_history_cache
434
history = self._gen_revision_history()
435
self._cache_revision_history(history)
439
"""Return current revision number for this branch.
441
That is equivalent to the number of revisions committed to
444
return len(self.revision_history())
447
"""Older format branches cannot bind or unbind."""
448
raise errors.UpgradeRequired(self.base)
450
def set_append_revisions_only(self, enabled):
451
"""Older format branches are never restricted to append-only"""
452
raise errors.UpgradeRequired(self.base)
454
def last_revision(self):
455
"""Return last revision id, or None"""
456
ph = self.revision_history()
460
return _mod_revision.NULL_REVISION
462
def last_revision_info(self):
463
"""Return information about the last revision.
465
:return: A tuple (revno, last_revision_id).
467
rh = self.revision_history()
470
return (revno, rh[-1])
472
return (0, _mod_revision.NULL_REVISION)
474
def missing_revisions(self, other, stop_revision=None):
475
"""Return a list of new revisions that would perfectly fit.
477
If self and other have not diverged, return a list of the revisions
478
present in other, but missing from self.
480
self_history = self.revision_history()
481
self_len = len(self_history)
482
other_history = other.revision_history()
483
other_len = len(other_history)
484
common_index = min(self_len, other_len) -1
485
if common_index >= 0 and \
486
self_history[common_index] != other_history[common_index]:
487
raise DivergedBranches(self, other)
489
if stop_revision is None:
490
stop_revision = other_len
492
assert isinstance(stop_revision, int)
493
if stop_revision > other_len:
494
raise errors.NoSuchRevision(self, stop_revision)
495
return other_history[self_len:stop_revision]
497
def update_revisions(self, other, stop_revision=None):
498
"""Pull in new perfect-fit revisions.
500
:param other: Another Branch to pull from
501
:param stop_revision: Updated until the given revision
504
raise NotImplementedError(self.update_revisions)
506
def revision_id_to_revno(self, revision_id):
507
"""Given a revision id, return its revno"""
508
if _mod_revision.is_null(revision_id):
510
revision_id = osutils.safe_revision_id(revision_id)
511
history = self.revision_history()
513
return history.index(revision_id) + 1
515
raise errors.NoSuchRevision(self, revision_id)
517
def get_rev_id(self, revno, history=None):
518
"""Find the revision id of the specified revno."""
522
history = self.revision_history()
523
if revno <= 0 or revno > len(history):
524
raise errors.NoSuchRevision(self, revno)
525
return history[revno - 1]
527
def pull(self, source, overwrite=False, stop_revision=None):
528
"""Mirror source into this branch.
530
This branch is considered to be 'local', having low latency.
532
:returns: PullResult instance
534
raise NotImplementedError(self.pull)
536
def push(self, target, overwrite=False, stop_revision=None):
537
"""Mirror this branch into target.
539
This branch is considered to be 'local', having low latency.
541
raise NotImplementedError(self.push)
543
def basis_tree(self):
544
"""Return `Tree` object for last revision."""
545
return self.repository.revision_tree(self.last_revision())
547
def rename_one(self, from_rel, to_rel):
550
This can change the directory or the filename or both.
552
raise NotImplementedError(self.rename_one)
554
def move(self, from_paths, to_name):
557
to_name must exist as a versioned directory.
559
If to_name exists and is a directory, the files are moved into
560
it, keeping their old names. If it is a directory,
562
Note that to_name is only the last component of the new name;
563
this doesn't change the directory.
565
This returns a list of (from_path, to_path) pairs for each
568
raise NotImplementedError(self.move)
570
def get_parent(self):
571
"""Return the parent location of the branch.
573
This is the default location for push/pull/missing. The usual
574
pattern is that the user can override it by specifying a
577
raise NotImplementedError(self.get_parent)
579
def _set_config_location(self, name, url, config=None,
580
make_relative=False):
582
config = self.get_config()
586
url = urlutils.relative_url(self.base, url)
587
config.set_user_option(name, url, warn_masked=True)
589
def _get_config_location(self, name, config=None):
591
config = self.get_config()
592
location = config.get_user_option(name)
597
def get_submit_branch(self):
598
"""Return the submit location of the branch.
600
This is the default location for bundle. The usual
601
pattern is that the user can override it by specifying a
604
return self.get_config().get_user_option('submit_branch')
606
def set_submit_branch(self, location):
607
"""Return the submit location of the branch.
609
This is the default location for bundle. The usual
610
pattern is that the user can override it by specifying a
613
self.get_config().set_user_option('submit_branch', location,
616
def get_public_branch(self):
617
"""Return the public location of the branch.
619
This is is used by merge directives.
621
return self._get_config_location('public_branch')
623
def set_public_branch(self, location):
624
"""Return the submit location of the branch.
626
This is the default location for bundle. The usual
627
pattern is that the user can override it by specifying a
630
self._set_config_location('public_branch', location)
632
def get_push_location(self):
633
"""Return the None or the location to push this branch to."""
634
push_loc = self.get_config().get_user_option('push_location')
637
def set_push_location(self, location):
638
"""Set a new push location for this branch."""
639
raise NotImplementedError(self.set_push_location)
641
def set_parent(self, url):
642
raise NotImplementedError(self.set_parent)
646
"""Synchronise this branch with the master branch if any.
648
:return: None or the last_revision pivoted out during the update.
652
def check_revno(self, revno):
654
Check whether a revno corresponds to any revision.
655
Zero (the NULL revision) is considered valid.
658
self.check_real_revno(revno)
660
def check_real_revno(self, revno):
662
Check whether a revno corresponds to a real revision.
663
Zero (the NULL revision) is considered invalid
665
if revno < 1 or revno > self.revno():
666
raise InvalidRevisionNumber(revno)
669
def clone(self, to_bzrdir, revision_id=None):
670
"""Clone this branch into to_bzrdir preserving all semantic values.
672
revision_id: if not None, the revision history in the new branch will
673
be truncated to end with revision_id.
675
result = self._format.initialize(to_bzrdir)
676
self.copy_content_into(result, revision_id=revision_id)
680
def sprout(self, to_bzrdir, revision_id=None):
681
"""Create a new line of development from the branch, into to_bzrdir.
683
revision_id: if not None, the revision history in the new branch will
684
be truncated to end with revision_id.
686
result = self._format.initialize(to_bzrdir)
687
self.copy_content_into(result, revision_id=revision_id)
688
result.set_parent(self.bzrdir.root_transport.base)
691
def _synchronize_history(self, destination, revision_id):
692
"""Synchronize last revision and revision history between branches.
694
This version is most efficient when the destination is also a
695
BzrBranch5, but works for BzrBranch6 as long as the revision
696
history is the true lefthand parent history, and all of the revisions
697
are in the destination's repository. If not, set_revision_history
700
:param destination: The branch to copy the history into
701
:param revision_id: The revision-id to truncate history at. May
702
be None to copy complete history.
704
if revision_id == _mod_revision.NULL_REVISION:
706
new_history = self.revision_history()
707
if revision_id is not None and new_history != []:
708
revision_id = osutils.safe_revision_id(revision_id)
710
new_history = new_history[:new_history.index(revision_id) + 1]
712
rev = self.repository.get_revision(revision_id)
713
new_history = rev.get_history(self.repository)[1:]
714
destination.set_revision_history(new_history)
717
def copy_content_into(self, destination, revision_id=None):
718
"""Copy the content of self into destination.
720
revision_id: if not None, the revision history in the new branch will
721
be truncated to end with revision_id.
723
self._synchronize_history(destination, revision_id)
725
parent = self.get_parent()
726
except errors.InaccessibleParent, e:
727
mutter('parent was not accessible to copy: %s', e)
730
destination.set_parent(parent)
731
self.tags.merge_to(destination.tags)
735
"""Check consistency of the branch.
737
In particular this checks that revisions given in the revision-history
738
do actually match up in the revision graph, and that they're all
739
present in the repository.
741
Callers will typically also want to check the repository.
743
:return: A BranchCheckResult.
745
mainline_parent_id = None
746
for revision_id in self.revision_history():
748
revision = self.repository.get_revision(revision_id)
749
except errors.NoSuchRevision, e:
750
raise errors.BzrCheckError("mainline revision {%s} not in repository"
752
# In general the first entry on the revision history has no parents.
753
# But it's not illegal for it to have parents listed; this can happen
754
# in imports from Arch when the parents weren't reachable.
755
if mainline_parent_id is not None:
756
if mainline_parent_id not in revision.parent_ids:
757
raise errors.BzrCheckError("previous revision {%s} not listed among "
759
% (mainline_parent_id, revision_id))
760
mainline_parent_id = revision_id
761
return BranchCheckResult(self)
763
def _get_checkout_format(self):
764
"""Return the most suitable metadir for a checkout of this branch.
765
Weaves are used if this branch's repository uses weaves.
767
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
768
from bzrlib.repofmt import weaverepo
769
format = bzrdir.BzrDirMetaFormat1()
770
format.repository_format = weaverepo.RepositoryFormat7()
772
format = self.repository.bzrdir.checkout_metadir()
773
format.set_branch_format(self._format)
776
def create_checkout(self, to_location, revision_id=None,
778
"""Create a checkout of a branch.
780
:param to_location: The url to produce the checkout at
781
:param revision_id: The revision to check out
782
:param lightweight: If True, produce a lightweight checkout, otherwise,
783
produce a bound branch (heavyweight checkout)
784
:return: The tree of the created checkout
786
t = transport.get_transport(to_location)
789
format = self._get_checkout_format()
790
checkout = format.initialize_on_transport(t)
791
BranchReferenceFormat().initialize(checkout, self)
793
format = self._get_checkout_format()
794
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
795
to_location, force_new_tree=False, format=format)
796
checkout = checkout_branch.bzrdir
797
checkout_branch.bind(self)
798
# pull up to the specified revision_id to set the initial
799
# branch tip correctly, and seed it with history.
800
checkout_branch.pull(self, stop_revision=revision_id)
801
tree = checkout.create_workingtree(revision_id)
802
basis_tree = tree.basis_tree()
803
basis_tree.lock_read()
805
for path, file_id in basis_tree.iter_references():
806
reference_parent = self.reference_parent(file_id, path)
807
reference_parent.create_checkout(tree.abspath(path),
808
basis_tree.get_reference_revision(file_id, path),
814
def reference_parent(self, file_id, path):
815
"""Return the parent branch for a tree-reference file_id
816
:param file_id: The file_id of the tree reference
817
:param path: The path of the file_id in the tree
818
:return: A branch associated with the file_id
820
# FIXME should provide multiple branches, based on config
821
return Branch.open(self.bzrdir.root_transport.clone(path).base)
823
def supports_tags(self):
824
return self._format.supports_tags()
827
class BranchFormat(object):
828
"""An encapsulation of the initialization and open routines for a format.
830
Formats provide three things:
831
* An initialization routine,
835
Formats are placed in an dict by their format string for reference
836
during branch opening. Its not required that these be instances, they
837
can be classes themselves with class methods - it simply depends on
838
whether state is needed for a given format or not.
840
Once a format is deprecated, just deprecate the initialize and open
841
methods on the format class. Do not deprecate the object, as the
842
object will be created every time regardless.
845
_default_format = None
846
"""The default format used for new branches."""
849
"""The known formats."""
851
def __eq__(self, other):
852
return self.__class__ is other.__class__
854
def __ne__(self, other):
855
return not (self == other)
858
def find_format(klass, a_bzrdir):
859
"""Return the format for the branch object in a_bzrdir."""
861
transport = a_bzrdir.get_branch_transport(None)
862
format_string = transport.get("format").read()
863
return klass._formats[format_string]
865
raise NotBranchError(path=transport.base)
867
raise errors.UnknownFormatError(format=format_string)
870
def get_default_format(klass):
871
"""Return the current default format."""
872
return klass._default_format
874
def get_reference(self, a_bzrdir):
875
"""Get the target reference of the branch in a_bzrdir.
877
format probing must have been completed before calling
878
this method - it is assumed that the format of the branch
879
in a_bzrdir is correct.
881
:param a_bzrdir: The bzrdir to get the branch data from.
882
:return: None if the branch is not a reference branch.
886
def get_format_string(self):
887
"""Return the ASCII format string that identifies this format."""
888
raise NotImplementedError(self.get_format_string)
890
def get_format_description(self):
891
"""Return the short format description for this format."""
892
raise NotImplementedError(self.get_format_description)
894
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
896
"""Initialize a branch in a bzrdir, with specified files
898
:param a_bzrdir: The bzrdir to initialize the branch in
899
:param utf8_files: The files to create as a list of
900
(filename, content) tuples
901
:param set_format: If True, set the format with
902
self.get_format_string. (BzrBranch4 has its format set
904
:return: a branch in this format
906
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
907
branch_transport = a_bzrdir.get_branch_transport(self)
909
'metadir': ('lock', lockdir.LockDir),
910
'branch4': ('branch-lock', lockable_files.TransportLock),
912
lock_name, lock_class = lock_map[lock_type]
913
control_files = lockable_files.LockableFiles(branch_transport,
914
lock_name, lock_class)
915
control_files.create_lock()
916
control_files.lock_write()
918
control_files.put_utf8('format', self.get_format_string())
920
for file, content in utf8_files:
921
control_files.put_utf8(file, content)
923
control_files.unlock()
924
return self.open(a_bzrdir, _found=True)
926
def initialize(self, a_bzrdir):
927
"""Create a branch of this format in a_bzrdir."""
928
raise NotImplementedError(self.initialize)
930
def is_supported(self):
931
"""Is this format supported?
933
Supported formats can be initialized and opened.
934
Unsupported formats may not support initialization or committing or
935
some other features depending on the reason for not being supported.
939
def open(self, a_bzrdir, _found=False):
940
"""Return the branch object for a_bzrdir
942
_found is a private parameter, do not use it. It is used to indicate
943
if format probing has already be done.
945
raise NotImplementedError(self.open)
948
def register_format(klass, format):
949
klass._formats[format.get_format_string()] = format
952
def set_default_format(klass, format):
953
klass._default_format = format
956
def unregister_format(klass, format):
957
assert klass._formats[format.get_format_string()] is format
958
del klass._formats[format.get_format_string()]
961
return self.get_format_string().rstrip()
963
def supports_tags(self):
964
"""True if this format supports tags stored in the branch"""
965
return False # by default
967
# XXX: Probably doesn't really belong here -- mbp 20070212
968
def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
970
branch_transport = a_bzrdir.get_branch_transport(self)
971
control_files = lockable_files.LockableFiles(branch_transport,
972
lock_filename, lock_class)
973
control_files.create_lock()
974
control_files.lock_write()
976
for filename, content in utf8_files:
977
control_files.put_utf8(filename, content)
979
control_files.unlock()
982
class BranchHooks(Hooks):
983
"""A dictionary mapping hook name to a list of callables for branch hooks.
985
e.g. ['set_rh'] Is the list of items to be called when the
986
set_revision_history function is invoked.
990
"""Create the default hooks.
992
These are all empty initially, because by default nothing should get
996
# Introduced in 0.15:
997
# invoked whenever the revision history has been set
998
# with set_revision_history. The api signature is
999
# (branch, revision_history), and the branch will
1002
# invoked after a push operation completes.
1003
# the api signature is
1005
# containing the members
1006
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1007
# where local is the local target branch or None, master is the target
1008
# master branch, and the rest should be self explanatory. The source
1009
# is read locked and the target branches write locked. Source will
1010
# be the local low-latency branch.
1011
self['post_push'] = []
1012
# invoked after a pull operation completes.
1013
# the api signature is
1015
# containing the members
1016
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1017
# where local is the local branch or None, master is the target
1018
# master branch, and the rest should be self explanatory. The source
1019
# is read locked and the target branches write locked. The local
1020
# branch is the low-latency branch.
1021
self['post_pull'] = []
1022
# invoked after a commit operation completes.
1023
# the api signature is
1024
# (local, master, old_revno, old_revid, new_revno, new_revid)
1025
# old_revid is NULL_REVISION for the first commit to a branch.
1026
self['post_commit'] = []
1027
# invoked after a uncommit operation completes.
1028
# the api signature is
1029
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1030
# local is the local branch or None, master is the target branch,
1031
# and an empty branch recieves new_revno of 0, new_revid of None.
1032
self['post_uncommit'] = []
1035
# install the default hooks into the Branch class.
1036
Branch.hooks = BranchHooks()
1039
class BzrBranchFormat4(BranchFormat):
1040
"""Bzr branch format 4.
1043
- a revision-history file.
1044
- a branch-lock lock file [ to be shared with the bzrdir ]
1047
def get_format_description(self):
1048
"""See BranchFormat.get_format_description()."""
1049
return "Branch format 4"
1051
def initialize(self, a_bzrdir):
1052
"""Create a branch of this format in a_bzrdir."""
1053
utf8_files = [('revision-history', ''),
1054
('branch-name', ''),
1056
return self._initialize_helper(a_bzrdir, utf8_files,
1057
lock_type='branch4', set_format=False)
1060
super(BzrBranchFormat4, self).__init__()
1061
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1063
def open(self, a_bzrdir, _found=False):
1064
"""Return the branch object for a_bzrdir
1066
_found is a private parameter, do not use it. It is used to indicate
1067
if format probing has already be done.
1070
# we are being called directly and must probe.
1071
raise NotImplementedError
1072
return BzrBranch(_format=self,
1073
_control_files=a_bzrdir._control_files,
1075
_repository=a_bzrdir.open_repository())
1078
return "Bazaar-NG branch format 4"
1081
class BzrBranchFormat5(BranchFormat):
1082
"""Bzr branch format 5.
1085
- a revision-history file.
1087
- a lock dir guarding the branch itself
1088
- all of this stored in a branch/ subdirectory
1089
- works with shared repositories.
1091
This format is new in bzr 0.8.
1094
def get_format_string(self):
1095
"""See BranchFormat.get_format_string()."""
1096
return "Bazaar-NG branch format 5\n"
1098
def get_format_description(self):
1099
"""See BranchFormat.get_format_description()."""
1100
return "Branch format 5"
1102
def initialize(self, a_bzrdir):
1103
"""Create a branch of this format in a_bzrdir."""
1104
utf8_files = [('revision-history', ''),
1105
('branch-name', ''),
1107
return self._initialize_helper(a_bzrdir, utf8_files)
1110
super(BzrBranchFormat5, self).__init__()
1111
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1113
def open(self, a_bzrdir, _found=False):
1114
"""Return the branch object for a_bzrdir
1116
_found is a private parameter, do not use it. It is used to indicate
1117
if format probing has already be done.
1120
format = BranchFormat.find_format(a_bzrdir)
1121
assert format.__class__ == self.__class__
1123
transport = a_bzrdir.get_branch_transport(None)
1124
control_files = lockable_files.LockableFiles(transport, 'lock',
1126
return BzrBranch5(_format=self,
1127
_control_files=control_files,
1129
_repository=a_bzrdir.find_repository())
1131
raise NotBranchError(path=transport.base)
1134
class BzrBranchFormat6(BzrBranchFormat5):
1135
"""Branch format with last-revision
1137
Unlike previous formats, this has no explicit revision history. Instead,
1138
this just stores the last-revision, and the left-hand history leading
1139
up to there is the history.
1141
This format was introduced in bzr 0.15
1144
def get_format_string(self):
1145
"""See BranchFormat.get_format_string()."""
1146
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1148
def get_format_description(self):
1149
"""See BranchFormat.get_format_description()."""
1150
return "Branch format 6"
1152
def initialize(self, a_bzrdir):
1153
"""Create a branch of this format in a_bzrdir."""
1154
utf8_files = [('last-revision', '0 null:\n'),
1155
('branch-name', ''),
1156
('branch.conf', ''),
1159
return self._initialize_helper(a_bzrdir, utf8_files)
1161
def open(self, a_bzrdir, _found=False):
1162
"""Return the branch object for a_bzrdir
1164
_found is a private parameter, do not use it. It is used to indicate
1165
if format probing has already be done.
1168
format = BranchFormat.find_format(a_bzrdir)
1169
assert format.__class__ == self.__class__
1170
transport = a_bzrdir.get_branch_transport(None)
1171
control_files = lockable_files.LockableFiles(transport, 'lock',
1173
return BzrBranch6(_format=self,
1174
_control_files=control_files,
1176
_repository=a_bzrdir.find_repository())
1178
def supports_tags(self):
1182
class BranchReferenceFormat(BranchFormat):
1183
"""Bzr branch reference format.
1185
Branch references are used in implementing checkouts, they
1186
act as an alias to the real branch which is at some other url.
1193
def get_format_string(self):
1194
"""See BranchFormat.get_format_string()."""
1195
return "Bazaar-NG Branch Reference Format 1\n"
1197
def get_format_description(self):
1198
"""See BranchFormat.get_format_description()."""
1199
return "Checkout reference format 1"
1201
def get_reference(self, a_bzrdir):
1202
"""See BranchFormat.get_reference()."""
1203
transport = a_bzrdir.get_branch_transport(None)
1204
return transport.get('location').read()
1206
def initialize(self, a_bzrdir, target_branch=None):
1207
"""Create a branch of this format in a_bzrdir."""
1208
if target_branch is None:
1209
# this format does not implement branch itself, thus the implicit
1210
# creation contract must see it as uninitializable
1211
raise errors.UninitializableFormat(self)
1212
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1213
branch_transport = a_bzrdir.get_branch_transport(self)
1214
branch_transport.put_bytes('location',
1215
target_branch.bzrdir.root_transport.base)
1216
branch_transport.put_bytes('format', self.get_format_string())
1217
return self.open(a_bzrdir, _found=True)
1220
super(BranchReferenceFormat, self).__init__()
1221
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1223
def _make_reference_clone_function(format, a_branch):
1224
"""Create a clone() routine for a branch dynamically."""
1225
def clone(to_bzrdir, revision_id=None):
1226
"""See Branch.clone()."""
1227
return format.initialize(to_bzrdir, a_branch)
1228
# cannot obey revision_id limits when cloning a reference ...
1229
# FIXME RBC 20060210 either nuke revision_id for clone, or
1230
# emit some sort of warning/error to the caller ?!
1233
def open(self, a_bzrdir, _found=False, location=None):
1234
"""Return the branch that the branch reference in a_bzrdir points at.
1236
_found is a private parameter, do not use it. It is used to indicate
1237
if format probing has already be done.
1240
format = BranchFormat.find_format(a_bzrdir)
1241
assert format.__class__ == self.__class__
1242
if location is None:
1243
location = self.get_reference(a_bzrdir)
1244
real_bzrdir = bzrdir.BzrDir.open(location)
1245
result = real_bzrdir.open_branch()
1246
# this changes the behaviour of result.clone to create a new reference
1247
# rather than a copy of the content of the branch.
1248
# I did not use a proxy object because that needs much more extensive
1249
# testing, and we are only changing one behaviour at the moment.
1250
# If we decide to alter more behaviours - i.e. the implicit nickname
1251
# then this should be refactored to introduce a tested proxy branch
1252
# and a subclass of that for use in overriding clone() and ....
1254
result.clone = self._make_reference_clone_function(result)
1258
# formats which have no format string are not discoverable
1259
# and not independently creatable, so are not registered.
1260
__default_format = BzrBranchFormat5()
1261
BranchFormat.register_format(__default_format)
1262
BranchFormat.register_format(BranchReferenceFormat())
1263
BranchFormat.register_format(BzrBranchFormat6())
1264
BranchFormat.set_default_format(__default_format)
1265
_legacy_formats = [BzrBranchFormat4(),
1268
class BzrBranch(Branch):
1269
"""A branch stored in the actual filesystem.
1271
Note that it's "local" in the context of the filesystem; it doesn't
1272
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1273
it's writable, and can be accessed via the normal filesystem API.
1276
def __init__(self, _format=None,
1277
_control_files=None, a_bzrdir=None, _repository=None):
1278
"""Create new branch object at a particular location."""
1279
Branch.__init__(self)
1280
if a_bzrdir is None:
1281
raise ValueError('a_bzrdir must be supplied')
1283
self.bzrdir = a_bzrdir
1284
# self._transport used to point to the directory containing the
1285
# control directory, but was not used - now it's just the transport
1286
# for the branch control files. mbp 20070212
1287
self._base = self.bzrdir.transport.clone('..').base
1288
self._format = _format
1289
if _control_files is None:
1290
raise ValueError('BzrBranch _control_files is None')
1291
self.control_files = _control_files
1292
self._transport = _control_files._transport
1293
self.repository = _repository
1296
return '%s(%r)' % (self.__class__.__name__, self.base)
1300
def _get_base(self):
1301
"""Returns the directory containing the control directory."""
1304
base = property(_get_base, doc="The URL for the root of this branch.")
1306
def abspath(self, name):
1307
"""See Branch.abspath."""
1308
return self.control_files._transport.abspath(name)
1311
@deprecated_method(zero_sixteen)
1313
def get_root_id(self):
1314
"""See Branch.get_root_id."""
1315
tree = self.repository.revision_tree(self.last_revision())
1316
return tree.inventory.root.file_id
1318
def is_locked(self):
1319
return self.control_files.is_locked()
1321
def lock_write(self, token=None):
1322
repo_token = self.repository.lock_write()
1324
token = self.control_files.lock_write(token=token)
1326
self.repository.unlock()
1330
def lock_read(self):
1331
self.repository.lock_read()
1333
self.control_files.lock_read()
1335
self.repository.unlock()
1339
# TODO: test for failed two phase locks. This is known broken.
1341
self.control_files.unlock()
1343
self.repository.unlock()
1344
if not self.control_files.is_locked():
1345
# we just released the lock
1346
self._clear_cached_state()
1348
def peek_lock_mode(self):
1349
if self.control_files._lock_count == 0:
1352
return self.control_files._lock_mode
1354
def get_physical_lock_status(self):
1355
return self.control_files.get_physical_lock_status()
1358
def print_file(self, file, revision_id):
1359
"""See Branch.print_file."""
1360
return self.repository.print_file(file, revision_id)
1363
def append_revision(self, *revision_ids):
1364
"""See Branch.append_revision."""
1365
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1366
for revision_id in revision_ids:
1367
_mod_revision.check_not_reserved_id(revision_id)
1368
mutter("add {%s} to revision-history" % revision_id)
1369
rev_history = self.revision_history()
1370
rev_history.extend(revision_ids)
1371
self.set_revision_history(rev_history)
1373
def _write_revision_history(self, history):
1374
"""Factored out of set_revision_history.
1376
This performs the actual writing to disk.
1377
It is intended to be called by BzrBranch5.set_revision_history."""
1378
self.control_files.put_bytes(
1379
'revision-history', '\n'.join(history))
1382
def set_revision_history(self, rev_history):
1383
"""See Branch.set_revision_history."""
1384
rev_history = [osutils.safe_revision_id(r) for r in rev_history]
1385
self._clear_cached_state()
1386
self._write_revision_history(rev_history)
1387
self._cache_revision_history(rev_history)
1388
for hook in Branch.hooks['set_rh']:
1389
hook(self, rev_history)
1392
def set_last_revision_info(self, revno, revision_id):
1393
revision_id = osutils.safe_revision_id(revision_id)
1394
history = self._lefthand_history(revision_id)
1395
assert len(history) == revno, '%d != %d' % (len(history), revno)
1396
self.set_revision_history(history)
1398
def _gen_revision_history(self):
1399
history = self.control_files.get('revision-history').read().split('\n')
1400
if history[-1:] == ['']:
1401
# There shouldn't be a trailing newline, but just in case.
1405
def _lefthand_history(self, revision_id, last_rev=None,
1407
# stop_revision must be a descendant of last_revision
1408
stop_graph = self.repository.get_revision_graph(revision_id)
1409
if not _mod_revision.is_null(last_rev) and last_rev not in stop_graph:
1410
# our previous tip is not merged into stop_revision
1411
raise errors.DivergedBranches(self, other_branch)
1412
# make a new revision history from the graph
1413
current_rev_id = revision_id
1415
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1416
new_history.append(current_rev_id)
1417
current_rev_id_parents = stop_graph[current_rev_id]
1419
current_rev_id = current_rev_id_parents[0]
1421
current_rev_id = None
1422
new_history.reverse()
1426
def generate_revision_history(self, revision_id, last_rev=None,
1428
"""Create a new revision history that will finish with revision_id.
1430
:param revision_id: the new tip to use.
1431
:param last_rev: The previous last_revision. If not None, then this
1432
must be a ancestory of revision_id, or DivergedBranches is raised.
1433
:param other_branch: The other branch that DivergedBranches should
1434
raise with respect to.
1436
revision_id = osutils.safe_revision_id(revision_id)
1437
self.set_revision_history(self._lefthand_history(revision_id,
1438
last_rev, other_branch))
1441
def update_revisions(self, other, stop_revision=None):
1442
"""See Branch.update_revisions."""
1445
if stop_revision is None:
1446
stop_revision = other.last_revision()
1447
if stop_revision is None:
1448
# if there are no commits, we're done.
1451
stop_revision = osutils.safe_revision_id(stop_revision)
1452
# whats the current last revision, before we fetch [and change it
1454
last_rev = self.last_revision()
1455
# we fetch here regardless of whether we need to so that we pickup
1457
self.fetch(other, stop_revision)
1458
my_ancestry = self.repository.get_ancestry(last_rev,
1460
if stop_revision in my_ancestry:
1461
# last_revision is a descendant of stop_revision
1463
self.generate_revision_history(stop_revision, last_rev=last_rev,
1468
def basis_tree(self):
1469
"""See Branch.basis_tree."""
1470
return self.repository.revision_tree(self.last_revision())
1472
@deprecated_method(zero_eight)
1473
def working_tree(self):
1474
"""Create a Working tree object for this branch."""
1476
from bzrlib.transport.local import LocalTransport
1477
if (self.base.find('://') != -1 or
1478
not isinstance(self._transport, LocalTransport)):
1479
raise NoWorkingTree(self.base)
1480
return self.bzrdir.open_workingtree()
1483
def pull(self, source, overwrite=False, stop_revision=None,
1484
_hook_master=None, run_hooks=True):
1487
:param _hook_master: Private parameter - set the branch to
1488
be supplied as the master to push hooks.
1489
:param run_hooks: Private parameter - if false, this branch
1490
is being called because it's the master of the primary branch,
1491
so it should not run its hooks.
1493
result = PullResult()
1494
result.source_branch = source
1495
result.target_branch = self
1498
result.old_revno, result.old_revid = self.last_revision_info()
1500
self.update_revisions(source, stop_revision)
1501
except DivergedBranches:
1505
if stop_revision is None:
1506
stop_revision = source.last_revision()
1507
self.generate_revision_history(stop_revision)
1508
result.tag_conflicts = source.tags.merge_to(self.tags)
1509
result.new_revno, result.new_revid = self.last_revision_info()
1511
result.master_branch = _hook_master
1512
result.local_branch = self
1514
result.master_branch = self
1515
result.local_branch = None
1517
for hook in Branch.hooks['post_pull']:
1523
def _get_parent_location(self):
1524
_locs = ['parent', 'pull', 'x-pull']
1527
return self.control_files.get(l).read().strip('\n')
1533
def push(self, target, overwrite=False, stop_revision=None,
1534
_override_hook_source_branch=None):
1537
This is the basic concrete implementation of push()
1539
:param _override_hook_source_branch: If specified, run
1540
the hooks passing this Branch as the source, rather than self.
1541
This is for use of RemoteBranch, where push is delegated to the
1542
underlying vfs-based Branch.
1544
# TODO: Public option to disable running hooks - should be trivial but
1548
result = self._push_with_bound_branches(target, overwrite,
1550
_override_hook_source_branch=_override_hook_source_branch)
1555
def _push_with_bound_branches(self, target, overwrite,
1557
_override_hook_source_branch=None):
1558
"""Push from self into target, and into target's master if any.
1560
This is on the base BzrBranch class even though it doesn't support
1561
bound branches because the *target* might be bound.
1564
if _override_hook_source_branch:
1565
result.source_branch = _override_hook_source_branch
1566
for hook in Branch.hooks['post_push']:
1569
bound_location = target.get_bound_location()
1570
if bound_location and target.base != bound_location:
1571
# there is a master branch.
1573
# XXX: Why the second check? Is it even supported for a branch to
1574
# be bound to itself? -- mbp 20070507
1575
master_branch = target.get_master_branch()
1576
master_branch.lock_write()
1578
# push into the master from this branch.
1579
self._basic_push(master_branch, overwrite, stop_revision)
1580
# and push into the target branch from this. Note that we push from
1581
# this branch again, because its considered the highest bandwidth
1583
result = self._basic_push(target, overwrite, stop_revision)
1584
result.master_branch = master_branch
1585
result.local_branch = target
1589
master_branch.unlock()
1592
result = self._basic_push(target, overwrite, stop_revision)
1593
# TODO: Why set master_branch and local_branch if there's no
1594
# binding? Maybe cleaner to just leave them unset? -- mbp
1596
result.master_branch = target
1597
result.local_branch = None
1601
def _basic_push(self, target, overwrite, stop_revision):
1602
"""Basic implementation of push without bound branches or hooks.
1604
Must be called with self read locked and target write locked.
1606
result = PushResult()
1607
result.source_branch = self
1608
result.target_branch = target
1609
result.old_revno, result.old_revid = target.last_revision_info()
1611
target.update_revisions(self, stop_revision)
1612
except DivergedBranches:
1616
target.set_revision_history(self.revision_history())
1617
result.tag_conflicts = self.tags.merge_to(target.tags)
1618
result.new_revno, result.new_revid = target.last_revision_info()
1621
def get_parent(self):
1622
"""See Branch.get_parent."""
1624
assert self.base[-1] == '/'
1625
parent = self._get_parent_location()
1628
# This is an old-format absolute path to a local branch
1629
# turn it into a url
1630
if parent.startswith('/'):
1631
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1633
return urlutils.join(self.base[:-1], parent)
1634
except errors.InvalidURLJoin, e:
1635
raise errors.InaccessibleParent(parent, self.base)
1637
def set_push_location(self, location):
1638
"""See Branch.set_push_location."""
1639
self.get_config().set_user_option(
1640
'push_location', location,
1641
store=_mod_config.STORE_LOCATION_NORECURSE)
1644
def set_parent(self, url):
1645
"""See Branch.set_parent."""
1646
# TODO: Maybe delete old location files?
1647
# URLs should never be unicode, even on the local fs,
1648
# FIXUP this and get_parent in a future branch format bump:
1649
# read and rewrite the file, and have the new format code read
1650
# using .get not .get_utf8. RBC 20060125
1652
if isinstance(url, unicode):
1654
url = url.encode('ascii')
1655
except UnicodeEncodeError:
1656
raise errors.InvalidURL(url,
1657
"Urls must be 7-bit ascii, "
1658
"use bzrlib.urlutils.escape")
1659
url = urlutils.relative_url(self.base, url)
1660
self._set_parent_location(url)
1662
def _set_parent_location(self, url):
1664
self.control_files._transport.delete('parent')
1666
assert isinstance(url, str)
1667
self.control_files.put_bytes('parent', url + '\n')
1669
@deprecated_function(zero_nine)
1670
def tree_config(self):
1671
"""DEPRECATED; call get_config instead.
1672
TreeConfig has become part of BranchConfig."""
1673
return TreeConfig(self)
1676
class BzrBranch5(BzrBranch):
1677
"""A format 5 branch. This supports new features over plan branches.
1679
It has support for a master_branch which is the data for bound branches.
1687
super(BzrBranch5, self).__init__(_format=_format,
1688
_control_files=_control_files,
1690
_repository=_repository)
1693
def pull(self, source, overwrite=False, stop_revision=None,
1695
"""Pull from source into self, updating my master if any.
1697
:param run_hooks: Private parameter - if false, this branch
1698
is being called because it's the master of the primary branch,
1699
so it should not run its hooks.
1701
bound_location = self.get_bound_location()
1702
master_branch = None
1703
if bound_location and source.base != bound_location:
1704
# not pulling from master, so we need to update master.
1705
master_branch = self.get_master_branch()
1706
master_branch.lock_write()
1709
# pull from source into master.
1710
master_branch.pull(source, overwrite, stop_revision,
1712
return super(BzrBranch5, self).pull(source, overwrite,
1713
stop_revision, _hook_master=master_branch,
1714
run_hooks=run_hooks)
1717
master_branch.unlock()
1719
def get_bound_location(self):
1721
return self.control_files.get_utf8('bound').read()[:-1]
1722
except errors.NoSuchFile:
1726
def get_master_branch(self):
1727
"""Return the branch we are bound to.
1729
:return: Either a Branch, or None
1731
This could memoise the branch, but if thats done
1732
it must be revalidated on each new lock.
1733
So for now we just don't memoise it.
1734
# RBC 20060304 review this decision.
1736
bound_loc = self.get_bound_location()
1740
return Branch.open(bound_loc)
1741
except (errors.NotBranchError, errors.ConnectionError), e:
1742
raise errors.BoundBranchConnectionFailure(
1746
def set_bound_location(self, location):
1747
"""Set the target where this branch is bound to.
1749
:param location: URL to the target branch
1752
self.control_files.put_utf8('bound', location+'\n')
1755
self.control_files._transport.delete('bound')
1761
def bind(self, other):
1762
"""Bind this branch to the branch other.
1764
This does not push or pull data between the branches, though it does
1765
check for divergence to raise an error when the branches are not
1766
either the same, or one a prefix of the other. That behaviour may not
1767
be useful, so that check may be removed in future.
1769
:param other: The branch to bind to
1772
# TODO: jam 20051230 Consider checking if the target is bound
1773
# It is debatable whether you should be able to bind to
1774
# a branch which is itself bound.
1775
# Committing is obviously forbidden,
1776
# but binding itself may not be.
1777
# Since we *have* to check at commit time, we don't
1778
# *need* to check here
1780
# we want to raise diverged if:
1781
# last_rev is not in the other_last_rev history, AND
1782
# other_last_rev is not in our history, and do it without pulling
1784
last_rev = self.last_revision()
1785
if not _mod_revision.is_null(last_rev):
1788
other_last_rev = other.last_revision()
1789
if not _mod_revision.is_null(other_last_rev):
1790
# neither branch is new, we have to do some work to
1791
# ascertain diversion.
1792
remote_graph = other.repository.get_revision_graph(
1794
local_graph = self.repository.get_revision_graph(last_rev)
1795
if (last_rev not in remote_graph and
1796
other_last_rev not in local_graph):
1797
raise errors.DivergedBranches(self, other)
1800
self.set_bound_location(other.base)
1804
"""If bound, unbind"""
1805
return self.set_bound_location(None)
1809
"""Synchronise this branch with the master branch if any.
1811
:return: None or the last_revision that was pivoted out during the
1814
master = self.get_master_branch()
1815
if master is not None:
1816
old_tip = self.last_revision()
1817
self.pull(master, overwrite=True)
1818
if old_tip in self.repository.get_ancestry(self.last_revision(),
1825
class BzrBranchExperimental(BzrBranch5):
1826
"""Bzr experimental branch format
1829
- a revision-history file.
1831
- a lock dir guarding the branch itself
1832
- all of this stored in a branch/ subdirectory
1833
- works with shared repositories.
1834
- a tag dictionary in the branch
1836
This format is new in bzr 0.15, but shouldn't be used for real data,
1839
This class acts as it's own BranchFormat.
1842
_matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1845
def get_format_string(cls):
1846
"""See BranchFormat.get_format_string()."""
1847
return "Bazaar-NG branch format experimental\n"
1850
def get_format_description(cls):
1851
"""See BranchFormat.get_format_description()."""
1852
return "Experimental branch format"
1855
def get_reference(cls, a_bzrdir):
1856
"""Get the target reference of the branch in a_bzrdir.
1858
format probing must have been completed before calling
1859
this method - it is assumed that the format of the branch
1860
in a_bzrdir is correct.
1862
:param a_bzrdir: The bzrdir to get the branch data from.
1863
:return: None if the branch is not a reference branch.
1868
def _initialize_control_files(cls, a_bzrdir, utf8_files, lock_filename,
1870
branch_transport = a_bzrdir.get_branch_transport(cls)
1871
control_files = lockable_files.LockableFiles(branch_transport,
1872
lock_filename, lock_class)
1873
control_files.create_lock()
1874
control_files.lock_write()
1876
for filename, content in utf8_files:
1877
control_files.put_utf8(filename, content)
1879
control_files.unlock()
1882
def initialize(cls, a_bzrdir):
1883
"""Create a branch of this format in a_bzrdir."""
1884
utf8_files = [('format', cls.get_format_string()),
1885
('revision-history', ''),
1886
('branch-name', ''),
1889
cls._initialize_control_files(a_bzrdir, utf8_files,
1890
'lock', lockdir.LockDir)
1891
return cls.open(a_bzrdir, _found=True)
1894
def open(cls, a_bzrdir, _found=False):
1895
"""Return the branch object for a_bzrdir
1897
_found is a private parameter, do not use it. It is used to indicate
1898
if format probing has already be done.
1901
format = BranchFormat.find_format(a_bzrdir)
1902
assert format.__class__ == cls
1903
transport = a_bzrdir.get_branch_transport(None)
1904
control_files = lockable_files.LockableFiles(transport, 'lock',
1906
return cls(_format=cls,
1907
_control_files=control_files,
1909
_repository=a_bzrdir.find_repository())
1912
def is_supported(cls):
1915
def _make_tags(self):
1916
return BasicTags(self)
1919
def supports_tags(cls):
1923
BranchFormat.register_format(BzrBranchExperimental)
1926
class BzrBranch6(BzrBranch5):
1929
def last_revision_info(self):
1930
revision_string = self.control_files.get('last-revision').read()
1931
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1932
revision_id = cache_utf8.get_cached_utf8(revision_id)
1934
return revno, revision_id
1936
def last_revision(self):
1937
"""Return last revision id, or None"""
1938
revision_id = self.last_revision_info()[1]
1941
def _write_last_revision_info(self, revno, revision_id):
1942
"""Simply write out the revision id, with no checks.
1944
Use set_last_revision_info to perform this safely.
1946
Does not update the revision_history cache.
1947
Intended to be called by set_last_revision_info and
1948
_write_revision_history.
1950
if revision_id is None:
1951
revision_id = 'null:'
1952
out_string = '%d %s\n' % (revno, revision_id)
1953
self.control_files.put_bytes('last-revision', out_string)
1956
def set_last_revision_info(self, revno, revision_id):
1957
revision_id = osutils.safe_revision_id(revision_id)
1958
if self._get_append_revisions_only():
1959
self._check_history_violation(revision_id)
1960
self._write_last_revision_info(revno, revision_id)
1961
self._clear_cached_state()
1963
def _check_history_violation(self, revision_id):
1964
last_revision = self.last_revision()
1965
if last_revision is None:
1967
if last_revision not in self._lefthand_history(revision_id):
1968
raise errors.AppendRevisionsOnlyViolation(self.base)
1970
def _gen_revision_history(self):
1971
"""Generate the revision history from last revision
1973
history = list(self.repository.iter_reverse_revision_history(
1974
self.last_revision()))
1978
def _write_revision_history(self, history):
1979
"""Factored out of set_revision_history.
1981
This performs the actual writing to disk, with format-specific checks.
1982
It is intended to be called by BzrBranch5.set_revision_history.
1984
if len(history) == 0:
1985
last_revision = 'null:'
1987
if history != self._lefthand_history(history[-1]):
1988
raise errors.NotLefthandHistory(history)
1989
last_revision = history[-1]
1990
if self._get_append_revisions_only():
1991
self._check_history_violation(last_revision)
1992
self._write_last_revision_info(len(history), last_revision)
1995
def append_revision(self, *revision_ids):
1996
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1997
if len(revision_ids) == 0:
1999
prev_revno, prev_revision = self.last_revision_info()
2000
for revision in self.repository.get_revisions(revision_ids):
2001
if prev_revision == _mod_revision.NULL_REVISION:
2002
if revision.parent_ids != []:
2003
raise errors.NotLeftParentDescendant(self, prev_revision,
2004
revision.revision_id)
2006
if revision.parent_ids[0] != prev_revision:
2007
raise errors.NotLeftParentDescendant(self, prev_revision,
2008
revision.revision_id)
2009
prev_revision = revision.revision_id
2010
self.set_last_revision_info(prev_revno + len(revision_ids),
2014
def _set_parent_location(self, url):
2015
"""Set the parent branch"""
2016
self._set_config_location('parent_location', url, make_relative=True)
2019
def _get_parent_location(self):
2020
"""Set the parent branch"""
2021
return self._get_config_location('parent_location')
2023
def set_push_location(self, location):
2024
"""See Branch.set_push_location."""
2025
self._set_config_location('push_location', location)
2027
def set_bound_location(self, location):
2028
"""See Branch.set_push_location."""
2030
config = self.get_config()
2031
if location is None:
2032
if config.get_user_option('bound') != 'True':
2035
config.set_user_option('bound', 'False', warn_masked=True)
2038
self._set_config_location('bound_location', location,
2040
config.set_user_option('bound', 'True', warn_masked=True)
2043
def _get_bound_location(self, bound):
2044
"""Return the bound location in the config file.
2046
Return None if the bound parameter does not match"""
2047
config = self.get_config()
2048
config_bound = (config.get_user_option('bound') == 'True')
2049
if config_bound != bound:
2051
return self._get_config_location('bound_location', config=config)
2053
def get_bound_location(self):
2054
"""See Branch.set_push_location."""
2055
return self._get_bound_location(True)
2057
def get_old_bound_location(self):
2058
"""See Branch.get_old_bound_location"""
2059
return self._get_bound_location(False)
2061
def set_append_revisions_only(self, enabled):
2066
self.get_config().set_user_option('append_revisions_only', value,
2069
def _get_append_revisions_only(self):
2070
value = self.get_config().get_user_option('append_revisions_only')
2071
return value == 'True'
2073
def _synchronize_history(self, destination, revision_id):
2074
"""Synchronize last revision and revision history between branches.
2076
This version is most efficient when the destination is also a
2077
BzrBranch6, but works for BzrBranch5, as long as the destination's
2078
repository contains all the lefthand ancestors of the intended
2079
last_revision. If not, set_last_revision_info will fail.
2081
:param destination: The branch to copy the history into
2082
:param revision_id: The revision-id to truncate history at. May
2083
be None to copy complete history.
2085
if revision_id is None:
2086
revno, revision_id = self.last_revision_info()
2088
# To figure out the revno for a random revision, we need to build
2089
# the revision history, and count its length.
2090
# We don't care about the order, just how long it is.
2091
# Alternatively, we could start at the current location, and count
2092
# backwards. But there is no guarantee that we will find it since
2093
# it may be a merged revision.
2094
revno = len(list(self.repository.iter_reverse_revision_history(
2096
destination.set_last_revision_info(revno, revision_id)
2098
def _make_tags(self):
2099
return BasicTags(self)
2102
######################################################################
2103
# results of operations
2106
class _Result(object):
2108
def _show_tag_conficts(self, to_file):
2109
if not getattr(self, 'tag_conflicts', None):
2111
to_file.write('Conflicting tags:\n')
2112
for name, value1, value2 in self.tag_conflicts:
2113
to_file.write(' %s\n' % (name, ))
2116
class PullResult(_Result):
2117
"""Result of a Branch.pull operation.
2119
:ivar old_revno: Revision number before pull.
2120
:ivar new_revno: Revision number after pull.
2121
:ivar old_revid: Tip revision id before pull.
2122
:ivar new_revid: Tip revision id after pull.
2123
:ivar source_branch: Source (local) branch object.
2124
:ivar master_branch: Master branch of the target, or None.
2125
:ivar target_branch: Target/destination branch object.
2129
# DEPRECATED: pull used to return the change in revno
2130
return self.new_revno - self.old_revno
2132
def report(self, to_file):
2133
if self.old_revid == self.new_revid:
2134
to_file.write('No revisions to pull.\n')
2136
to_file.write('Now on revision %d.\n' % self.new_revno)
2137
self._show_tag_conficts(to_file)
2140
class PushResult(_Result):
2141
"""Result of a Branch.push operation.
2143
:ivar old_revno: Revision number before push.
2144
:ivar new_revno: Revision number after push.
2145
:ivar old_revid: Tip revision id before push.
2146
:ivar new_revid: Tip revision id after push.
2147
:ivar source_branch: Source branch object.
2148
:ivar master_branch: Master branch of the target, or None.
2149
:ivar target_branch: Target/destination branch object.
2153
# DEPRECATED: push used to return the change in revno
2154
return self.new_revno - self.old_revno
2156
def report(self, to_file):
2157
"""Write a human-readable description of the result."""
2158
if self.old_revid == self.new_revid:
2159
to_file.write('No new revisions to push.\n')
2161
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2162
self._show_tag_conficts(to_file)
2165
class BranchCheckResult(object):
2166
"""Results of checking branch consistency.
2171
def __init__(self, branch):
2172
self.branch = branch
2174
def report_results(self, verbose):
2175
"""Report the check results via trace.note.
2177
:param verbose: Requests more detailed display of what was checked,
2180
note('checked branch %s format %s',
2182
self.branch._format)
2185
class Converter5to6(object):
2186
"""Perform an in-place upgrade of format 5 to format 6"""
2188
def convert(self, branch):
2189
# Data for 5 and 6 can peacefully coexist.
2190
format = BzrBranchFormat6()
2191
new_branch = format.open(branch.bzrdir, _found=True)
2193
# Copy source data into target
2194
new_branch.set_last_revision_info(*branch.last_revision_info())
2195
new_branch.set_parent(branch.get_parent())
2196
new_branch.set_bound_location(branch.get_bound_location())
2197
new_branch.set_push_location(branch.get_push_location())
2199
# New branch has no tags by default
2200
new_branch.tags._set_tag_dict({})
2202
# Copying done; now update target format
2203
new_branch.control_files.put_utf8('format',
2204
format.get_format_string())
2206
# Clean up old files
2207
new_branch.control_files._transport.delete('revision-history')
2209
branch.set_parent(None)
2212
branch.set_bound_location(None)
added
removed
bzrlib/branch.py
