1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
from cStringIO import StringIO
20
from bzrlib.lazy_import import lazy_import
21
lazy_import(globals(), """
22
from copy import deepcopy
23
from unittest import TestSuite
24
from warnings import warn
30
config as _mod_config,
35
revision as _mod_revision,
41
from bzrlib.config import BranchConfig, TreeConfig
42
from bzrlib.lockable_files import LockableFiles, TransportLock
45
from bzrlib.decorators import needs_read_lock, needs_write_lock
46
from bzrlib.errors import (BzrError, BzrCheckError, DivergedBranches,
47
HistoryMissing, InvalidRevisionId,
48
InvalidRevisionNumber, LockError, NoSuchFile,
49
NoSuchRevision, NoWorkingTree, NotVersionedError,
50
NotBranchError, UninitializableFormat,
51
UnlistableStore, UnlistableBranch,
53
from bzrlib.symbol_versioning import (deprecated_function,
57
zero_eight, zero_nine,
59
from bzrlib.trace import mutter, note
62
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
63
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
64
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
67
# TODO: Maybe include checks for common corruption of newlines, etc?
69
# TODO: Some operations like log might retrieve the same revisions
70
# repeatedly to calculate deltas. We could perhaps have a weakref
71
# cache in memory to make this faster. In general anything can be
72
# cached in memory between lock and unlock operations. .. nb thats
73
# what the transaction identity map provides
76
######################################################################
80
"""Branch holding a history of revisions.
83
Base directory/url of the branch.
85
hooks: An instance of BranchHooks.
87
# this is really an instance variable - FIXME move it there
91
def __init__(self, *ignored, **ignored_too):
92
raise NotImplementedError('The Branch class is abstract')
95
"""Break a lock if one is present from another instance.
97
Uses the ui factory to ask for confirmation if the lock may be from
100
This will probe the repository for its lock as well.
102
self.control_files.break_lock()
103
self.repository.break_lock()
104
master = self.get_master_branch()
105
if master is not None:
109
@deprecated_method(zero_eight)
110
def open_downlevel(base):
111
"""Open a branch which may be of an old format."""
112
return Branch.open(base, _unsupported=True)
115
def open(base, _unsupported=False):
116
"""Open the branch rooted at base.
118
For instance, if the branch is at URL/.bzr/branch,
119
Branch.open(URL) -> a Branch instance.
121
control = bzrdir.BzrDir.open(base, _unsupported)
122
return control.open_branch(_unsupported)
125
def open_containing(url):
126
"""Open an existing branch which contains url.
128
This probes for a branch at url, and searches upwards from there.
130
Basically we keep looking up until we find the control directory or
131
run into the root. If there isn't one, raises NotBranchError.
132
If there is one and it is either an unrecognised format or an unsupported
133
format, UnknownFormatError or UnsupportedFormatError are raised.
134
If there is one, it is returned, along with the unused portion of url.
136
control, relpath = bzrdir.BzrDir.open_containing(url)
137
return control.open_branch(), relpath
140
@deprecated_function(zero_eight)
141
def initialize(base):
142
"""Create a new working tree and branch, rooted at 'base' (url)
144
NOTE: This will soon be deprecated in favour of creation
147
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
149
@deprecated_function(zero_eight)
150
def setup_caching(self, cache_root):
151
"""Subclasses that care about caching should override this, and set
152
up cached stores located under cache_root.
154
NOTE: This is unused.
158
def get_config(self):
159
return BranchConfig(self)
162
return self.get_config().get_nickname()
164
def _set_nick(self, nick):
165
self.get_config().set_user_option('nickname', nick)
167
nick = property(_get_nick, _set_nick)
170
raise NotImplementedError(self.is_locked)
172
def lock_write(self):
173
raise NotImplementedError(self.lock_write)
176
raise NotImplementedError(self.lock_read)
179
raise NotImplementedError(self.unlock)
181
def peek_lock_mode(self):
182
"""Return lock mode for the Branch: 'r', 'w' or None"""
183
raise NotImplementedError(self.peek_lock_mode)
185
def get_physical_lock_status(self):
186
raise NotImplementedError(self.get_physical_lock_status)
188
def abspath(self, name):
189
"""Return absolute filename for something in the branch
191
XXX: Robert Collins 20051017 what is this used for? why is it a branch
192
method and not a tree method.
194
raise NotImplementedError(self.abspath)
196
def bind(self, other):
197
"""Bind the local branch the other branch.
199
:param other: The branch to bind to
202
raise errors.UpgradeRequired(self.base)
205
def fetch(self, from_branch, last_revision=None, pb=None):
206
"""Copy revisions from from_branch into this branch.
208
:param from_branch: Where to copy from.
209
:param last_revision: What revision to stop at (None for at the end
211
:param pb: An optional progress bar to use.
213
Returns the copied revision count and the failed revisions in a tuple:
216
if self.base == from_branch.base:
219
nested_pb = ui.ui_factory.nested_progress_bar()
224
from_branch.lock_read()
226
if last_revision is None:
227
pb.update('get source history')
228
last_revision = from_branch.last_revision()
229
if last_revision is None:
230
last_revision = _mod_revision.NULL_REVISION
231
return self.repository.fetch(from_branch.repository,
232
revision_id=last_revision,
235
if nested_pb is not None:
239
def get_bound_location(self):
240
"""Return the URL of the branch we are bound to.
242
Older format branches cannot bind, please be sure to use a metadir
247
def get_old_bound_location(self):
248
"""Return the URL of the branch we used to be bound to
250
raise errors.UpgradeRequired(self.base)
252
def get_commit_builder(self, parents, config=None, timestamp=None,
253
timezone=None, committer=None, revprops=None,
255
"""Obtain a CommitBuilder for this branch.
257
:param parents: Revision ids of the parents of the new revision.
258
:param config: Optional configuration to use.
259
:param timestamp: Optional timestamp recorded for commit.
260
:param timezone: Optional timezone for timestamp.
261
:param committer: Optional committer to set for commit.
262
:param revprops: Optional dictionary of revision properties.
263
:param revision_id: Optional revision id.
267
config = self.get_config()
269
return self.repository.get_commit_builder(self, parents, config,
270
timestamp, timezone, committer, revprops, revision_id)
272
def get_master_branch(self):
273
"""Return the branch we are bound to.
275
:return: Either a Branch, or None
279
def get_revision_delta(self, revno):
280
"""Return the delta for one revision.
282
The delta is relative to its mainline predecessor, or the
283
empty tree for revision 1.
285
assert isinstance(revno, int)
286
rh = self.revision_history()
287
if not (1 <= revno <= len(rh)):
288
raise InvalidRevisionNumber(revno)
289
return self.repository.get_revision_delta(rh[revno-1])
291
def get_root_id(self):
292
"""Return the id of this branches root"""
293
raise NotImplementedError(self.get_root_id)
295
def print_file(self, file, revision_id):
296
"""Print `file` to stdout."""
297
raise NotImplementedError(self.print_file)
299
def append_revision(self, *revision_ids):
300
raise NotImplementedError(self.append_revision)
302
def set_revision_history(self, rev_history):
303
raise NotImplementedError(self.set_revision_history)
305
def revision_history(self):
306
"""Return sequence of revision hashes on to this branch."""
307
raise NotImplementedError(self.revision_history)
310
"""Return current revision number for this branch.
312
That is equivalent to the number of revisions committed to
315
return len(self.revision_history())
318
"""Older format branches cannot bind or unbind."""
319
raise errors.UpgradeRequired(self.base)
321
def set_append_revisions_only(self, enabled):
322
"""Older format branches are never restricted to append-only"""
323
raise errors.UpgradeRequired(self.base)
325
def last_revision(self):
326
"""Return last revision id, or None"""
327
ph = self.revision_history()
333
def last_revision_info(self):
334
"""Return information about the last revision.
336
:return: A tuple (revno, last_revision_id).
338
rh = self.revision_history()
341
return (revno, rh[-1])
343
return (0, _mod_revision.NULL_REVISION)
345
def missing_revisions(self, other, stop_revision=None):
346
"""Return a list of new revisions that would perfectly fit.
348
If self and other have not diverged, return a list of the revisions
349
present in other, but missing from self.
351
self_history = self.revision_history()
352
self_len = len(self_history)
353
other_history = other.revision_history()
354
other_len = len(other_history)
355
common_index = min(self_len, other_len) -1
356
if common_index >= 0 and \
357
self_history[common_index] != other_history[common_index]:
358
raise DivergedBranches(self, other)
360
if stop_revision is None:
361
stop_revision = other_len
363
assert isinstance(stop_revision, int)
364
if stop_revision > other_len:
365
raise errors.NoSuchRevision(self, stop_revision)
366
return other_history[self_len:stop_revision]
368
def update_revisions(self, other, stop_revision=None):
369
"""Pull in new perfect-fit revisions.
371
:param other: Another Branch to pull from
372
:param stop_revision: Updated until the given revision
375
raise NotImplementedError(self.update_revisions)
377
def revision_id_to_revno(self, revision_id):
378
"""Given a revision id, return its revno"""
379
if revision_id is None:
381
revision_id = osutils.safe_revision_id(revision_id)
382
history = self.revision_history()
384
return history.index(revision_id) + 1
386
raise bzrlib.errors.NoSuchRevision(self, revision_id)
388
def get_rev_id(self, revno, history=None):
389
"""Find the revision id of the specified revno."""
393
history = self.revision_history()
394
if revno <= 0 or revno > len(history):
395
raise bzrlib.errors.NoSuchRevision(self, revno)
396
return history[revno - 1]
398
def pull(self, source, overwrite=False, stop_revision=None):
399
"""Mirror source into this branch.
401
This branch is considered to be 'local', having low latency.
403
raise NotImplementedError(self.pull)
405
def push(self, target, overwrite=False, stop_revision=None):
406
"""Mirror this branch into target.
408
This branch is considered to be 'local', having low latency.
410
raise NotImplementedError(self.push)
412
def basis_tree(self):
413
"""Return `Tree` object for last revision."""
414
return self.repository.revision_tree(self.last_revision())
416
def rename_one(self, from_rel, to_rel):
419
This can change the directory or the filename or both.
421
raise NotImplementedError(self.rename_one)
423
def move(self, from_paths, to_name):
426
to_name must exist as a versioned directory.
428
If to_name exists and is a directory, the files are moved into
429
it, keeping their old names. If it is a directory,
431
Note that to_name is only the last component of the new name;
432
this doesn't change the directory.
434
This returns a list of (from_path, to_path) pairs for each
437
raise NotImplementedError(self.move)
439
def get_parent(self):
440
"""Return the parent location of the branch.
442
This is the default location for push/pull/missing. The usual
443
pattern is that the user can override it by specifying a
446
raise NotImplementedError(self.get_parent)
448
def get_submit_branch(self):
449
"""Return the submit location of the branch.
451
This is the default location for bundle. The usual
452
pattern is that the user can override it by specifying a
455
return self.get_config().get_user_option('submit_branch')
457
def set_submit_branch(self, location):
458
"""Return the submit location of the branch.
460
This is the default location for bundle. The usual
461
pattern is that the user can override it by specifying a
464
self.get_config().set_user_option('submit_branch', location)
466
def get_push_location(self):
467
"""Return the None or the location to push this branch to."""
468
raise NotImplementedError(self.get_push_location)
470
def set_push_location(self, location):
471
"""Set a new push location for this branch."""
472
raise NotImplementedError(self.set_push_location)
474
def set_parent(self, url):
475
raise NotImplementedError(self.set_parent)
479
"""Synchronise this branch with the master branch if any.
481
:return: None or the last_revision pivoted out during the update.
485
def check_revno(self, revno):
487
Check whether a revno corresponds to any revision.
488
Zero (the NULL revision) is considered valid.
491
self.check_real_revno(revno)
493
def check_real_revno(self, revno):
495
Check whether a revno corresponds to a real revision.
496
Zero (the NULL revision) is considered invalid
498
if revno < 1 or revno > self.revno():
499
raise InvalidRevisionNumber(revno)
502
def clone(self, *args, **kwargs):
503
"""Clone this branch into to_bzrdir preserving all semantic values.
505
revision_id: if not None, the revision history in the new branch will
506
be truncated to end with revision_id.
508
# for API compatibility, until 0.8 releases we provide the old api:
509
# def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
510
# after 0.8 releases, the *args and **kwargs should be changed:
511
# def clone(self, to_bzrdir, revision_id=None):
512
if (kwargs.get('to_location', None) or
513
kwargs.get('revision', None) or
514
kwargs.get('basis_branch', None) or
515
(len(args) and isinstance(args[0], basestring))):
516
# backwards compatibility api:
517
warn("Branch.clone() has been deprecated for BzrDir.clone() from"
518
" bzrlib 0.8.", DeprecationWarning, stacklevel=3)
521
basis_branch = args[2]
523
basis_branch = kwargs.get('basis_branch', None)
525
basis = basis_branch.bzrdir
530
revision_id = args[1]
532
revision_id = kwargs.get('revision', None)
537
# no default to raise if not provided.
538
url = kwargs.get('to_location')
539
return self.bzrdir.clone(url,
540
revision_id=revision_id,
541
basis=basis).open_branch()
543
# generate args by hand
545
revision_id = args[1]
547
revision_id = kwargs.get('revision_id', None)
551
# no default to raise if not provided.
552
to_bzrdir = kwargs.get('to_bzrdir')
553
result = self._format.initialize(to_bzrdir)
554
self.copy_content_into(result, revision_id=revision_id)
558
def sprout(self, to_bzrdir, revision_id=None):
559
"""Create a new line of development from the branch, into to_bzrdir.
561
revision_id: if not None, the revision history in the new branch will
562
be truncated to end with revision_id.
564
result = self._format.initialize(to_bzrdir)
565
self.copy_content_into(result, revision_id=revision_id)
566
result.set_parent(self.bzrdir.root_transport.base)
569
def _synchronize_history(self, destination, revision_id):
570
"""Synchronize last revision and revision history between branches.
572
This version is most efficient when the destination is also a
573
BzrBranch5, but works for BzrBranch6 as long as the revision
574
history is the true lefthand parent history, and all of the revisions
575
are in the destination's repository. If not, set_revision_history
578
:param destination: The branch to copy the history into
579
:param revision_id: The revision-id to truncate history at. May
580
be None to copy complete history.
582
new_history = self.revision_history()
583
if revision_id is not None:
584
revision_id = osutils.safe_revision_id(revision_id)
586
new_history = new_history[:new_history.index(revision_id) + 1]
588
rev = self.repository.get_revision(revision_id)
589
new_history = rev.get_history(self.repository)[1:]
590
destination.set_revision_history(new_history)
593
def copy_content_into(self, destination, revision_id=None):
594
"""Copy the content of self into destination.
596
revision_id: if not None, the revision history in the new branch will
597
be truncated to end with revision_id.
599
self._synchronize_history(destination, revision_id)
601
parent = self.get_parent()
602
except errors.InaccessibleParent, e:
603
mutter('parent was not accessible to copy: %s', e)
606
destination.set_parent(parent)
610
"""Check consistency of the branch.
612
In particular this checks that revisions given in the revision-history
613
do actually match up in the revision graph, and that they're all
614
present in the repository.
616
Callers will typically also want to check the repository.
618
:return: A BranchCheckResult.
620
mainline_parent_id = None
621
for revision_id in self.revision_history():
623
revision = self.repository.get_revision(revision_id)
624
except errors.NoSuchRevision, e:
625
raise errors.BzrCheckError("mainline revision {%s} not in repository"
627
# In general the first entry on the revision history has no parents.
628
# But it's not illegal for it to have parents listed; this can happen
629
# in imports from Arch when the parents weren't reachable.
630
if mainline_parent_id is not None:
631
if mainline_parent_id not in revision.parent_ids:
632
raise errors.BzrCheckError("previous revision {%s} not listed among "
634
% (mainline_parent_id, revision_id))
635
mainline_parent_id = revision_id
636
return BranchCheckResult(self)
638
def _get_checkout_format(self):
639
"""Return the most suitable metadir for a checkout of this branch.
640
Weaves are used if this branch's repostory uses weaves.
642
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
643
from bzrlib.repofmt import weaverepo
644
format = bzrdir.BzrDirMetaFormat1()
645
format.repository_format = weaverepo.RepositoryFormat7()
647
format = self.repository.bzrdir.cloning_metadir()
648
format.branch_format = self._format
651
def create_checkout(self, to_location, revision_id=None,
653
"""Create a checkout of a branch.
655
:param to_location: The url to produce the checkout at
656
:param revision_id: The revision to check out
657
:param lightweight: If True, produce a lightweight checkout, otherwise,
658
produce a bound branch (heavyweight checkout)
659
:return: The tree of the created checkout
661
t = transport.get_transport(to_location)
664
except errors.FileExists:
667
checkout = bzrdir.BzrDirMetaFormat1().initialize_on_transport(t)
668
BranchReferenceFormat().initialize(checkout, self)
670
format = self._get_checkout_format()
671
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
672
to_location, force_new_tree=False, format=format)
673
checkout = checkout_branch.bzrdir
674
checkout_branch.bind(self)
675
# pull up to the specified revision_id to set the initial
676
# branch tip correctly, and seed it with history.
677
checkout_branch.pull(self, stop_revision=revision_id)
678
return checkout.create_workingtree(revision_id)
681
class BranchFormat(object):
682
"""An encapsulation of the initialization and open routines for a format.
684
Formats provide three things:
685
* An initialization routine,
689
Formats are placed in an dict by their format string for reference
690
during branch opening. Its not required that these be instances, they
691
can be classes themselves with class methods - it simply depends on
692
whether state is needed for a given format or not.
694
Once a format is deprecated, just deprecate the initialize and open
695
methods on the format class. Do not deprecate the object, as the
696
object will be created every time regardless.
699
_default_format = None
700
"""The default format used for new branches."""
703
"""The known formats."""
706
def find_format(klass, a_bzrdir):
707
"""Return the format for the branch object in a_bzrdir."""
709
transport = a_bzrdir.get_branch_transport(None)
710
format_string = transport.get("format").read()
711
return klass._formats[format_string]
713
raise NotBranchError(path=transport.base)
715
raise errors.UnknownFormatError(format=format_string)
718
def get_default_format(klass):
719
"""Return the current default format."""
720
return klass._default_format
722
def get_format_string(self):
723
"""Return the ASCII format string that identifies this format."""
724
raise NotImplementedError(self.get_format_string)
726
def get_format_description(self):
727
"""Return the short format description for this format."""
728
raise NotImplementedError(self.get_format_description)
730
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
732
"""Initialize a branch in a bzrdir, with specified files
734
:param a_bzrdir: The bzrdir to initialize the branch in
735
:param utf8_files: The files to create as a list of
736
(filename, content) tuples
737
:param set_format: If True, set the format with
738
self.get_format_string. (BzrBranch4 has its format set
740
:return: a branch in this format
742
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
743
branch_transport = a_bzrdir.get_branch_transport(self)
745
'metadir': ('lock', lockdir.LockDir),
746
'branch4': ('branch-lock', lockable_files.TransportLock),
748
lock_name, lock_class = lock_map[lock_type]
749
control_files = lockable_files.LockableFiles(branch_transport,
750
lock_name, lock_class)
751
control_files.create_lock()
752
control_files.lock_write()
754
control_files.put_utf8('format', self.get_format_string())
756
for file, content in utf8_files:
757
control_files.put_utf8(file, content)
759
control_files.unlock()
760
return self.open(a_bzrdir, _found=True)
762
def initialize(self, a_bzrdir):
763
"""Create a branch of this format in a_bzrdir."""
764
raise NotImplementedError(self.initialize)
766
def is_supported(self):
767
"""Is this format supported?
769
Supported formats can be initialized and opened.
770
Unsupported formats may not support initialization or committing or
771
some other features depending on the reason for not being supported.
775
def open(self, a_bzrdir, _found=False):
776
"""Return the branch object for a_bzrdir
778
_found is a private parameter, do not use it. It is used to indicate
779
if format probing has already be done.
781
raise NotImplementedError(self.open)
784
def register_format(klass, format):
785
klass._formats[format.get_format_string()] = format
788
def set_default_format(klass, format):
789
klass._default_format = format
792
def unregister_format(klass, format):
793
assert klass._formats[format.get_format_string()] is format
794
del klass._formats[format.get_format_string()]
797
return self.get_format_string().rstrip()
800
class BranchHooks(dict):
801
"""A dictionary mapping hook name to a list of callables for branch hooks.
803
e.g. ['set_rh'] Is the list of items to be called when the
804
set_revision_history function is invoked.
808
"""Create the default hooks.
810
These are all empty initially, because by default nothing should get
814
# Introduced in 0.15:
815
# invoked whenever the revision history has been set
816
# with set_revision_history. The api signature is
817
# (branch, revision_history), and the branch will
820
# invoked after a push operation completes.
821
# the api signature is
822
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
823
# where local is the local branch or None, master is the target
824
# master branch, and the rest should be self explanatory. The source
825
# is read locked and the target branches write locked. Source will
826
# be the local low-latency branch.
827
self['post_push'] = []
828
# invoked after a pull operation completes.
829
# the api signature is
830
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
831
# where local is the local branch or None, master is the target
832
# master branch, and the rest should be self explanatory. The source
833
# is read locked and the target branches write locked. The local
834
# branch is the low-latency branch.
835
self['post_pull'] = []
836
# invoked after a commit operation completes.
837
# the api signature is
838
# (local, master, old_revno, old_revid, new_revno, new_revid)
839
# old_revid is NULL_REVISION for the first commit to a branch.
840
self['post_commit'] = []
841
# invoked after a uncommit operation completes.
842
# the api signature is
843
# (local, master, old_revno, old_revid, new_revno, new_revid) where
844
# local is the local branch or None, master is the target branch,
845
# and an empty branch recieves new_revno of 0, new_revid of None.
846
self['post_uncommit'] = []
848
def install_hook(self, hook_name, a_callable):
849
"""Install a_callable in to the hook hook_name.
851
:param hook_name: A hook name. See the __init__ method of BranchHooks
852
for the complete list of hooks.
853
:param a_callable: The callable to be invoked when the hook triggers.
854
The exact signature will depend on the hook - see the __init__
855
method of BranchHooks for details on each hook.
858
self[hook_name].append(a_callable)
860
raise errors.UnknownHook('branch', hook_name)
863
# install the default hooks into the Branch class.
864
Branch.hooks = BranchHooks()
867
class BzrBranchFormat4(BranchFormat):
868
"""Bzr branch format 4.
871
- a revision-history file.
872
- a branch-lock lock file [ to be shared with the bzrdir ]
875
def get_format_description(self):
876
"""See BranchFormat.get_format_description()."""
877
return "Branch format 4"
879
def initialize(self, a_bzrdir):
880
"""Create a branch of this format in a_bzrdir."""
881
utf8_files = [('revision-history', ''),
884
return self._initialize_helper(a_bzrdir, utf8_files,
885
lock_type='branch4', set_format=False)
888
super(BzrBranchFormat4, self).__init__()
889
self._matchingbzrdir = bzrdir.BzrDirFormat6()
891
def open(self, a_bzrdir, _found=False):
892
"""Return the branch object for a_bzrdir
894
_found is a private parameter, do not use it. It is used to indicate
895
if format probing has already be done.
898
# we are being called directly and must probe.
899
raise NotImplementedError
900
return BzrBranch(_format=self,
901
_control_files=a_bzrdir._control_files,
903
_repository=a_bzrdir.open_repository())
906
return "Bazaar-NG branch format 4"
909
class BzrBranchFormat5(BranchFormat):
910
"""Bzr branch format 5.
913
- a revision-history file.
915
- a lock dir guarding the branch itself
916
- all of this stored in a branch/ subdirectory
917
- works with shared repositories.
919
This format is new in bzr 0.8.
922
def get_format_string(self):
923
"""See BranchFormat.get_format_string()."""
924
return "Bazaar-NG branch format 5\n"
926
def get_format_description(self):
927
"""See BranchFormat.get_format_description()."""
928
return "Branch format 5"
930
def initialize(self, a_bzrdir):
931
"""Create a branch of this format in a_bzrdir."""
932
utf8_files = [('revision-history', ''),
935
return self._initialize_helper(a_bzrdir, utf8_files)
938
super(BzrBranchFormat5, self).__init__()
939
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
941
def open(self, a_bzrdir, _found=False):
942
"""Return the branch object for a_bzrdir
944
_found is a private parameter, do not use it. It is used to indicate
945
if format probing has already be done.
948
format = BranchFormat.find_format(a_bzrdir)
949
assert format.__class__ == self.__class__
950
transport = a_bzrdir.get_branch_transport(None)
951
control_files = lockable_files.LockableFiles(transport, 'lock',
953
return BzrBranch5(_format=self,
954
_control_files=control_files,
956
_repository=a_bzrdir.find_repository())
959
return "Bazaar-NG Metadir branch format 5"
962
class BzrBranchFormat6(BzrBranchFormat5):
963
"""Branch format with last-revision
965
Unlike previous formats, this has no explicit revision history. Instead,
966
this just stores the last-revision, and the left-hand history leading
967
up to there is the history.
969
This format was introduced in bzr 0.15
972
def get_format_string(self):
973
"""See BranchFormat.get_format_string()."""
974
return "Bazaar-NG branch format 6\n"
976
def get_format_description(self):
977
"""See BranchFormat.get_format_description()."""
978
return "Branch format 6"
980
def initialize(self, a_bzrdir):
981
"""Create a branch of this format in a_bzrdir."""
982
utf8_files = [('last-revision', '0 null:\n'),
986
return self._initialize_helper(a_bzrdir, utf8_files)
988
def open(self, a_bzrdir, _found=False):
989
"""Return the branch object for a_bzrdir
991
_found is a private parameter, do not use it. It is used to indicate
992
if format probing has already be done.
995
format = BranchFormat.find_format(a_bzrdir)
996
assert format.__class__ == self.__class__
997
transport = a_bzrdir.get_branch_transport(None)
998
control_files = lockable_files.LockableFiles(transport, 'lock',
1000
return BzrBranch6(_format=self,
1001
_control_files=control_files,
1003
_repository=a_bzrdir.find_repository())
1006
class BranchReferenceFormat(BranchFormat):
1007
"""Bzr branch reference format.
1009
Branch references are used in implementing checkouts, they
1010
act as an alias to the real branch which is at some other url.
1017
def get_format_string(self):
1018
"""See BranchFormat.get_format_string()."""
1019
return "Bazaar-NG Branch Reference Format 1\n"
1021
def get_format_description(self):
1022
"""See BranchFormat.get_format_description()."""
1023
return "Checkout reference format 1"
1025
def initialize(self, a_bzrdir, target_branch=None):
1026
"""Create a branch of this format in a_bzrdir."""
1027
if target_branch is None:
1028
# this format does not implement branch itself, thus the implicit
1029
# creation contract must see it as uninitializable
1030
raise errors.UninitializableFormat(self)
1031
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1032
branch_transport = a_bzrdir.get_branch_transport(self)
1033
branch_transport.put_bytes('location',
1034
target_branch.bzrdir.root_transport.base)
1035
branch_transport.put_bytes('format', self.get_format_string())
1036
return self.open(a_bzrdir, _found=True)
1039
super(BranchReferenceFormat, self).__init__()
1040
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1042
def _make_reference_clone_function(format, a_branch):
1043
"""Create a clone() routine for a branch dynamically."""
1044
def clone(to_bzrdir, revision_id=None):
1045
"""See Branch.clone()."""
1046
return format.initialize(to_bzrdir, a_branch)
1047
# cannot obey revision_id limits when cloning a reference ...
1048
# FIXME RBC 20060210 either nuke revision_id for clone, or
1049
# emit some sort of warning/error to the caller ?!
1052
def open(self, a_bzrdir, _found=False):
1053
"""Return the branch that the branch reference in a_bzrdir points at.
1055
_found is a private parameter, do not use it. It is used to indicate
1056
if format probing has already be done.
1059
format = BranchFormat.find_format(a_bzrdir)
1060
assert format.__class__ == self.__class__
1061
transport = a_bzrdir.get_branch_transport(None)
1062
real_bzrdir = bzrdir.BzrDir.open(transport.get('location').read())
1063
result = real_bzrdir.open_branch()
1064
# this changes the behaviour of result.clone to create a new reference
1065
# rather than a copy of the content of the branch.
1066
# I did not use a proxy object because that needs much more extensive
1067
# testing, and we are only changing one behaviour at the moment.
1068
# If we decide to alter more behaviours - i.e. the implicit nickname
1069
# then this should be refactored to introduce a tested proxy branch
1070
# and a subclass of that for use in overriding clone() and ....
1072
result.clone = self._make_reference_clone_function(result)
1076
# formats which have no format string are not discoverable
1077
# and not independently creatable, so are not registered.
1078
__default_format = BzrBranchFormat5()
1079
BranchFormat.register_format(__default_format)
1080
BranchFormat.register_format(BranchReferenceFormat())
1081
BranchFormat.register_format(BzrBranchFormat6())
1082
BranchFormat.set_default_format(__default_format)
1083
_legacy_formats = [BzrBranchFormat4(),
1086
class BzrBranch(Branch):
1087
"""A branch stored in the actual filesystem.
1089
Note that it's "local" in the context of the filesystem; it doesn't
1090
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1091
it's writable, and can be accessed via the normal filesystem API.
1094
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
1095
relax_version_check=DEPRECATED_PARAMETER, _format=None,
1096
_control_files=None, a_bzrdir=None, _repository=None):
1097
"""Create new branch object at a particular location.
1099
transport -- A Transport object, defining how to access files.
1101
init -- If True, create new control files in a previously
1102
unversioned directory. If False, the branch must already
1105
relax_version_check -- If true, the usual check for the branch
1106
version is not applied. This is intended only for
1107
upgrade/recovery type use; it's not guaranteed that
1108
all operations will work on old format branches.
1110
if a_bzrdir is None:
1111
self.bzrdir = bzrdir.BzrDir.open(transport.base)
1113
self.bzrdir = a_bzrdir
1114
self._transport = self.bzrdir.transport.clone('..')
1115
self._base = self._transport.base
1116
self._format = _format
1117
if _control_files is None:
1118
raise ValueError('BzrBranch _control_files is None')
1119
self.control_files = _control_files
1120
if deprecated_passed(init):
1121
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
1122
"deprecated as of bzr 0.8. Please use Branch.create().",
1126
# this is slower than before deprecation, oh well never mind.
1127
# -> its deprecated.
1128
self._initialize(transport.base)
1129
self._check_format(_format)
1130
if deprecated_passed(relax_version_check):
1131
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
1132
"relax_version_check parameter is deprecated as of bzr 0.8. "
1133
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
1137
if (not relax_version_check
1138
and not self._format.is_supported()):
1139
raise errors.UnsupportedFormatError(format=fmt)
1140
if deprecated_passed(transport):
1141
warn("BzrBranch.__init__(transport=XXX...): The transport "
1142
"parameter is deprecated as of bzr 0.8. "
1143
"Please use Branch.open, or bzrdir.open_branch().",
1146
self.repository = _repository
1149
return '%s(%r)' % (self.__class__.__name__, self.base)
1153
def _get_base(self):
1156
base = property(_get_base, doc="The URL for the root of this branch.")
1158
def _finish_transaction(self):
1159
"""Exit the current transaction."""
1160
return self.control_files._finish_transaction()
1162
def get_transaction(self):
1163
"""Return the current active transaction.
1165
If no transaction is active, this returns a passthrough object
1166
for which all data is immediately flushed and no caching happens.
1168
# this is an explicit function so that we can do tricky stuff
1169
# when the storage in rev_storage is elsewhere.
1170
# we probably need to hook the two 'lock a location' and
1171
# 'have a transaction' together more delicately, so that
1172
# we can have two locks (branch and storage) and one transaction
1173
# ... and finishing the transaction unlocks both, but unlocking
1174
# does not. - RBC 20051121
1175
return self.control_files.get_transaction()
1177
def _set_transaction(self, transaction):
1178
"""Set a new active transaction."""
1179
return self.control_files._set_transaction(transaction)
1181
def abspath(self, name):
1182
"""See Branch.abspath."""
1183
return self.control_files._transport.abspath(name)
1185
def _check_format(self, format):
1186
"""Identify the branch format if needed.
1188
The format is stored as a reference to the format object in
1189
self._format for code that needs to check it later.
1191
The format parameter is either None or the branch format class
1192
used to open this branch.
1194
FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
1197
format = BranchFormat.find_format(self.bzrdir)
1198
self._format = format
1199
mutter("got branch format %s", self._format)
1202
def get_root_id(self):
1203
"""See Branch.get_root_id."""
1204
tree = self.repository.revision_tree(self.last_revision())
1205
return tree.inventory.root.file_id
1207
def is_locked(self):
1208
return self.control_files.is_locked()
1210
def lock_write(self):
1211
self.repository.lock_write()
1213
self.control_files.lock_write()
1215
self.repository.unlock()
1218
def lock_read(self):
1219
self.repository.lock_read()
1221
self.control_files.lock_read()
1223
self.repository.unlock()
1227
# TODO: test for failed two phase locks. This is known broken.
1229
self.control_files.unlock()
1231
self.repository.unlock()
1233
def peek_lock_mode(self):
1234
if self.control_files._lock_count == 0:
1237
return self.control_files._lock_mode
1239
def get_physical_lock_status(self):
1240
return self.control_files.get_physical_lock_status()
1243
def print_file(self, file, revision_id):
1244
"""See Branch.print_file."""
1245
return self.repository.print_file(file, revision_id)
1248
def append_revision(self, *revision_ids):
1249
"""See Branch.append_revision."""
1250
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1251
for revision_id in revision_ids:
1252
_mod_revision.check_not_reserved_id(revision_id)
1253
mutter("add {%s} to revision-history" % revision_id)
1254
rev_history = self.revision_history()
1255
rev_history.extend(revision_ids)
1256
self.set_revision_history(rev_history)
1258
def _write_revision_history(self, history):
1259
"""Factored out of set_revision_history.
1261
This performs the actual writing to disk.
1262
It is intended to be called by BzrBranch5.set_revision_history."""
1263
self.control_files.put_bytes(
1264
'revision-history', '\n'.join(history))
1267
def set_revision_history(self, rev_history):
1268
"""See Branch.set_revision_history."""
1269
rev_history = [osutils.safe_revision_id(r) for r in rev_history]
1270
self._write_revision_history(rev_history)
1271
transaction = self.get_transaction()
1272
history = transaction.map.find_revision_history()
1273
if history is not None:
1274
# update the revision history in the identity map.
1275
history[:] = list(rev_history)
1276
# this call is disabled because revision_history is
1277
# not really an object yet, and the transaction is for objects.
1278
# transaction.register_dirty(history)
1280
transaction.map.add_revision_history(rev_history)
1281
# this call is disabled because revision_history is
1282
# not really an object yet, and the transaction is for objects.
1283
# transaction.register_clean(history)
1284
for hook in Branch.hooks['set_rh']:
1285
hook(self, rev_history)
1288
def set_last_revision_info(self, revno, revision_id):
1289
revision_id = osutils.safe_revision_id(revision_id)
1290
history = self._lefthand_history(revision_id)
1291
assert len(history) == revno, '%d != %d' % (len(history), revno)
1292
self.set_revision_history(history)
1294
def _gen_revision_history(self):
1295
history = [l.rstrip('\r\n') for l in
1296
self.control_files.get('revision-history').readlines()]
1300
def revision_history(self):
1301
"""See Branch.revision_history."""
1302
transaction = self.get_transaction()
1303
history = transaction.map.find_revision_history()
1304
if history is not None:
1305
# mutter("cache hit for revision-history in %s", self)
1306
return list(history)
1307
history = self._gen_revision_history()
1308
transaction.map.add_revision_history(history)
1309
# this call is disabled because revision_history is
1310
# not really an object yet, and the transaction is for objects.
1311
# transaction.register_clean(history, precious=True)
1312
return list(history)
1314
def _lefthand_history(self, revision_id, last_rev=None,
1316
# stop_revision must be a descendant of last_revision
1317
stop_graph = self.repository.get_revision_graph(revision_id)
1318
if last_rev is not None and last_rev not in stop_graph:
1319
# our previous tip is not merged into stop_revision
1320
raise errors.DivergedBranches(self, other_branch)
1321
# make a new revision history from the graph
1322
current_rev_id = revision_id
1324
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1325
new_history.append(current_rev_id)
1326
current_rev_id_parents = stop_graph[current_rev_id]
1328
current_rev_id = current_rev_id_parents[0]
1330
current_rev_id = None
1331
new_history.reverse()
1335
def generate_revision_history(self, revision_id, last_rev=None,
1337
"""Create a new revision history that will finish with revision_id.
1339
:param revision_id: the new tip to use.
1340
:param last_rev: The previous last_revision. If not None, then this
1341
must be a ancestory of revision_id, or DivergedBranches is raised.
1342
:param other_branch: The other branch that DivergedBranches should
1343
raise with respect to.
1345
revision_id = osutils.safe_revision_id(revision_id)
1346
self.set_revision_history(self._lefthand_history(revision_id,
1347
last_rev, other_branch))
1350
def update_revisions(self, other, stop_revision=None):
1351
"""See Branch.update_revisions."""
1354
if stop_revision is None:
1355
stop_revision = other.last_revision()
1356
if stop_revision is None:
1357
# if there are no commits, we're done.
1360
stop_revision = osutils.safe_revision_id(stop_revision)
1361
# whats the current last revision, before we fetch [and change it
1363
last_rev = self.last_revision()
1364
# we fetch here regardless of whether we need to so that we pickup
1366
self.fetch(other, stop_revision)
1367
my_ancestry = self.repository.get_ancestry(last_rev)
1368
if stop_revision in my_ancestry:
1369
# last_revision is a descendant of stop_revision
1371
self.generate_revision_history(stop_revision, last_rev=last_rev,
1376
def basis_tree(self):
1377
"""See Branch.basis_tree."""
1378
return self.repository.revision_tree(self.last_revision())
1380
@deprecated_method(zero_eight)
1381
def working_tree(self):
1382
"""Create a Working tree object for this branch."""
1384
from bzrlib.transport.local import LocalTransport
1385
if (self.base.find('://') != -1 or
1386
not isinstance(self._transport, LocalTransport)):
1387
raise NoWorkingTree(self.base)
1388
return self.bzrdir.open_workingtree()
1391
def pull(self, source, overwrite=False, stop_revision=None,
1392
_hook_master=None, _run_hooks=True):
1395
:param _hook_master: Private parameter - set the branch to
1396
be supplied as the master to push hooks.
1397
:param _run_hooks: Private parameter - allow disabling of
1398
hooks, used when pushing to a master branch.
1402
old_count, old_tip = self.last_revision_info()
1404
self.update_revisions(source, stop_revision)
1405
except DivergedBranches:
1409
self.set_revision_history(source.revision_history())
1410
new_count, new_tip = self.last_revision_info()
1417
for hook in Branch.hooks['post_pull']:
1418
hook(source, _hook_local, _hook_master, old_count, old_tip,
1420
return new_count - old_count
1424
def _get_parent_location(self):
1425
_locs = ['parent', 'pull', 'x-pull']
1428
return self.control_files.get(l).read().strip('\n')
1434
def push(self, target, overwrite=False, stop_revision=None,
1435
_hook_master=None, _run_hooks=True):
1438
:param _hook_master: Private parameter - set the branch to
1439
be supplied as the master to push hooks.
1440
:param _run_hooks: Private parameter - allow disabling of
1441
hooks, used when pushing to a master branch.
1445
old_count, old_tip = target.last_revision_info()
1447
target.update_revisions(self, stop_revision)
1448
except DivergedBranches:
1452
target.set_revision_history(self.revision_history())
1453
new_count, new_tip = target.last_revision_info()
1456
_hook_local = target
1458
_hook_master = target
1460
for hook in Branch.hooks['post_push']:
1461
hook(self, _hook_local, _hook_master, old_count, old_tip,
1463
return new_count - old_count
1467
def get_parent(self):
1468
"""See Branch.get_parent."""
1470
assert self.base[-1] == '/'
1471
parent = self._get_parent_location()
1474
# This is an old-format absolute path to a local branch
1475
# turn it into a url
1476
if parent.startswith('/'):
1477
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1479
return urlutils.join(self.base[:-1], parent)
1480
except errors.InvalidURLJoin, e:
1481
raise errors.InaccessibleParent(parent, self.base)
1483
def get_push_location(self):
1484
"""See Branch.get_push_location."""
1485
push_loc = self.get_config().get_user_option('push_location')
1488
def set_push_location(self, location):
1489
"""See Branch.set_push_location."""
1490
self.get_config().set_user_option(
1491
'push_location', location,
1492
store=_mod_config.STORE_LOCATION_NORECURSE)
1495
def set_parent(self, url):
1496
"""See Branch.set_parent."""
1497
# TODO: Maybe delete old location files?
1498
# URLs should never be unicode, even on the local fs,
1499
# FIXUP this and get_parent in a future branch format bump:
1500
# read and rewrite the file, and have the new format code read
1501
# using .get not .get_utf8. RBC 20060125
1503
if isinstance(url, unicode):
1505
url = url.encode('ascii')
1506
except UnicodeEncodeError:
1507
raise bzrlib.errors.InvalidURL(url,
1508
"Urls must be 7-bit ascii, "
1509
"use bzrlib.urlutils.escape")
1510
url = urlutils.relative_url(self.base, url)
1511
self._set_parent_location(url)
1513
def _set_parent_location(self, url):
1515
self.control_files._transport.delete('parent')
1517
assert isinstance(url, str)
1518
self.control_files.put_bytes('parent', url + '\n')
1520
@deprecated_function(zero_nine)
1521
def tree_config(self):
1522
"""DEPRECATED; call get_config instead.
1523
TreeConfig has become part of BranchConfig."""
1524
return TreeConfig(self)
1527
class BzrBranch5(BzrBranch):
1528
"""A format 5 branch. This supports new features over plan branches.
1530
It has support for a master_branch which is the data for bound branches.
1538
super(BzrBranch5, self).__init__(_format=_format,
1539
_control_files=_control_files,
1541
_repository=_repository)
1544
def pull(self, source, overwrite=False, stop_revision=None,
1546
"""Extends branch.pull to be bound branch aware.
1548
:param _run_hooks: Private parameter used to force hook running
1549
off during bound branch double-pushing.
1551
bound_location = self.get_bound_location()
1552
master_branch = None
1553
if bound_location and source.base != bound_location:
1554
# not pulling from master, so we need to update master.
1555
master_branch = self.get_master_branch()
1556
master_branch.lock_write()
1559
# pull from source into master.
1560
master_branch.pull(source, overwrite, stop_revision,
1562
return super(BzrBranch5, self).pull(source, overwrite,
1563
stop_revision, _hook_master=master_branch,
1564
_run_hooks=_run_hooks)
1567
master_branch.unlock()
1570
def push(self, target, overwrite=False, stop_revision=None):
1571
"""Updates branch.push to be bound branch aware."""
1572
bound_location = target.get_bound_location()
1573
master_branch = None
1574
if bound_location and target.base != bound_location:
1575
# not pushing to master, so we need to update master.
1576
master_branch = target.get_master_branch()
1577
master_branch.lock_write()
1580
# push into the master from this branch.
1581
super(BzrBranch5, self).push(master_branch, overwrite,
1582
stop_revision, _run_hooks=False)
1583
# and push into the target branch from this. Note that we push from
1584
# this branch again, because its considered the highest bandwidth
1586
return super(BzrBranch5, self).push(target, overwrite,
1587
stop_revision, _hook_master=master_branch)
1590
master_branch.unlock()
1592
def get_bound_location(self):
1594
return self.control_files.get_utf8('bound').read()[:-1]
1595
except errors.NoSuchFile:
1599
def get_master_branch(self):
1600
"""Return the branch we are bound to.
1602
:return: Either a Branch, or None
1604
This could memoise the branch, but if thats done
1605
it must be revalidated on each new lock.
1606
So for now we just don't memoise it.
1607
# RBC 20060304 review this decision.
1609
bound_loc = self.get_bound_location()
1613
return Branch.open(bound_loc)
1614
except (errors.NotBranchError, errors.ConnectionError), e:
1615
raise errors.BoundBranchConnectionFailure(
1619
def set_bound_location(self, location):
1620
"""Set the target where this branch is bound to.
1622
:param location: URL to the target branch
1625
self.control_files.put_utf8('bound', location+'\n')
1628
self.control_files._transport.delete('bound')
1634
def bind(self, other):
1635
"""Bind this branch to the branch other.
1637
This does not push or pull data between the branches, though it does
1638
check for divergence to raise an error when the branches are not
1639
either the same, or one a prefix of the other. That behaviour may not
1640
be useful, so that check may be removed in future.
1642
:param other: The branch to bind to
1645
# TODO: jam 20051230 Consider checking if the target is bound
1646
# It is debatable whether you should be able to bind to
1647
# a branch which is itself bound.
1648
# Committing is obviously forbidden,
1649
# but binding itself may not be.
1650
# Since we *have* to check at commit time, we don't
1651
# *need* to check here
1653
# we want to raise diverged if:
1654
# last_rev is not in the other_last_rev history, AND
1655
# other_last_rev is not in our history, and do it without pulling
1657
last_rev = self.last_revision()
1658
if last_rev is not None:
1661
other_last_rev = other.last_revision()
1662
if other_last_rev is not None:
1663
# neither branch is new, we have to do some work to
1664
# ascertain diversion.
1665
remote_graph = other.repository.get_revision_graph(
1667
local_graph = self.repository.get_revision_graph(last_rev)
1668
if (last_rev not in remote_graph and
1669
other_last_rev not in local_graph):
1670
raise errors.DivergedBranches(self, other)
1673
self.set_bound_location(other.base)
1677
"""If bound, unbind"""
1678
return self.set_bound_location(None)
1682
"""Synchronise this branch with the master branch if any.
1684
:return: None or the last_revision that was pivoted out during the
1687
master = self.get_master_branch()
1688
if master is not None:
1689
old_tip = self.last_revision()
1690
self.pull(master, overwrite=True)
1691
if old_tip in self.repository.get_ancestry(self.last_revision()):
1697
class BzrBranch6(BzrBranch5):
1700
def last_revision_info(self):
1701
revision_string = self.control_files.get('last-revision').read()
1702
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1703
revision_id = cache_utf8.get_cached_utf8(revision_id)
1705
return revno, revision_id
1707
def last_revision(self):
1708
"""Return last revision id, or None"""
1709
revision_id = self.last_revision_info()[1]
1710
if revision_id == _mod_revision.NULL_REVISION:
1714
def _write_last_revision_info(self, revno, revision_id):
1715
"""Simply write out the revision id, with no checks.
1717
Use set_last_revision_info to perform this safely.
1719
Does not update the revision_history cache.
1720
Intended to be called by set_last_revision_info and
1721
_write_revision_history.
1723
if revision_id is None:
1724
revision_id = 'null:'
1725
out_string = '%d %s\n' % (revno, revision_id)
1726
self.control_files.put_bytes('last-revision', out_string)
1729
def set_last_revision_info(self, revno, revision_id):
1730
revision_id = osutils.safe_revision_id(revision_id)
1731
if self._get_append_revisions_only():
1732
self._check_history_violation(revision_id)
1733
self._write_last_revision_info(revno, revision_id)
1734
transaction = self.get_transaction()
1735
cached_history = transaction.map.find_revision_history()
1736
if cached_history is not None:
1737
transaction.map.remove_object(cached_history)
1739
def _check_history_violation(self, revision_id):
1740
last_revision = self.last_revision()
1741
if last_revision is None:
1743
if last_revision not in self._lefthand_history(revision_id):
1744
raise errors.AppendRevisionsOnlyViolation(self.base)
1746
def _gen_revision_history(self):
1747
"""Generate the revision history from last revision
1749
history = list(self.repository.iter_reverse_revision_history(
1750
self.last_revision()))
1754
def _write_revision_history(self, history):
1755
"""Factored out of set_revision_history.
1757
This performs the actual writing to disk, with format-specific checks.
1758
It is intended to be called by BzrBranch5.set_revision_history.
1760
if len(history) == 0:
1761
last_revision = 'null:'
1763
if history != self._lefthand_history(history[-1]):
1764
raise errors.NotLefthandHistory(history)
1765
last_revision = history[-1]
1766
if self._get_append_revisions_only():
1767
self._check_history_violation(last_revision)
1768
self._write_last_revision_info(len(history), last_revision)
1771
def append_revision(self, *revision_ids):
1772
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1773
if len(revision_ids) == 0:
1775
prev_revno, prev_revision = self.last_revision_info()
1776
for revision in self.repository.get_revisions(revision_ids):
1777
if prev_revision == _mod_revision.NULL_REVISION:
1778
if revision.parent_ids != []:
1779
raise errors.NotLeftParentDescendant(self, prev_revision,
1780
revision.revision_id)
1782
if revision.parent_ids[0] != prev_revision:
1783
raise errors.NotLeftParentDescendant(self, prev_revision,
1784
revision.revision_id)
1785
prev_revision = revision.revision_id
1786
self.set_last_revision_info(prev_revno + len(revision_ids),
1789
def _set_config_location(self, name, url, config=None,
1790
make_relative=False):
1792
config = self.get_config()
1796
url = urlutils.relative_url(self.base, url)
1797
config.set_user_option(name, url)
1800
def _get_config_location(self, name, config=None):
1802
config = self.get_config()
1803
location = config.get_user_option(name)
1809
def _set_parent_location(self, url):
1810
"""Set the parent branch"""
1811
self._set_config_location('parent_location', url, make_relative=True)
1814
def _get_parent_location(self):
1815
"""Set the parent branch"""
1816
return self._get_config_location('parent_location')
1818
def set_push_location(self, location):
1819
"""See Branch.set_push_location."""
1820
self._set_config_location('push_location', location)
1822
def set_bound_location(self, location):
1823
"""See Branch.set_push_location."""
1825
config = self.get_config()
1826
if location is None:
1827
if config.get_user_option('bound') != 'True':
1830
config.set_user_option('bound', 'False')
1833
self._set_config_location('bound_location', location,
1835
config.set_user_option('bound', 'True')
1838
def _get_bound_location(self, bound):
1839
"""Return the bound location in the config file.
1841
Return None if the bound parameter does not match"""
1842
config = self.get_config()
1843
config_bound = (config.get_user_option('bound') == 'True')
1844
if config_bound != bound:
1846
return self._get_config_location('bound_location', config=config)
1848
def get_bound_location(self):
1849
"""See Branch.set_push_location."""
1850
return self._get_bound_location(True)
1852
def get_old_bound_location(self):
1853
"""See Branch.get_old_bound_location"""
1854
return self._get_bound_location(False)
1856
def set_append_revisions_only(self, enabled):
1861
self.get_config().set_user_option('append_revisions_only', value)
1863
def _get_append_revisions_only(self):
1864
value = self.get_config().get_user_option('append_revisions_only')
1865
return value == 'True'
1867
def _synchronize_history(self, destination, revision_id):
1868
"""Synchronize last revision and revision history between branches.
1870
This version is most efficient when the destination is also a
1871
BzrBranch6, but works for BzrBranch5, as long as the destination's
1872
repository contains all the lefthand ancestors of the intended
1873
last_revision. If not, set_last_revision_info will fail.
1875
:param destination: The branch to copy the history into
1876
:param revision_id: The revision-id to truncate history at. May
1877
be None to copy complete history.
1879
if revision_id is None:
1880
revno, revision_id = self.last_revision_info()
1882
revno = self.revision_id_to_revno(revision_id)
1883
destination.set_last_revision_info(revno, revision_id)
1886
class BranchTestProviderAdapter(object):
1887
"""A tool to generate a suite testing multiple branch formats at once.
1889
This is done by copying the test once for each transport and injecting
1890
the transport_server, transport_readonly_server, and branch_format
1891
classes into each copy. Each copy is also given a new id() to make it
1895
def __init__(self, transport_server, transport_readonly_server, formats):
1896
self._transport_server = transport_server
1897
self._transport_readonly_server = transport_readonly_server
1898
self._formats = formats
1900
def adapt(self, test):
1901
result = TestSuite()
1902
for branch_format, bzrdir_format in self._formats:
1903
new_test = deepcopy(test)
1904
new_test.transport_server = self._transport_server
1905
new_test.transport_readonly_server = self._transport_readonly_server
1906
new_test.bzrdir_format = bzrdir_format
1907
new_test.branch_format = branch_format
1908
def make_new_test_id():
1909
new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
1910
return lambda: new_id
1911
new_test.id = make_new_test_id()
1912
result.addTest(new_test)
1916
class BranchCheckResult(object):
1917
"""Results of checking branch consistency.
1922
def __init__(self, branch):
1923
self.branch = branch
1925
def report_results(self, verbose):
1926
"""Report the check results via trace.note.
1928
:param verbose: Requests more detailed display of what was checked,
1931
note('checked branch %s format %s',
1933
self.branch._format)
1936
######################################################################
1940
@deprecated_function(zero_eight)
1941
def is_control_file(*args, **kwargs):
1942
"""See bzrlib.workingtree.is_control_file."""
1943
from bzrlib import workingtree
1944
return workingtree.is_control_file(*args, **kwargs)
1947
class Converter5to6(object):
1948
"""Perform an in-place upgrade of format 5 to format 6"""
1950
def convert(self, branch):
1951
# Data for 5 and 6 can peacefully coexist.
1952
format = BzrBranchFormat6()
1953
new_branch = format.open(branch.bzrdir, _found=True)
1955
# Copy source data into target
1956
new_branch.set_last_revision_info(*branch.last_revision_info())
1957
new_branch.set_parent(branch.get_parent())
1958
new_branch.set_bound_location(branch.get_bound_location())
1959
new_branch.set_push_location(branch.get_push_location())
1961
# Copying done; now update target format
1962
new_branch.control_files.put_utf8('format',
1963
format.get_format_string())
1965
# Clean up old files
1966
new_branch.control_files._transport.delete('revision-history')
1968
branch.set_parent(None)
1971
branch.set_bound_location(None)
added
removed
bzrlib/branch.py
