1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
from cStringIO import StringIO
20
from bzrlib.lazy_import import lazy_import
21
lazy_import(globals(), """
22
from copy import deepcopy
23
from unittest import TestSuite
24
from warnings import warn
30
config as _mod_config,
35
revision as _mod_revision,
41
from bzrlib.config import BranchConfig, TreeConfig
42
from bzrlib.lockable_files import LockableFiles, TransportLock
45
from bzrlib.decorators import needs_read_lock, needs_write_lock
46
from bzrlib.errors import (BzrError, BzrCheckError, DivergedBranches,
47
HistoryMissing, InvalidRevisionId,
48
InvalidRevisionNumber, LockError, NoSuchFile,
49
NoSuchRevision, NoWorkingTree, NotVersionedError,
50
NotBranchError, UninitializableFormat,
51
UnlistableStore, UnlistableBranch,
53
from bzrlib.symbol_versioning import (deprecated_function,
57
zero_eight, zero_nine,
59
from bzrlib.trace import mutter, note
62
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
63
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
64
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
67
# TODO: Maybe include checks for common corruption of newlines, etc?
69
# TODO: Some operations like log might retrieve the same revisions
70
# repeatedly to calculate deltas. We could perhaps have a weakref
71
# cache in memory to make this faster. In general anything can be
72
# cached in memory between lock and unlock operations. .. nb thats
73
# what the transaction identity map provides
76
######################################################################
80
"""Branch holding a history of revisions.
83
Base directory/url of the branch.
85
hooks: An instance of BranchHooks.
87
# this is really an instance variable - FIXME move it there
91
def __init__(self, *ignored, **ignored_too):
92
raise NotImplementedError('The Branch class is abstract')
95
"""Break a lock if one is present from another instance.
97
Uses the ui factory to ask for confirmation if the lock may be from
100
This will probe the repository for its lock as well.
102
self.control_files.break_lock()
103
self.repository.break_lock()
104
master = self.get_master_branch()
105
if master is not None:
109
@deprecated_method(zero_eight)
110
def open_downlevel(base):
111
"""Open a branch which may be of an old format."""
112
return Branch.open(base, _unsupported=True)
115
def open(base, _unsupported=False):
116
"""Open the branch rooted at base.
118
For instance, if the branch is at URL/.bzr/branch,
119
Branch.open(URL) -> a Branch instance.
121
control = bzrdir.BzrDir.open(base, _unsupported)
122
return control.open_branch(_unsupported)
125
def open_containing(url):
126
"""Open an existing branch which contains url.
128
This probes for a branch at url, and searches upwards from there.
130
Basically we keep looking up until we find the control directory or
131
run into the root. If there isn't one, raises NotBranchError.
132
If there is one and it is either an unrecognised format or an unsupported
133
format, UnknownFormatError or UnsupportedFormatError are raised.
134
If there is one, it is returned, along with the unused portion of url.
136
control, relpath = bzrdir.BzrDir.open_containing(url)
137
return control.open_branch(), relpath
140
@deprecated_function(zero_eight)
141
def initialize(base):
142
"""Create a new working tree and branch, rooted at 'base' (url)
144
NOTE: This will soon be deprecated in favour of creation
147
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
149
@deprecated_function(zero_eight)
150
def setup_caching(self, cache_root):
151
"""Subclasses that care about caching should override this, and set
152
up cached stores located under cache_root.
154
NOTE: This is unused.
158
def get_config(self):
159
return BranchConfig(self)
162
return self.get_config().get_nickname()
164
def _set_nick(self, nick):
165
self.get_config().set_user_option('nickname', nick)
167
nick = property(_get_nick, _set_nick)
170
raise NotImplementedError(self.is_locked)
172
def lock_write(self):
173
raise NotImplementedError(self.lock_write)
176
raise NotImplementedError(self.lock_read)
179
raise NotImplementedError(self.unlock)
181
def peek_lock_mode(self):
182
"""Return lock mode for the Branch: 'r', 'w' or None"""
183
raise NotImplementedError(self.peek_lock_mode)
185
def get_physical_lock_status(self):
186
raise NotImplementedError(self.get_physical_lock_status)
188
def leave_lock_in_place(self):
189
"""Tell this branch object not to release the physical lock when this
192
If lock_write doesn't return a token, then this method is not supported.
194
self.control_files.leave_in_place()
196
def dont_leave_lock_in_place(self):
197
"""Tell this branch object to release the physical lock when this
198
object is unlocked, even if it didn't originally acquire it.
200
If lock_write doesn't return a token, then this method is not supported.
202
self.control_files.dont_leave_in_place()
204
def abspath(self, name):
205
"""Return absolute filename for something in the branch
207
XXX: Robert Collins 20051017 what is this used for? why is it a branch
208
method and not a tree method.
210
raise NotImplementedError(self.abspath)
212
def bind(self, other):
213
"""Bind the local branch the other branch.
215
:param other: The branch to bind to
218
raise errors.UpgradeRequired(self.base)
221
def fetch(self, from_branch, last_revision=None, pb=None):
222
"""Copy revisions from from_branch into this branch.
224
:param from_branch: Where to copy from.
225
:param last_revision: What revision to stop at (None for at the end
227
:param pb: An optional progress bar to use.
229
Returns the copied revision count and the failed revisions in a tuple:
232
if self.base == from_branch.base:
235
nested_pb = ui.ui_factory.nested_progress_bar()
240
from_branch.lock_read()
242
if last_revision is None:
243
pb.update('get source history')
244
last_revision = from_branch.last_revision()
245
if last_revision is None:
246
last_revision = _mod_revision.NULL_REVISION
247
return self.repository.fetch(from_branch.repository,
248
revision_id=last_revision,
251
if nested_pb is not None:
255
def get_bound_location(self):
256
"""Return the URL of the branch we are bound to.
258
Older format branches cannot bind, please be sure to use a metadir
263
def get_old_bound_location(self):
264
"""Return the URL of the branch we used to be bound to
266
raise errors.UpgradeRequired(self.base)
268
def get_commit_builder(self, parents, config=None, timestamp=None,
269
timezone=None, committer=None, revprops=None,
271
"""Obtain a CommitBuilder for this branch.
273
:param parents: Revision ids of the parents of the new revision.
274
:param config: Optional configuration to use.
275
:param timestamp: Optional timestamp recorded for commit.
276
:param timezone: Optional timezone for timestamp.
277
:param committer: Optional committer to set for commit.
278
:param revprops: Optional dictionary of revision properties.
279
:param revision_id: Optional revision id.
283
config = self.get_config()
285
return self.repository.get_commit_builder(self, parents, config,
286
timestamp, timezone, committer, revprops, revision_id)
288
def get_master_branch(self):
289
"""Return the branch we are bound to.
291
:return: Either a Branch, or None
295
def get_revision_delta(self, revno):
296
"""Return the delta for one revision.
298
The delta is relative to its mainline predecessor, or the
299
empty tree for revision 1.
301
assert isinstance(revno, int)
302
rh = self.revision_history()
303
if not (1 <= revno <= len(rh)):
304
raise InvalidRevisionNumber(revno)
305
return self.repository.get_revision_delta(rh[revno-1])
307
def get_root_id(self):
308
"""Return the id of this branches root"""
309
raise NotImplementedError(self.get_root_id)
311
def print_file(self, file, revision_id):
312
"""Print `file` to stdout."""
313
raise NotImplementedError(self.print_file)
315
def append_revision(self, *revision_ids):
316
raise NotImplementedError(self.append_revision)
318
def set_revision_history(self, rev_history):
319
raise NotImplementedError(self.set_revision_history)
321
def revision_history(self):
322
"""Return sequence of revision hashes on to this branch."""
323
raise NotImplementedError(self.revision_history)
326
"""Return current revision number for this branch.
328
That is equivalent to the number of revisions committed to
331
return len(self.revision_history())
334
"""Older format branches cannot bind or unbind."""
335
raise errors.UpgradeRequired(self.base)
337
def set_append_revisions_only(self, enabled):
338
"""Older format branches are never restricted to append-only"""
339
raise errors.UpgradeRequired(self.base)
341
def last_revision(self):
342
"""Return last revision id, or None"""
343
ph = self.revision_history()
349
def last_revision_info(self):
350
"""Return information about the last revision.
352
:return: A tuple (revno, last_revision_id).
354
rh = self.revision_history()
357
return (revno, rh[-1])
359
return (0, _mod_revision.NULL_REVISION)
361
def missing_revisions(self, other, stop_revision=None):
362
"""Return a list of new revisions that would perfectly fit.
364
If self and other have not diverged, return a list of the revisions
365
present in other, but missing from self.
367
self_history = self.revision_history()
368
self_len = len(self_history)
369
other_history = other.revision_history()
370
other_len = len(other_history)
371
common_index = min(self_len, other_len) -1
372
if common_index >= 0 and \
373
self_history[common_index] != other_history[common_index]:
374
raise DivergedBranches(self, other)
376
if stop_revision is None:
377
stop_revision = other_len
379
assert isinstance(stop_revision, int)
380
if stop_revision > other_len:
381
raise errors.NoSuchRevision(self, stop_revision)
382
return other_history[self_len:stop_revision]
384
def update_revisions(self, other, stop_revision=None):
385
"""Pull in new perfect-fit revisions.
387
:param other: Another Branch to pull from
388
:param stop_revision: Updated until the given revision
391
raise NotImplementedError(self.update_revisions)
393
def revision_id_to_revno(self, revision_id):
394
"""Given a revision id, return its revno"""
395
if revision_id is None:
397
revision_id = osutils.safe_revision_id(revision_id)
398
history = self.revision_history()
400
return history.index(revision_id) + 1
402
raise bzrlib.errors.NoSuchRevision(self, revision_id)
404
def get_rev_id(self, revno, history=None):
405
"""Find the revision id of the specified revno."""
409
history = self.revision_history()
410
if revno <= 0 or revno > len(history):
411
raise bzrlib.errors.NoSuchRevision(self, revno)
412
return history[revno - 1]
414
def pull(self, source, overwrite=False, stop_revision=None):
415
"""Mirror source into this branch.
417
This branch is considered to be 'local', having low latency.
419
raise NotImplementedError(self.pull)
421
def push(self, target, overwrite=False, stop_revision=None):
422
"""Mirror this branch into target.
424
This branch is considered to be 'local', having low latency.
426
raise NotImplementedError(self.push)
428
def basis_tree(self):
429
"""Return `Tree` object for last revision."""
430
return self.repository.revision_tree(self.last_revision())
432
def rename_one(self, from_rel, to_rel):
435
This can change the directory or the filename or both.
437
raise NotImplementedError(self.rename_one)
439
def move(self, from_paths, to_name):
442
to_name must exist as a versioned directory.
444
If to_name exists and is a directory, the files are moved into
445
it, keeping their old names. If it is a directory,
447
Note that to_name is only the last component of the new name;
448
this doesn't change the directory.
450
This returns a list of (from_path, to_path) pairs for each
453
raise NotImplementedError(self.move)
455
def get_parent(self):
456
"""Return the parent location of the branch.
458
This is the default location for push/pull/missing. The usual
459
pattern is that the user can override it by specifying a
462
raise NotImplementedError(self.get_parent)
464
def get_submit_branch(self):
465
"""Return the submit location of the branch.
467
This is the default location for bundle. The usual
468
pattern is that the user can override it by specifying a
471
return self.get_config().get_user_option('submit_branch')
473
def set_submit_branch(self, location):
474
"""Return the submit location of the branch.
476
This is the default location for bundle. The usual
477
pattern is that the user can override it by specifying a
480
self.get_config().set_user_option('submit_branch', location)
482
def get_push_location(self):
483
"""Return the None or the location to push this branch to."""
484
push_loc = self.get_config().get_user_option('push_location')
487
def set_push_location(self, location):
488
"""Set a new push location for this branch."""
489
raise NotImplementedError(self.set_push_location)
491
def set_parent(self, url):
492
raise NotImplementedError(self.set_parent)
496
"""Synchronise this branch with the master branch if any.
498
:return: None or the last_revision pivoted out during the update.
502
def check_revno(self, revno):
504
Check whether a revno corresponds to any revision.
505
Zero (the NULL revision) is considered valid.
508
self.check_real_revno(revno)
510
def check_real_revno(self, revno):
512
Check whether a revno corresponds to a real revision.
513
Zero (the NULL revision) is considered invalid
515
if revno < 1 or revno > self.revno():
516
raise InvalidRevisionNumber(revno)
519
def clone(self, *args, **kwargs):
520
"""Clone this branch into to_bzrdir preserving all semantic values.
522
revision_id: if not None, the revision history in the new branch will
523
be truncated to end with revision_id.
525
# for API compatibility, until 0.8 releases we provide the old api:
526
# def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
527
# after 0.8 releases, the *args and **kwargs should be changed:
528
# def clone(self, to_bzrdir, revision_id=None):
529
if (kwargs.get('to_location', None) or
530
kwargs.get('revision', None) or
531
kwargs.get('basis_branch', None) or
532
(len(args) and isinstance(args[0], basestring))):
533
# backwards compatibility api:
534
warn("Branch.clone() has been deprecated for BzrDir.clone() from"
535
" bzrlib 0.8.", DeprecationWarning, stacklevel=3)
538
basis_branch = args[2]
540
basis_branch = kwargs.get('basis_branch', None)
542
basis = basis_branch.bzrdir
547
revision_id = args[1]
549
revision_id = kwargs.get('revision', None)
554
# no default to raise if not provided.
555
url = kwargs.get('to_location')
556
return self.bzrdir.clone(url,
557
revision_id=revision_id,
558
basis=basis).open_branch()
560
# generate args by hand
562
revision_id = args[1]
564
revision_id = kwargs.get('revision_id', None)
568
# no default to raise if not provided.
569
to_bzrdir = kwargs.get('to_bzrdir')
570
result = self._format.initialize(to_bzrdir)
571
self.copy_content_into(result, revision_id=revision_id)
575
def sprout(self, to_bzrdir, revision_id=None):
576
"""Create a new line of development from the branch, into to_bzrdir.
578
revision_id: if not None, the revision history in the new branch will
579
be truncated to end with revision_id.
581
result = self._format.initialize(to_bzrdir)
582
self.copy_content_into(result, revision_id=revision_id)
583
result.set_parent(self.bzrdir.root_transport.base)
586
def _synchronize_history(self, destination, revision_id):
587
"""Synchronize last revision and revision history between branches.
589
This version is most efficient when the destination is also a
590
BzrBranch5, but works for BzrBranch6 as long as the revision
591
history is the true lefthand parent history, and all of the revisions
592
are in the destination's repository. If not, set_revision_history
595
:param destination: The branch to copy the history into
596
:param revision_id: The revision-id to truncate history at. May
597
be None to copy complete history.
599
new_history = self.revision_history()
600
if revision_id is not None:
601
revision_id = osutils.safe_revision_id(revision_id)
603
new_history = new_history[:new_history.index(revision_id) + 1]
605
rev = self.repository.get_revision(revision_id)
606
new_history = rev.get_history(self.repository)[1:]
607
destination.set_revision_history(new_history)
610
def copy_content_into(self, destination, revision_id=None):
611
"""Copy the content of self into destination.
613
revision_id: if not None, the revision history in the new branch will
614
be truncated to end with revision_id.
616
self._synchronize_history(destination, revision_id)
618
parent = self.get_parent()
619
except errors.InaccessibleParent, e:
620
mutter('parent was not accessible to copy: %s', e)
623
destination.set_parent(parent)
627
"""Check consistency of the branch.
629
In particular this checks that revisions given in the revision-history
630
do actually match up in the revision graph, and that they're all
631
present in the repository.
633
Callers will typically also want to check the repository.
635
:return: A BranchCheckResult.
637
mainline_parent_id = None
638
for revision_id in self.revision_history():
640
revision = self.repository.get_revision(revision_id)
641
except errors.NoSuchRevision, e:
642
raise errors.BzrCheckError("mainline revision {%s} not in repository"
644
# In general the first entry on the revision history has no parents.
645
# But it's not illegal for it to have parents listed; this can happen
646
# in imports from Arch when the parents weren't reachable.
647
if mainline_parent_id is not None:
648
if mainline_parent_id not in revision.parent_ids:
649
raise errors.BzrCheckError("previous revision {%s} not listed among "
651
% (mainline_parent_id, revision_id))
652
mainline_parent_id = revision_id
653
return BranchCheckResult(self)
655
def _get_checkout_format(self):
656
"""Return the most suitable metadir for a checkout of this branch.
657
Weaves are used if this branch's repository uses weaves.
659
from bzrlib.remote import RemoteBzrDir
660
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
661
from bzrlib.repofmt import weaverepo
662
format = bzrdir.BzrDirMetaFormat1()
663
format.repository_format = weaverepo.RepositoryFormat7()
664
elif isinstance(self.bzrdir, RemoteBzrDir):
665
format = bzrdir.BzrDirMetaFormat1()
667
format = self.repository.bzrdir.cloning_metadir()
668
format.branch_format = self._format
671
def create_checkout(self, to_location, revision_id=None,
673
"""Create a checkout of a branch.
675
:param to_location: The url to produce the checkout at
676
:param revision_id: The revision to check out
677
:param lightweight: If True, produce a lightweight checkout, otherwise,
678
produce a bound branch (heavyweight checkout)
679
:return: The tree of the created checkout
681
t = transport.get_transport(to_location)
684
except errors.FileExists:
687
checkout = bzrdir.BzrDirMetaFormat1().initialize_on_transport(t)
688
BranchReferenceFormat().initialize(checkout, self)
690
format = self._get_checkout_format()
691
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
692
to_location, force_new_tree=False, format=format)
693
checkout = checkout_branch.bzrdir
694
checkout_branch.bind(self)
695
# pull up to the specified revision_id to set the initial
696
# branch tip correctly, and seed it with history.
697
checkout_branch.pull(self, stop_revision=revision_id)
698
return checkout.create_workingtree(revision_id)
701
class BranchFormat(object):
702
"""An encapsulation of the initialization and open routines for a format.
704
Formats provide three things:
705
* An initialization routine,
709
Formats are placed in an dict by their format string for reference
710
during branch opening. Its not required that these be instances, they
711
can be classes themselves with class methods - it simply depends on
712
whether state is needed for a given format or not.
714
Once a format is deprecated, just deprecate the initialize and open
715
methods on the format class. Do not deprecate the object, as the
716
object will be created every time regardless.
719
_default_format = None
720
"""The default format used for new branches."""
723
"""The known formats."""
726
def find_format(klass, a_bzrdir):
727
"""Return the format for the branch object in a_bzrdir."""
729
transport = a_bzrdir.get_branch_transport(None)
730
format_string = transport.get("format").read()
731
return klass._formats[format_string]
733
raise NotBranchError(path=transport.base)
735
raise errors.UnknownFormatError(format=format_string)
738
def get_default_format(klass):
739
"""Return the current default format."""
740
return klass._default_format
742
def get_format_string(self):
743
"""Return the ASCII format string that identifies this format."""
744
raise NotImplementedError(self.get_format_string)
746
def get_format_description(self):
747
"""Return the short format description for this format."""
748
raise NotImplementedError(self.get_format_description)
750
def get_reference(self, a_bzrdir):
751
"""Get the target reference of the branch in a_bzrdir.
753
format probing must have been completed before calling
754
this method - it is assumed that the format of the branch
755
in a_bzrdir is correct.
757
:param a_bzrdir: The bzrdir to get the branch data from.
758
:return: None if the branch is not a reference branch.
762
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
764
"""Initialize a branch in a bzrdir, with specified files
766
:param a_bzrdir: The bzrdir to initialize the branch in
767
:param utf8_files: The files to create as a list of
768
(filename, content) tuples
769
:param set_format: If True, set the format with
770
self.get_format_string. (BzrBranch4 has its format set
772
:return: a branch in this format
774
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
775
branch_transport = a_bzrdir.get_branch_transport(self)
777
'metadir': ('lock', lockdir.LockDir),
778
'branch4': ('branch-lock', lockable_files.TransportLock),
780
lock_name, lock_class = lock_map[lock_type]
781
control_files = lockable_files.LockableFiles(branch_transport,
782
lock_name, lock_class)
783
control_files.create_lock()
784
control_files.lock_write()
786
control_files.put_utf8('format', self.get_format_string())
788
for file, content in utf8_files:
789
control_files.put_utf8(file, content)
791
control_files.unlock()
792
return self.open(a_bzrdir, _found=True)
794
def initialize(self, a_bzrdir):
795
"""Create a branch of this format in a_bzrdir."""
796
raise NotImplementedError(self.initialize)
798
def is_supported(self):
799
"""Is this format supported?
801
Supported formats can be initialized and opened.
802
Unsupported formats may not support initialization or committing or
803
some other features depending on the reason for not being supported.
807
def open(self, a_bzrdir, _found=False):
808
"""Return the branch object for a_bzrdir
810
_found is a private parameter, do not use it. It is used to indicate
811
if format probing has already be done.
813
raise NotImplementedError(self.open)
816
def register_format(klass, format):
817
klass._formats[format.get_format_string()] = format
820
def set_default_format(klass, format):
821
klass._default_format = format
824
def unregister_format(klass, format):
825
assert klass._formats[format.get_format_string()] is format
826
del klass._formats[format.get_format_string()]
829
return self.get_format_string().rstrip()
832
class BranchHooks(dict):
833
"""A dictionary mapping hook name to a list of callables for branch hooks.
835
e.g. ['set_rh'] Is the list of items to be called when the
836
set_revision_history function is invoked.
840
"""Create the default hooks.
842
These are all empty initially, because by default nothing should get
846
# Introduced in 0.15:
847
# invoked whenever the revision history has been set
848
# with set_revision_history. The api signature is
849
# (branch, revision_history), and the branch will
852
# invoked after a push operation completes.
853
# the api signature is
854
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
855
# where local is the local branch or None, master is the target
856
# master branch, and the rest should be self explanatory. The source
857
# is read locked and the target branches write locked. Source will
858
# be the local low-latency branch.
859
self['post_push'] = []
860
# invoked after a pull operation completes.
861
# the api signature is
862
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
863
# where local is the local branch or None, master is the target
864
# master branch, and the rest should be self explanatory. The source
865
# is read locked and the target branches write locked. The local
866
# branch is the low-latency branch.
867
self['post_pull'] = []
868
# invoked after a commit operation completes.
869
# the api signature is
870
# (local, master, old_revno, old_revid, new_revno, new_revid)
871
# old_revid is NULL_REVISION for the first commit to a branch.
872
self['post_commit'] = []
873
# invoked after a uncommit operation completes.
874
# the api signature is
875
# (local, master, old_revno, old_revid, new_revno, new_revid) where
876
# local is the local branch or None, master is the target branch,
877
# and an empty branch recieves new_revno of 0, new_revid of None.
878
self['post_uncommit'] = []
880
def install_hook(self, hook_name, a_callable):
881
"""Install a_callable in to the hook hook_name.
883
:param hook_name: A hook name. See the __init__ method of BranchHooks
884
for the complete list of hooks.
885
:param a_callable: The callable to be invoked when the hook triggers.
886
The exact signature will depend on the hook - see the __init__
887
method of BranchHooks for details on each hook.
890
self[hook_name].append(a_callable)
892
raise errors.UnknownHook('branch', hook_name)
895
# install the default hooks into the Branch class.
896
Branch.hooks = BranchHooks()
899
class BzrBranchFormat4(BranchFormat):
900
"""Bzr branch format 4.
903
- a revision-history file.
904
- a branch-lock lock file [ to be shared with the bzrdir ]
907
def get_format_description(self):
908
"""See BranchFormat.get_format_description()."""
909
return "Branch format 4"
911
def initialize(self, a_bzrdir):
912
"""Create a branch of this format in a_bzrdir."""
913
utf8_files = [('revision-history', ''),
916
return self._initialize_helper(a_bzrdir, utf8_files,
917
lock_type='branch4', set_format=False)
920
super(BzrBranchFormat4, self).__init__()
921
self._matchingbzrdir = bzrdir.BzrDirFormat6()
923
def open(self, a_bzrdir, _found=False):
924
"""Return the branch object for a_bzrdir
926
_found is a private parameter, do not use it. It is used to indicate
927
if format probing has already be done.
930
# we are being called directly and must probe.
931
raise NotImplementedError
932
return BzrBranch(_format=self,
933
_control_files=a_bzrdir._control_files,
935
_repository=a_bzrdir.open_repository())
938
return "Bazaar-NG branch format 4"
941
class BzrBranchFormat5(BranchFormat):
942
"""Bzr branch format 5.
945
- a revision-history file.
947
- a lock dir guarding the branch itself
948
- all of this stored in a branch/ subdirectory
949
- works with shared repositories.
951
This format is new in bzr 0.8.
954
def get_format_string(self):
955
"""See BranchFormat.get_format_string()."""
956
return "Bazaar-NG branch format 5\n"
958
def get_format_description(self):
959
"""See BranchFormat.get_format_description()."""
960
return "Branch format 5"
962
def initialize(self, a_bzrdir):
963
"""Create a branch of this format in a_bzrdir."""
964
utf8_files = [('revision-history', ''),
967
return self._initialize_helper(a_bzrdir, utf8_files)
970
super(BzrBranchFormat5, self).__init__()
971
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
973
def open(self, a_bzrdir, _found=False):
974
"""Return the branch object for a_bzrdir
976
_found is a private parameter, do not use it. It is used to indicate
977
if format probing has already be done.
980
format = BranchFormat.find_format(a_bzrdir)
981
assert format.__class__ == self.__class__
983
transport = a_bzrdir.get_branch_transport(None)
984
control_files = lockable_files.LockableFiles(transport, 'lock',
986
return BzrBranch5(_format=self,
987
_control_files=control_files,
989
_repository=a_bzrdir.find_repository())
991
raise NotBranchError(path=transport.base)
994
return "Bazaar-NG Metadir branch format 5"
997
class BzrBranchFormat6(BzrBranchFormat5):
998
"""Branch format with last-revision
1000
Unlike previous formats, this has no explicit revision history. Instead,
1001
this just stores the last-revision, and the left-hand history leading
1002
up to there is the history.
1004
This format was introduced in bzr 0.15
1007
def get_format_string(self):
1008
"""See BranchFormat.get_format_string()."""
1009
return "Bazaar-NG branch format 6\n"
1011
def get_format_description(self):
1012
"""See BranchFormat.get_format_description()."""
1013
return "Branch format 6"
1015
def initialize(self, a_bzrdir):
1016
"""Create a branch of this format in a_bzrdir."""
1017
utf8_files = [('last-revision', '0 null:\n'),
1018
('branch-name', ''),
1021
return self._initialize_helper(a_bzrdir, utf8_files)
1023
def open(self, a_bzrdir, _found=False):
1024
"""Return the branch object for a_bzrdir
1026
_found is a private parameter, do not use it. It is used to indicate
1027
if format probing has already be done.
1030
format = BranchFormat.find_format(a_bzrdir)
1031
assert format.__class__ == self.__class__
1032
transport = a_bzrdir.get_branch_transport(None)
1033
control_files = lockable_files.LockableFiles(transport, 'lock',
1035
return BzrBranch6(_format=self,
1036
_control_files=control_files,
1038
_repository=a_bzrdir.find_repository())
1041
class BranchReferenceFormat(BranchFormat):
1042
"""Bzr branch reference format.
1044
Branch references are used in implementing checkouts, they
1045
act as an alias to the real branch which is at some other url.
1052
def get_format_string(self):
1053
"""See BranchFormat.get_format_string()."""
1054
return "Bazaar-NG Branch Reference Format 1\n"
1056
def get_format_description(self):
1057
"""See BranchFormat.get_format_description()."""
1058
return "Checkout reference format 1"
1060
def get_reference(self, a_bzrdir):
1061
"""See BranchFormat.get_reference()."""
1062
transport = a_bzrdir.get_branch_transport(None)
1063
return transport.get('location').read()
1065
def initialize(self, a_bzrdir, target_branch=None):
1066
"""Create a branch of this format in a_bzrdir."""
1067
if target_branch is None:
1068
# this format does not implement branch itself, thus the implicit
1069
# creation contract must see it as uninitializable
1070
raise errors.UninitializableFormat(self)
1071
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1072
branch_transport = a_bzrdir.get_branch_transport(self)
1073
branch_transport.put_bytes('location',
1074
target_branch.bzrdir.root_transport.base)
1075
branch_transport.put_bytes('format', self.get_format_string())
1076
return self.open(a_bzrdir, _found=True)
1079
super(BranchReferenceFormat, self).__init__()
1080
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1082
def _make_reference_clone_function(format, a_branch):
1083
"""Create a clone() routine for a branch dynamically."""
1084
def clone(to_bzrdir, revision_id=None):
1085
"""See Branch.clone()."""
1086
return format.initialize(to_bzrdir, a_branch)
1087
# cannot obey revision_id limits when cloning a reference ...
1088
# FIXME RBC 20060210 either nuke revision_id for clone, or
1089
# emit some sort of warning/error to the caller ?!
1092
def open(self, a_bzrdir, _found=False, location=None):
1093
"""Return the branch that the branch reference in a_bzrdir points at.
1095
_found is a private parameter, do not use it. It is used to indicate
1096
if format probing has already be done.
1099
format = BranchFormat.find_format(a_bzrdir)
1100
assert format.__class__ == self.__class__
1101
if location is None:
1102
location = self.get_reference(a_bzrdir)
1103
real_bzrdir = bzrdir.BzrDir.open(location)
1104
result = real_bzrdir.open_branch()
1105
# this changes the behaviour of result.clone to create a new reference
1106
# rather than a copy of the content of the branch.
1107
# I did not use a proxy object because that needs much more extensive
1108
# testing, and we are only changing one behaviour at the moment.
1109
# If we decide to alter more behaviours - i.e. the implicit nickname
1110
# then this should be refactored to introduce a tested proxy branch
1111
# and a subclass of that for use in overriding clone() and ....
1113
result.clone = self._make_reference_clone_function(result)
1117
# formats which have no format string are not discoverable
1118
# and not independently creatable, so are not registered.
1119
__default_format = BzrBranchFormat5()
1120
BranchFormat.register_format(__default_format)
1121
BranchFormat.register_format(BranchReferenceFormat())
1122
BranchFormat.register_format(BzrBranchFormat6())
1123
BranchFormat.set_default_format(__default_format)
1124
_legacy_formats = [BzrBranchFormat4(),
1127
class BzrBranch(Branch):
1128
"""A branch stored in the actual filesystem.
1130
Note that it's "local" in the context of the filesystem; it doesn't
1131
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1132
it's writable, and can be accessed via the normal filesystem API.
1135
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
1136
relax_version_check=DEPRECATED_PARAMETER, _format=None,
1137
_control_files=None, a_bzrdir=None, _repository=None):
1138
"""Create new branch object at a particular location.
1140
transport -- A Transport object, defining how to access files.
1142
init -- If True, create new control files in a previously
1143
unversioned directory. If False, the branch must already
1146
relax_version_check -- If true, the usual check for the branch
1147
version is not applied. This is intended only for
1148
upgrade/recovery type use; it's not guaranteed that
1149
all operations will work on old format branches.
1151
if a_bzrdir is None:
1152
self.bzrdir = bzrdir.BzrDir.open(transport.base)
1154
self.bzrdir = a_bzrdir
1155
self._transport = self.bzrdir.transport.clone('..')
1156
self._base = self._transport.base
1157
self._format = _format
1158
if _control_files is None:
1159
raise ValueError('BzrBranch _control_files is None')
1160
self.control_files = _control_files
1161
if deprecated_passed(init):
1162
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
1163
"deprecated as of bzr 0.8. Please use Branch.create().",
1167
# this is slower than before deprecation, oh well never mind.
1168
# -> its deprecated.
1169
self._initialize(transport.base)
1170
self._check_format(_format)
1171
if deprecated_passed(relax_version_check):
1172
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
1173
"relax_version_check parameter is deprecated as of bzr 0.8. "
1174
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
1178
if (not relax_version_check
1179
and not self._format.is_supported()):
1180
raise errors.UnsupportedFormatError(format=fmt)
1181
if deprecated_passed(transport):
1182
warn("BzrBranch.__init__(transport=XXX...): The transport "
1183
"parameter is deprecated as of bzr 0.8. "
1184
"Please use Branch.open, or bzrdir.open_branch().",
1187
self.repository = _repository
1190
return '%s(%r)' % (self.__class__.__name__, self.base)
1194
def _get_base(self):
1197
base = property(_get_base, doc="The URL for the root of this branch.")
1199
def _finish_transaction(self):
1200
"""Exit the current transaction."""
1201
return self.control_files._finish_transaction()
1203
def get_transaction(self):
1204
"""Return the current active transaction.
1206
If no transaction is active, this returns a passthrough object
1207
for which all data is immediately flushed and no caching happens.
1209
# this is an explicit function so that we can do tricky stuff
1210
# when the storage in rev_storage is elsewhere.
1211
# we probably need to hook the two 'lock a location' and
1212
# 'have a transaction' together more delicately, so that
1213
# we can have two locks (branch and storage) and one transaction
1214
# ... and finishing the transaction unlocks both, but unlocking
1215
# does not. - RBC 20051121
1216
return self.control_files.get_transaction()
1218
def _set_transaction(self, transaction):
1219
"""Set a new active transaction."""
1220
return self.control_files._set_transaction(transaction)
1222
def abspath(self, name):
1223
"""See Branch.abspath."""
1224
return self.control_files._transport.abspath(name)
1226
def _check_format(self, format):
1227
"""Identify the branch format if needed.
1229
The format is stored as a reference to the format object in
1230
self._format for code that needs to check it later.
1232
The format parameter is either None or the branch format class
1233
used to open this branch.
1235
FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
1238
format = BranchFormat.find_format(self.bzrdir)
1239
self._format = format
1240
mutter("got branch format %s", self._format)
1243
def get_root_id(self):
1244
"""See Branch.get_root_id."""
1245
tree = self.repository.revision_tree(self.last_revision())
1246
return tree.inventory.root.file_id
1248
def is_locked(self):
1249
return self.control_files.is_locked()
1251
def lock_write(self, tokens=None):
1252
if tokens is not None:
1253
branch_token, repo_token = tokens
1255
branch_token = repo_token = None
1256
repo_token = self.repository.lock_write(token=repo_token)
1258
branch_token = self.control_files.lock_write(token=branch_token)
1260
self.repository.unlock()
1263
tokens = (branch_token, repo_token)
1264
assert tokens == (None, None) or None not in tokens, (
1265
'Both branch and repository locks must return tokens, or else '
1266
'neither must return tokens. Got %r.' % (tokens,))
1267
if tokens == (None, None):
1272
def lock_read(self):
1273
self.repository.lock_read()
1275
self.control_files.lock_read()
1277
self.repository.unlock()
1281
# TODO: test for failed two phase locks. This is known broken.
1283
self.control_files.unlock()
1285
self.repository.unlock()
1287
def peek_lock_mode(self):
1288
if self.control_files._lock_count == 0:
1291
return self.control_files._lock_mode
1293
def get_physical_lock_status(self):
1294
return self.control_files.get_physical_lock_status()
1297
def print_file(self, file, revision_id):
1298
"""See Branch.print_file."""
1299
return self.repository.print_file(file, revision_id)
1302
def append_revision(self, *revision_ids):
1303
"""See Branch.append_revision."""
1304
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1305
for revision_id in revision_ids:
1306
_mod_revision.check_not_reserved_id(revision_id)
1307
mutter("add {%s} to revision-history" % revision_id)
1308
rev_history = self.revision_history()
1309
rev_history.extend(revision_ids)
1310
self.set_revision_history(rev_history)
1312
def _write_revision_history(self, history):
1313
"""Factored out of set_revision_history.
1315
This performs the actual writing to disk.
1316
It is intended to be called by BzrBranch5.set_revision_history."""
1317
self.control_files.put_bytes(
1318
'revision-history', '\n'.join(history))
1321
def set_revision_history(self, rev_history):
1322
"""See Branch.set_revision_history."""
1323
rev_history = [osutils.safe_revision_id(r) for r in rev_history]
1324
self._write_revision_history(rev_history)
1325
transaction = self.get_transaction()
1326
history = transaction.map.find_revision_history()
1327
if history is not None:
1328
# update the revision history in the identity map.
1329
history[:] = list(rev_history)
1330
# this call is disabled because revision_history is
1331
# not really an object yet, and the transaction is for objects.
1332
# transaction.register_dirty(history)
1334
transaction.map.add_revision_history(rev_history)
1335
# this call is disabled because revision_history is
1336
# not really an object yet, and the transaction is for objects.
1337
# transaction.register_clean(history)
1338
for hook in Branch.hooks['set_rh']:
1339
hook(self, rev_history)
1342
def set_last_revision_info(self, revno, revision_id):
1343
revision_id = osutils.safe_revision_id(revision_id)
1344
history = self._lefthand_history(revision_id)
1345
assert len(history) == revno, '%d != %d' % (len(history), revno)
1346
self.set_revision_history(history)
1348
def _gen_revision_history(self):
1349
get_cached_utf8 = cache_utf8.get_cached_utf8
1350
history = [get_cached_utf8(l.rstrip('\r\n')) for l in
1351
self.control_files.get('revision-history').readlines()]
1355
def revision_history(self):
1356
"""See Branch.revision_history."""
1357
transaction = self.get_transaction()
1358
history = transaction.map.find_revision_history()
1359
if history is not None:
1360
# mutter("cache hit for revision-history in %s", self)
1361
return list(history)
1362
history = self._gen_revision_history()
1363
transaction.map.add_revision_history(history)
1364
# this call is disabled because revision_history is
1365
# not really an object yet, and the transaction is for objects.
1366
# transaction.register_clean(history, precious=True)
1367
return list(history)
1369
def _lefthand_history(self, revision_id, last_rev=None,
1371
# stop_revision must be a descendant of last_revision
1372
stop_graph = self.repository.get_revision_graph(revision_id)
1373
if last_rev is not None and last_rev not in stop_graph:
1374
# our previous tip is not merged into stop_revision
1375
raise errors.DivergedBranches(self, other_branch)
1376
# make a new revision history from the graph
1377
current_rev_id = revision_id
1379
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1380
new_history.append(current_rev_id)
1381
current_rev_id_parents = stop_graph[current_rev_id]
1383
current_rev_id = current_rev_id_parents[0]
1385
current_rev_id = None
1386
new_history.reverse()
1390
def generate_revision_history(self, revision_id, last_rev=None,
1392
"""Create a new revision history that will finish with revision_id.
1394
:param revision_id: the new tip to use.
1395
:param last_rev: The previous last_revision. If not None, then this
1396
must be a ancestory of revision_id, or DivergedBranches is raised.
1397
:param other_branch: The other branch that DivergedBranches should
1398
raise with respect to.
1400
revision_id = osutils.safe_revision_id(revision_id)
1401
self.set_revision_history(self._lefthand_history(revision_id,
1402
last_rev, other_branch))
1405
def update_revisions(self, other, stop_revision=None):
1406
"""See Branch.update_revisions."""
1409
if stop_revision is None:
1410
stop_revision = other.last_revision()
1411
if stop_revision is None:
1412
# if there are no commits, we're done.
1415
stop_revision = osutils.safe_revision_id(stop_revision)
1416
# whats the current last revision, before we fetch [and change it
1418
last_rev = self.last_revision()
1419
# we fetch here regardless of whether we need to so that we pickup
1421
self.fetch(other, stop_revision)
1422
my_ancestry = self.repository.get_ancestry(last_rev)
1423
if stop_revision in my_ancestry:
1424
# last_revision is a descendant of stop_revision
1426
self.generate_revision_history(stop_revision, last_rev=last_rev,
1431
def basis_tree(self):
1432
"""See Branch.basis_tree."""
1433
return self.repository.revision_tree(self.last_revision())
1435
@deprecated_method(zero_eight)
1436
def working_tree(self):
1437
"""Create a Working tree object for this branch."""
1439
from bzrlib.transport.local import LocalTransport
1440
if (self.base.find('://') != -1 or
1441
not isinstance(self._transport, LocalTransport)):
1442
raise NoWorkingTree(self.base)
1443
return self.bzrdir.open_workingtree()
1446
def pull(self, source, overwrite=False, stop_revision=None,
1447
_hook_master=None, _run_hooks=True):
1450
:param _hook_master: Private parameter - set the branch to
1451
be supplied as the master to push hooks.
1452
:param _run_hooks: Private parameter - allow disabling of
1453
hooks, used when pushing to a master branch.
1457
old_count, old_tip = self.last_revision_info()
1459
self.update_revisions(source, stop_revision)
1460
except DivergedBranches:
1464
self.set_revision_history(source.revision_history())
1465
new_count, new_tip = self.last_revision_info()
1472
for hook in Branch.hooks['post_pull']:
1473
hook(source, _hook_local, _hook_master, old_count, old_tip,
1475
return new_count - old_count
1479
def _get_parent_location(self):
1480
_locs = ['parent', 'pull', 'x-pull']
1483
return self.control_files.get(l).read().strip('\n')
1489
def push(self, target, 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.
1500
old_count, old_tip = target.last_revision_info()
1502
target.update_revisions(self, stop_revision)
1503
except DivergedBranches:
1507
target.set_revision_history(self.revision_history())
1508
new_count, new_tip = target.last_revision_info()
1511
_hook_local = target
1513
_hook_master = target
1515
for hook in Branch.hooks['post_push']:
1516
hook(self, _hook_local, _hook_master, old_count, old_tip,
1518
return new_count - old_count
1522
def get_parent(self):
1523
"""See Branch.get_parent."""
1525
assert self.base[-1] == '/'
1526
parent = self._get_parent_location()
1529
# This is an old-format absolute path to a local branch
1530
# turn it into a url
1531
if parent.startswith('/'):
1532
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1534
return urlutils.join(self.base[:-1], parent)
1535
except errors.InvalidURLJoin, e:
1536
raise errors.InaccessibleParent(parent, self.base)
1538
def set_push_location(self, location):
1539
"""See Branch.set_push_location."""
1540
self.get_config().set_user_option(
1541
'push_location', location,
1542
store=_mod_config.STORE_LOCATION_NORECURSE)
1545
def set_parent(self, url):
1546
"""See Branch.set_parent."""
1547
# TODO: Maybe delete old location files?
1548
# URLs should never be unicode, even on the local fs,
1549
# FIXUP this and get_parent in a future branch format bump:
1550
# read and rewrite the file, and have the new format code read
1551
# using .get not .get_utf8. RBC 20060125
1553
if isinstance(url, unicode):
1555
url = url.encode('ascii')
1556
except UnicodeEncodeError:
1557
raise bzrlib.errors.InvalidURL(url,
1558
"Urls must be 7-bit ascii, "
1559
"use bzrlib.urlutils.escape")
1560
url = urlutils.relative_url(self.base, url)
1561
self._set_parent_location(url)
1563
def _set_parent_location(self, url):
1565
self.control_files._transport.delete('parent')
1567
assert isinstance(url, str)
1568
self.control_files.put_bytes('parent', url + '\n')
1570
@deprecated_function(zero_nine)
1571
def tree_config(self):
1572
"""DEPRECATED; call get_config instead.
1573
TreeConfig has become part of BranchConfig."""
1574
return TreeConfig(self)
1577
class BzrBranch5(BzrBranch):
1578
"""A format 5 branch. This supports new features over plan branches.
1580
It has support for a master_branch which is the data for bound branches.
1588
super(BzrBranch5, self).__init__(_format=_format,
1589
_control_files=_control_files,
1591
_repository=_repository)
1594
def pull(self, source, overwrite=False, stop_revision=None,
1596
"""Extends branch.pull to be bound branch aware.
1598
:param _run_hooks: Private parameter used to force hook running
1599
off during bound branch double-pushing.
1601
bound_location = self.get_bound_location()
1602
master_branch = None
1603
if bound_location and source.base != bound_location:
1604
# not pulling from master, so we need to update master.
1605
master_branch = self.get_master_branch()
1606
master_branch.lock_write()
1609
# pull from source into master.
1610
master_branch.pull(source, overwrite, stop_revision,
1612
return super(BzrBranch5, self).pull(source, overwrite,
1613
stop_revision, _hook_master=master_branch,
1614
_run_hooks=_run_hooks)
1617
master_branch.unlock()
1620
def push(self, target, overwrite=False, stop_revision=None):
1621
"""Updates branch.push to be bound branch aware."""
1622
bound_location = target.get_bound_location()
1623
master_branch = None
1624
if bound_location and target.base != bound_location:
1625
# not pushing to master, so we need to update master.
1626
master_branch = target.get_master_branch()
1627
master_branch.lock_write()
1630
# push into the master from this branch.
1631
super(BzrBranch5, self).push(master_branch, overwrite,
1632
stop_revision, _run_hooks=False)
1633
# and push into the target branch from this. Note that we push from
1634
# this branch again, because its considered the highest bandwidth
1636
return super(BzrBranch5, self).push(target, overwrite,
1637
stop_revision, _hook_master=master_branch)
1640
master_branch.unlock()
1642
def get_bound_location(self):
1644
return self.control_files.get_utf8('bound').read()[:-1]
1645
except errors.NoSuchFile:
1649
def get_master_branch(self):
1650
"""Return the branch we are bound to.
1652
:return: Either a Branch, or None
1654
This could memoise the branch, but if thats done
1655
it must be revalidated on each new lock.
1656
So for now we just don't memoise it.
1657
# RBC 20060304 review this decision.
1659
bound_loc = self.get_bound_location()
1663
return Branch.open(bound_loc)
1664
except (errors.NotBranchError, errors.ConnectionError), e:
1665
raise errors.BoundBranchConnectionFailure(
1669
def set_bound_location(self, location):
1670
"""Set the target where this branch is bound to.
1672
:param location: URL to the target branch
1675
self.control_files.put_utf8('bound', location+'\n')
1678
self.control_files._transport.delete('bound')
1684
def bind(self, other):
1685
"""Bind this branch to the branch other.
1687
This does not push or pull data between the branches, though it does
1688
check for divergence to raise an error when the branches are not
1689
either the same, or one a prefix of the other. That behaviour may not
1690
be useful, so that check may be removed in future.
1692
:param other: The branch to bind to
1695
# TODO: jam 20051230 Consider checking if the target is bound
1696
# It is debatable whether you should be able to bind to
1697
# a branch which is itself bound.
1698
# Committing is obviously forbidden,
1699
# but binding itself may not be.
1700
# Since we *have* to check at commit time, we don't
1701
# *need* to check here
1703
# we want to raise diverged if:
1704
# last_rev is not in the other_last_rev history, AND
1705
# other_last_rev is not in our history, and do it without pulling
1707
last_rev = self.last_revision()
1708
if last_rev is not None:
1711
other_last_rev = other.last_revision()
1712
if other_last_rev is not None:
1713
# neither branch is new, we have to do some work to
1714
# ascertain diversion.
1715
remote_graph = other.repository.get_revision_graph(
1717
local_graph = self.repository.get_revision_graph(last_rev)
1718
if (last_rev not in remote_graph and
1719
other_last_rev not in local_graph):
1720
raise errors.DivergedBranches(self, other)
1723
self.set_bound_location(other.base)
1727
"""If bound, unbind"""
1728
return self.set_bound_location(None)
1732
"""Synchronise this branch with the master branch if any.
1734
:return: None or the last_revision that was pivoted out during the
1737
master = self.get_master_branch()
1738
if master is not None:
1739
old_tip = self.last_revision()
1740
self.pull(master, overwrite=True)
1741
if old_tip in self.repository.get_ancestry(self.last_revision()):
1747
class BzrBranch6(BzrBranch5):
1750
def last_revision_info(self):
1751
revision_string = self.control_files.get('last-revision').read()
1752
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1753
revision_id = cache_utf8.get_cached_utf8(revision_id)
1755
return revno, revision_id
1757
def last_revision(self):
1758
"""Return last revision id, or None"""
1759
revision_id = self.last_revision_info()[1]
1760
if revision_id == _mod_revision.NULL_REVISION:
1764
def _write_last_revision_info(self, revno, revision_id):
1765
"""Simply write out the revision id, with no checks.
1767
Use set_last_revision_info to perform this safely.
1769
Does not update the revision_history cache.
1770
Intended to be called by set_last_revision_info and
1771
_write_revision_history.
1773
if revision_id is None:
1774
revision_id = 'null:'
1775
out_string = '%d %s\n' % (revno, revision_id)
1776
self.control_files.put_bytes('last-revision', out_string)
1779
def set_last_revision_info(self, revno, revision_id):
1780
revision_id = osutils.safe_revision_id(revision_id)
1781
if self._get_append_revisions_only():
1782
self._check_history_violation(revision_id)
1783
self._write_last_revision_info(revno, revision_id)
1784
transaction = self.get_transaction()
1785
cached_history = transaction.map.find_revision_history()
1786
if cached_history is not None:
1787
transaction.map.remove_object(cached_history)
1789
def _check_history_violation(self, revision_id):
1790
last_revision = self.last_revision()
1791
if last_revision is None:
1793
if last_revision not in self._lefthand_history(revision_id):
1794
raise errors.AppendRevisionsOnlyViolation(self.base)
1796
def _gen_revision_history(self):
1797
"""Generate the revision history from last revision
1799
history = list(self.repository.iter_reverse_revision_history(
1800
self.last_revision()))
1804
def _write_revision_history(self, history):
1805
"""Factored out of set_revision_history.
1807
This performs the actual writing to disk, with format-specific checks.
1808
It is intended to be called by BzrBranch5.set_revision_history.
1810
if len(history) == 0:
1811
last_revision = 'null:'
1813
if history != self._lefthand_history(history[-1]):
1814
raise errors.NotLefthandHistory(history)
1815
last_revision = history[-1]
1816
if self._get_append_revisions_only():
1817
self._check_history_violation(last_revision)
1818
self._write_last_revision_info(len(history), last_revision)
1821
def append_revision(self, *revision_ids):
1822
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1823
if len(revision_ids) == 0:
1825
prev_revno, prev_revision = self.last_revision_info()
1826
for revision in self.repository.get_revisions(revision_ids):
1827
if prev_revision == _mod_revision.NULL_REVISION:
1828
if revision.parent_ids != []:
1829
raise errors.NotLeftParentDescendant(self, prev_revision,
1830
revision.revision_id)
1832
if revision.parent_ids[0] != prev_revision:
1833
raise errors.NotLeftParentDescendant(self, prev_revision,
1834
revision.revision_id)
1835
prev_revision = revision.revision_id
1836
self.set_last_revision_info(prev_revno + len(revision_ids),
1839
def _set_config_location(self, name, url, config=None,
1840
make_relative=False):
1842
config = self.get_config()
1846
url = urlutils.relative_url(self.base, url)
1847
config.set_user_option(name, url)
1850
def _get_config_location(self, name, config=None):
1852
config = self.get_config()
1853
location = config.get_user_option(name)
1859
def _set_parent_location(self, url):
1860
"""Set the parent branch"""
1861
self._set_config_location('parent_location', url, make_relative=True)
1864
def _get_parent_location(self):
1865
"""Set the parent branch"""
1866
return self._get_config_location('parent_location')
1868
def set_push_location(self, location):
1869
"""See Branch.set_push_location."""
1870
self._set_config_location('push_location', location)
1872
def set_bound_location(self, location):
1873
"""See Branch.set_push_location."""
1875
config = self.get_config()
1876
if location is None:
1877
if config.get_user_option('bound') != 'True':
1880
config.set_user_option('bound', 'False')
1883
self._set_config_location('bound_location', location,
1885
config.set_user_option('bound', 'True')
1888
def _get_bound_location(self, bound):
1889
"""Return the bound location in the config file.
1891
Return None if the bound parameter does not match"""
1892
config = self.get_config()
1893
config_bound = (config.get_user_option('bound') == 'True')
1894
if config_bound != bound:
1896
return self._get_config_location('bound_location', config=config)
1898
def get_bound_location(self):
1899
"""See Branch.set_push_location."""
1900
return self._get_bound_location(True)
1902
def get_old_bound_location(self):
1903
"""See Branch.get_old_bound_location"""
1904
return self._get_bound_location(False)
1906
def set_append_revisions_only(self, enabled):
1911
self.get_config().set_user_option('append_revisions_only', value)
1913
def _get_append_revisions_only(self):
1914
value = self.get_config().get_user_option('append_revisions_only')
1915
return value == 'True'
1917
def _synchronize_history(self, destination, revision_id):
1918
"""Synchronize last revision and revision history between branches.
1920
This version is most efficient when the destination is also a
1921
BzrBranch6, but works for BzrBranch5, as long as the destination's
1922
repository contains all the lefthand ancestors of the intended
1923
last_revision. If not, set_last_revision_info will fail.
1925
:param destination: The branch to copy the history into
1926
:param revision_id: The revision-id to truncate history at. May
1927
be None to copy complete history.
1929
if revision_id is None:
1930
revno, revision_id = self.last_revision_info()
1932
revno = self.revision_id_to_revno(revision_id)
1933
destination.set_last_revision_info(revno, revision_id)
1936
class BranchTestProviderAdapter(object):
1937
"""A tool to generate a suite testing multiple branch formats at once.
1939
This is done by copying the test once for each transport and injecting
1940
the transport_server, transport_readonly_server, and branch_format
1941
classes into each copy. Each copy is also given a new id() to make it
1945
def __init__(self, transport_server, transport_readonly_server, formats,
1946
vfs_transport_factory=None):
1947
self._transport_server = transport_server
1948
self._transport_readonly_server = transport_readonly_server
1949
self._formats = formats
1950
self._vfs_transport_factory = vfs_transport_factory
1952
def adapt(self, test):
1953
result = TestSuite()
1954
for branch_format, bzrdir_format in self._formats:
1955
new_test = deepcopy(test)
1956
new_test.transport_server = self._transport_server
1957
new_test.transport_readonly_server = self._transport_readonly_server
1958
if self._vfs_transport_factory:
1959
new_test.vfs_transport_factory = self._vfs_transport_factory
1960
new_test.bzrdir_format = bzrdir_format
1961
new_test.branch_format = branch_format
1962
def make_new_test_id():
1963
new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
1964
return lambda: new_id
1965
new_test.id = make_new_test_id()
1966
result.addTest(new_test)
1970
class BranchCheckResult(object):
1971
"""Results of checking branch consistency.
1976
def __init__(self, branch):
1977
self.branch = branch
1979
def report_results(self, verbose):
1980
"""Report the check results via trace.note.
1982
:param verbose: Requests more detailed display of what was checked,
1985
note('checked branch %s format %s',
1987
self.branch._format)
1990
######################################################################
1994
@deprecated_function(zero_eight)
1995
def is_control_file(*args, **kwargs):
1996
"""See bzrlib.workingtree.is_control_file."""
1997
from bzrlib import workingtree
1998
return workingtree.is_control_file(*args, **kwargs)
2001
class Converter5to6(object):
2002
"""Perform an in-place upgrade of format 5 to format 6"""
2004
def convert(self, branch):
2005
# Data for 5 and 6 can peacefully coexist.
2006
format = BzrBranchFormat6()
2007
new_branch = format.open(branch.bzrdir, _found=True)
2009
# Copy source data into target
2010
new_branch.set_last_revision_info(*branch.last_revision_info())
2011
new_branch.set_parent(branch.get_parent())
2012
new_branch.set_bound_location(branch.get_bound_location())
2013
new_branch.set_push_location(branch.get_push_location())
2015
# Copying done; now update target format
2016
new_branch.control_files.put_utf8('format',
2017
format.get_format_string())
2019
# Clean up old files
2020
new_branch.control_files._transport.delete('revision-history')
2022
branch.set_parent(None)
2025
branch.set_bound_location(None)
added
removed
bzrlib/branch.py
