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
:returns: PullResult instance
405
raise NotImplementedError(self.pull)
407
def push(self, target, overwrite=False, stop_revision=None):
408
"""Mirror this branch into target.
410
This branch is considered to be 'local', having low latency.
412
raise NotImplementedError(self.push)
414
def basis_tree(self):
415
"""Return `Tree` object for last revision."""
416
return self.repository.revision_tree(self.last_revision())
418
def rename_one(self, from_rel, to_rel):
421
This can change the directory or the filename or both.
423
raise NotImplementedError(self.rename_one)
425
def move(self, from_paths, to_name):
428
to_name must exist as a versioned directory.
430
If to_name exists and is a directory, the files are moved into
431
it, keeping their old names. If it is a directory,
433
Note that to_name is only the last component of the new name;
434
this doesn't change the directory.
436
This returns a list of (from_path, to_path) pairs for each
439
raise NotImplementedError(self.move)
441
def get_parent(self):
442
"""Return the parent location of the branch.
444
This is the default location for push/pull/missing. The usual
445
pattern is that the user can override it by specifying a
448
raise NotImplementedError(self.get_parent)
450
def get_submit_branch(self):
451
"""Return the submit location of the branch.
453
This is the default location for bundle. The usual
454
pattern is that the user can override it by specifying a
457
return self.get_config().get_user_option('submit_branch')
459
def set_submit_branch(self, location):
460
"""Return the submit location of the branch.
462
This is the default location for bundle. The usual
463
pattern is that the user can override it by specifying a
466
self.get_config().set_user_option('submit_branch', location)
468
def get_push_location(self):
469
"""Return the None or the location to push this branch to."""
470
raise NotImplementedError(self.get_push_location)
472
def set_push_location(self, location):
473
"""Set a new push location for this branch."""
474
raise NotImplementedError(self.set_push_location)
476
def set_parent(self, url):
477
raise NotImplementedError(self.set_parent)
481
"""Synchronise this branch with the master branch if any.
483
:return: None or the last_revision pivoted out during the update.
487
def check_revno(self, revno):
489
Check whether a revno corresponds to any revision.
490
Zero (the NULL revision) is considered valid.
493
self.check_real_revno(revno)
495
def check_real_revno(self, revno):
497
Check whether a revno corresponds to a real revision.
498
Zero (the NULL revision) is considered invalid
500
if revno < 1 or revno > self.revno():
501
raise InvalidRevisionNumber(revno)
504
def clone(self, *args, **kwargs):
505
"""Clone this branch into to_bzrdir preserving all semantic values.
507
revision_id: if not None, the revision history in the new branch will
508
be truncated to end with revision_id.
510
# for API compatibility, until 0.8 releases we provide the old api:
511
# def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
512
# after 0.8 releases, the *args and **kwargs should be changed:
513
# def clone(self, to_bzrdir, revision_id=None):
514
if (kwargs.get('to_location', None) or
515
kwargs.get('revision', None) or
516
kwargs.get('basis_branch', None) or
517
(len(args) and isinstance(args[0], basestring))):
518
# backwards compatibility api:
519
warn("Branch.clone() has been deprecated for BzrDir.clone() from"
520
" bzrlib 0.8.", DeprecationWarning, stacklevel=3)
523
basis_branch = args[2]
525
basis_branch = kwargs.get('basis_branch', None)
527
basis = basis_branch.bzrdir
532
revision_id = args[1]
534
revision_id = kwargs.get('revision', None)
539
# no default to raise if not provided.
540
url = kwargs.get('to_location')
541
return self.bzrdir.clone(url,
542
revision_id=revision_id,
543
basis=basis).open_branch()
545
# generate args by hand
547
revision_id = args[1]
549
revision_id = kwargs.get('revision_id', None)
553
# no default to raise if not provided.
554
to_bzrdir = kwargs.get('to_bzrdir')
555
result = self._format.initialize(to_bzrdir)
556
self.copy_content_into(result, revision_id=revision_id)
560
def sprout(self, to_bzrdir, revision_id=None):
561
"""Create a new line of development from the branch, into to_bzrdir.
563
revision_id: if not None, the revision history in the new branch will
564
be truncated to end with revision_id.
566
result = self._format.initialize(to_bzrdir)
567
self.copy_content_into(result, revision_id=revision_id)
568
result.set_parent(self.bzrdir.root_transport.base)
571
def _synchronize_history(self, destination, revision_id):
572
"""Synchronize last revision and revision history between branches.
574
This version is most efficient when the destination is also a
575
BzrBranch5, but works for BzrBranch6 as long as the revision
576
history is the true lefthand parent history, and all of the revisions
577
are in the destination's repository. If not, set_revision_history
580
:param destination: The branch to copy the history into
581
:param revision_id: The revision-id to truncate history at. May
582
be None to copy complete history.
584
new_history = self.revision_history()
585
if revision_id is not None:
586
revision_id = osutils.safe_revision_id(revision_id)
588
new_history = new_history[:new_history.index(revision_id) + 1]
590
rev = self.repository.get_revision(revision_id)
591
new_history = rev.get_history(self.repository)[1:]
592
destination.set_revision_history(new_history)
595
def copy_content_into(self, destination, revision_id=None):
596
"""Copy the content of self into destination.
598
revision_id: if not None, the revision history in the new branch will
599
be truncated to end with revision_id.
601
self._synchronize_history(destination, revision_id)
603
parent = self.get_parent()
604
except errors.InaccessibleParent, e:
605
mutter('parent was not accessible to copy: %s', e)
608
destination.set_parent(parent)
612
"""Check consistency of the branch.
614
In particular this checks that revisions given in the revision-history
615
do actually match up in the revision graph, and that they're all
616
present in the repository.
618
Callers will typically also want to check the repository.
620
:return: A BranchCheckResult.
622
mainline_parent_id = None
623
for revision_id in self.revision_history():
625
revision = self.repository.get_revision(revision_id)
626
except errors.NoSuchRevision, e:
627
raise errors.BzrCheckError("mainline revision {%s} not in repository"
629
# In general the first entry on the revision history has no parents.
630
# But it's not illegal for it to have parents listed; this can happen
631
# in imports from Arch when the parents weren't reachable.
632
if mainline_parent_id is not None:
633
if mainline_parent_id not in revision.parent_ids:
634
raise errors.BzrCheckError("previous revision {%s} not listed among "
636
% (mainline_parent_id, revision_id))
637
mainline_parent_id = revision_id
638
return BranchCheckResult(self)
640
def _get_checkout_format(self):
641
"""Return the most suitable metadir for a checkout of this branch.
642
Weaves are used if this branch's repostory uses weaves.
644
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
645
from bzrlib.repofmt import weaverepo
646
format = bzrdir.BzrDirMetaFormat1()
647
format.repository_format = weaverepo.RepositoryFormat7()
649
format = self.repository.bzrdir.cloning_metadir()
650
format.branch_format = self._format
653
def create_checkout(self, to_location, revision_id=None,
655
"""Create a checkout of a branch.
657
:param to_location: The url to produce the checkout at
658
:param revision_id: The revision to check out
659
:param lightweight: If True, produce a lightweight checkout, otherwise,
660
produce a bound branch (heavyweight checkout)
661
:return: The tree of the created checkout
663
t = transport.get_transport(to_location)
666
except errors.FileExists:
669
checkout = bzrdir.BzrDirMetaFormat1().initialize_on_transport(t)
670
BranchReferenceFormat().initialize(checkout, self)
672
format = self._get_checkout_format()
673
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
674
to_location, force_new_tree=False, format=format)
675
checkout = checkout_branch.bzrdir
676
checkout_branch.bind(self)
677
# pull up to the specified revision_id to set the initial
678
# branch tip correctly, and seed it with history.
679
checkout_branch.pull(self, stop_revision=revision_id)
680
return checkout.create_workingtree(revision_id)
683
class BranchFormat(object):
684
"""An encapsulation of the initialization and open routines for a format.
686
Formats provide three things:
687
* An initialization routine,
691
Formats are placed in an dict by their format string for reference
692
during branch opening. Its not required that these be instances, they
693
can be classes themselves with class methods - it simply depends on
694
whether state is needed for a given format or not.
696
Once a format is deprecated, just deprecate the initialize and open
697
methods on the format class. Do not deprecate the object, as the
698
object will be created every time regardless.
701
_default_format = None
702
"""The default format used for new branches."""
705
"""The known formats."""
708
def find_format(klass, a_bzrdir):
709
"""Return the format for the branch object in a_bzrdir."""
711
transport = a_bzrdir.get_branch_transport(None)
712
format_string = transport.get("format").read()
713
return klass._formats[format_string]
715
raise NotBranchError(path=transport.base)
717
raise errors.UnknownFormatError(format=format_string)
720
def get_default_format(klass):
721
"""Return the current default format."""
722
return klass._default_format
724
def get_format_string(self):
725
"""Return the ASCII format string that identifies this format."""
726
raise NotImplementedError(self.get_format_string)
728
def get_format_description(self):
729
"""Return the short format description for this format."""
730
raise NotImplementedError(self.get_format_description)
732
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
734
"""Initialize a branch in a bzrdir, with specified files
736
:param a_bzrdir: The bzrdir to initialize the branch in
737
:param utf8_files: The files to create as a list of
738
(filename, content) tuples
739
:param set_format: If True, set the format with
740
self.get_format_string. (BzrBranch4 has its format set
742
:return: a branch in this format
744
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
745
branch_transport = a_bzrdir.get_branch_transport(self)
747
'metadir': ('lock', lockdir.LockDir),
748
'branch4': ('branch-lock', lockable_files.TransportLock),
750
lock_name, lock_class = lock_map[lock_type]
751
control_files = lockable_files.LockableFiles(branch_transport,
752
lock_name, lock_class)
753
control_files.create_lock()
754
control_files.lock_write()
756
control_files.put_utf8('format', self.get_format_string())
758
for file, content in utf8_files:
759
control_files.put_utf8(file, content)
761
control_files.unlock()
762
return self.open(a_bzrdir, _found=True)
764
def initialize(self, a_bzrdir):
765
"""Create a branch of this format in a_bzrdir."""
766
raise NotImplementedError(self.initialize)
768
def is_supported(self):
769
"""Is this format supported?
771
Supported formats can be initialized and opened.
772
Unsupported formats may not support initialization or committing or
773
some other features depending on the reason for not being supported.
777
def open(self, a_bzrdir, _found=False):
778
"""Return the branch object for a_bzrdir
780
_found is a private parameter, do not use it. It is used to indicate
781
if format probing has already be done.
783
raise NotImplementedError(self.open)
786
def register_format(klass, format):
787
klass._formats[format.get_format_string()] = format
790
def set_default_format(klass, format):
791
klass._default_format = format
794
def unregister_format(klass, format):
795
assert klass._formats[format.get_format_string()] is format
796
del klass._formats[format.get_format_string()]
799
return self.get_format_string().rstrip()
802
class BranchHooks(dict):
803
"""A dictionary mapping hook name to a list of callables for branch hooks.
805
e.g. ['set_rh'] Is the list of items to be called when the
806
set_revision_history function is invoked.
810
"""Create the default hooks.
812
These are all empty initially, because by default nothing should get
816
# Introduced in 0.15:
817
# invoked whenever the revision history has been set
818
# with set_revision_history. The api signature is
819
# (branch, revision_history), and the branch will
822
# invoked after a push operation completes.
823
# the api signature is
824
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
825
# where local is the local branch or None, master is the target
826
# master branch, and the rest should be self explanatory. The source
827
# is read locked and the target branches write locked. Source will
828
# be the local low-latency branch.
829
self['post_push'] = []
830
# invoked after a pull operation completes.
831
# the api signature is
832
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
833
# where local is the local branch or None, master is the target
834
# master branch, and the rest should be self explanatory. The source
835
# is read locked and the target branches write locked. The local
836
# branch is the low-latency branch.
837
self['post_pull'] = []
838
# invoked after a commit operation completes.
839
# the api signature is
840
# (local, master, old_revno, old_revid, new_revno, new_revid)
841
# old_revid is NULL_REVISION for the first commit to a branch.
842
self['post_commit'] = []
843
# invoked after a uncommit operation completes.
844
# the api signature is
845
# (local, master, old_revno, old_revid, new_revno, new_revid) where
846
# local is the local branch or None, master is the target branch,
847
# and an empty branch recieves new_revno of 0, new_revid of None.
848
self['post_uncommit'] = []
850
def install_hook(self, hook_name, a_callable):
851
"""Install a_callable in to the hook hook_name.
853
:param hook_name: A hook name. See the __init__ method of BranchHooks
854
for the complete list of hooks.
855
:param a_callable: The callable to be invoked when the hook triggers.
856
The exact signature will depend on the hook - see the __init__
857
method of BranchHooks for details on each hook.
860
self[hook_name].append(a_callable)
862
raise errors.UnknownHook('branch', hook_name)
865
# install the default hooks into the Branch class.
866
Branch.hooks = BranchHooks()
869
class BzrBranchFormat4(BranchFormat):
870
"""Bzr branch format 4.
873
- a revision-history file.
874
- a branch-lock lock file [ to be shared with the bzrdir ]
877
def get_format_description(self):
878
"""See BranchFormat.get_format_description()."""
879
return "Branch format 4"
881
def initialize(self, a_bzrdir):
882
"""Create a branch of this format in a_bzrdir."""
883
utf8_files = [('revision-history', ''),
886
return self._initialize_helper(a_bzrdir, utf8_files,
887
lock_type='branch4', set_format=False)
890
super(BzrBranchFormat4, self).__init__()
891
self._matchingbzrdir = bzrdir.BzrDirFormat6()
893
def open(self, a_bzrdir, _found=False):
894
"""Return the branch object for a_bzrdir
896
_found is a private parameter, do not use it. It is used to indicate
897
if format probing has already be done.
900
# we are being called directly and must probe.
901
raise NotImplementedError
902
return BzrBranch(_format=self,
903
_control_files=a_bzrdir._control_files,
905
_repository=a_bzrdir.open_repository())
908
return "Bazaar-NG branch format 4"
911
class BzrBranchFormat5(BranchFormat):
912
"""Bzr branch format 5.
915
- a revision-history file.
917
- a lock dir guarding the branch itself
918
- all of this stored in a branch/ subdirectory
919
- works with shared repositories.
921
This format is new in bzr 0.8.
924
def get_format_string(self):
925
"""See BranchFormat.get_format_string()."""
926
return "Bazaar-NG branch format 5\n"
928
def get_format_description(self):
929
"""See BranchFormat.get_format_description()."""
930
return "Branch format 5"
932
def initialize(self, a_bzrdir):
933
"""Create a branch of this format in a_bzrdir."""
934
utf8_files = [('revision-history', ''),
937
return self._initialize_helper(a_bzrdir, utf8_files)
940
super(BzrBranchFormat5, self).__init__()
941
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
943
def open(self, a_bzrdir, _found=False):
944
"""Return the branch object for a_bzrdir
946
_found is a private parameter, do not use it. It is used to indicate
947
if format probing has already be done.
950
format = BranchFormat.find_format(a_bzrdir)
951
assert format.__class__ == self.__class__
952
transport = a_bzrdir.get_branch_transport(None)
953
control_files = lockable_files.LockableFiles(transport, 'lock',
955
return BzrBranch5(_format=self,
956
_control_files=control_files,
958
_repository=a_bzrdir.find_repository())
961
return "Bazaar-NG Metadir branch format 5"
964
class BzrBranchFormat6(BzrBranchFormat5):
965
"""Branch format with last-revision
967
Unlike previous formats, this has no explicit revision history. Instead,
968
this just stores the last-revision, and the left-hand history leading
969
up to there is the history.
971
This format was introduced in bzr 0.15
974
def get_format_string(self):
975
"""See BranchFormat.get_format_string()."""
976
return "Bazaar-NG branch format 6\n"
978
def get_format_description(self):
979
"""See BranchFormat.get_format_description()."""
980
return "Branch format 6"
982
def initialize(self, a_bzrdir):
983
"""Create a branch of this format in a_bzrdir."""
984
utf8_files = [('last-revision', '0 null:\n'),
988
return self._initialize_helper(a_bzrdir, utf8_files)
990
def open(self, a_bzrdir, _found=False):
991
"""Return the branch object for a_bzrdir
993
_found is a private parameter, do not use it. It is used to indicate
994
if format probing has already be done.
997
format = BranchFormat.find_format(a_bzrdir)
998
assert format.__class__ == self.__class__
999
transport = a_bzrdir.get_branch_transport(None)
1000
control_files = lockable_files.LockableFiles(transport, 'lock',
1002
return BzrBranch6(_format=self,
1003
_control_files=control_files,
1005
_repository=a_bzrdir.find_repository())
1008
class BranchReferenceFormat(BranchFormat):
1009
"""Bzr branch reference format.
1011
Branch references are used in implementing checkouts, they
1012
act as an alias to the real branch which is at some other url.
1019
def get_format_string(self):
1020
"""See BranchFormat.get_format_string()."""
1021
return "Bazaar-NG Branch Reference Format 1\n"
1023
def get_format_description(self):
1024
"""See BranchFormat.get_format_description()."""
1025
return "Checkout reference format 1"
1027
def initialize(self, a_bzrdir, target_branch=None):
1028
"""Create a branch of this format in a_bzrdir."""
1029
if target_branch is None:
1030
# this format does not implement branch itself, thus the implicit
1031
# creation contract must see it as uninitializable
1032
raise errors.UninitializableFormat(self)
1033
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1034
branch_transport = a_bzrdir.get_branch_transport(self)
1035
branch_transport.put_bytes('location',
1036
target_branch.bzrdir.root_transport.base)
1037
branch_transport.put_bytes('format', self.get_format_string())
1038
return self.open(a_bzrdir, _found=True)
1041
super(BranchReferenceFormat, self).__init__()
1042
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1044
def _make_reference_clone_function(format, a_branch):
1045
"""Create a clone() routine for a branch dynamically."""
1046
def clone(to_bzrdir, revision_id=None):
1047
"""See Branch.clone()."""
1048
return format.initialize(to_bzrdir, a_branch)
1049
# cannot obey revision_id limits when cloning a reference ...
1050
# FIXME RBC 20060210 either nuke revision_id for clone, or
1051
# emit some sort of warning/error to the caller ?!
1054
def open(self, a_bzrdir, _found=False):
1055
"""Return the branch that the branch reference in a_bzrdir points at.
1057
_found is a private parameter, do not use it. It is used to indicate
1058
if format probing has already be done.
1061
format = BranchFormat.find_format(a_bzrdir)
1062
assert format.__class__ == self.__class__
1063
transport = a_bzrdir.get_branch_transport(None)
1064
real_bzrdir = bzrdir.BzrDir.open(transport.get('location').read())
1065
result = real_bzrdir.open_branch()
1066
# this changes the behaviour of result.clone to create a new reference
1067
# rather than a copy of the content of the branch.
1068
# I did not use a proxy object because that needs much more extensive
1069
# testing, and we are only changing one behaviour at the moment.
1070
# If we decide to alter more behaviours - i.e. the implicit nickname
1071
# then this should be refactored to introduce a tested proxy branch
1072
# and a subclass of that for use in overriding clone() and ....
1074
result.clone = self._make_reference_clone_function(result)
1078
# formats which have no format string are not discoverable
1079
# and not independently creatable, so are not registered.
1080
__default_format = BzrBranchFormat5()
1081
BranchFormat.register_format(__default_format)
1082
BranchFormat.register_format(BranchReferenceFormat())
1083
BranchFormat.register_format(BzrBranchFormat6())
1084
BranchFormat.set_default_format(__default_format)
1085
_legacy_formats = [BzrBranchFormat4(),
1088
class BzrBranch(Branch):
1089
"""A branch stored in the actual filesystem.
1091
Note that it's "local" in the context of the filesystem; it doesn't
1092
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1093
it's writable, and can be accessed via the normal filesystem API.
1096
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
1097
relax_version_check=DEPRECATED_PARAMETER, _format=None,
1098
_control_files=None, a_bzrdir=None, _repository=None):
1099
"""Create new branch object at a particular location.
1101
transport -- A Transport object, defining how to access files.
1103
init -- If True, create new control files in a previously
1104
unversioned directory. If False, the branch must already
1107
relax_version_check -- If true, the usual check for the branch
1108
version is not applied. This is intended only for
1109
upgrade/recovery type use; it's not guaranteed that
1110
all operations will work on old format branches.
1112
if a_bzrdir is None:
1113
self.bzrdir = bzrdir.BzrDir.open(transport.base)
1115
self.bzrdir = a_bzrdir
1116
self._transport = self.bzrdir.transport.clone('..')
1117
self._base = self._transport.base
1118
self._format = _format
1119
if _control_files is None:
1120
raise ValueError('BzrBranch _control_files is None')
1121
self.control_files = _control_files
1122
if deprecated_passed(init):
1123
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
1124
"deprecated as of bzr 0.8. Please use Branch.create().",
1128
# this is slower than before deprecation, oh well never mind.
1129
# -> its deprecated.
1130
self._initialize(transport.base)
1131
self._check_format(_format)
1132
if deprecated_passed(relax_version_check):
1133
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
1134
"relax_version_check parameter is deprecated as of bzr 0.8. "
1135
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
1139
if (not relax_version_check
1140
and not self._format.is_supported()):
1141
raise errors.UnsupportedFormatError(format=fmt)
1142
if deprecated_passed(transport):
1143
warn("BzrBranch.__init__(transport=XXX...): The transport "
1144
"parameter is deprecated as of bzr 0.8. "
1145
"Please use Branch.open, or bzrdir.open_branch().",
1148
self.repository = _repository
1151
return '%s(%r)' % (self.__class__.__name__, self.base)
1155
def _get_base(self):
1158
base = property(_get_base, doc="The URL for the root of this branch.")
1160
def _finish_transaction(self):
1161
"""Exit the current transaction."""
1162
return self.control_files._finish_transaction()
1164
def get_transaction(self):
1165
"""Return the current active transaction.
1167
If no transaction is active, this returns a passthrough object
1168
for which all data is immediately flushed and no caching happens.
1170
# this is an explicit function so that we can do tricky stuff
1171
# when the storage in rev_storage is elsewhere.
1172
# we probably need to hook the two 'lock a location' and
1173
# 'have a transaction' together more delicately, so that
1174
# we can have two locks (branch and storage) and one transaction
1175
# ... and finishing the transaction unlocks both, but unlocking
1176
# does not. - RBC 20051121
1177
return self.control_files.get_transaction()
1179
def _set_transaction(self, transaction):
1180
"""Set a new active transaction."""
1181
return self.control_files._set_transaction(transaction)
1183
def abspath(self, name):
1184
"""See Branch.abspath."""
1185
return self.control_files._transport.abspath(name)
1187
def _check_format(self, format):
1188
"""Identify the branch format if needed.
1190
The format is stored as a reference to the format object in
1191
self._format for code that needs to check it later.
1193
The format parameter is either None or the branch format class
1194
used to open this branch.
1196
FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
1199
format = BranchFormat.find_format(self.bzrdir)
1200
self._format = format
1201
mutter("got branch format %s", self._format)
1204
def get_root_id(self):
1205
"""See Branch.get_root_id."""
1206
tree = self.repository.revision_tree(self.last_revision())
1207
return tree.inventory.root.file_id
1209
def is_locked(self):
1210
return self.control_files.is_locked()
1212
def lock_write(self):
1213
self.repository.lock_write()
1215
self.control_files.lock_write()
1217
self.repository.unlock()
1220
def lock_read(self):
1221
self.repository.lock_read()
1223
self.control_files.lock_read()
1225
self.repository.unlock()
1229
# TODO: test for failed two phase locks. This is known broken.
1231
self.control_files.unlock()
1233
self.repository.unlock()
1235
def peek_lock_mode(self):
1236
if self.control_files._lock_count == 0:
1239
return self.control_files._lock_mode
1241
def get_physical_lock_status(self):
1242
return self.control_files.get_physical_lock_status()
1245
def print_file(self, file, revision_id):
1246
"""See Branch.print_file."""
1247
return self.repository.print_file(file, revision_id)
1250
def append_revision(self, *revision_ids):
1251
"""See Branch.append_revision."""
1252
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1253
for revision_id in revision_ids:
1254
_mod_revision.check_not_reserved_id(revision_id)
1255
mutter("add {%s} to revision-history" % revision_id)
1256
rev_history = self.revision_history()
1257
rev_history.extend(revision_ids)
1258
self.set_revision_history(rev_history)
1260
def _write_revision_history(self, history):
1261
"""Factored out of set_revision_history.
1263
This performs the actual writing to disk.
1264
It is intended to be called by BzrBranch5.set_revision_history."""
1265
self.control_files.put_bytes(
1266
'revision-history', '\n'.join(history))
1269
def set_revision_history(self, rev_history):
1270
"""See Branch.set_revision_history."""
1271
rev_history = [osutils.safe_revision_id(r) for r in rev_history]
1272
self._write_revision_history(rev_history)
1273
transaction = self.get_transaction()
1274
history = transaction.map.find_revision_history()
1275
if history is not None:
1276
# update the revision history in the identity map.
1277
history[:] = list(rev_history)
1278
# this call is disabled because revision_history is
1279
# not really an object yet, and the transaction is for objects.
1280
# transaction.register_dirty(history)
1282
transaction.map.add_revision_history(rev_history)
1283
# this call is disabled because revision_history is
1284
# not really an object yet, and the transaction is for objects.
1285
# transaction.register_clean(history)
1286
for hook in Branch.hooks['set_rh']:
1287
hook(self, rev_history)
1290
def set_last_revision_info(self, revno, revision_id):
1291
revision_id = osutils.safe_revision_id(revision_id)
1292
history = self._lefthand_history(revision_id)
1293
assert len(history) == revno, '%d != %d' % (len(history), revno)
1294
self.set_revision_history(history)
1296
def _gen_revision_history(self):
1297
get_cached_utf8 = cache_utf8.get_cached_utf8
1298
history = [get_cached_utf8(l.rstrip('\r\n')) for l in
1299
self.control_files.get('revision-history').readlines()]
1303
def revision_history(self):
1304
"""See Branch.revision_history."""
1305
transaction = self.get_transaction()
1306
history = transaction.map.find_revision_history()
1307
if history is not None:
1308
# mutter("cache hit for revision-history in %s", self)
1309
return list(history)
1310
history = self._gen_revision_history()
1311
transaction.map.add_revision_history(history)
1312
# this call is disabled because revision_history is
1313
# not really an object yet, and the transaction is for objects.
1314
# transaction.register_clean(history, precious=True)
1315
return list(history)
1317
def _lefthand_history(self, revision_id, last_rev=None,
1319
# stop_revision must be a descendant of last_revision
1320
stop_graph = self.repository.get_revision_graph(revision_id)
1321
if last_rev is not None and last_rev not in stop_graph:
1322
# our previous tip is not merged into stop_revision
1323
raise errors.DivergedBranches(self, other_branch)
1324
# make a new revision history from the graph
1325
current_rev_id = revision_id
1327
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1328
new_history.append(current_rev_id)
1329
current_rev_id_parents = stop_graph[current_rev_id]
1331
current_rev_id = current_rev_id_parents[0]
1333
current_rev_id = None
1334
new_history.reverse()
1338
def generate_revision_history(self, revision_id, last_rev=None,
1340
"""Create a new revision history that will finish with revision_id.
1342
:param revision_id: the new tip to use.
1343
:param last_rev: The previous last_revision. If not None, then this
1344
must be a ancestory of revision_id, or DivergedBranches is raised.
1345
:param other_branch: The other branch that DivergedBranches should
1346
raise with respect to.
1348
revision_id = osutils.safe_revision_id(revision_id)
1349
self.set_revision_history(self._lefthand_history(revision_id,
1350
last_rev, other_branch))
1353
def update_revisions(self, other, stop_revision=None):
1354
"""See Branch.update_revisions."""
1357
if stop_revision is None:
1358
stop_revision = other.last_revision()
1359
if stop_revision is None:
1360
# if there are no commits, we're done.
1363
stop_revision = osutils.safe_revision_id(stop_revision)
1364
# whats the current last revision, before we fetch [and change it
1366
last_rev = self.last_revision()
1367
# we fetch here regardless of whether we need to so that we pickup
1369
self.fetch(other, stop_revision)
1370
my_ancestry = self.repository.get_ancestry(last_rev)
1371
if stop_revision in my_ancestry:
1372
# last_revision is a descendant of stop_revision
1374
self.generate_revision_history(stop_revision, last_rev=last_rev,
1379
def basis_tree(self):
1380
"""See Branch.basis_tree."""
1381
return self.repository.revision_tree(self.last_revision())
1383
@deprecated_method(zero_eight)
1384
def working_tree(self):
1385
"""Create a Working tree object for this branch."""
1387
from bzrlib.transport.local import LocalTransport
1388
if (self.base.find('://') != -1 or
1389
not isinstance(self._transport, LocalTransport)):
1390
raise NoWorkingTree(self.base)
1391
return self.bzrdir.open_workingtree()
1394
def pull(self, source, overwrite=False, stop_revision=None,
1395
_hook_master=None, _run_hooks=True):
1398
:param _hook_master: Private parameter - set the branch to
1399
be supplied as the master to push hooks.
1400
:param _run_hooks: Private parameter - allow disabling of
1401
hooks, used when pushing to a master branch.
1403
result = PullResult()
1404
result.source = source
1407
result.old_revno, result.old_revid = self.last_revision_info()
1409
self.update_revisions(source, stop_revision)
1410
except DivergedBranches:
1414
self.set_revision_history(source.revision_history())
1415
result.new_revno, result.new_revid = self.last_revision_info()
1418
result.master = _hook_master
1421
result.master = self
1423
for hook in Branch.hooks['post_pull']:
1429
def _get_parent_location(self):
1430
_locs = ['parent', 'pull', 'x-pull']
1433
return self.control_files.get(l).read().strip('\n')
1439
def push(self, target, overwrite=False, stop_revision=None,
1440
_hook_master=None, _run_hooks=True):
1443
:param _hook_master: Private parameter - set the branch to
1444
be supplied as the master to push hooks.
1445
:param _run_hooks: Private parameter - allow disabling of
1446
hooks, used when pushing to a master branch.
1450
old_count, old_tip = target.last_revision_info()
1452
target.update_revisions(self, stop_revision)
1453
except DivergedBranches:
1457
target.set_revision_history(self.revision_history())
1458
new_count, new_tip = target.last_revision_info()
1461
_hook_local = target
1463
_hook_master = target
1465
for hook in Branch.hooks['post_push']:
1466
hook(self, _hook_local, _hook_master, old_count, old_tip,
1468
return new_count - old_count
1472
def get_parent(self):
1473
"""See Branch.get_parent."""
1475
assert self.base[-1] == '/'
1476
parent = self._get_parent_location()
1479
# This is an old-format absolute path to a local branch
1480
# turn it into a url
1481
if parent.startswith('/'):
1482
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1484
return urlutils.join(self.base[:-1], parent)
1485
except errors.InvalidURLJoin, e:
1486
raise errors.InaccessibleParent(parent, self.base)
1488
def get_push_location(self):
1489
"""See Branch.get_push_location."""
1490
push_loc = self.get_config().get_user_option('push_location')
1493
def set_push_location(self, location):
1494
"""See Branch.set_push_location."""
1495
self.get_config().set_user_option(
1496
'push_location', location,
1497
store=_mod_config.STORE_LOCATION_NORECURSE)
1500
def set_parent(self, url):
1501
"""See Branch.set_parent."""
1502
# TODO: Maybe delete old location files?
1503
# URLs should never be unicode, even on the local fs,
1504
# FIXUP this and get_parent in a future branch format bump:
1505
# read and rewrite the file, and have the new format code read
1506
# using .get not .get_utf8. RBC 20060125
1508
if isinstance(url, unicode):
1510
url = url.encode('ascii')
1511
except UnicodeEncodeError:
1512
raise bzrlib.errors.InvalidURL(url,
1513
"Urls must be 7-bit ascii, "
1514
"use bzrlib.urlutils.escape")
1515
url = urlutils.relative_url(self.base, url)
1516
self._set_parent_location(url)
1518
def _set_parent_location(self, url):
1520
self.control_files._transport.delete('parent')
1522
assert isinstance(url, str)
1523
self.control_files.put_bytes('parent', url + '\n')
1525
@deprecated_function(zero_nine)
1526
def tree_config(self):
1527
"""DEPRECATED; call get_config instead.
1528
TreeConfig has become part of BranchConfig."""
1529
return TreeConfig(self)
1532
class BzrBranch5(BzrBranch):
1533
"""A format 5 branch. This supports new features over plan branches.
1535
It has support for a master_branch which is the data for bound branches.
1543
super(BzrBranch5, self).__init__(_format=_format,
1544
_control_files=_control_files,
1546
_repository=_repository)
1549
def pull(self, source, overwrite=False, stop_revision=None,
1551
"""Extends branch.pull to be bound branch aware.
1553
:param _run_hooks: Private parameter used to force hook running
1554
off during bound branch double-pushing.
1556
bound_location = self.get_bound_location()
1557
master_branch = None
1558
if bound_location and source.base != bound_location:
1559
# not pulling from master, so we need to update master.
1560
master_branch = self.get_master_branch()
1561
master_branch.lock_write()
1564
# pull from source into master.
1565
master_branch.pull(source, overwrite, stop_revision,
1567
return super(BzrBranch5, self).pull(source, overwrite,
1568
stop_revision, _hook_master=master_branch,
1569
_run_hooks=_run_hooks)
1572
master_branch.unlock()
1575
def push(self, target, overwrite=False, stop_revision=None):
1576
"""Updates branch.push to be bound branch aware."""
1577
bound_location = target.get_bound_location()
1578
master_branch = None
1579
if bound_location and target.base != bound_location:
1580
# not pushing to master, so we need to update master.
1581
master_branch = target.get_master_branch()
1582
master_branch.lock_write()
1585
# push into the master from this branch.
1586
super(BzrBranch5, self).push(master_branch, overwrite,
1587
stop_revision, _run_hooks=False)
1588
# and push into the target branch from this. Note that we push from
1589
# this branch again, because its considered the highest bandwidth
1591
return super(BzrBranch5, self).push(target, overwrite,
1592
stop_revision, _hook_master=master_branch)
1595
master_branch.unlock()
1597
def get_bound_location(self):
1599
return self.control_files.get_utf8('bound').read()[:-1]
1600
except errors.NoSuchFile:
1604
def get_master_branch(self):
1605
"""Return the branch we are bound to.
1607
:return: Either a Branch, or None
1609
This could memoise the branch, but if thats done
1610
it must be revalidated on each new lock.
1611
So for now we just don't memoise it.
1612
# RBC 20060304 review this decision.
1614
bound_loc = self.get_bound_location()
1618
return Branch.open(bound_loc)
1619
except (errors.NotBranchError, errors.ConnectionError), e:
1620
raise errors.BoundBranchConnectionFailure(
1624
def set_bound_location(self, location):
1625
"""Set the target where this branch is bound to.
1627
:param location: URL to the target branch
1630
self.control_files.put_utf8('bound', location+'\n')
1633
self.control_files._transport.delete('bound')
1639
def bind(self, other):
1640
"""Bind this branch to the branch other.
1642
This does not push or pull data between the branches, though it does
1643
check for divergence to raise an error when the branches are not
1644
either the same, or one a prefix of the other. That behaviour may not
1645
be useful, so that check may be removed in future.
1647
:param other: The branch to bind to
1650
# TODO: jam 20051230 Consider checking if the target is bound
1651
# It is debatable whether you should be able to bind to
1652
# a branch which is itself bound.
1653
# Committing is obviously forbidden,
1654
# but binding itself may not be.
1655
# Since we *have* to check at commit time, we don't
1656
# *need* to check here
1658
# we want to raise diverged if:
1659
# last_rev is not in the other_last_rev history, AND
1660
# other_last_rev is not in our history, and do it without pulling
1662
last_rev = self.last_revision()
1663
if last_rev is not None:
1666
other_last_rev = other.last_revision()
1667
if other_last_rev is not None:
1668
# neither branch is new, we have to do some work to
1669
# ascertain diversion.
1670
remote_graph = other.repository.get_revision_graph(
1672
local_graph = self.repository.get_revision_graph(last_rev)
1673
if (last_rev not in remote_graph and
1674
other_last_rev not in local_graph):
1675
raise errors.DivergedBranches(self, other)
1678
self.set_bound_location(other.base)
1682
"""If bound, unbind"""
1683
return self.set_bound_location(None)
1687
"""Synchronise this branch with the master branch if any.
1689
:return: None or the last_revision that was pivoted out during the
1692
master = self.get_master_branch()
1693
if master is not None:
1694
old_tip = self.last_revision()
1695
self.pull(master, overwrite=True)
1696
if old_tip in self.repository.get_ancestry(self.last_revision()):
1702
class BzrBranch6(BzrBranch5):
1705
def last_revision_info(self):
1706
revision_string = self.control_files.get('last-revision').read()
1707
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1708
revision_id = cache_utf8.get_cached_utf8(revision_id)
1710
return revno, revision_id
1712
def last_revision(self):
1713
"""Return last revision id, or None"""
1714
revision_id = self.last_revision_info()[1]
1715
if revision_id == _mod_revision.NULL_REVISION:
1719
def _write_last_revision_info(self, revno, revision_id):
1720
"""Simply write out the revision id, with no checks.
1722
Use set_last_revision_info to perform this safely.
1724
Does not update the revision_history cache.
1725
Intended to be called by set_last_revision_info and
1726
_write_revision_history.
1728
if revision_id is None:
1729
revision_id = 'null:'
1730
out_string = '%d %s\n' % (revno, revision_id)
1731
self.control_files.put_bytes('last-revision', out_string)
1734
def set_last_revision_info(self, revno, revision_id):
1735
revision_id = osutils.safe_revision_id(revision_id)
1736
if self._get_append_revisions_only():
1737
self._check_history_violation(revision_id)
1738
self._write_last_revision_info(revno, revision_id)
1739
transaction = self.get_transaction()
1740
cached_history = transaction.map.find_revision_history()
1741
if cached_history is not None:
1742
transaction.map.remove_object(cached_history)
1744
def _check_history_violation(self, revision_id):
1745
last_revision = self.last_revision()
1746
if last_revision is None:
1748
if last_revision not in self._lefthand_history(revision_id):
1749
raise errors.AppendRevisionsOnlyViolation(self.base)
1751
def _gen_revision_history(self):
1752
"""Generate the revision history from last revision
1754
history = list(self.repository.iter_reverse_revision_history(
1755
self.last_revision()))
1759
def _write_revision_history(self, history):
1760
"""Factored out of set_revision_history.
1762
This performs the actual writing to disk, with format-specific checks.
1763
It is intended to be called by BzrBranch5.set_revision_history.
1765
if len(history) == 0:
1766
last_revision = 'null:'
1768
if history != self._lefthand_history(history[-1]):
1769
raise errors.NotLefthandHistory(history)
1770
last_revision = history[-1]
1771
if self._get_append_revisions_only():
1772
self._check_history_violation(last_revision)
1773
self._write_last_revision_info(len(history), last_revision)
1776
def append_revision(self, *revision_ids):
1777
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1778
if len(revision_ids) == 0:
1780
prev_revno, prev_revision = self.last_revision_info()
1781
for revision in self.repository.get_revisions(revision_ids):
1782
if prev_revision == _mod_revision.NULL_REVISION:
1783
if revision.parent_ids != []:
1784
raise errors.NotLeftParentDescendant(self, prev_revision,
1785
revision.revision_id)
1787
if revision.parent_ids[0] != prev_revision:
1788
raise errors.NotLeftParentDescendant(self, prev_revision,
1789
revision.revision_id)
1790
prev_revision = revision.revision_id
1791
self.set_last_revision_info(prev_revno + len(revision_ids),
1794
def _set_config_location(self, name, url, config=None,
1795
make_relative=False):
1797
config = self.get_config()
1801
url = urlutils.relative_url(self.base, url)
1802
config.set_user_option(name, url)
1805
def _get_config_location(self, name, config=None):
1807
config = self.get_config()
1808
location = config.get_user_option(name)
1814
def _set_parent_location(self, url):
1815
"""Set the parent branch"""
1816
self._set_config_location('parent_location', url, make_relative=True)
1819
def _get_parent_location(self):
1820
"""Set the parent branch"""
1821
return self._get_config_location('parent_location')
1823
def set_push_location(self, location):
1824
"""See Branch.set_push_location."""
1825
self._set_config_location('push_location', location)
1827
def set_bound_location(self, location):
1828
"""See Branch.set_push_location."""
1830
config = self.get_config()
1831
if location is None:
1832
if config.get_user_option('bound') != 'True':
1835
config.set_user_option('bound', 'False')
1838
self._set_config_location('bound_location', location,
1840
config.set_user_option('bound', 'True')
1843
def _get_bound_location(self, bound):
1844
"""Return the bound location in the config file.
1846
Return None if the bound parameter does not match"""
1847
config = self.get_config()
1848
config_bound = (config.get_user_option('bound') == 'True')
1849
if config_bound != bound:
1851
return self._get_config_location('bound_location', config=config)
1853
def get_bound_location(self):
1854
"""See Branch.set_push_location."""
1855
return self._get_bound_location(True)
1857
def get_old_bound_location(self):
1858
"""See Branch.get_old_bound_location"""
1859
return self._get_bound_location(False)
1861
def set_append_revisions_only(self, enabled):
1866
self.get_config().set_user_option('append_revisions_only', value)
1868
def _get_append_revisions_only(self):
1869
value = self.get_config().get_user_option('append_revisions_only')
1870
return value == 'True'
1872
def _synchronize_history(self, destination, revision_id):
1873
"""Synchronize last revision and revision history between branches.
1875
This version is most efficient when the destination is also a
1876
BzrBranch6, but works for BzrBranch5, as long as the destination's
1877
repository contains all the lefthand ancestors of the intended
1878
last_revision. If not, set_last_revision_info will fail.
1880
:param destination: The branch to copy the history into
1881
:param revision_id: The revision-id to truncate history at. May
1882
be None to copy complete history.
1884
if revision_id is None:
1885
revno, revision_id = self.last_revision_info()
1887
revno = self.revision_id_to_revno(revision_id)
1888
destination.set_last_revision_info(revno, revision_id)
1891
class BranchTestProviderAdapter(object):
1892
"""A tool to generate a suite testing multiple branch formats at once.
1894
This is done by copying the test once for each transport and injecting
1895
the transport_server, transport_readonly_server, and branch_format
1896
classes into each copy. Each copy is also given a new id() to make it
1900
def __init__(self, transport_server, transport_readonly_server, formats):
1901
self._transport_server = transport_server
1902
self._transport_readonly_server = transport_readonly_server
1903
self._formats = formats
1905
def adapt(self, test):
1906
result = TestSuite()
1907
for branch_format, bzrdir_format in self._formats:
1908
new_test = deepcopy(test)
1909
new_test.transport_server = self._transport_server
1910
new_test.transport_readonly_server = self._transport_readonly_server
1911
new_test.bzrdir_format = bzrdir_format
1912
new_test.branch_format = branch_format
1913
def make_new_test_id():
1914
new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
1915
return lambda: new_id
1916
new_test.id = make_new_test_id()
1917
result.addTest(new_test)
1921
######################################################################
1922
# results of operations
1924
class PullResult(object):
1927
# somewhat deprecated: pull used to return the change in revno
1928
return self.new_revno - self.old_revno
1931
class BranchCheckResult(object):
1932
"""Results of checking branch consistency.
1937
def __init__(self, branch):
1938
self.branch = branch
1940
def report_results(self, verbose):
1941
"""Report the check results via trace.note.
1943
:param verbose: Requests more detailed display of what was checked,
1946
note('checked branch %s format %s',
1948
self.branch._format)
1951
class Converter5to6(object):
1952
"""Perform an in-place upgrade of format 5 to format 6"""
1954
def convert(self, branch):
1955
# Data for 5 and 6 can peacefully coexist.
1956
format = BzrBranchFormat6()
1957
new_branch = format.open(branch.bzrdir, _found=True)
1959
# Copy source data into target
1960
new_branch.set_last_revision_info(*branch.last_revision_info())
1961
new_branch.set_parent(branch.get_parent())
1962
new_branch.set_bound_location(branch.get_bound_location())
1963
new_branch.set_push_location(branch.get_push_location())
1965
# Copying done; now update target format
1966
new_branch.control_files.put_utf8('format',
1967
format.get_format_string())
1969
# Clean up old files
1970
new_branch.control_files._transport.delete('revision-history')
1972
branch.set_parent(None)
1975
branch.set_bound_location(None)
added
removed
bzrlib/branch.py
