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 repostory uses weaves.
659
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
660
from bzrlib.repofmt import weaverepo
661
format = bzrdir.BzrDirMetaFormat1()
662
format.repository_format = weaverepo.RepositoryFormat7()
664
format = self.repository.bzrdir.cloning_metadir()
665
format.branch_format = self._format
668
def create_checkout(self, to_location, revision_id=None,
670
"""Create a checkout of a branch.
672
:param to_location: The url to produce the checkout at
673
:param revision_id: The revision to check out
674
:param lightweight: If True, produce a lightweight checkout, otherwise,
675
produce a bound branch (heavyweight checkout)
676
:return: The tree of the created checkout
678
t = transport.get_transport(to_location)
681
except errors.FileExists:
684
checkout = bzrdir.BzrDirMetaFormat1().initialize_on_transport(t)
685
BranchReferenceFormat().initialize(checkout, self)
687
format = self._get_checkout_format()
688
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
689
to_location, force_new_tree=False, format=format)
690
checkout = checkout_branch.bzrdir
691
checkout_branch.bind(self)
692
# pull up to the specified revision_id to set the initial
693
# branch tip correctly, and seed it with history.
694
checkout_branch.pull(self, stop_revision=revision_id)
695
return checkout.create_workingtree(revision_id)
698
class BranchFormat(object):
699
"""An encapsulation of the initialization and open routines for a format.
701
Formats provide three things:
702
* An initialization routine,
706
Formats are placed in an dict by their format string for reference
707
during branch opening. Its not required that these be instances, they
708
can be classes themselves with class methods - it simply depends on
709
whether state is needed for a given format or not.
711
Once a format is deprecated, just deprecate the initialize and open
712
methods on the format class. Do not deprecate the object, as the
713
object will be created every time regardless.
716
_default_format = None
717
"""The default format used for new branches."""
720
"""The known formats."""
723
def find_format(klass, a_bzrdir):
724
"""Return the format for the branch object in a_bzrdir."""
726
transport = a_bzrdir.get_branch_transport(None)
727
format_string = transport.get("format").read()
728
return klass._formats[format_string]
730
raise NotBranchError(path=transport.base)
732
raise errors.UnknownFormatError(format=format_string)
735
def get_default_format(klass):
736
"""Return the current default format."""
737
return klass._default_format
739
def get_format_string(self):
740
"""Return the ASCII format string that identifies this format."""
741
raise NotImplementedError(self.get_format_string)
743
def get_format_description(self):
744
"""Return the short format description for this format."""
745
raise NotImplementedError(self.get_format_description)
747
def get_reference(self, a_bzrdir):
748
"""Get the target reference of the branch in a_bzrdir.
750
format probing must have been completed before calling
751
this method - it is assumed that the format of the branch
752
in a_bzrdir is correct.
754
:param a_bzrdir: The bzrdir to get the branch data from.
755
:return: None if the branch is not a reference branch.
759
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
761
"""Initialize a branch in a bzrdir, with specified files
763
:param a_bzrdir: The bzrdir to initialize the branch in
764
:param utf8_files: The files to create as a list of
765
(filename, content) tuples
766
:param set_format: If True, set the format with
767
self.get_format_string. (BzrBranch4 has its format set
769
:return: a branch in this format
771
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
772
branch_transport = a_bzrdir.get_branch_transport(self)
774
'metadir': ('lock', lockdir.LockDir),
775
'branch4': ('branch-lock', lockable_files.TransportLock),
777
lock_name, lock_class = lock_map[lock_type]
778
control_files = lockable_files.LockableFiles(branch_transport,
779
lock_name, lock_class)
780
control_files.create_lock()
781
control_files.lock_write()
783
control_files.put_utf8('format', self.get_format_string())
785
for file, content in utf8_files:
786
control_files.put_utf8(file, content)
788
control_files.unlock()
789
return self.open(a_bzrdir, _found=True)
791
def initialize(self, a_bzrdir):
792
"""Create a branch of this format in a_bzrdir."""
793
raise NotImplementedError(self.initialize)
795
def is_supported(self):
796
"""Is this format supported?
798
Supported formats can be initialized and opened.
799
Unsupported formats may not support initialization or committing or
800
some other features depending on the reason for not being supported.
804
def open(self, a_bzrdir, _found=False):
805
"""Return the branch object for a_bzrdir
807
_found is a private parameter, do not use it. It is used to indicate
808
if format probing has already be done.
810
raise NotImplementedError(self.open)
813
def register_format(klass, format):
814
klass._formats[format.get_format_string()] = format
817
def set_default_format(klass, format):
818
klass._default_format = format
821
def unregister_format(klass, format):
822
assert klass._formats[format.get_format_string()] is format
823
del klass._formats[format.get_format_string()]
826
return self.get_format_string().rstrip()
829
class BranchHooks(dict):
830
"""A dictionary mapping hook name to a list of callables for branch hooks.
832
e.g. ['set_rh'] Is the list of items to be called when the
833
set_revision_history function is invoked.
837
"""Create the default hooks.
839
These are all empty initially, because by default nothing should get
843
# Introduced in 0.15:
844
# invoked whenever the revision history has been set
845
# with set_revision_history. The api signature is
846
# (branch, revision_history), and the branch will
849
# invoked after a push operation completes.
850
# the api signature is
851
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
852
# where local is the local branch or None, master is the target
853
# master branch, and the rest should be self explanatory. The source
854
# is read locked and the target branches write locked. Source will
855
# be the local low-latency branch.
856
self['post_push'] = []
857
# invoked after a pull operation completes.
858
# the api signature is
859
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
860
# where local is the local branch or None, master is the target
861
# master branch, and the rest should be self explanatory. The source
862
# is read locked and the target branches write locked. The local
863
# branch is the low-latency branch.
864
self['post_pull'] = []
865
# invoked after a commit operation completes.
866
# the api signature is
867
# (local, master, old_revno, old_revid, new_revno, new_revid)
868
# old_revid is NULL_REVISION for the first commit to a branch.
869
self['post_commit'] = []
870
# invoked after a uncommit operation completes.
871
# the api signature is
872
# (local, master, old_revno, old_revid, new_revno, new_revid) where
873
# local is the local branch or None, master is the target branch,
874
# and an empty branch recieves new_revno of 0, new_revid of None.
875
self['post_uncommit'] = []
877
def install_hook(self, hook_name, a_callable):
878
"""Install a_callable in to the hook hook_name.
880
:param hook_name: A hook name. See the __init__ method of BranchHooks
881
for the complete list of hooks.
882
:param a_callable: The callable to be invoked when the hook triggers.
883
The exact signature will depend on the hook - see the __init__
884
method of BranchHooks for details on each hook.
887
self[hook_name].append(a_callable)
889
raise errors.UnknownHook('branch', hook_name)
892
# install the default hooks into the Branch class.
893
Branch.hooks = BranchHooks()
896
class BzrBranchFormat4(BranchFormat):
897
"""Bzr branch format 4.
900
- a revision-history file.
901
- a branch-lock lock file [ to be shared with the bzrdir ]
904
def get_format_description(self):
905
"""See BranchFormat.get_format_description()."""
906
return "Branch format 4"
908
def initialize(self, a_bzrdir):
909
"""Create a branch of this format in a_bzrdir."""
910
utf8_files = [('revision-history', ''),
913
return self._initialize_helper(a_bzrdir, utf8_files,
914
lock_type='branch4', set_format=False)
917
super(BzrBranchFormat4, self).__init__()
918
self._matchingbzrdir = bzrdir.BzrDirFormat6()
920
def open(self, a_bzrdir, _found=False):
921
"""Return the branch object for a_bzrdir
923
_found is a private parameter, do not use it. It is used to indicate
924
if format probing has already be done.
927
# we are being called directly and must probe.
928
raise NotImplementedError
929
return BzrBranch(_format=self,
930
_control_files=a_bzrdir._control_files,
932
_repository=a_bzrdir.open_repository())
935
return "Bazaar-NG branch format 4"
938
class BzrBranchFormat5(BranchFormat):
939
"""Bzr branch format 5.
942
- a revision-history file.
944
- a lock dir guarding the branch itself
945
- all of this stored in a branch/ subdirectory
946
- works with shared repositories.
948
This format is new in bzr 0.8.
951
def get_format_string(self):
952
"""See BranchFormat.get_format_string()."""
953
return "Bazaar-NG branch format 5\n"
955
def get_format_description(self):
956
"""See BranchFormat.get_format_description()."""
957
return "Branch format 5"
959
def initialize(self, a_bzrdir):
960
"""Create a branch of this format in a_bzrdir."""
961
utf8_files = [('revision-history', ''),
964
return self._initialize_helper(a_bzrdir, utf8_files)
967
super(BzrBranchFormat5, self).__init__()
968
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
970
def open(self, a_bzrdir, _found=False):
971
"""Return the branch object for a_bzrdir
973
_found is a private parameter, do not use it. It is used to indicate
974
if format probing has already be done.
977
format = BranchFormat.find_format(a_bzrdir)
978
assert format.__class__ == self.__class__
980
transport = a_bzrdir.get_branch_transport(None)
981
control_files = lockable_files.LockableFiles(transport, 'lock',
983
return BzrBranch5(_format=self,
984
_control_files=control_files,
986
_repository=a_bzrdir.find_repository())
988
raise NotBranchError(path=transport.base)
991
return "Bazaar-NG Metadir branch format 5"
994
class BzrBranchFormat6(BzrBranchFormat5):
995
"""Branch format with last-revision
997
Unlike previous formats, this has no explicit revision history. Instead,
998
this just stores the last-revision, and the left-hand history leading
999
up to there is the history.
1001
This format was introduced in bzr 0.15
1004
def get_format_string(self):
1005
"""See BranchFormat.get_format_string()."""
1006
return "Bazaar-NG branch format 6\n"
1008
def get_format_description(self):
1009
"""See BranchFormat.get_format_description()."""
1010
return "Branch format 6"
1012
def initialize(self, a_bzrdir):
1013
"""Create a branch of this format in a_bzrdir."""
1014
utf8_files = [('last-revision', '0 null:\n'),
1015
('branch-name', ''),
1018
return self._initialize_helper(a_bzrdir, utf8_files)
1020
def open(self, a_bzrdir, _found=False):
1021
"""Return the branch object for a_bzrdir
1023
_found is a private parameter, do not use it. It is used to indicate
1024
if format probing has already be done.
1027
format = BranchFormat.find_format(a_bzrdir)
1028
assert format.__class__ == self.__class__
1029
transport = a_bzrdir.get_branch_transport(None)
1030
control_files = lockable_files.LockableFiles(transport, 'lock',
1032
return BzrBranch6(_format=self,
1033
_control_files=control_files,
1035
_repository=a_bzrdir.find_repository())
1038
class BranchReferenceFormat(BranchFormat):
1039
"""Bzr branch reference format.
1041
Branch references are used in implementing checkouts, they
1042
act as an alias to the real branch which is at some other url.
1049
def get_format_string(self):
1050
"""See BranchFormat.get_format_string()."""
1051
return "Bazaar-NG Branch Reference Format 1\n"
1053
def get_format_description(self):
1054
"""See BranchFormat.get_format_description()."""
1055
return "Checkout reference format 1"
1057
def get_reference(self, a_bzrdir):
1058
"""See BranchFormat.get_reference()."""
1059
transport = a_bzrdir.get_branch_transport(None)
1060
return transport.get('location').read()
1062
def initialize(self, a_bzrdir, target_branch=None):
1063
"""Create a branch of this format in a_bzrdir."""
1064
if target_branch is None:
1065
# this format does not implement branch itself, thus the implicit
1066
# creation contract must see it as uninitializable
1067
raise errors.UninitializableFormat(self)
1068
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1069
branch_transport = a_bzrdir.get_branch_transport(self)
1070
branch_transport.put_bytes('location',
1071
target_branch.bzrdir.root_transport.base)
1072
branch_transport.put_bytes('format', self.get_format_string())
1073
return self.open(a_bzrdir, _found=True)
1076
super(BranchReferenceFormat, self).__init__()
1077
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1079
def _make_reference_clone_function(format, a_branch):
1080
"""Create a clone() routine for a branch dynamically."""
1081
def clone(to_bzrdir, revision_id=None):
1082
"""See Branch.clone()."""
1083
return format.initialize(to_bzrdir, a_branch)
1084
# cannot obey revision_id limits when cloning a reference ...
1085
# FIXME RBC 20060210 either nuke revision_id for clone, or
1086
# emit some sort of warning/error to the caller ?!
1089
def open(self, a_bzrdir, _found=False, location=None):
1090
"""Return the branch that the branch reference in a_bzrdir points at.
1092
_found is a private parameter, do not use it. It is used to indicate
1093
if format probing has already be done.
1096
format = BranchFormat.find_format(a_bzrdir)
1097
assert format.__class__ == self.__class__
1098
if location is None:
1099
location = self.get_reference(a_bzrdir)
1100
real_bzrdir = bzrdir.BzrDir.open(location)
1101
result = real_bzrdir.open_branch()
1102
# this changes the behaviour of result.clone to create a new reference
1103
# rather than a copy of the content of the branch.
1104
# I did not use a proxy object because that needs much more extensive
1105
# testing, and we are only changing one behaviour at the moment.
1106
# If we decide to alter more behaviours - i.e. the implicit nickname
1107
# then this should be refactored to introduce a tested proxy branch
1108
# and a subclass of that for use in overriding clone() and ....
1110
result.clone = self._make_reference_clone_function(result)
1114
# formats which have no format string are not discoverable
1115
# and not independently creatable, so are not registered.
1116
__default_format = BzrBranchFormat5()
1117
BranchFormat.register_format(__default_format)
1118
BranchFormat.register_format(BranchReferenceFormat())
1119
BranchFormat.register_format(BzrBranchFormat6())
1120
BranchFormat.set_default_format(__default_format)
1121
_legacy_formats = [BzrBranchFormat4(),
1124
class BzrBranch(Branch):
1125
"""A branch stored in the actual filesystem.
1127
Note that it's "local" in the context of the filesystem; it doesn't
1128
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1129
it's writable, and can be accessed via the normal filesystem API.
1132
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
1133
relax_version_check=DEPRECATED_PARAMETER, _format=None,
1134
_control_files=None, a_bzrdir=None, _repository=None):
1135
"""Create new branch object at a particular location.
1137
transport -- A Transport object, defining how to access files.
1139
init -- If True, create new control files in a previously
1140
unversioned directory. If False, the branch must already
1143
relax_version_check -- If true, the usual check for the branch
1144
version is not applied. This is intended only for
1145
upgrade/recovery type use; it's not guaranteed that
1146
all operations will work on old format branches.
1148
if a_bzrdir is None:
1149
self.bzrdir = bzrdir.BzrDir.open(transport.base)
1151
self.bzrdir = a_bzrdir
1152
self._transport = self.bzrdir.transport.clone('..')
1153
self._base = self._transport.base
1154
self._format = _format
1155
if _control_files is None:
1156
raise ValueError('BzrBranch _control_files is None')
1157
self.control_files = _control_files
1158
if deprecated_passed(init):
1159
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
1160
"deprecated as of bzr 0.8. Please use Branch.create().",
1164
# this is slower than before deprecation, oh well never mind.
1165
# -> its deprecated.
1166
self._initialize(transport.base)
1167
self._check_format(_format)
1168
if deprecated_passed(relax_version_check):
1169
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
1170
"relax_version_check parameter is deprecated as of bzr 0.8. "
1171
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
1175
if (not relax_version_check
1176
and not self._format.is_supported()):
1177
raise errors.UnsupportedFormatError(format=fmt)
1178
if deprecated_passed(transport):
1179
warn("BzrBranch.__init__(transport=XXX...): The transport "
1180
"parameter is deprecated as of bzr 0.8. "
1181
"Please use Branch.open, or bzrdir.open_branch().",
1184
self.repository = _repository
1187
return '%s(%r)' % (self.__class__.__name__, self.base)
1191
def _get_base(self):
1194
base = property(_get_base, doc="The URL for the root of this branch.")
1196
def _finish_transaction(self):
1197
"""Exit the current transaction."""
1198
return self.control_files._finish_transaction()
1200
def get_transaction(self):
1201
"""Return the current active transaction.
1203
If no transaction is active, this returns a passthrough object
1204
for which all data is immediately flushed and no caching happens.
1206
# this is an explicit function so that we can do tricky stuff
1207
# when the storage in rev_storage is elsewhere.
1208
# we probably need to hook the two 'lock a location' and
1209
# 'have a transaction' together more delicately, so that
1210
# we can have two locks (branch and storage) and one transaction
1211
# ... and finishing the transaction unlocks both, but unlocking
1212
# does not. - RBC 20051121
1213
return self.control_files.get_transaction()
1215
def _set_transaction(self, transaction):
1216
"""Set a new active transaction."""
1217
return self.control_files._set_transaction(transaction)
1219
def abspath(self, name):
1220
"""See Branch.abspath."""
1221
return self.control_files._transport.abspath(name)
1223
def _check_format(self, format):
1224
"""Identify the branch format if needed.
1226
The format is stored as a reference to the format object in
1227
self._format for code that needs to check it later.
1229
The format parameter is either None or the branch format class
1230
used to open this branch.
1232
FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
1235
format = BranchFormat.find_format(self.bzrdir)
1236
self._format = format
1237
mutter("got branch format %s", self._format)
1240
def get_root_id(self):
1241
"""See Branch.get_root_id."""
1242
tree = self.repository.revision_tree(self.last_revision())
1243
return tree.inventory.root.file_id
1245
def is_locked(self):
1246
return self.control_files.is_locked()
1248
def lock_write(self, tokens=None):
1249
if tokens is not None:
1250
branch_token, repo_token = tokens
1252
branch_token = repo_token = None
1253
repo_token = self.repository.lock_write(token=repo_token)
1255
branch_token = self.control_files.lock_write(token=branch_token)
1257
self.repository.unlock()
1260
tokens = (branch_token, repo_token)
1261
assert tokens == (None, None) or None not in tokens, (
1262
'Both branch and repository locks must return tokens, or else '
1263
'neither must return tokens. Got %r.' % (tokens,))
1264
if tokens == (None, None):
1269
def lock_read(self):
1270
self.repository.lock_read()
1272
self.control_files.lock_read()
1274
self.repository.unlock()
1278
# TODO: test for failed two phase locks. This is known broken.
1280
self.control_files.unlock()
1282
self.repository.unlock()
1284
def peek_lock_mode(self):
1285
if self.control_files._lock_count == 0:
1288
return self.control_files._lock_mode
1290
def get_physical_lock_status(self):
1291
return self.control_files.get_physical_lock_status()
1294
def print_file(self, file, revision_id):
1295
"""See Branch.print_file."""
1296
return self.repository.print_file(file, revision_id)
1299
def append_revision(self, *revision_ids):
1300
"""See Branch.append_revision."""
1301
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1302
for revision_id in revision_ids:
1303
_mod_revision.check_not_reserved_id(revision_id)
1304
mutter("add {%s} to revision-history" % revision_id)
1305
rev_history = self.revision_history()
1306
rev_history.extend(revision_ids)
1307
self.set_revision_history(rev_history)
1309
def _write_revision_history(self, history):
1310
"""Factored out of set_revision_history.
1312
This performs the actual writing to disk.
1313
It is intended to be called by BzrBranch5.set_revision_history."""
1314
self.control_files.put_bytes(
1315
'revision-history', '\n'.join(history))
1318
def set_revision_history(self, rev_history):
1319
"""See Branch.set_revision_history."""
1320
rev_history = [osutils.safe_revision_id(r) for r in rev_history]
1321
self._write_revision_history(rev_history)
1322
transaction = self.get_transaction()
1323
history = transaction.map.find_revision_history()
1324
if history is not None:
1325
# update the revision history in the identity map.
1326
history[:] = list(rev_history)
1327
# this call is disabled because revision_history is
1328
# not really an object yet, and the transaction is for objects.
1329
# transaction.register_dirty(history)
1331
transaction.map.add_revision_history(rev_history)
1332
# this call is disabled because revision_history is
1333
# not really an object yet, and the transaction is for objects.
1334
# transaction.register_clean(history)
1335
for hook in Branch.hooks['set_rh']:
1336
hook(self, rev_history)
1339
def set_last_revision_info(self, revno, revision_id):
1340
revision_id = osutils.safe_revision_id(revision_id)
1341
history = self._lefthand_history(revision_id)
1342
assert len(history) == revno, '%d != %d' % (len(history), revno)
1343
self.set_revision_history(history)
1345
def _gen_revision_history(self):
1346
get_cached_utf8 = cache_utf8.get_cached_utf8
1347
history = [get_cached_utf8(l.rstrip('\r\n')) for l in
1348
self.control_files.get('revision-history').readlines()]
1352
def revision_history(self):
1353
"""See Branch.revision_history."""
1354
transaction = self.get_transaction()
1355
history = transaction.map.find_revision_history()
1356
if history is not None:
1357
# mutter("cache hit for revision-history in %s", self)
1358
return list(history)
1359
history = self._gen_revision_history()
1360
transaction.map.add_revision_history(history)
1361
# this call is disabled because revision_history is
1362
# not really an object yet, and the transaction is for objects.
1363
# transaction.register_clean(history, precious=True)
1364
return list(history)
1366
def _lefthand_history(self, revision_id, last_rev=None,
1368
# stop_revision must be a descendant of last_revision
1369
stop_graph = self.repository.get_revision_graph(revision_id)
1370
if last_rev is not None and last_rev not in stop_graph:
1371
# our previous tip is not merged into stop_revision
1372
raise errors.DivergedBranches(self, other_branch)
1373
# make a new revision history from the graph
1374
current_rev_id = revision_id
1376
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1377
new_history.append(current_rev_id)
1378
current_rev_id_parents = stop_graph[current_rev_id]
1380
current_rev_id = current_rev_id_parents[0]
1382
current_rev_id = None
1383
new_history.reverse()
1387
def generate_revision_history(self, revision_id, last_rev=None,
1389
"""Create a new revision history that will finish with revision_id.
1391
:param revision_id: the new tip to use.
1392
:param last_rev: The previous last_revision. If not None, then this
1393
must be a ancestory of revision_id, or DivergedBranches is raised.
1394
:param other_branch: The other branch that DivergedBranches should
1395
raise with respect to.
1397
revision_id = osutils.safe_revision_id(revision_id)
1398
self.set_revision_history(self._lefthand_history(revision_id,
1399
last_rev, other_branch))
1402
def update_revisions(self, other, stop_revision=None):
1403
"""See Branch.update_revisions."""
1406
if stop_revision is None:
1407
stop_revision = other.last_revision()
1408
if stop_revision is None:
1409
# if there are no commits, we're done.
1412
stop_revision = osutils.safe_revision_id(stop_revision)
1413
# whats the current last revision, before we fetch [and change it
1415
last_rev = self.last_revision()
1416
# we fetch here regardless of whether we need to so that we pickup
1418
self.fetch(other, stop_revision)
1419
my_ancestry = self.repository.get_ancestry(last_rev)
1420
if stop_revision in my_ancestry:
1421
# last_revision is a descendant of stop_revision
1423
self.generate_revision_history(stop_revision, last_rev=last_rev,
1428
def basis_tree(self):
1429
"""See Branch.basis_tree."""
1430
return self.repository.revision_tree(self.last_revision())
1432
@deprecated_method(zero_eight)
1433
def working_tree(self):
1434
"""Create a Working tree object for this branch."""
1436
from bzrlib.transport.local import LocalTransport
1437
if (self.base.find('://') != -1 or
1438
not isinstance(self._transport, LocalTransport)):
1439
raise NoWorkingTree(self.base)
1440
return self.bzrdir.open_workingtree()
1443
def pull(self, source, overwrite=False, stop_revision=None,
1444
_hook_master=None, _run_hooks=True):
1447
:param _hook_master: Private parameter - set the branch to
1448
be supplied as the master to push hooks.
1449
:param _run_hooks: Private parameter - allow disabling of
1450
hooks, used when pushing to a master branch.
1454
old_count, old_tip = self.last_revision_info()
1456
self.update_revisions(source, stop_revision)
1457
except DivergedBranches:
1461
self.set_revision_history(source.revision_history())
1462
new_count, new_tip = self.last_revision_info()
1469
for hook in Branch.hooks['post_pull']:
1470
hook(source, _hook_local, _hook_master, old_count, old_tip,
1472
return new_count - old_count
1476
def _get_parent_location(self):
1477
_locs = ['parent', 'pull', 'x-pull']
1480
return self.control_files.get(l).read().strip('\n')
1486
def push(self, target, overwrite=False, stop_revision=None,
1487
_hook_master=None, _run_hooks=True):
1490
:param _hook_master: Private parameter - set the branch to
1491
be supplied as the master to push hooks.
1492
:param _run_hooks: Private parameter - allow disabling of
1493
hooks, used when pushing to a master branch.
1497
old_count, old_tip = target.last_revision_info()
1499
target.update_revisions(self, stop_revision)
1500
except DivergedBranches:
1504
target.set_revision_history(self.revision_history())
1505
new_count, new_tip = target.last_revision_info()
1508
_hook_local = target
1510
_hook_master = target
1512
for hook in Branch.hooks['post_push']:
1513
hook(self, _hook_local, _hook_master, old_count, old_tip,
1515
return new_count - old_count
1519
def get_parent(self):
1520
"""See Branch.get_parent."""
1522
assert self.base[-1] == '/'
1523
parent = self._get_parent_location()
1526
# This is an old-format absolute path to a local branch
1527
# turn it into a url
1528
if parent.startswith('/'):
1529
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1531
return urlutils.join(self.base[:-1], parent)
1532
except errors.InvalidURLJoin, e:
1533
raise errors.InaccessibleParent(parent, self.base)
1535
def set_push_location(self, location):
1536
"""See Branch.set_push_location."""
1537
self.get_config().set_user_option(
1538
'push_location', location,
1539
store=_mod_config.STORE_LOCATION_NORECURSE)
1542
def set_parent(self, url):
1543
"""See Branch.set_parent."""
1544
# TODO: Maybe delete old location files?
1545
# URLs should never be unicode, even on the local fs,
1546
# FIXUP this and get_parent in a future branch format bump:
1547
# read and rewrite the file, and have the new format code read
1548
# using .get not .get_utf8. RBC 20060125
1550
if isinstance(url, unicode):
1552
url = url.encode('ascii')
1553
except UnicodeEncodeError:
1554
raise bzrlib.errors.InvalidURL(url,
1555
"Urls must be 7-bit ascii, "
1556
"use bzrlib.urlutils.escape")
1557
url = urlutils.relative_url(self.base, url)
1558
self._set_parent_location(url)
1560
def _set_parent_location(self, url):
1562
self.control_files._transport.delete('parent')
1564
assert isinstance(url, str)
1565
self.control_files.put_bytes('parent', url + '\n')
1567
@deprecated_function(zero_nine)
1568
def tree_config(self):
1569
"""DEPRECATED; call get_config instead.
1570
TreeConfig has become part of BranchConfig."""
1571
return TreeConfig(self)
1574
class BzrBranch5(BzrBranch):
1575
"""A format 5 branch. This supports new features over plan branches.
1577
It has support for a master_branch which is the data for bound branches.
1585
super(BzrBranch5, self).__init__(_format=_format,
1586
_control_files=_control_files,
1588
_repository=_repository)
1591
def pull(self, source, overwrite=False, stop_revision=None,
1593
"""Extends branch.pull to be bound branch aware.
1595
:param _run_hooks: Private parameter used to force hook running
1596
off during bound branch double-pushing.
1598
bound_location = self.get_bound_location()
1599
master_branch = None
1600
if bound_location and source.base != bound_location:
1601
# not pulling from master, so we need to update master.
1602
master_branch = self.get_master_branch()
1603
master_branch.lock_write()
1606
# pull from source into master.
1607
master_branch.pull(source, overwrite, stop_revision,
1609
return super(BzrBranch5, self).pull(source, overwrite,
1610
stop_revision, _hook_master=master_branch,
1611
_run_hooks=_run_hooks)
1614
master_branch.unlock()
1617
def push(self, target, overwrite=False, stop_revision=None):
1618
"""Updates branch.push to be bound branch aware."""
1619
bound_location = target.get_bound_location()
1620
master_branch = None
1621
if bound_location and target.base != bound_location:
1622
# not pushing to master, so we need to update master.
1623
master_branch = target.get_master_branch()
1624
master_branch.lock_write()
1627
# push into the master from this branch.
1628
super(BzrBranch5, self).push(master_branch, overwrite,
1629
stop_revision, _run_hooks=False)
1630
# and push into the target branch from this. Note that we push from
1631
# this branch again, because its considered the highest bandwidth
1633
return super(BzrBranch5, self).push(target, overwrite,
1634
stop_revision, _hook_master=master_branch)
1637
master_branch.unlock()
1639
def get_bound_location(self):
1641
return self.control_files.get_utf8('bound').read()[:-1]
1642
except errors.NoSuchFile:
1646
def get_master_branch(self):
1647
"""Return the branch we are bound to.
1649
:return: Either a Branch, or None
1651
This could memoise the branch, but if thats done
1652
it must be revalidated on each new lock.
1653
So for now we just don't memoise it.
1654
# RBC 20060304 review this decision.
1656
bound_loc = self.get_bound_location()
1660
return Branch.open(bound_loc)
1661
except (errors.NotBranchError, errors.ConnectionError), e:
1662
raise errors.BoundBranchConnectionFailure(
1666
def set_bound_location(self, location):
1667
"""Set the target where this branch is bound to.
1669
:param location: URL to the target branch
1672
self.control_files.put_utf8('bound', location+'\n')
1675
self.control_files._transport.delete('bound')
1681
def bind(self, other):
1682
"""Bind this branch to the branch other.
1684
This does not push or pull data between the branches, though it does
1685
check for divergence to raise an error when the branches are not
1686
either the same, or one a prefix of the other. That behaviour may not
1687
be useful, so that check may be removed in future.
1689
:param other: The branch to bind to
1692
# TODO: jam 20051230 Consider checking if the target is bound
1693
# It is debatable whether you should be able to bind to
1694
# a branch which is itself bound.
1695
# Committing is obviously forbidden,
1696
# but binding itself may not be.
1697
# Since we *have* to check at commit time, we don't
1698
# *need* to check here
1700
# we want to raise diverged if:
1701
# last_rev is not in the other_last_rev history, AND
1702
# other_last_rev is not in our history, and do it without pulling
1704
last_rev = self.last_revision()
1705
if last_rev is not None:
1708
other_last_rev = other.last_revision()
1709
if other_last_rev is not None:
1710
# neither branch is new, we have to do some work to
1711
# ascertain diversion.
1712
remote_graph = other.repository.get_revision_graph(
1714
local_graph = self.repository.get_revision_graph(last_rev)
1715
if (last_rev not in remote_graph and
1716
other_last_rev not in local_graph):
1717
raise errors.DivergedBranches(self, other)
1720
self.set_bound_location(other.base)
1724
"""If bound, unbind"""
1725
return self.set_bound_location(None)
1729
"""Synchronise this branch with the master branch if any.
1731
:return: None or the last_revision that was pivoted out during the
1734
master = self.get_master_branch()
1735
if master is not None:
1736
old_tip = self.last_revision()
1737
self.pull(master, overwrite=True)
1738
if old_tip in self.repository.get_ancestry(self.last_revision()):
1744
class BzrBranch6(BzrBranch5):
1747
def last_revision_info(self):
1748
revision_string = self.control_files.get('last-revision').read()
1749
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1750
revision_id = cache_utf8.get_cached_utf8(revision_id)
1752
return revno, revision_id
1754
def last_revision(self):
1755
"""Return last revision id, or None"""
1756
revision_id = self.last_revision_info()[1]
1757
if revision_id == _mod_revision.NULL_REVISION:
1761
def _write_last_revision_info(self, revno, revision_id):
1762
"""Simply write out the revision id, with no checks.
1764
Use set_last_revision_info to perform this safely.
1766
Does not update the revision_history cache.
1767
Intended to be called by set_last_revision_info and
1768
_write_revision_history.
1770
if revision_id is None:
1771
revision_id = 'null:'
1772
out_string = '%d %s\n' % (revno, revision_id)
1773
self.control_files.put_bytes('last-revision', out_string)
1776
def set_last_revision_info(self, revno, revision_id):
1777
revision_id = osutils.safe_revision_id(revision_id)
1778
if self._get_append_revisions_only():
1779
self._check_history_violation(revision_id)
1780
self._write_last_revision_info(revno, revision_id)
1781
transaction = self.get_transaction()
1782
cached_history = transaction.map.find_revision_history()
1783
if cached_history is not None:
1784
transaction.map.remove_object(cached_history)
1786
def _check_history_violation(self, revision_id):
1787
last_revision = self.last_revision()
1788
if last_revision is None:
1790
if last_revision not in self._lefthand_history(revision_id):
1791
raise errors.AppendRevisionsOnlyViolation(self.base)
1793
def _gen_revision_history(self):
1794
"""Generate the revision history from last revision
1796
history = list(self.repository.iter_reverse_revision_history(
1797
self.last_revision()))
1801
def _write_revision_history(self, history):
1802
"""Factored out of set_revision_history.
1804
This performs the actual writing to disk, with format-specific checks.
1805
It is intended to be called by BzrBranch5.set_revision_history.
1807
if len(history) == 0:
1808
last_revision = 'null:'
1810
if history != self._lefthand_history(history[-1]):
1811
raise errors.NotLefthandHistory(history)
1812
last_revision = history[-1]
1813
if self._get_append_revisions_only():
1814
self._check_history_violation(last_revision)
1815
self._write_last_revision_info(len(history), last_revision)
1818
def append_revision(self, *revision_ids):
1819
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1820
if len(revision_ids) == 0:
1822
prev_revno, prev_revision = self.last_revision_info()
1823
for revision in self.repository.get_revisions(revision_ids):
1824
if prev_revision == _mod_revision.NULL_REVISION:
1825
if revision.parent_ids != []:
1826
raise errors.NotLeftParentDescendant(self, prev_revision,
1827
revision.revision_id)
1829
if revision.parent_ids[0] != prev_revision:
1830
raise errors.NotLeftParentDescendant(self, prev_revision,
1831
revision.revision_id)
1832
prev_revision = revision.revision_id
1833
self.set_last_revision_info(prev_revno + len(revision_ids),
1836
def _set_config_location(self, name, url, config=None,
1837
make_relative=False):
1839
config = self.get_config()
1843
url = urlutils.relative_url(self.base, url)
1844
config.set_user_option(name, url)
1847
def _get_config_location(self, name, config=None):
1849
config = self.get_config()
1850
location = config.get_user_option(name)
1856
def _set_parent_location(self, url):
1857
"""Set the parent branch"""
1858
self._set_config_location('parent_location', url, make_relative=True)
1861
def _get_parent_location(self):
1862
"""Set the parent branch"""
1863
return self._get_config_location('parent_location')
1865
def set_push_location(self, location):
1866
"""See Branch.set_push_location."""
1867
self._set_config_location('push_location', location)
1869
def set_bound_location(self, location):
1870
"""See Branch.set_push_location."""
1872
config = self.get_config()
1873
if location is None:
1874
if config.get_user_option('bound') != 'True':
1877
config.set_user_option('bound', 'False')
1880
self._set_config_location('bound_location', location,
1882
config.set_user_option('bound', 'True')
1885
def _get_bound_location(self, bound):
1886
"""Return the bound location in the config file.
1888
Return None if the bound parameter does not match"""
1889
config = self.get_config()
1890
config_bound = (config.get_user_option('bound') == 'True')
1891
if config_bound != bound:
1893
return self._get_config_location('bound_location', config=config)
1895
def get_bound_location(self):
1896
"""See Branch.set_push_location."""
1897
return self._get_bound_location(True)
1899
def get_old_bound_location(self):
1900
"""See Branch.get_old_bound_location"""
1901
return self._get_bound_location(False)
1903
def set_append_revisions_only(self, enabled):
1908
self.get_config().set_user_option('append_revisions_only', value)
1910
def _get_append_revisions_only(self):
1911
value = self.get_config().get_user_option('append_revisions_only')
1912
return value == 'True'
1914
def _synchronize_history(self, destination, revision_id):
1915
"""Synchronize last revision and revision history between branches.
1917
This version is most efficient when the destination is also a
1918
BzrBranch6, but works for BzrBranch5, as long as the destination's
1919
repository contains all the lefthand ancestors of the intended
1920
last_revision. If not, set_last_revision_info will fail.
1922
:param destination: The branch to copy the history into
1923
:param revision_id: The revision-id to truncate history at. May
1924
be None to copy complete history.
1926
if revision_id is None:
1927
revno, revision_id = self.last_revision_info()
1929
revno = self.revision_id_to_revno(revision_id)
1930
destination.set_last_revision_info(revno, revision_id)
1933
class BranchTestProviderAdapter(object):
1934
"""A tool to generate a suite testing multiple branch formats at once.
1936
This is done by copying the test once for each transport and injecting
1937
the transport_server, transport_readonly_server, and branch_format
1938
classes into each copy. Each copy is also given a new id() to make it
1942
def __init__(self, transport_server, transport_readonly_server, formats,
1943
vfs_transport_factory=None):
1944
self._transport_server = transport_server
1945
self._transport_readonly_server = transport_readonly_server
1946
self._formats = formats
1947
self._vfs_transport_factory = vfs_transport_factory
1949
def adapt(self, test):
1950
result = TestSuite()
1951
for branch_format, bzrdir_format in self._formats:
1952
new_test = deepcopy(test)
1953
new_test.transport_server = self._transport_server
1954
new_test.transport_readonly_server = self._transport_readonly_server
1955
if self._vfs_transport_factory:
1956
new_test.vfs_transport_factory = self._vfs_transport_factory
1957
new_test.bzrdir_format = bzrdir_format
1958
new_test.branch_format = branch_format
1959
def make_new_test_id():
1960
new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
1961
return lambda: new_id
1962
new_test.id = make_new_test_id()
1963
result.addTest(new_test)
1967
class BranchCheckResult(object):
1968
"""Results of checking branch consistency.
1973
def __init__(self, branch):
1974
self.branch = branch
1976
def report_results(self, verbose):
1977
"""Report the check results via trace.note.
1979
:param verbose: Requests more detailed display of what was checked,
1982
note('checked branch %s format %s',
1984
self.branch._format)
1987
######################################################################
1991
@deprecated_function(zero_eight)
1992
def is_control_file(*args, **kwargs):
1993
"""See bzrlib.workingtree.is_control_file."""
1994
from bzrlib import workingtree
1995
return workingtree.is_control_file(*args, **kwargs)
1998
class Converter5to6(object):
1999
"""Perform an in-place upgrade of format 5 to format 6"""
2001
def convert(self, branch):
2002
# Data for 5 and 6 can peacefully coexist.
2003
format = BzrBranchFormat6()
2004
new_branch = format.open(branch.bzrdir, _found=True)
2006
# Copy source data into target
2007
new_branch.set_last_revision_info(*branch.last_revision_info())
2008
new_branch.set_parent(branch.get_parent())
2009
new_branch.set_bound_location(branch.get_bound_location())
2010
new_branch.set_push_location(branch.get_push_location())
2012
# Copying done; now update target format
2013
new_branch.control_files.put_utf8('format',
2014
format.get_format_string())
2016
# Clean up old files
2017
new_branch.control_files._transport.delete('revision-history')
2019
branch.set_parent(None)
2022
branch.set_bound_location(None)
added
removed
bzrlib/branch.py
