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
history = self.revision_history()
383
return history.index(revision_id) + 1
385
raise bzrlib.errors.NoSuchRevision(self, revision_id)
387
def get_rev_id(self, revno, history=None):
388
"""Find the revision id of the specified revno."""
392
history = self.revision_history()
393
if revno <= 0 or revno > len(history):
394
raise bzrlib.errors.NoSuchRevision(self, revno)
395
return history[revno - 1]
397
def pull(self, source, overwrite=False, stop_revision=None):
398
"""Mirror source into this branch.
400
This branch is considered to be 'local', having low latency.
402
raise NotImplementedError(self.pull)
404
def push(self, target, overwrite=False, stop_revision=None):
405
"""Mirror this branch into target.
407
This branch is considered to be 'local', having low latency.
409
raise NotImplementedError(self.push)
411
def basis_tree(self):
412
"""Return `Tree` object for last revision."""
413
return self.repository.revision_tree(self.last_revision())
415
def rename_one(self, from_rel, to_rel):
418
This can change the directory or the filename or both.
420
raise NotImplementedError(self.rename_one)
422
def move(self, from_paths, to_name):
425
to_name must exist as a versioned directory.
427
If to_name exists and is a directory, the files are moved into
428
it, keeping their old names. If it is a directory,
430
Note that to_name is only the last component of the new name;
431
this doesn't change the directory.
433
This returns a list of (from_path, to_path) pairs for each
436
raise NotImplementedError(self.move)
438
def get_parent(self):
439
"""Return the parent location of the branch.
441
This is the default location for push/pull/missing. The usual
442
pattern is that the user can override it by specifying a
445
raise NotImplementedError(self.get_parent)
447
def get_submit_branch(self):
448
"""Return the submit location of the branch.
450
This is the default location for bundle. The usual
451
pattern is that the user can override it by specifying a
454
return self.get_config().get_user_option('submit_branch')
456
def set_submit_branch(self, location):
457
"""Return the submit location of the branch.
459
This is the default location for bundle. The usual
460
pattern is that the user can override it by specifying a
463
self.get_config().set_user_option('submit_branch', location)
465
def get_push_location(self):
466
"""Return the None or the location to push this branch to."""
467
raise NotImplementedError(self.get_push_location)
469
def set_push_location(self, location):
470
"""Set a new push location for this branch."""
471
raise NotImplementedError(self.set_push_location)
473
def set_parent(self, url):
474
raise NotImplementedError(self.set_parent)
478
"""Synchronise this branch with the master branch if any.
480
:return: None or the last_revision pivoted out during the update.
484
def check_revno(self, revno):
486
Check whether a revno corresponds to any revision.
487
Zero (the NULL revision) is considered valid.
490
self.check_real_revno(revno)
492
def check_real_revno(self, revno):
494
Check whether a revno corresponds to a real revision.
495
Zero (the NULL revision) is considered invalid
497
if revno < 1 or revno > self.revno():
498
raise InvalidRevisionNumber(revno)
501
def clone(self, *args, **kwargs):
502
"""Clone this branch into to_bzrdir preserving all semantic values.
504
revision_id: if not None, the revision history in the new branch will
505
be truncated to end with revision_id.
507
# for API compatibility, until 0.8 releases we provide the old api:
508
# def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
509
# after 0.8 releases, the *args and **kwargs should be changed:
510
# def clone(self, to_bzrdir, revision_id=None):
511
if (kwargs.get('to_location', None) or
512
kwargs.get('revision', None) or
513
kwargs.get('basis_branch', None) or
514
(len(args) and isinstance(args[0], basestring))):
515
# backwards compatibility api:
516
warn("Branch.clone() has been deprecated for BzrDir.clone() from"
517
" bzrlib 0.8.", DeprecationWarning, stacklevel=3)
520
basis_branch = args[2]
522
basis_branch = kwargs.get('basis_branch', None)
524
basis = basis_branch.bzrdir
529
revision_id = args[1]
531
revision_id = kwargs.get('revision', None)
536
# no default to raise if not provided.
537
url = kwargs.get('to_location')
538
return self.bzrdir.clone(url,
539
revision_id=revision_id,
540
basis=basis).open_branch()
542
# generate args by hand
544
revision_id = args[1]
546
revision_id = kwargs.get('revision_id', None)
550
# no default to raise if not provided.
551
to_bzrdir = kwargs.get('to_bzrdir')
552
result = self._format.initialize(to_bzrdir)
553
self.copy_content_into(result, revision_id=revision_id)
557
def sprout(self, to_bzrdir, revision_id=None):
558
"""Create a new line of development from the branch, into to_bzrdir.
560
revision_id: if not None, the revision history in the new branch will
561
be truncated to end with revision_id.
563
result = self._format.initialize(to_bzrdir)
564
self.copy_content_into(result, revision_id=revision_id)
565
result.set_parent(self.bzrdir.root_transport.base)
568
def _synchronize_history(self, destination, revision_id):
569
"""Synchronize last revision and revision history between branches.
571
This version is most efficient when the destination is also a
572
BzrBranch5, but works for BzrBranch6 as long as the revision
573
history is the true lefthand parent history, and all of the revisions
574
are in the destination's repository. If not, set_revision_history
577
:param destination: The branch to copy the history into
578
:param revision_id: The revision-id to truncate history at. May
579
be None to copy complete history.
581
new_history = self.revision_history()
582
if revision_id is not None:
584
new_history = new_history[:new_history.index(revision_id) + 1]
586
rev = self.repository.get_revision(revision_id)
587
new_history = rev.get_history(self.repository)[1:]
588
destination.set_revision_history(new_history)
591
def copy_content_into(self, destination, revision_id=None):
592
"""Copy the content of self into destination.
594
revision_id: if not None, the revision history in the new branch will
595
be truncated to end with revision_id.
597
self._synchronize_history(destination, revision_id)
599
parent = self.get_parent()
600
except errors.InaccessibleParent, e:
601
mutter('parent was not accessible to copy: %s', e)
604
destination.set_parent(parent)
608
"""Check consistency of the branch.
610
In particular this checks that revisions given in the revision-history
611
do actually match up in the revision graph, and that they're all
612
present in the repository.
614
Callers will typically also want to check the repository.
616
:return: A BranchCheckResult.
618
mainline_parent_id = None
619
for revision_id in self.revision_history():
621
revision = self.repository.get_revision(revision_id)
622
except errors.NoSuchRevision, e:
623
raise errors.BzrCheckError("mainline revision {%s} not in repository"
625
# In general the first entry on the revision history has no parents.
626
# But it's not illegal for it to have parents listed; this can happen
627
# in imports from Arch when the parents weren't reachable.
628
if mainline_parent_id is not None:
629
if mainline_parent_id not in revision.parent_ids:
630
raise errors.BzrCheckError("previous revision {%s} not listed among "
632
% (mainline_parent_id, revision_id))
633
mainline_parent_id = revision_id
634
return BranchCheckResult(self)
636
def _get_checkout_format(self):
637
"""Return the most suitable metadir for a checkout of this branch.
638
Weaves are used if this branch's repostory uses weaves.
640
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
641
from bzrlib.repofmt import weaverepo
642
format = bzrdir.BzrDirMetaFormat1()
643
format.repository_format = weaverepo.RepositoryFormat7()
645
format = self.repository.bzrdir.checkout_metadir()
646
format.branch_format = self._format
649
def create_checkout(self, to_location, revision_id=None,
651
"""Create a checkout of a branch.
653
:param to_location: The url to produce the checkout at
654
:param revision_id: The revision to check out
655
:param lightweight: If True, produce a lightweight checkout, otherwise,
656
produce a bound branch (heavyweight checkout)
657
:return: The tree of the created checkout
659
t = transport.get_transport(to_location)
662
except errors.FileExists:
665
format = self._get_checkout_format()
666
checkout = format.initialize_on_transport(t)
667
BranchReferenceFormat().initialize(checkout, self)
669
format = self._get_checkout_format()
670
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
671
to_location, force_new_tree=False, format=format)
672
checkout = checkout_branch.bzrdir
673
checkout_branch.bind(self)
674
# pull up to the specified revision_id to set the initial
675
# branch tip correctly, and seed it with history.
676
checkout_branch.pull(self, stop_revision=revision_id)
677
tree = checkout.create_workingtree(revision_id)
678
for path, entry in tree.iter_reference_entries():
679
path = tree.id2path(entry.file_id)
680
reference_parent = self.reference_parent(entry.file_id, path)
681
reference_parent.create_checkout(tree.abspath(path),
682
entry.reference_revision,
686
def reference_parent(self, file_id, path):
687
"""Return the parent branch for a tree-reference file_id
688
:param file_id: The file_id of the tree reference
689
:param path: The path of the file_id in the tree
690
:return: A branch associated with the file_id
692
# FIXME should provide multiple branches, based on config
693
return Branch.open(self.bzrdir.root_transport.clone(path).base)
696
class BranchFormat(object):
697
"""An encapsulation of the initialization and open routines for a format.
699
Formats provide three things:
700
* An initialization routine,
704
Formats are placed in an dict by their format string for reference
705
during branch opening. Its not required that these be instances, they
706
can be classes themselves with class methods - it simply depends on
707
whether state is needed for a given format or not.
709
Once a format is deprecated, just deprecate the initialize and open
710
methods on the format class. Do not deprecate the object, as the
711
object will be created every time regardless.
714
_default_format = None
715
"""The default format used for new branches."""
718
"""The known formats."""
721
def find_format(klass, a_bzrdir):
722
"""Return the format for the branch object in a_bzrdir."""
724
transport = a_bzrdir.get_branch_transport(None)
725
format_string = transport.get("format").read()
726
return klass._formats[format_string]
728
raise NotBranchError(path=transport.base)
730
raise errors.UnknownFormatError(format=format_string)
733
def get_default_format(klass):
734
"""Return the current default format."""
735
return klass._default_format
737
def get_format_string(self):
738
"""Return the ASCII format string that identifies this format."""
739
raise NotImplementedError(self.get_format_string)
741
def get_format_description(self):
742
"""Return the short format description for this format."""
743
raise NotImplementedError(self.get_format_description)
745
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
747
"""Initialize a branch in a bzrdir, with specified files
749
:param a_bzrdir: The bzrdir to initialize the branch in
750
:param utf8_files: The files to create as a list of
751
(filename, content) tuples
752
:param set_format: If True, set the format with
753
self.get_format_string. (BzrBranch4 has its format set
755
:return: a branch in this format
757
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
758
branch_transport = a_bzrdir.get_branch_transport(self)
760
'metadir': ('lock', lockdir.LockDir),
761
'branch4': ('branch-lock', lockable_files.TransportLock),
763
lock_name, lock_class = lock_map[lock_type]
764
control_files = lockable_files.LockableFiles(branch_transport,
765
lock_name, lock_class)
766
control_files.create_lock()
767
control_files.lock_write()
769
control_files.put_utf8('format', self.get_format_string())
771
for file, content in utf8_files:
772
control_files.put_utf8(file, content)
774
control_files.unlock()
775
return self.open(a_bzrdir, _found=True)
777
def initialize(self, a_bzrdir):
778
"""Create a branch of this format in a_bzrdir."""
779
raise NotImplementedError(self.initialize)
781
def is_supported(self):
782
"""Is this format supported?
784
Supported formats can be initialized and opened.
785
Unsupported formats may not support initialization or committing or
786
some other features depending on the reason for not being supported.
790
def open(self, a_bzrdir, _found=False):
791
"""Return the branch object for a_bzrdir
793
_found is a private parameter, do not use it. It is used to indicate
794
if format probing has already be done.
796
raise NotImplementedError(self.open)
799
def register_format(klass, format):
800
klass._formats[format.get_format_string()] = format
803
def set_default_format(klass, format):
804
klass._default_format = format
807
def unregister_format(klass, format):
808
assert klass._formats[format.get_format_string()] is format
809
del klass._formats[format.get_format_string()]
812
return self.get_format_string().rstrip()
815
class BranchHooks(dict):
816
"""A dictionary mapping hook name to a list of callables for branch hooks.
818
e.g. ['set_rh'] Is the list of items to be called when the
819
set_revision_history function is invoked.
823
"""Create the default hooks.
825
These are all empty initially, because by default nothing should get
829
# Introduced in 0.15:
830
# invoked whenever the revision history has been set
831
# with set_revision_history. The api signature is
832
# (branch, revision_history), and the branch will
835
# invoked after a push operation completes.
836
# the api signature is
837
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
838
# where local is the local branch or None, master is the target
839
# master branch, and the rest should be self explanatory. The source
840
# is read locked and the target branches write locked. Source will
841
# be the local low-latency branch.
842
self['post_push'] = []
843
# invoked after a pull operation completes.
844
# the api signature is
845
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
846
# where local is the local branch or None, master is the target
847
# master branch, and the rest should be self explanatory. The source
848
# is read locked and the target branches write locked. The local
849
# branch is the low-latency branch.
850
self['post_pull'] = []
851
# invoked after a commit operation completes.
852
# the api signature is
853
# (local, master, old_revno, old_revid, new_revno, new_revid)
854
# old_revid is NULL_REVISION for the first commit to a branch.
855
self['post_commit'] = []
856
# invoked after a uncommit operation completes.
857
# the api signature is
858
# (local, master, old_revno, old_revid, new_revno, new_revid) where
859
# local is the local branch or None, master is the target branch,
860
# and an empty branch recieves new_revno of 0, new_revid of None.
861
self['post_uncommit'] = []
863
def install_hook(self, hook_name, a_callable):
864
"""Install a_callable in to the hook hook_name.
866
:param hook_name: A hook name. See the __init__ method of BranchHooks
867
for the complete list of hooks.
868
:param a_callable: The callable to be invoked when the hook triggers.
869
The exact signature will depend on the hook - see the __init__
870
method of BranchHooks for details on each hook.
873
self[hook_name].append(a_callable)
875
raise errors.UnknownHook('branch', hook_name)
878
# install the default hooks into the Branch class.
879
Branch.hooks = BranchHooks()
882
class BzrBranchFormat4(BranchFormat):
883
"""Bzr branch format 4.
886
- a revision-history file.
887
- a branch-lock lock file [ to be shared with the bzrdir ]
890
def get_format_description(self):
891
"""See BranchFormat.get_format_description()."""
892
return "Branch format 4"
894
def initialize(self, a_bzrdir):
895
"""Create a branch of this format in a_bzrdir."""
896
utf8_files = [('revision-history', ''),
899
return self._initialize_helper(a_bzrdir, utf8_files,
900
lock_type='branch4', set_format=False)
903
super(BzrBranchFormat4, self).__init__()
904
self._matchingbzrdir = bzrdir.BzrDirFormat6()
906
def open(self, a_bzrdir, _found=False):
907
"""Return the branch object for a_bzrdir
909
_found is a private parameter, do not use it. It is used to indicate
910
if format probing has already be done.
913
# we are being called directly and must probe.
914
raise NotImplementedError
915
return BzrBranch(_format=self,
916
_control_files=a_bzrdir._control_files,
918
_repository=a_bzrdir.open_repository())
921
return "Bazaar-NG branch format 4"
924
class BzrBranchFormat5(BranchFormat):
925
"""Bzr branch format 5.
928
- a revision-history file.
930
- a lock dir guarding the branch itself
931
- all of this stored in a branch/ subdirectory
932
- works with shared repositories.
934
This format is new in bzr 0.8.
937
def get_format_string(self):
938
"""See BranchFormat.get_format_string()."""
939
return "Bazaar-NG branch format 5\n"
941
def get_format_description(self):
942
"""See BranchFormat.get_format_description()."""
943
return "Branch format 5"
945
def initialize(self, a_bzrdir):
946
"""Create a branch of this format in a_bzrdir."""
947
utf8_files = [('revision-history', ''),
950
return self._initialize_helper(a_bzrdir, utf8_files)
953
super(BzrBranchFormat5, self).__init__()
954
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
956
def open(self, a_bzrdir, _found=False):
957
"""Return the branch object for a_bzrdir
959
_found is a private parameter, do not use it. It is used to indicate
960
if format probing has already be done.
963
format = BranchFormat.find_format(a_bzrdir)
964
assert format.__class__ == self.__class__
965
transport = a_bzrdir.get_branch_transport(None)
966
control_files = lockable_files.LockableFiles(transport, 'lock',
968
return BzrBranch5(_format=self,
969
_control_files=control_files,
971
_repository=a_bzrdir.find_repository())
974
return "Bazaar-NG Metadir branch format 5"
977
class BzrBranchFormat6(BzrBranchFormat5):
978
"""Branch format with last-revision
980
Unlike previous formats, this has no explicit revision history. Instead,
981
this just stores the last-revision, and the left-hand history leading
982
up to there is the history.
984
This format was introduced in bzr 0.15
987
def get_format_string(self):
988
"""See BranchFormat.get_format_string()."""
989
return "Bazaar-NG branch format 6\n"
991
def get_format_description(self):
992
"""See BranchFormat.get_format_description()."""
993
return "Branch format 6"
995
def initialize(self, a_bzrdir):
996
"""Create a branch of this format in a_bzrdir."""
997
utf8_files = [('last-revision', '0 null:\n'),
1001
return self._initialize_helper(a_bzrdir, utf8_files)
1003
def open(self, a_bzrdir, _found=False):
1004
"""Return the branch object for a_bzrdir
1006
_found is a private parameter, do not use it. It is used to indicate
1007
if format probing has already be done.
1010
format = BranchFormat.find_format(a_bzrdir)
1011
assert format.__class__ == self.__class__
1012
transport = a_bzrdir.get_branch_transport(None)
1013
control_files = lockable_files.LockableFiles(transport, 'lock',
1015
return BzrBranch6(_format=self,
1016
_control_files=control_files,
1018
_repository=a_bzrdir.find_repository())
1021
class BranchReferenceFormat(BranchFormat):
1022
"""Bzr branch reference format.
1024
Branch references are used in implementing checkouts, they
1025
act as an alias to the real branch which is at some other url.
1032
def get_format_string(self):
1033
"""See BranchFormat.get_format_string()."""
1034
return "Bazaar-NG Branch Reference Format 1\n"
1036
def get_format_description(self):
1037
"""See BranchFormat.get_format_description()."""
1038
return "Checkout reference format 1"
1040
def initialize(self, a_bzrdir, target_branch=None):
1041
"""Create a branch of this format in a_bzrdir."""
1042
if target_branch is None:
1043
# this format does not implement branch itself, thus the implicit
1044
# creation contract must see it as uninitializable
1045
raise errors.UninitializableFormat(self)
1046
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1047
branch_transport = a_bzrdir.get_branch_transport(self)
1048
branch_transport.put_bytes('location',
1049
target_branch.bzrdir.root_transport.base)
1050
branch_transport.put_bytes('format', self.get_format_string())
1051
return self.open(a_bzrdir, _found=True)
1054
super(BranchReferenceFormat, self).__init__()
1055
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1057
def _make_reference_clone_function(format, a_branch):
1058
"""Create a clone() routine for a branch dynamically."""
1059
def clone(to_bzrdir, revision_id=None):
1060
"""See Branch.clone()."""
1061
return format.initialize(to_bzrdir, a_branch)
1062
# cannot obey revision_id limits when cloning a reference ...
1063
# FIXME RBC 20060210 either nuke revision_id for clone, or
1064
# emit some sort of warning/error to the caller ?!
1067
def open(self, a_bzrdir, _found=False):
1068
"""Return the branch that the branch reference in a_bzrdir points at.
1070
_found is a private parameter, do not use it. It is used to indicate
1071
if format probing has already be done.
1074
format = BranchFormat.find_format(a_bzrdir)
1075
assert format.__class__ == self.__class__
1076
transport = a_bzrdir.get_branch_transport(None)
1077
real_bzrdir = bzrdir.BzrDir.open(transport.get('location').read())
1078
result = real_bzrdir.open_branch()
1079
# this changes the behaviour of result.clone to create a new reference
1080
# rather than a copy of the content of the branch.
1081
# I did not use a proxy object because that needs much more extensive
1082
# testing, and we are only changing one behaviour at the moment.
1083
# If we decide to alter more behaviours - i.e. the implicit nickname
1084
# then this should be refactored to introduce a tested proxy branch
1085
# and a subclass of that for use in overriding clone() and ....
1087
result.clone = self._make_reference_clone_function(result)
1091
# formats which have no format string are not discoverable
1092
# and not independently creatable, so are not registered.
1093
__default_format = BzrBranchFormat5()
1094
BranchFormat.register_format(__default_format)
1095
BranchFormat.register_format(BranchReferenceFormat())
1096
BranchFormat.register_format(BzrBranchFormat6())
1097
BranchFormat.set_default_format(__default_format)
1098
_legacy_formats = [BzrBranchFormat4(),
1101
class BzrBranch(Branch):
1102
"""A branch stored in the actual filesystem.
1104
Note that it's "local" in the context of the filesystem; it doesn't
1105
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1106
it's writable, and can be accessed via the normal filesystem API.
1109
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
1110
relax_version_check=DEPRECATED_PARAMETER, _format=None,
1111
_control_files=None, a_bzrdir=None, _repository=None):
1112
"""Create new branch object at a particular location.
1114
transport -- A Transport object, defining how to access files.
1116
init -- If True, create new control files in a previously
1117
unversioned directory. If False, the branch must already
1120
relax_version_check -- If true, the usual check for the branch
1121
version is not applied. This is intended only for
1122
upgrade/recovery type use; it's not guaranteed that
1123
all operations will work on old format branches.
1125
if a_bzrdir is None:
1126
self.bzrdir = bzrdir.BzrDir.open(transport.base)
1128
self.bzrdir = a_bzrdir
1129
self._transport = self.bzrdir.transport.clone('..')
1130
self._base = self._transport.base
1131
self._format = _format
1132
if _control_files is None:
1133
raise ValueError('BzrBranch _control_files is None')
1134
self.control_files = _control_files
1135
if deprecated_passed(init):
1136
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
1137
"deprecated as of bzr 0.8. Please use Branch.create().",
1141
# this is slower than before deprecation, oh well never mind.
1142
# -> its deprecated.
1143
self._initialize(transport.base)
1144
self._check_format(_format)
1145
if deprecated_passed(relax_version_check):
1146
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
1147
"relax_version_check parameter is deprecated as of bzr 0.8. "
1148
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
1152
if (not relax_version_check
1153
and not self._format.is_supported()):
1154
raise errors.UnsupportedFormatError(format=fmt)
1155
if deprecated_passed(transport):
1156
warn("BzrBranch.__init__(transport=XXX...): The transport "
1157
"parameter is deprecated as of bzr 0.8. "
1158
"Please use Branch.open, or bzrdir.open_branch().",
1161
self.repository = _repository
1164
return '%s(%r)' % (self.__class__.__name__, self.base)
1168
def _get_base(self):
1171
base = property(_get_base, doc="The URL for the root of this branch.")
1173
def _finish_transaction(self):
1174
"""Exit the current transaction."""
1175
return self.control_files._finish_transaction()
1177
def get_transaction(self):
1178
"""Return the current active transaction.
1180
If no transaction is active, this returns a passthrough object
1181
for which all data is immediately flushed and no caching happens.
1183
# this is an explicit function so that we can do tricky stuff
1184
# when the storage in rev_storage is elsewhere.
1185
# we probably need to hook the two 'lock a location' and
1186
# 'have a transaction' together more delicately, so that
1187
# we can have two locks (branch and storage) and one transaction
1188
# ... and finishing the transaction unlocks both, but unlocking
1189
# does not. - RBC 20051121
1190
return self.control_files.get_transaction()
1192
def _set_transaction(self, transaction):
1193
"""Set a new active transaction."""
1194
return self.control_files._set_transaction(transaction)
1196
def abspath(self, name):
1197
"""See Branch.abspath."""
1198
return self.control_files._transport.abspath(name)
1200
def _check_format(self, format):
1201
"""Identify the branch format if needed.
1203
The format is stored as a reference to the format object in
1204
self._format for code that needs to check it later.
1206
The format parameter is either None or the branch format class
1207
used to open this branch.
1209
FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
1212
format = BranchFormat.find_format(self.bzrdir)
1213
self._format = format
1214
mutter("got branch format %s", self._format)
1217
def get_root_id(self):
1218
"""See Branch.get_root_id."""
1219
tree = self.repository.revision_tree(self.last_revision())
1220
return tree.inventory.root.file_id
1222
def is_locked(self):
1223
return self.control_files.is_locked()
1225
def lock_write(self):
1226
self.repository.lock_write()
1228
self.control_files.lock_write()
1230
self.repository.unlock()
1233
def lock_read(self):
1234
self.repository.lock_read()
1236
self.control_files.lock_read()
1238
self.repository.unlock()
1242
# TODO: test for failed two phase locks. This is known broken.
1244
self.control_files.unlock()
1246
self.repository.unlock()
1248
def peek_lock_mode(self):
1249
if self.control_files._lock_count == 0:
1252
return self.control_files._lock_mode
1254
def get_physical_lock_status(self):
1255
return self.control_files.get_physical_lock_status()
1258
def print_file(self, file, revision_id):
1259
"""See Branch.print_file."""
1260
return self.repository.print_file(file, revision_id)
1263
def append_revision(self, *revision_ids):
1264
"""See Branch.append_revision."""
1265
for revision_id in revision_ids:
1266
_mod_revision.check_not_reserved_id(revision_id)
1267
mutter("add {%s} to revision-history" % revision_id)
1268
rev_history = self.revision_history()
1269
rev_history.extend(revision_ids)
1270
self.set_revision_history(rev_history)
1272
def _write_revision_history(self, history):
1273
"""Factored out of set_revision_history.
1275
This performs the actual writing to disk.
1276
It is intended to be called by BzrBranch5.set_revision_history."""
1277
self.control_files.put_utf8(
1278
'revision-history', '\n'.join(history))
1281
def set_revision_history(self, rev_history):
1282
"""See Branch.set_revision_history."""
1283
self._write_revision_history(rev_history)
1284
transaction = self.get_transaction()
1285
history = transaction.map.find_revision_history()
1286
if history is not None:
1287
# update the revision history in the identity map.
1288
history[:] = list(rev_history)
1289
# this call is disabled because revision_history is
1290
# not really an object yet, and the transaction is for objects.
1291
# transaction.register_dirty(history)
1293
transaction.map.add_revision_history(rev_history)
1294
# this call is disabled because revision_history is
1295
# not really an object yet, and the transaction is for objects.
1296
# transaction.register_clean(history)
1297
for hook in Branch.hooks['set_rh']:
1298
hook(self, rev_history)
1301
def set_last_revision_info(self, revno, revision_id):
1302
history = self._lefthand_history(revision_id)
1303
assert len(history) == revno, '%d != %d' % (len(history), revno)
1304
self.set_revision_history(history)
1306
def _gen_revision_history(self):
1307
decode_utf8 = cache_utf8.decode
1308
history = [decode_utf8(l.rstrip('\r\n')) for l in
1309
self.control_files.get('revision-history').readlines()]
1313
def revision_history(self):
1314
"""See Branch.revision_history."""
1315
transaction = self.get_transaction()
1316
history = transaction.map.find_revision_history()
1317
if history is not None:
1318
# mutter("cache hit for revision-history in %s", self)
1319
return list(history)
1320
history = self._gen_revision_history()
1321
transaction.map.add_revision_history(history)
1322
# this call is disabled because revision_history is
1323
# not really an object yet, and the transaction is for objects.
1324
# transaction.register_clean(history, precious=True)
1325
return list(history)
1327
def _lefthand_history(self, revision_id, last_rev=None,
1329
# stop_revision must be a descendant of last_revision
1330
stop_graph = self.repository.get_revision_graph(revision_id)
1331
if last_rev is not None and last_rev not in stop_graph:
1332
# our previous tip is not merged into stop_revision
1333
raise errors.DivergedBranches(self, other_branch)
1334
# make a new revision history from the graph
1335
current_rev_id = revision_id
1337
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1338
new_history.append(current_rev_id)
1339
current_rev_id_parents = stop_graph[current_rev_id]
1341
current_rev_id = current_rev_id_parents[0]
1343
current_rev_id = None
1344
new_history.reverse()
1348
def generate_revision_history(self, revision_id, last_rev=None,
1350
"""Create a new revision history that will finish with revision_id.
1352
:param revision_id: the new tip to use.
1353
:param last_rev: The previous last_revision. If not None, then this
1354
must be a ancestory of revision_id, or DivergedBranches is raised.
1355
:param other_branch: The other branch that DivergedBranches should
1356
raise with respect to.
1358
self.set_revision_history(self._lefthand_history(revision_id,
1359
last_rev, other_branch))
1362
def update_revisions(self, other, stop_revision=None):
1363
"""See Branch.update_revisions."""
1366
if stop_revision is None:
1367
stop_revision = other.last_revision()
1368
if stop_revision is None:
1369
# if there are no commits, we're done.
1371
# whats the current last revision, before we fetch [and change it
1373
last_rev = self.last_revision()
1374
# we fetch here regardless of whether we need to so that we pickup
1376
self.fetch(other, stop_revision)
1377
my_ancestry = self.repository.get_ancestry(last_rev)
1378
if stop_revision in my_ancestry:
1379
# last_revision is a descendant of stop_revision
1381
self.generate_revision_history(stop_revision, last_rev=last_rev,
1386
def basis_tree(self):
1387
"""See Branch.basis_tree."""
1388
return self.repository.revision_tree(self.last_revision())
1390
@deprecated_method(zero_eight)
1391
def working_tree(self):
1392
"""Create a Working tree object for this branch."""
1394
from bzrlib.transport.local import LocalTransport
1395
if (self.base.find('://') != -1 or
1396
not isinstance(self._transport, LocalTransport)):
1397
raise NoWorkingTree(self.base)
1398
return self.bzrdir.open_workingtree()
1401
def pull(self, source, overwrite=False, stop_revision=None,
1402
_hook_master=None, _run_hooks=True):
1405
:param _hook_master: Private parameter - set the branch to
1406
be supplied as the master to push hooks.
1407
:param _run_hooks: Private parameter - allow disabling of
1408
hooks, used when pushing to a master branch.
1412
old_count, old_tip = self.last_revision_info()
1414
self.update_revisions(source, stop_revision)
1415
except DivergedBranches:
1419
self.set_revision_history(source.revision_history())
1420
new_count, new_tip = self.last_revision_info()
1427
for hook in Branch.hooks['post_pull']:
1428
hook(source, _hook_local, _hook_master, old_count, old_tip,
1430
return new_count - old_count
1434
def _get_parent_location(self):
1435
_locs = ['parent', 'pull', 'x-pull']
1438
return self.control_files.get(l).read().strip('\n')
1444
def push(self, target, overwrite=False, stop_revision=None,
1445
_hook_master=None, _run_hooks=True):
1448
:param _hook_master: Private parameter - set the branch to
1449
be supplied as the master to push hooks.
1450
:param _run_hooks: Private parameter - allow disabling of
1451
hooks, used when pushing to a master branch.
1455
old_count, old_tip = target.last_revision_info()
1457
target.update_revisions(self, stop_revision)
1458
except DivergedBranches:
1462
target.set_revision_history(self.revision_history())
1463
new_count, new_tip = target.last_revision_info()
1466
_hook_local = target
1468
_hook_master = target
1470
for hook in Branch.hooks['post_push']:
1471
hook(self, _hook_local, _hook_master, old_count, old_tip,
1473
return new_count - old_count
1477
def get_parent(self):
1478
"""See Branch.get_parent."""
1480
assert self.base[-1] == '/'
1481
parent = self._get_parent_location()
1484
# This is an old-format absolute path to a local branch
1485
# turn it into a url
1486
if parent.startswith('/'):
1487
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1489
return urlutils.join(self.base[:-1], parent)
1490
except errors.InvalidURLJoin, e:
1491
raise errors.InaccessibleParent(parent, self.base)
1493
def get_push_location(self):
1494
"""See Branch.get_push_location."""
1495
push_loc = self.get_config().get_user_option('push_location')
1498
def set_push_location(self, location):
1499
"""See Branch.set_push_location."""
1500
self.get_config().set_user_option(
1501
'push_location', location,
1502
store=_mod_config.STORE_LOCATION_NORECURSE)
1505
def set_parent(self, url):
1506
"""See Branch.set_parent."""
1507
# TODO: Maybe delete old location files?
1508
# URLs should never be unicode, even on the local fs,
1509
# FIXUP this and get_parent in a future branch format bump:
1510
# read and rewrite the file, and have the new format code read
1511
# using .get not .get_utf8. RBC 20060125
1513
if isinstance(url, unicode):
1515
url = url.encode('ascii')
1516
except UnicodeEncodeError:
1517
raise bzrlib.errors.InvalidURL(url,
1518
"Urls must be 7-bit ascii, "
1519
"use bzrlib.urlutils.escape")
1521
url = urlutils.relative_url(self.base, url)
1522
self._set_parent_location(url)
1524
def _set_parent_location(self, url):
1526
self.control_files._transport.delete('parent')
1528
assert isinstance(url, str)
1529
self.control_files.put('parent', StringIO(url + '\n'))
1531
@deprecated_function(zero_nine)
1532
def tree_config(self):
1533
"""DEPRECATED; call get_config instead.
1534
TreeConfig has become part of BranchConfig."""
1535
return TreeConfig(self)
1538
class BzrBranch5(BzrBranch):
1539
"""A format 5 branch. This supports new features over plan branches.
1541
It has support for a master_branch which is the data for bound branches.
1549
super(BzrBranch5, self).__init__(_format=_format,
1550
_control_files=_control_files,
1552
_repository=_repository)
1555
def pull(self, source, overwrite=False, stop_revision=None,
1557
"""Extends branch.pull to be bound branch aware.
1559
:param _run_hooks: Private parameter used to force hook running
1560
off during bound branch double-pushing.
1562
bound_location = self.get_bound_location()
1563
master_branch = None
1564
if bound_location and source.base != bound_location:
1565
# not pulling from master, so we need to update master.
1566
master_branch = self.get_master_branch()
1567
master_branch.lock_write()
1570
# pull from source into master.
1571
master_branch.pull(source, overwrite, stop_revision,
1573
return super(BzrBranch5, self).pull(source, overwrite,
1574
stop_revision, _hook_master=master_branch,
1575
_run_hooks=_run_hooks)
1578
master_branch.unlock()
1581
def push(self, target, overwrite=False, stop_revision=None):
1582
"""Updates branch.push to be bound branch aware."""
1583
bound_location = target.get_bound_location()
1584
master_branch = None
1585
if bound_location and target.base != bound_location:
1586
# not pushing to master, so we need to update master.
1587
master_branch = target.get_master_branch()
1588
master_branch.lock_write()
1591
# push into the master from this branch.
1592
super(BzrBranch5, self).push(master_branch, overwrite,
1593
stop_revision, _run_hooks=False)
1594
# and push into the target branch from this. Note that we push from
1595
# this branch again, because its considered the highest bandwidth
1597
return super(BzrBranch5, self).push(target, overwrite,
1598
stop_revision, _hook_master=master_branch)
1601
master_branch.unlock()
1603
def get_bound_location(self):
1605
return self.control_files.get_utf8('bound').read()[:-1]
1606
except errors.NoSuchFile:
1610
def get_master_branch(self):
1611
"""Return the branch we are bound to.
1613
:return: Either a Branch, or None
1615
This could memoise the branch, but if thats done
1616
it must be revalidated on each new lock.
1617
So for now we just don't memoise it.
1618
# RBC 20060304 review this decision.
1620
bound_loc = self.get_bound_location()
1624
return Branch.open(bound_loc)
1625
except (errors.NotBranchError, errors.ConnectionError), e:
1626
raise errors.BoundBranchConnectionFailure(
1630
def set_bound_location(self, location):
1631
"""Set the target where this branch is bound to.
1633
:param location: URL to the target branch
1636
self.control_files.put_utf8('bound', location+'\n')
1639
self.control_files._transport.delete('bound')
1645
def bind(self, other):
1646
"""Bind this branch to the branch other.
1648
This does not push or pull data between the branches, though it does
1649
check for divergence to raise an error when the branches are not
1650
either the same, or one a prefix of the other. That behaviour may not
1651
be useful, so that check may be removed in future.
1653
:param other: The branch to bind to
1656
# TODO: jam 20051230 Consider checking if the target is bound
1657
# It is debatable whether you should be able to bind to
1658
# a branch which is itself bound.
1659
# Committing is obviously forbidden,
1660
# but binding itself may not be.
1661
# Since we *have* to check at commit time, we don't
1662
# *need* to check here
1664
# we want to raise diverged if:
1665
# last_rev is not in the other_last_rev history, AND
1666
# other_last_rev is not in our history, and do it without pulling
1668
last_rev = self.last_revision()
1669
if last_rev is not None:
1672
other_last_rev = other.last_revision()
1673
if other_last_rev is not None:
1674
# neither branch is new, we have to do some work to
1675
# ascertain diversion.
1676
remote_graph = other.repository.get_revision_graph(
1678
local_graph = self.repository.get_revision_graph(last_rev)
1679
if (last_rev not in remote_graph and
1680
other_last_rev not in local_graph):
1681
raise errors.DivergedBranches(self, other)
1684
self.set_bound_location(other.base)
1688
"""If bound, unbind"""
1689
return self.set_bound_location(None)
1693
"""Synchronise this branch with the master branch if any.
1695
:return: None or the last_revision that was pivoted out during the
1698
master = self.get_master_branch()
1699
if master is not None:
1700
old_tip = self.last_revision()
1701
self.pull(master, overwrite=True)
1702
if old_tip in self.repository.get_ancestry(self.last_revision()):
1708
class BzrBranch6(BzrBranch5):
1711
def last_revision_info(self):
1712
revision_string = self.control_files.get_utf8('last-revision').read()
1713
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1715
return revno, revision_id
1717
def last_revision(self):
1718
"""Return last revision id, or None"""
1719
revision_id = self.last_revision_info()[1]
1720
if revision_id == _mod_revision.NULL_REVISION:
1724
def _write_last_revision_info(self, revno, revision_id):
1725
"""Simply write out the revision id, with no checks.
1727
Use set_last_revision_info to perform this safely.
1729
Does not update the revision_history cache.
1730
Intended to be called by set_last_revision_info and
1731
_write_revision_history.
1733
if revision_id is None:
1734
revision_id = 'null:'
1735
out_string = '%d %s\n' % (revno, revision_id)
1736
self.control_files.put_utf8('last-revision', out_string)
1739
def set_last_revision_info(self, revno, revision_id):
1740
if self._get_append_revisions_only():
1741
self._check_history_violation(revision_id)
1742
self._write_last_revision_info(revno, revision_id)
1743
transaction = self.get_transaction()
1744
cached_history = transaction.map.find_revision_history()
1745
if cached_history is not None:
1746
transaction.map.remove_object(cached_history)
1748
def _check_history_violation(self, revision_id):
1749
last_revision = self.last_revision()
1750
if last_revision is None:
1752
if last_revision not in self._lefthand_history(revision_id):
1753
raise errors.AppendRevisionsOnlyViolation(self.base)
1755
def _gen_revision_history(self):
1756
"""Generate the revision history from last revision
1758
history = list(self.repository.iter_reverse_revision_history(
1759
self.last_revision()))
1763
def _write_revision_history(self, history):
1764
"""Factored out of set_revision_history.
1766
This performs the actual writing to disk, with format-specific checks.
1767
It is intended to be called by BzrBranch5.set_revision_history.
1769
if len(history) == 0:
1770
last_revision = 'null:'
1772
if history != self._lefthand_history(history[-1]):
1773
raise errors.NotLefthandHistory(history)
1774
last_revision = history[-1]
1775
if self._get_append_revisions_only():
1776
self._check_history_violation(last_revision)
1777
self._write_last_revision_info(len(history), last_revision)
1780
def append_revision(self, *revision_ids):
1781
if len(revision_ids) == 0:
1783
prev_revno, prev_revision = self.last_revision_info()
1784
for revision in self.repository.get_revisions(revision_ids):
1785
if prev_revision == _mod_revision.NULL_REVISION:
1786
if revision.parent_ids != []:
1787
raise errors.NotLeftParentDescendant(self, prev_revision,
1788
revision.revision_id)
1790
if revision.parent_ids[0] != prev_revision:
1791
raise errors.NotLeftParentDescendant(self, prev_revision,
1792
revision.revision_id)
1793
prev_revision = revision.revision_id
1794
self.set_last_revision_info(prev_revno + len(revision_ids),
1797
def _set_config_location(self, name, url, config=None,
1798
make_relative=False):
1800
config = self.get_config()
1804
url = urlutils.relative_url(self.base, url)
1805
config.set_user_option(name, url)
1808
def _get_config_location(self, name, config=None):
1810
config = self.get_config()
1811
location = config.get_user_option(name)
1817
def _set_parent_location(self, url):
1818
"""Set the parent branch"""
1819
self._set_config_location('parent_location', url, make_relative=True)
1822
def _get_parent_location(self):
1823
"""Set the parent branch"""
1824
return self._get_config_location('parent_location')
1826
def set_push_location(self, location):
1827
"""See Branch.set_push_location."""
1828
self._set_config_location('push_location', location)
1830
def set_bound_location(self, location):
1831
"""See Branch.set_push_location."""
1833
config = self.get_config()
1834
if location is None:
1835
if config.get_user_option('bound') != 'True':
1838
config.set_user_option('bound', 'False')
1841
self._set_config_location('bound_location', location,
1843
config.set_user_option('bound', 'True')
1846
def _get_bound_location(self, bound):
1847
"""Return the bound location in the config file.
1849
Return None if the bound parameter does not match"""
1850
config = self.get_config()
1851
config_bound = (config.get_user_option('bound') == 'True')
1852
if config_bound != bound:
1854
return self._get_config_location('bound_location', config=config)
1856
def get_bound_location(self):
1857
"""See Branch.set_push_location."""
1858
return self._get_bound_location(True)
1860
def get_old_bound_location(self):
1861
"""See Branch.get_old_bound_location"""
1862
return self._get_bound_location(False)
1864
def set_append_revisions_only(self, enabled):
1869
self.get_config().set_user_option('append_revisions_only', value)
1871
def _get_append_revisions_only(self):
1872
value = self.get_config().get_user_option('append_revisions_only')
1873
return value == 'True'
1875
def _synchronize_history(self, destination, revision_id):
1876
"""Synchronize last revision and revision history between branches.
1878
This version is most efficient when the destination is also a
1879
BzrBranch6, but works for BzrBranch5, as long as the destination's
1880
repository contains all the lefthand ancestors of the intended
1881
last_revision. If not, set_last_revision_info will fail.
1883
:param destination: The branch to copy the history into
1884
:param revision_id: The revision-id to truncate history at. May
1885
be None to copy complete history.
1887
if revision_id is None:
1888
revno, revision_id = self.last_revision_info()
1890
revno = self.revision_id_to_revno(revision_id)
1891
destination.set_last_revision_info(revno, revision_id)
1894
class BranchTestProviderAdapter(object):
1895
"""A tool to generate a suite testing multiple branch formats at once.
1897
This is done by copying the test once for each transport and injecting
1898
the transport_server, transport_readonly_server, and branch_format
1899
classes into each copy. Each copy is also given a new id() to make it
1903
def __init__(self, transport_server, transport_readonly_server, formats):
1904
self._transport_server = transport_server
1905
self._transport_readonly_server = transport_readonly_server
1906
self._formats = formats
1908
def adapt(self, test):
1909
result = TestSuite()
1910
for branch_format, bzrdir_format in self._formats:
1911
new_test = deepcopy(test)
1912
new_test.transport_server = self._transport_server
1913
new_test.transport_readonly_server = self._transport_readonly_server
1914
new_test.bzrdir_format = bzrdir_format
1915
new_test.branch_format = branch_format
1916
def make_new_test_id():
1917
new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
1918
return lambda: new_id
1919
new_test.id = make_new_test_id()
1920
result.addTest(new_test)
1924
class BranchCheckResult(object):
1925
"""Results of checking branch consistency.
1930
def __init__(self, branch):
1931
self.branch = branch
1933
def report_results(self, verbose):
1934
"""Report the check results via trace.note.
1936
:param verbose: Requests more detailed display of what was checked,
1939
note('checked branch %s format %s',
1941
self.branch._format)
1944
######################################################################
1948
@deprecated_function(zero_eight)
1949
def is_control_file(*args, **kwargs):
1950
"""See bzrlib.workingtree.is_control_file."""
1951
from bzrlib import workingtree
1952
return workingtree.is_control_file(*args, **kwargs)
1955
class Converter5to6(object):
1956
"""Perform an in-place upgrade of format 5 to format 6"""
1958
def convert(self, branch):
1959
# Data for 5 and 6 can peacefully coexist.
1960
format = BzrBranchFormat6()
1961
new_branch = format.open(branch.bzrdir, _found=True)
1963
# Copy source data into target
1964
new_branch.set_last_revision_info(*branch.last_revision_info())
1965
new_branch.set_parent(branch.get_parent())
1966
new_branch.set_bound_location(branch.get_bound_location())
1967
new_branch.set_push_location(branch.get_push_location())
1969
# Copying done; now update target format
1970
new_branch.control_files.put_utf8('format',
1971
format.get_format_string())
1973
# Clean up old files
1974
new_branch.control_files._transport.delete('revision-history')
1976
branch.set_parent(None)
1979
branch.set_bound_location(None)
added
removed
bzrlib/branch.py
