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
43
from bzrlib.tag import (
49
from bzrlib.decorators import needs_read_lock, needs_write_lock
50
from bzrlib.errors import (BzrError, BzrCheckError, DivergedBranches,
51
HistoryMissing, InvalidRevisionId,
52
InvalidRevisionNumber, LockError, NoSuchFile,
53
NoSuchRevision, NoWorkingTree, NotVersionedError,
54
NotBranchError, UninitializableFormat,
55
UnlistableStore, UnlistableBranch,
57
from bzrlib.symbol_versioning import (deprecated_function,
61
zero_eight, zero_nine,
63
from bzrlib.trace import mutter, note
66
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
67
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
68
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
71
# TODO: Maybe include checks for common corruption of newlines, etc?
73
# TODO: Some operations like log might retrieve the same revisions
74
# repeatedly to calculate deltas. We could perhaps have a weakref
75
# cache in memory to make this faster. In general anything can be
76
# cached in memory between lock and unlock operations. .. nb thats
77
# what the transaction identity map provides
80
######################################################################
84
"""Branch holding a history of revisions.
87
Base directory/url of the branch.
89
hooks: An instance of BranchHooks.
91
# this is really an instance variable - FIXME move it there
95
# override this to set the strategy for storing tags
97
return DisabledTags(self)
99
def __init__(self, *ignored, **ignored_too):
100
self.tags = self._make_tags()
102
def break_lock(self):
103
"""Break a lock if one is present from another instance.
105
Uses the ui factory to ask for confirmation if the lock may be from
108
This will probe the repository for its lock as well.
110
self.control_files.break_lock()
111
self.repository.break_lock()
112
master = self.get_master_branch()
113
if master is not None:
117
@deprecated_method(zero_eight)
118
def open_downlevel(base):
119
"""Open a branch which may be of an old format."""
120
return Branch.open(base, _unsupported=True)
123
def open(base, _unsupported=False):
124
"""Open the branch rooted at base.
126
For instance, if the branch is at URL/.bzr/branch,
127
Branch.open(URL) -> a Branch instance.
129
control = bzrdir.BzrDir.open(base, _unsupported)
130
return control.open_branch(_unsupported)
133
def open_containing(url):
134
"""Open an existing branch which contains url.
136
This probes for a branch at url, and searches upwards from there.
138
Basically we keep looking up until we find the control directory or
139
run into the root. If there isn't one, raises NotBranchError.
140
If there is one and it is either an unrecognised format or an unsupported
141
format, UnknownFormatError or UnsupportedFormatError are raised.
142
If there is one, it is returned, along with the unused portion of url.
144
control, relpath = bzrdir.BzrDir.open_containing(url)
145
return control.open_branch(), relpath
148
@deprecated_function(zero_eight)
149
def initialize(base):
150
"""Create a new working tree and branch, rooted at 'base' (url)
152
NOTE: This will soon be deprecated in favour of creation
155
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
157
@deprecated_function(zero_eight)
158
def setup_caching(self, cache_root):
159
"""Subclasses that care about caching should override this, and set
160
up cached stores located under cache_root.
162
NOTE: This is unused.
166
def get_config(self):
167
return BranchConfig(self)
170
return self.get_config().get_nickname()
172
def _set_nick(self, nick):
173
self.get_config().set_user_option('nickname', nick)
175
nick = property(_get_nick, _set_nick)
178
raise NotImplementedError(self.is_locked)
180
def lock_write(self):
181
raise NotImplementedError(self.lock_write)
184
raise NotImplementedError(self.lock_read)
187
raise NotImplementedError(self.unlock)
189
def peek_lock_mode(self):
190
"""Return lock mode for the Branch: 'r', 'w' or None"""
191
raise NotImplementedError(self.peek_lock_mode)
193
def get_physical_lock_status(self):
194
raise NotImplementedError(self.get_physical_lock_status)
196
def abspath(self, name):
197
"""Return absolute filename for something in the branch
199
XXX: Robert Collins 20051017 what is this used for? why is it a branch
200
method and not a tree method.
202
raise NotImplementedError(self.abspath)
204
def bind(self, other):
205
"""Bind the local branch the other branch.
207
:param other: The branch to bind to
210
raise errors.UpgradeRequired(self.base)
213
def fetch(self, from_branch, last_revision=None, pb=None):
214
"""Copy revisions from from_branch into this branch.
216
:param from_branch: Where to copy from.
217
:param last_revision: What revision to stop at (None for at the end
219
:param pb: An optional progress bar to use.
221
Returns the copied revision count and the failed revisions in a tuple:
224
if self.base == from_branch.base:
227
nested_pb = ui.ui_factory.nested_progress_bar()
232
from_branch.lock_read()
234
if last_revision is None:
235
pb.update('get source history')
236
last_revision = from_branch.last_revision()
237
if last_revision is None:
238
last_revision = _mod_revision.NULL_REVISION
239
return self.repository.fetch(from_branch.repository,
240
revision_id=last_revision,
243
if nested_pb is not None:
247
def get_bound_location(self):
248
"""Return the URL of the branch we are bound to.
250
Older format branches cannot bind, please be sure to use a metadir
255
def get_old_bound_location(self):
256
"""Return the URL of the branch we used to be bound to
258
raise errors.UpgradeRequired(self.base)
260
def get_commit_builder(self, parents, config=None, timestamp=None,
261
timezone=None, committer=None, revprops=None,
263
"""Obtain a CommitBuilder for this branch.
265
:param parents: Revision ids of the parents of the new revision.
266
:param config: Optional configuration to use.
267
:param timestamp: Optional timestamp recorded for commit.
268
:param timezone: Optional timezone for timestamp.
269
:param committer: Optional committer to set for commit.
270
:param revprops: Optional dictionary of revision properties.
271
:param revision_id: Optional revision id.
275
config = self.get_config()
277
return self.repository.get_commit_builder(self, parents, config,
278
timestamp, timezone, committer, revprops, revision_id)
280
def get_master_branch(self):
281
"""Return the branch we are bound to.
283
:return: Either a Branch, or None
287
def get_revision_delta(self, revno):
288
"""Return the delta for one revision.
290
The delta is relative to its mainline predecessor, or the
291
empty tree for revision 1.
293
assert isinstance(revno, int)
294
rh = self.revision_history()
295
if not (1 <= revno <= len(rh)):
296
raise InvalidRevisionNumber(revno)
297
return self.repository.get_revision_delta(rh[revno-1])
299
def get_root_id(self):
300
"""Return the id of this branches root"""
301
raise NotImplementedError(self.get_root_id)
303
def print_file(self, file, revision_id):
304
"""Print `file` to stdout."""
305
raise NotImplementedError(self.print_file)
307
def append_revision(self, *revision_ids):
308
raise NotImplementedError(self.append_revision)
310
def set_revision_history(self, rev_history):
311
raise NotImplementedError(self.set_revision_history)
313
def revision_history(self):
314
"""Return sequence of revision hashes on to this branch."""
315
raise NotImplementedError(self.revision_history)
318
"""Return current revision number for this branch.
320
That is equivalent to the number of revisions committed to
323
return len(self.revision_history())
326
"""Older format branches cannot bind or unbind."""
327
raise errors.UpgradeRequired(self.base)
329
def set_append_revisions_only(self, enabled):
330
"""Older format branches are never restricted to append-only"""
331
raise errors.UpgradeRequired(self.base)
333
def last_revision(self):
334
"""Return last revision id, or None"""
335
ph = self.revision_history()
341
def last_revision_info(self):
342
"""Return information about the last revision.
344
:return: A tuple (revno, last_revision_id).
346
rh = self.revision_history()
349
return (revno, rh[-1])
351
return (0, _mod_revision.NULL_REVISION)
353
def missing_revisions(self, other, stop_revision=None):
354
"""Return a list of new revisions that would perfectly fit.
356
If self and other have not diverged, return a list of the revisions
357
present in other, but missing from self.
359
self_history = self.revision_history()
360
self_len = len(self_history)
361
other_history = other.revision_history()
362
other_len = len(other_history)
363
common_index = min(self_len, other_len) -1
364
if common_index >= 0 and \
365
self_history[common_index] != other_history[common_index]:
366
raise DivergedBranches(self, other)
368
if stop_revision is None:
369
stop_revision = other_len
371
assert isinstance(stop_revision, int)
372
if stop_revision > other_len:
373
raise errors.NoSuchRevision(self, stop_revision)
374
return other_history[self_len:stop_revision]
376
def update_revisions(self, other, stop_revision=None):
377
"""Pull in new perfect-fit revisions.
379
:param other: Another Branch to pull from
380
:param stop_revision: Updated until the given revision
383
raise NotImplementedError(self.update_revisions)
385
def revision_id_to_revno(self, revision_id):
386
"""Given a revision id, return its revno"""
387
if revision_id is None:
389
revision_id = osutils.safe_revision_id(revision_id)
390
history = self.revision_history()
392
return history.index(revision_id) + 1
394
raise bzrlib.errors.NoSuchRevision(self, revision_id)
396
def get_rev_id(self, revno, history=None):
397
"""Find the revision id of the specified revno."""
401
history = self.revision_history()
402
if revno <= 0 or revno > len(history):
403
raise bzrlib.errors.NoSuchRevision(self, revno)
404
return history[revno - 1]
406
def pull(self, source, overwrite=False, stop_revision=None):
407
"""Mirror source into this branch.
409
This branch is considered to be 'local', having low latency.
411
:returns: PullResult instance
413
raise NotImplementedError(self.pull)
415
def push(self, target, overwrite=False, stop_revision=None):
416
"""Mirror this branch into target.
418
This branch is considered to be 'local', having low latency.
420
raise NotImplementedError(self.push)
422
def basis_tree(self):
423
"""Return `Tree` object for last revision."""
424
return self.repository.revision_tree(self.last_revision())
426
def rename_one(self, from_rel, to_rel):
429
This can change the directory or the filename or both.
431
raise NotImplementedError(self.rename_one)
433
def move(self, from_paths, to_name):
436
to_name must exist as a versioned directory.
438
If to_name exists and is a directory, the files are moved into
439
it, keeping their old names. If it is a directory,
441
Note that to_name is only the last component of the new name;
442
this doesn't change the directory.
444
This returns a list of (from_path, to_path) pairs for each
447
raise NotImplementedError(self.move)
449
def get_parent(self):
450
"""Return the parent location of the branch.
452
This is the default location for push/pull/missing. The usual
453
pattern is that the user can override it by specifying a
456
raise NotImplementedError(self.get_parent)
458
def get_submit_branch(self):
459
"""Return the submit location of the branch.
461
This is the default location for bundle. The usual
462
pattern is that the user can override it by specifying a
465
return self.get_config().get_user_option('submit_branch')
467
def set_submit_branch(self, location):
468
"""Return the submit location of the branch.
470
This is the default location for bundle. The usual
471
pattern is that the user can override it by specifying a
474
self.get_config().set_user_option('submit_branch', location)
476
def get_push_location(self):
477
"""Return the None or the location to push this branch to."""
478
raise NotImplementedError(self.get_push_location)
480
def set_push_location(self, location):
481
"""Set a new push location for this branch."""
482
raise NotImplementedError(self.set_push_location)
484
def set_parent(self, url):
485
raise NotImplementedError(self.set_parent)
489
"""Synchronise this branch with the master branch if any.
491
:return: None or the last_revision pivoted out during the update.
495
def check_revno(self, revno):
497
Check whether a revno corresponds to any revision.
498
Zero (the NULL revision) is considered valid.
501
self.check_real_revno(revno)
503
def check_real_revno(self, revno):
505
Check whether a revno corresponds to a real revision.
506
Zero (the NULL revision) is considered invalid
508
if revno < 1 or revno > self.revno():
509
raise InvalidRevisionNumber(revno)
512
def clone(self, *args, **kwargs):
513
"""Clone this branch into to_bzrdir preserving all semantic values.
515
revision_id: if not None, the revision history in the new branch will
516
be truncated to end with revision_id.
518
# for API compatibility, until 0.8 releases we provide the old api:
519
# def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
520
# after 0.8 releases, the *args and **kwargs should be changed:
521
# def clone(self, to_bzrdir, revision_id=None):
522
if (kwargs.get('to_location', None) or
523
kwargs.get('revision', None) or
524
kwargs.get('basis_branch', None) or
525
(len(args) and isinstance(args[0], basestring))):
526
# backwards compatibility api:
527
warn("Branch.clone() has been deprecated for BzrDir.clone() from"
528
" bzrlib 0.8.", DeprecationWarning, stacklevel=3)
531
basis_branch = args[2]
533
basis_branch = kwargs.get('basis_branch', None)
535
basis = basis_branch.bzrdir
540
revision_id = args[1]
542
revision_id = kwargs.get('revision', None)
547
# no default to raise if not provided.
548
url = kwargs.get('to_location')
549
return self.bzrdir.clone(url,
550
revision_id=revision_id,
551
basis=basis).open_branch()
553
# generate args by hand
555
revision_id = args[1]
557
revision_id = kwargs.get('revision_id', None)
561
# no default to raise if not provided.
562
to_bzrdir = kwargs.get('to_bzrdir')
563
result = self._format.initialize(to_bzrdir)
564
self.copy_content_into(result, revision_id=revision_id)
568
def sprout(self, to_bzrdir, revision_id=None):
569
"""Create a new line of development from the branch, into to_bzrdir.
571
revision_id: if not None, the revision history in the new branch will
572
be truncated to end with revision_id.
574
result = self._format.initialize(to_bzrdir)
575
self.copy_content_into(result, revision_id=revision_id)
576
result.set_parent(self.bzrdir.root_transport.base)
579
def _synchronize_history(self, destination, revision_id):
580
"""Synchronize last revision and revision history between branches.
582
This version is most efficient when the destination is also a
583
BzrBranch5, but works for BzrBranch6 as long as the revision
584
history is the true lefthand parent history, and all of the revisions
585
are in the destination's repository. If not, set_revision_history
588
:param destination: The branch to copy the history into
589
:param revision_id: The revision-id to truncate history at. May
590
be None to copy complete history.
592
new_history = self.revision_history()
593
if revision_id is not None:
594
revision_id = osutils.safe_revision_id(revision_id)
596
new_history = new_history[:new_history.index(revision_id) + 1]
598
rev = self.repository.get_revision(revision_id)
599
new_history = rev.get_history(self.repository)[1:]
600
destination.set_revision_history(new_history)
603
def copy_content_into(self, destination, revision_id=None):
604
"""Copy the content of self into destination.
606
revision_id: if not None, the revision history in the new branch will
607
be truncated to end with revision_id.
609
self._synchronize_history(destination, revision_id)
611
parent = self.get_parent()
612
except errors.InaccessibleParent, e:
613
mutter('parent was not accessible to copy: %s', e)
616
destination.set_parent(parent)
620
"""Check consistency of the branch.
622
In particular this checks that revisions given in the revision-history
623
do actually match up in the revision graph, and that they're all
624
present in the repository.
626
Callers will typically also want to check the repository.
628
:return: A BranchCheckResult.
630
mainline_parent_id = None
631
for revision_id in self.revision_history():
633
revision = self.repository.get_revision(revision_id)
634
except errors.NoSuchRevision, e:
635
raise errors.BzrCheckError("mainline revision {%s} not in repository"
637
# In general the first entry on the revision history has no parents.
638
# But it's not illegal for it to have parents listed; this can happen
639
# in imports from Arch when the parents weren't reachable.
640
if mainline_parent_id is not None:
641
if mainline_parent_id not in revision.parent_ids:
642
raise errors.BzrCheckError("previous revision {%s} not listed among "
644
% (mainline_parent_id, revision_id))
645
mainline_parent_id = revision_id
646
return BranchCheckResult(self)
648
def _get_checkout_format(self):
649
"""Return the most suitable metadir for a checkout of this branch.
650
Weaves are used if this branch's repostory uses weaves.
652
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
653
from bzrlib.repofmt import weaverepo
654
format = bzrdir.BzrDirMetaFormat1()
655
format.repository_format = weaverepo.RepositoryFormat7()
657
format = self.repository.bzrdir.cloning_metadir()
658
format.branch_format = self._format
661
def create_checkout(self, to_location, revision_id=None,
663
"""Create a checkout of a branch.
665
:param to_location: The url to produce the checkout at
666
:param revision_id: The revision to check out
667
:param lightweight: If True, produce a lightweight checkout, otherwise,
668
produce a bound branch (heavyweight checkout)
669
:return: The tree of the created checkout
671
t = transport.get_transport(to_location)
674
except errors.FileExists:
677
checkout = bzrdir.BzrDirMetaFormat1().initialize_on_transport(t)
678
BranchReferenceFormat().initialize(checkout, self)
680
format = self._get_checkout_format()
681
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
682
to_location, force_new_tree=False, format=format)
683
checkout = checkout_branch.bzrdir
684
checkout_branch.bind(self)
685
# pull up to the specified revision_id to set the initial
686
# branch tip correctly, and seed it with history.
687
checkout_branch.pull(self, stop_revision=revision_id)
688
return checkout.create_workingtree(revision_id)
690
def supports_tags(self):
691
return self._format.supports_tags()
694
class BranchFormat(object):
695
"""An encapsulation of the initialization and open routines for a format.
697
Formats provide three things:
698
* An initialization routine,
702
Formats are placed in an dict by their format string for reference
703
during branch opening. Its not required that these be instances, they
704
can be classes themselves with class methods - it simply depends on
705
whether state is needed for a given format or not.
707
Once a format is deprecated, just deprecate the initialize and open
708
methods on the format class. Do not deprecate the object, as the
709
object will be created every time regardless.
712
_default_format = None
713
"""The default format used for new branches."""
716
"""The known formats."""
719
def find_format(klass, a_bzrdir):
720
"""Return the format for the branch object in a_bzrdir."""
722
transport = a_bzrdir.get_branch_transport(None)
723
format_string = transport.get("format").read()
724
return klass._formats[format_string]
726
raise NotBranchError(path=transport.base)
728
raise errors.UnknownFormatError(format=format_string)
731
def get_default_format(klass):
732
"""Return the current default format."""
733
return klass._default_format
735
def get_format_string(self):
736
"""Return the ASCII format string that identifies this format."""
737
raise NotImplementedError(self.get_format_string)
739
def get_format_description(self):
740
"""Return the short format description for this format."""
741
raise NotImplementedError(self.get_format_description)
743
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
745
"""Initialize a branch in a bzrdir, with specified files
747
:param a_bzrdir: The bzrdir to initialize the branch in
748
:param utf8_files: The files to create as a list of
749
(filename, content) tuples
750
:param set_format: If True, set the format with
751
self.get_format_string. (BzrBranch4 has its format set
753
:return: a branch in this format
755
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
756
branch_transport = a_bzrdir.get_branch_transport(self)
758
'metadir': ('lock', lockdir.LockDir),
759
'branch4': ('branch-lock', lockable_files.TransportLock),
761
lock_name, lock_class = lock_map[lock_type]
762
control_files = lockable_files.LockableFiles(branch_transport,
763
lock_name, lock_class)
764
control_files.create_lock()
765
control_files.lock_write()
767
control_files.put_utf8('format', self.get_format_string())
769
for file, content in utf8_files:
770
control_files.put_utf8(file, content)
772
control_files.unlock()
773
return self.open(a_bzrdir, _found=True)
775
def initialize(self, a_bzrdir):
776
"""Create a branch of this format in a_bzrdir."""
777
raise NotImplementedError(self.initialize)
779
def is_supported(self):
780
"""Is this format supported?
782
Supported formats can be initialized and opened.
783
Unsupported formats may not support initialization or committing or
784
some other features depending on the reason for not being supported.
788
def open(self, a_bzrdir, _found=False):
789
"""Return the branch object for a_bzrdir
791
_found is a private parameter, do not use it. It is used to indicate
792
if format probing has already be done.
794
raise NotImplementedError(self.open)
797
def register_format(klass, format):
798
klass._formats[format.get_format_string()] = format
801
def set_default_format(klass, format):
802
klass._default_format = format
805
def unregister_format(klass, format):
806
assert klass._formats[format.get_format_string()] is format
807
del klass._formats[format.get_format_string()]
810
return self.get_format_string().rstrip()
812
def supports_tags(self):
813
"""True if this format supports tags stored in the branch"""
814
return False # by default
816
# XXX: Probably doesn't really belong here -- mbp 20070212
817
def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
819
branch_transport = a_bzrdir.get_branch_transport(self)
820
control_files = lockable_files.LockableFiles(branch_transport,
821
lock_filename, lock_class)
822
control_files.create_lock()
823
control_files.lock_write()
825
for filename, content in utf8_files:
826
control_files.put_utf8(filename, content)
828
control_files.unlock()
831
class BranchHooks(dict):
832
"""A dictionary mapping hook name to a list of callables for branch hooks.
834
e.g. ['set_rh'] Is the list of items to be called when the
835
set_revision_history function is invoked.
839
"""Create the default hooks.
841
These are all empty initially, because by default nothing should get
845
# Introduced in 0.15:
846
# invoked whenever the revision history has been set
847
# with set_revision_history. The api signature is
848
# (branch, revision_history), and the branch will
851
# invoked after a push operation completes.
852
# the api signature is
854
# containing the members
855
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
856
# where local is the local branch or None, master is the target
857
# master branch, and the rest should be self explanatory. The source
858
# is read locked and the target branches write locked. Source will
859
# be the local low-latency branch.
860
self['post_push'] = []
861
# invoked after a pull operation completes.
862
# the api signature is
864
# containing the members
865
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
866
# where local is the local branch or None, master is the target
867
# master branch, and the rest should be self explanatory. The source
868
# is read locked and the target branches write locked. The local
869
# branch is the low-latency branch.
870
self['post_pull'] = []
871
# invoked after a commit operation completes.
872
# the api signature is
873
# (local, master, old_revno, old_revid, new_revno, new_revid)
874
# old_revid is NULL_REVISION for the first commit to a branch.
875
self['post_commit'] = []
876
# invoked after a uncommit operation completes.
877
# the api signature is
878
# (local, master, old_revno, old_revid, new_revno, new_revid) where
879
# local is the local branch or None, master is the target branch,
880
# and an empty branch recieves new_revno of 0, new_revid of None.
881
self['post_uncommit'] = []
883
def install_hook(self, hook_name, a_callable):
884
"""Install a_callable in to the hook hook_name.
886
:param hook_name: A hook name. See the __init__ method of BranchHooks
887
for the complete list of hooks.
888
:param a_callable: The callable to be invoked when the hook triggers.
889
The exact signature will depend on the hook - see the __init__
890
method of BranchHooks for details on each hook.
893
self[hook_name].append(a_callable)
895
raise errors.UnknownHook('branch', hook_name)
898
# install the default hooks into the Branch class.
899
Branch.hooks = BranchHooks()
902
class BzrBranchFormat4(BranchFormat):
903
"""Bzr branch format 4.
906
- a revision-history file.
907
- a branch-lock lock file [ to be shared with the bzrdir ]
910
def get_format_description(self):
911
"""See BranchFormat.get_format_description()."""
912
return "Branch format 4"
914
def initialize(self, a_bzrdir):
915
"""Create a branch of this format in a_bzrdir."""
916
utf8_files = [('revision-history', ''),
919
return self._initialize_helper(a_bzrdir, utf8_files,
920
lock_type='branch4', set_format=False)
923
super(BzrBranchFormat4, self).__init__()
924
self._matchingbzrdir = bzrdir.BzrDirFormat6()
926
def open(self, a_bzrdir, _found=False):
927
"""Return the branch object for a_bzrdir
929
_found is a private parameter, do not use it. It is used to indicate
930
if format probing has already be done.
933
# we are being called directly and must probe.
934
raise NotImplementedError
935
return BzrBranch(_format=self,
936
_control_files=a_bzrdir._control_files,
938
_repository=a_bzrdir.open_repository())
941
return "Bazaar-NG branch format 4"
944
class BzrBranchFormat5(BranchFormat):
945
"""Bzr branch format 5.
948
- a revision-history file.
950
- a lock dir guarding the branch itself
951
- all of this stored in a branch/ subdirectory
952
- works with shared repositories.
954
This format is new in bzr 0.8.
957
def get_format_string(self):
958
"""See BranchFormat.get_format_string()."""
959
return "Bazaar-NG branch format 5\n"
961
def get_format_description(self):
962
"""See BranchFormat.get_format_description()."""
963
return "Branch format 5"
965
def initialize(self, a_bzrdir):
966
"""Create a branch of this format in a_bzrdir."""
967
utf8_files = [('revision-history', ''),
970
return self._initialize_helper(a_bzrdir, utf8_files)
973
super(BzrBranchFormat5, self).__init__()
974
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
976
def open(self, a_bzrdir, _found=False):
977
"""Return the branch object for a_bzrdir
979
_found is a private parameter, do not use it. It is used to indicate
980
if format probing has already be done.
983
format = BranchFormat.find_format(a_bzrdir)
984
assert format.__class__ == self.__class__
985
transport = a_bzrdir.get_branch_transport(None)
986
control_files = lockable_files.LockableFiles(transport, 'lock',
988
return BzrBranch5(_format=self,
989
_control_files=control_files,
991
_repository=a_bzrdir.find_repository())
994
class BzrBranchFormat6(BzrBranchFormat5):
995
"""Branch format with last-revision
997
Unlike previous formats, this has no explicit revision history. Instead,
998
this just stores the last-revision, and the left-hand history leading
999
up to there is the history.
1001
This format was introduced in bzr 0.15
1004
def get_format_string(self):
1005
"""See BranchFormat.get_format_string()."""
1006
return "Bazaar-NG branch format 6\n"
1008
def get_format_description(self):
1009
"""See BranchFormat.get_format_description()."""
1010
return "Branch format 6"
1012
def initialize(self, a_bzrdir):
1013
"""Create a branch of this format in a_bzrdir."""
1014
utf8_files = [('last-revision', '0 null:\n'),
1015
('branch-name', ''),
1016
('branch.conf', ''),
1019
return self._initialize_helper(a_bzrdir, utf8_files)
1021
def open(self, a_bzrdir, _found=False):
1022
"""Return the branch object for a_bzrdir
1024
_found is a private parameter, do not use it. It is used to indicate
1025
if format probing has already be done.
1028
format = BranchFormat.find_format(a_bzrdir)
1029
assert format.__class__ == self.__class__
1030
transport = a_bzrdir.get_branch_transport(None)
1031
control_files = lockable_files.LockableFiles(transport, 'lock',
1033
return BzrBranch6(_format=self,
1034
_control_files=control_files,
1036
_repository=a_bzrdir.find_repository())
1038
def supports_tags(self):
1042
class BranchReferenceFormat(BranchFormat):
1043
"""Bzr branch reference format.
1045
Branch references are used in implementing checkouts, they
1046
act as an alias to the real branch which is at some other url.
1053
def get_format_string(self):
1054
"""See BranchFormat.get_format_string()."""
1055
return "Bazaar-NG Branch Reference Format 1\n"
1057
def get_format_description(self):
1058
"""See BranchFormat.get_format_description()."""
1059
return "Checkout reference format 1"
1061
def initialize(self, a_bzrdir, target_branch=None):
1062
"""Create a branch of this format in a_bzrdir."""
1063
if target_branch is None:
1064
# this format does not implement branch itself, thus the implicit
1065
# creation contract must see it as uninitializable
1066
raise errors.UninitializableFormat(self)
1067
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1068
branch_transport = a_bzrdir.get_branch_transport(self)
1069
branch_transport.put_bytes('location',
1070
target_branch.bzrdir.root_transport.base)
1071
branch_transport.put_bytes('format', self.get_format_string())
1072
return self.open(a_bzrdir, _found=True)
1075
super(BranchReferenceFormat, self).__init__()
1076
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1078
def _make_reference_clone_function(format, a_branch):
1079
"""Create a clone() routine for a branch dynamically."""
1080
def clone(to_bzrdir, revision_id=None):
1081
"""See Branch.clone()."""
1082
return format.initialize(to_bzrdir, a_branch)
1083
# cannot obey revision_id limits when cloning a reference ...
1084
# FIXME RBC 20060210 either nuke revision_id for clone, or
1085
# emit some sort of warning/error to the caller ?!
1088
def open(self, a_bzrdir, _found=False):
1089
"""Return the branch that the branch reference in a_bzrdir points at.
1091
_found is a private parameter, do not use it. It is used to indicate
1092
if format probing has already be done.
1095
format = BranchFormat.find_format(a_bzrdir)
1096
assert format.__class__ == self.__class__
1097
transport = a_bzrdir.get_branch_transport(None)
1098
real_bzrdir = bzrdir.BzrDir.open(transport.get('location').read())
1099
result = real_bzrdir.open_branch()
1100
# this changes the behaviour of result.clone to create a new reference
1101
# rather than a copy of the content of the branch.
1102
# I did not use a proxy object because that needs much more extensive
1103
# testing, and we are only changing one behaviour at the moment.
1104
# If we decide to alter more behaviours - i.e. the implicit nickname
1105
# then this should be refactored to introduce a tested proxy branch
1106
# and a subclass of that for use in overriding clone() and ....
1108
result.clone = self._make_reference_clone_function(result)
1112
# formats which have no format string are not discoverable
1113
# and not independently creatable, so are not registered.
1114
__default_format = BzrBranchFormat5()
1115
BranchFormat.register_format(__default_format)
1116
BranchFormat.register_format(BranchReferenceFormat())
1117
BranchFormat.register_format(BzrBranchFormat6())
1118
BranchFormat.set_default_format(__default_format)
1119
_legacy_formats = [BzrBranchFormat4(),
1122
class BzrBranch(Branch):
1123
"""A branch stored in the actual filesystem.
1125
Note that it's "local" in the context of the filesystem; it doesn't
1126
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1127
it's writable, and can be accessed via the normal filesystem API.
1130
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
1131
relax_version_check=DEPRECATED_PARAMETER, _format=None,
1132
_control_files=None, a_bzrdir=None, _repository=None):
1133
"""Create new branch object at a particular location.
1135
transport -- A Transport object, defining how to access files.
1137
init -- If True, create new control files in a previously
1138
unversioned directory. If False, the branch must already
1141
relax_version_check -- If true, the usual check for the branch
1142
version is not applied. This is intended only for
1143
upgrade/recovery type use; it's not guaranteed that
1144
all operations will work on old format branches.
1146
Branch.__init__(self)
1147
if a_bzrdir is None:
1148
self.bzrdir = bzrdir.BzrDir.open(transport.base)
1150
self.bzrdir = a_bzrdir
1151
# self._transport used to point to the directory containing the
1152
# control directory, but was not used - now it's just the transport
1153
# for the branch control files. mbp 20070212
1154
self._base = self.bzrdir.transport.clone('..').base
1155
self._format = _format
1156
if _control_files is None:
1157
raise ValueError('BzrBranch _control_files is None')
1158
self.control_files = _control_files
1159
self._transport = _control_files._transport
1160
if deprecated_passed(init):
1161
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
1162
"deprecated as of bzr 0.8. Please use Branch.create().",
1166
# this is slower than before deprecation, oh well never mind.
1167
# -> its deprecated.
1168
self._initialize(transport.base)
1169
self._check_format(_format)
1170
if deprecated_passed(relax_version_check):
1171
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
1172
"relax_version_check parameter is deprecated as of bzr 0.8. "
1173
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
1177
if (not relax_version_check
1178
and not self._format.is_supported()):
1179
raise errors.UnsupportedFormatError(format=fmt)
1180
if deprecated_passed(transport):
1181
warn("BzrBranch.__init__(transport=XXX...): The transport "
1182
"parameter is deprecated as of bzr 0.8. "
1183
"Please use Branch.open, or bzrdir.open_branch().",
1186
self.repository = _repository
1189
return '%s(%r)' % (self.__class__.__name__, self.base)
1193
def _get_base(self):
1194
"""Returns the directory containing the control directory."""
1197
base = property(_get_base, doc="The URL for the root of this branch.")
1199
def _finish_transaction(self):
1200
"""Exit the current transaction."""
1201
return self.control_files._finish_transaction()
1203
def get_transaction(self):
1204
"""Return the current active transaction.
1206
If no transaction is active, this returns a passthrough object
1207
for which all data is immediately flushed and no caching happens.
1209
# this is an explicit function so that we can do tricky stuff
1210
# when the storage in rev_storage is elsewhere.
1211
# we probably need to hook the two 'lock a location' and
1212
# 'have a transaction' together more delicately, so that
1213
# we can have two locks (branch and storage) and one transaction
1214
# ... and finishing the transaction unlocks both, but unlocking
1215
# does not. - RBC 20051121
1216
return self.control_files.get_transaction()
1218
def _set_transaction(self, transaction):
1219
"""Set a new active transaction."""
1220
return self.control_files._set_transaction(transaction)
1222
def abspath(self, name):
1223
"""See Branch.abspath."""
1224
return self.control_files._transport.abspath(name)
1226
def _check_format(self, format):
1227
"""Identify the branch format if needed.
1229
The format is stored as a reference to the format object in
1230
self._format for code that needs to check it later.
1232
The format parameter is either None or the branch format class
1233
used to open this branch.
1235
FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
1238
format = BranchFormat.find_format(self.bzrdir)
1239
self._format = format
1240
mutter("got branch format %s", self._format)
1243
def get_root_id(self):
1244
"""See Branch.get_root_id."""
1245
tree = self.repository.revision_tree(self.last_revision())
1246
return tree.inventory.root.file_id
1248
def is_locked(self):
1249
return self.control_files.is_locked()
1251
def lock_write(self):
1252
self.repository.lock_write()
1254
self.control_files.lock_write()
1256
self.repository.unlock()
1259
def lock_read(self):
1260
self.repository.lock_read()
1262
self.control_files.lock_read()
1264
self.repository.unlock()
1268
# TODO: test for failed two phase locks. This is known broken.
1270
self.control_files.unlock()
1272
self.repository.unlock()
1274
def peek_lock_mode(self):
1275
if self.control_files._lock_count == 0:
1278
return self.control_files._lock_mode
1280
def get_physical_lock_status(self):
1281
return self.control_files.get_physical_lock_status()
1284
def print_file(self, file, revision_id):
1285
"""See Branch.print_file."""
1286
return self.repository.print_file(file, revision_id)
1289
def append_revision(self, *revision_ids):
1290
"""See Branch.append_revision."""
1291
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1292
for revision_id in revision_ids:
1293
_mod_revision.check_not_reserved_id(revision_id)
1294
mutter("add {%s} to revision-history" % revision_id)
1295
rev_history = self.revision_history()
1296
rev_history.extend(revision_ids)
1297
self.set_revision_history(rev_history)
1299
def _write_revision_history(self, history):
1300
"""Factored out of set_revision_history.
1302
This performs the actual writing to disk.
1303
It is intended to be called by BzrBranch5.set_revision_history."""
1304
self.control_files.put_bytes(
1305
'revision-history', '\n'.join(history))
1308
def set_revision_history(self, rev_history):
1309
"""See Branch.set_revision_history."""
1310
rev_history = [osutils.safe_revision_id(r) for r in rev_history]
1311
self._write_revision_history(rev_history)
1312
transaction = self.get_transaction()
1313
history = transaction.map.find_revision_history()
1314
if history is not None:
1315
# update the revision history in the identity map.
1316
history[:] = list(rev_history)
1317
# this call is disabled because revision_history is
1318
# not really an object yet, and the transaction is for objects.
1319
# transaction.register_dirty(history)
1321
transaction.map.add_revision_history(rev_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)
1325
for hook in Branch.hooks['set_rh']:
1326
hook(self, rev_history)
1329
def set_last_revision_info(self, revno, revision_id):
1330
revision_id = osutils.safe_revision_id(revision_id)
1331
history = self._lefthand_history(revision_id)
1332
assert len(history) == revno, '%d != %d' % (len(history), revno)
1333
self.set_revision_history(history)
1335
def _gen_revision_history(self):
1336
get_cached_utf8 = cache_utf8.get_cached_utf8
1337
history = [get_cached_utf8(l.rstrip('\r\n')) for l in
1338
self.control_files.get('revision-history').readlines()]
1342
def revision_history(self):
1343
"""See Branch.revision_history."""
1344
transaction = self.get_transaction()
1345
history = transaction.map.find_revision_history()
1346
if history is not None:
1347
# mutter("cache hit for revision-history in %s", self)
1348
return list(history)
1349
history = self._gen_revision_history()
1350
transaction.map.add_revision_history(history)
1351
# this call is disabled because revision_history is
1352
# not really an object yet, and the transaction is for objects.
1353
# transaction.register_clean(history, precious=True)
1354
return list(history)
1356
def _lefthand_history(self, revision_id, last_rev=None,
1358
# stop_revision must be a descendant of last_revision
1359
stop_graph = self.repository.get_revision_graph(revision_id)
1360
if last_rev is not None and last_rev not in stop_graph:
1361
# our previous tip is not merged into stop_revision
1362
raise errors.DivergedBranches(self, other_branch)
1363
# make a new revision history from the graph
1364
current_rev_id = revision_id
1366
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1367
new_history.append(current_rev_id)
1368
current_rev_id_parents = stop_graph[current_rev_id]
1370
current_rev_id = current_rev_id_parents[0]
1372
current_rev_id = None
1373
new_history.reverse()
1377
def generate_revision_history(self, revision_id, last_rev=None,
1379
"""Create a new revision history that will finish with revision_id.
1381
:param revision_id: the new tip to use.
1382
:param last_rev: The previous last_revision. If not None, then this
1383
must be a ancestory of revision_id, or DivergedBranches is raised.
1384
:param other_branch: The other branch that DivergedBranches should
1385
raise with respect to.
1387
revision_id = osutils.safe_revision_id(revision_id)
1388
self.set_revision_history(self._lefthand_history(revision_id,
1389
last_rev, other_branch))
1392
def update_revisions(self, other, stop_revision=None):
1393
"""See Branch.update_revisions."""
1396
if stop_revision is None:
1397
stop_revision = other.last_revision()
1398
if stop_revision is None:
1399
# if there are no commits, we're done.
1402
stop_revision = osutils.safe_revision_id(stop_revision)
1403
# whats the current last revision, before we fetch [and change it
1405
last_rev = self.last_revision()
1406
# we fetch here regardless of whether we need to so that we pickup
1408
self.fetch(other, stop_revision)
1409
my_ancestry = self.repository.get_ancestry(last_rev)
1410
if stop_revision in my_ancestry:
1411
# last_revision is a descendant of stop_revision
1413
self.generate_revision_history(stop_revision, last_rev=last_rev,
1418
def basis_tree(self):
1419
"""See Branch.basis_tree."""
1420
return self.repository.revision_tree(self.last_revision())
1422
@deprecated_method(zero_eight)
1423
def working_tree(self):
1424
"""Create a Working tree object for this branch."""
1426
from bzrlib.transport.local import LocalTransport
1427
if (self.base.find('://') != -1 or
1428
not isinstance(self._transport, LocalTransport)):
1429
raise NoWorkingTree(self.base)
1430
return self.bzrdir.open_workingtree()
1433
def pull(self, source, overwrite=False, stop_revision=None,
1434
_hook_master=None, _run_hooks=True):
1437
:param _hook_master: Private parameter - set the branch to
1438
be supplied as the master to push hooks.
1439
:param _run_hooks: Private parameter - allow disabling of
1440
hooks, used when pushing to a master branch.
1442
result = PullResult()
1443
result.source = source
1446
result.old_revno, result.old_revid = self.last_revision_info()
1448
self.update_revisions(source, stop_revision)
1449
except DivergedBranches:
1453
self.set_revision_history(source.revision_history())
1454
result.tag_conflicts = source.tags.merge_to(self.tags)
1455
result.new_revno, result.new_revid = self.last_revision_info()
1457
result.master = _hook_master
1460
result.master = self
1463
for hook in Branch.hooks['post_pull']:
1469
def _get_parent_location(self):
1470
_locs = ['parent', 'pull', 'x-pull']
1473
return self.control_files.get(l).read().strip('\n')
1479
def push(self, target, overwrite=False, stop_revision=None,
1480
_hook_master=None, _run_hooks=True):
1483
:param _hook_master: Private parameter - set the branch to
1484
be supplied as the master to push hooks.
1485
:param _run_hooks: Private parameter - allow disabling of
1486
hooks, used when pushing to a master branch.
1488
result = PushResult()
1489
result.source = self
1490
result.target = target
1493
result.old_revno, result.old_revid = target.last_revision_info()
1495
target.update_revisions(self, stop_revision)
1496
except DivergedBranches:
1500
target.set_revision_history(self.revision_history())
1501
result.tag_conflicts = self.tags.merge_to(target.tags)
1502
result.new_revno, result.new_revid = target.last_revision_info()
1504
result.master = _hook_master
1505
result.local = target
1507
result.master = target
1510
for hook in Branch.hooks['post_push']:
1516
def get_parent(self):
1517
"""See Branch.get_parent."""
1519
assert self.base[-1] == '/'
1520
parent = self._get_parent_location()
1523
# This is an old-format absolute path to a local branch
1524
# turn it into a url
1525
if parent.startswith('/'):
1526
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1528
return urlutils.join(self.base[:-1], parent)
1529
except errors.InvalidURLJoin, e:
1530
raise errors.InaccessibleParent(parent, self.base)
1532
def get_push_location(self):
1533
"""See Branch.get_push_location."""
1534
push_loc = self.get_config().get_user_option('push_location')
1537
def set_push_location(self, location):
1538
"""See Branch.set_push_location."""
1539
self.get_config().set_user_option(
1540
'push_location', location,
1541
store=_mod_config.STORE_LOCATION_NORECURSE)
1544
def set_parent(self, url):
1545
"""See Branch.set_parent."""
1546
# TODO: Maybe delete old location files?
1547
# URLs should never be unicode, even on the local fs,
1548
# FIXUP this and get_parent in a future branch format bump:
1549
# read and rewrite the file, and have the new format code read
1550
# using .get not .get_utf8. RBC 20060125
1552
if isinstance(url, unicode):
1554
url = url.encode('ascii')
1555
except UnicodeEncodeError:
1556
raise bzrlib.errors.InvalidURL(url,
1557
"Urls must be 7-bit ascii, "
1558
"use bzrlib.urlutils.escape")
1559
url = urlutils.relative_url(self.base, url)
1560
self._set_parent_location(url)
1562
def _set_parent_location(self, url):
1564
self.control_files._transport.delete('parent')
1566
assert isinstance(url, str)
1567
self.control_files.put_bytes('parent', url + '\n')
1569
@deprecated_function(zero_nine)
1570
def tree_config(self):
1571
"""DEPRECATED; call get_config instead.
1572
TreeConfig has become part of BranchConfig."""
1573
return TreeConfig(self)
1576
class BzrBranch5(BzrBranch):
1577
"""A format 5 branch. This supports new features over plan branches.
1579
It has support for a master_branch which is the data for bound branches.
1587
super(BzrBranch5, self).__init__(_format=_format,
1588
_control_files=_control_files,
1590
_repository=_repository)
1593
def pull(self, source, overwrite=False, stop_revision=None,
1595
"""Extends branch.pull to be bound branch aware.
1597
:param _run_hooks: Private parameter used to force hook running
1598
off during bound branch double-pushing.
1600
bound_location = self.get_bound_location()
1601
master_branch = None
1602
if bound_location and source.base != bound_location:
1603
# not pulling from master, so we need to update master.
1604
master_branch = self.get_master_branch()
1605
master_branch.lock_write()
1608
# pull from source into master.
1609
master_branch.pull(source, overwrite, stop_revision,
1611
return super(BzrBranch5, self).pull(source, overwrite,
1612
stop_revision, _hook_master=master_branch,
1613
_run_hooks=_run_hooks)
1616
master_branch.unlock()
1619
def push(self, target, overwrite=False, stop_revision=None):
1620
"""Updates branch.push to be bound branch aware."""
1621
bound_location = target.get_bound_location()
1622
master_branch = None
1623
if bound_location and target.base != bound_location:
1624
# not pushing to master, so we need to update master.
1625
master_branch = target.get_master_branch()
1626
master_branch.lock_write()
1629
# push into the master from this branch.
1630
super(BzrBranch5, self).push(master_branch, overwrite,
1631
stop_revision, _run_hooks=False)
1632
# and push into the target branch from this. Note that we push from
1633
# this branch again, because its considered the highest bandwidth
1635
return super(BzrBranch5, self).push(target, overwrite,
1636
stop_revision, _hook_master=master_branch)
1639
master_branch.unlock()
1641
def get_bound_location(self):
1643
return self.control_files.get_utf8('bound').read()[:-1]
1644
except errors.NoSuchFile:
1648
def get_master_branch(self):
1649
"""Return the branch we are bound to.
1651
:return: Either a Branch, or None
1653
This could memoise the branch, but if thats done
1654
it must be revalidated on each new lock.
1655
So for now we just don't memoise it.
1656
# RBC 20060304 review this decision.
1658
bound_loc = self.get_bound_location()
1662
return Branch.open(bound_loc)
1663
except (errors.NotBranchError, errors.ConnectionError), e:
1664
raise errors.BoundBranchConnectionFailure(
1668
def set_bound_location(self, location):
1669
"""Set the target where this branch is bound to.
1671
:param location: URL to the target branch
1674
self.control_files.put_utf8('bound', location+'\n')
1677
self.control_files._transport.delete('bound')
1683
def bind(self, other):
1684
"""Bind this branch to the branch other.
1686
This does not push or pull data between the branches, though it does
1687
check for divergence to raise an error when the branches are not
1688
either the same, or one a prefix of the other. That behaviour may not
1689
be useful, so that check may be removed in future.
1691
:param other: The branch to bind to
1694
# TODO: jam 20051230 Consider checking if the target is bound
1695
# It is debatable whether you should be able to bind to
1696
# a branch which is itself bound.
1697
# Committing is obviously forbidden,
1698
# but binding itself may not be.
1699
# Since we *have* to check at commit time, we don't
1700
# *need* to check here
1702
# we want to raise diverged if:
1703
# last_rev is not in the other_last_rev history, AND
1704
# other_last_rev is not in our history, and do it without pulling
1706
last_rev = self.last_revision()
1707
if last_rev is not None:
1710
other_last_rev = other.last_revision()
1711
if other_last_rev is not None:
1712
# neither branch is new, we have to do some work to
1713
# ascertain diversion.
1714
remote_graph = other.repository.get_revision_graph(
1716
local_graph = self.repository.get_revision_graph(last_rev)
1717
if (last_rev not in remote_graph and
1718
other_last_rev not in local_graph):
1719
raise errors.DivergedBranches(self, other)
1722
self.set_bound_location(other.base)
1726
"""If bound, unbind"""
1727
return self.set_bound_location(None)
1731
"""Synchronise this branch with the master branch if any.
1733
:return: None or the last_revision that was pivoted out during the
1736
master = self.get_master_branch()
1737
if master is not None:
1738
old_tip = self.last_revision()
1739
self.pull(master, overwrite=True)
1740
if old_tip in self.repository.get_ancestry(self.last_revision()):
1746
class BzrBranchExperimental(BzrBranch5):
1747
"""Bzr experimental branch format
1750
- a revision-history file.
1752
- a lock dir guarding the branch itself
1753
- all of this stored in a branch/ subdirectory
1754
- works with shared repositories.
1755
- a tag dictionary in the branch
1757
This format is new in bzr 0.15, but shouldn't be used for real data,
1760
This class acts as it's own BranchFormat.
1763
_matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1766
def get_format_string(cls):
1767
"""See BranchFormat.get_format_string()."""
1768
return "Bazaar-NG branch format experimental\n"
1771
def get_format_description(cls):
1772
"""See BranchFormat.get_format_description()."""
1773
return "Experimental branch format"
1776
def _initialize_control_files(cls, a_bzrdir, utf8_files, lock_filename,
1778
branch_transport = a_bzrdir.get_branch_transport(cls)
1779
control_files = lockable_files.LockableFiles(branch_transport,
1780
lock_filename, lock_class)
1781
control_files.create_lock()
1782
control_files.lock_write()
1784
for filename, content in utf8_files:
1785
control_files.put_utf8(filename, content)
1787
control_files.unlock()
1790
def initialize(cls, a_bzrdir):
1791
"""Create a branch of this format in a_bzrdir."""
1792
utf8_files = [('format', cls.get_format_string()),
1793
('revision-history', ''),
1794
('branch-name', ''),
1797
cls._initialize_control_files(a_bzrdir, utf8_files,
1798
'lock', lockdir.LockDir)
1799
return cls.open(a_bzrdir, _found=True)
1802
def open(cls, a_bzrdir, _found=False):
1803
"""Return the branch object for a_bzrdir
1805
_found is a private parameter, do not use it. It is used to indicate
1806
if format probing has already be done.
1809
format = BranchFormat.find_format(a_bzrdir)
1810
assert format.__class__ == cls
1811
transport = a_bzrdir.get_branch_transport(None)
1812
control_files = lockable_files.LockableFiles(transport, 'lock',
1814
return cls(_format=cls,
1815
_control_files=control_files,
1817
_repository=a_bzrdir.find_repository())
1820
def is_supported(cls):
1823
def _make_tags(self):
1824
return BasicTags(self)
1827
def supports_tags(cls):
1831
BranchFormat.register_format(BzrBranchExperimental)
1834
class BzrBranch6(BzrBranch5):
1837
def last_revision_info(self):
1838
revision_string = self.control_files.get('last-revision').read()
1839
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1840
revision_id = cache_utf8.get_cached_utf8(revision_id)
1842
return revno, revision_id
1844
def last_revision(self):
1845
"""Return last revision id, or None"""
1846
revision_id = self.last_revision_info()[1]
1847
if revision_id == _mod_revision.NULL_REVISION:
1851
def _write_last_revision_info(self, revno, revision_id):
1852
"""Simply write out the revision id, with no checks.
1854
Use set_last_revision_info to perform this safely.
1856
Does not update the revision_history cache.
1857
Intended to be called by set_last_revision_info and
1858
_write_revision_history.
1860
if revision_id is None:
1861
revision_id = 'null:'
1862
out_string = '%d %s\n' % (revno, revision_id)
1863
self.control_files.put_bytes('last-revision', out_string)
1866
def set_last_revision_info(self, revno, revision_id):
1867
revision_id = osutils.safe_revision_id(revision_id)
1868
if self._get_append_revisions_only():
1869
self._check_history_violation(revision_id)
1870
self._write_last_revision_info(revno, revision_id)
1871
transaction = self.get_transaction()
1872
cached_history = transaction.map.find_revision_history()
1873
if cached_history is not None:
1874
transaction.map.remove_object(cached_history)
1876
def _check_history_violation(self, revision_id):
1877
last_revision = self.last_revision()
1878
if last_revision is None:
1880
if last_revision not in self._lefthand_history(revision_id):
1881
raise errors.AppendRevisionsOnlyViolation(self.base)
1883
def _gen_revision_history(self):
1884
"""Generate the revision history from last revision
1886
history = list(self.repository.iter_reverse_revision_history(
1887
self.last_revision()))
1891
def _write_revision_history(self, history):
1892
"""Factored out of set_revision_history.
1894
This performs the actual writing to disk, with format-specific checks.
1895
It is intended to be called by BzrBranch5.set_revision_history.
1897
if len(history) == 0:
1898
last_revision = 'null:'
1900
if history != self._lefthand_history(history[-1]):
1901
raise errors.NotLefthandHistory(history)
1902
last_revision = history[-1]
1903
if self._get_append_revisions_only():
1904
self._check_history_violation(last_revision)
1905
self._write_last_revision_info(len(history), last_revision)
1908
def append_revision(self, *revision_ids):
1909
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1910
if len(revision_ids) == 0:
1912
prev_revno, prev_revision = self.last_revision_info()
1913
for revision in self.repository.get_revisions(revision_ids):
1914
if prev_revision == _mod_revision.NULL_REVISION:
1915
if revision.parent_ids != []:
1916
raise errors.NotLeftParentDescendant(self, prev_revision,
1917
revision.revision_id)
1919
if revision.parent_ids[0] != prev_revision:
1920
raise errors.NotLeftParentDescendant(self, prev_revision,
1921
revision.revision_id)
1922
prev_revision = revision.revision_id
1923
self.set_last_revision_info(prev_revno + len(revision_ids),
1926
def _set_config_location(self, name, url, config=None,
1927
make_relative=False):
1929
config = self.get_config()
1933
url = urlutils.relative_url(self.base, url)
1934
config.set_user_option(name, url)
1937
def _get_config_location(self, name, config=None):
1939
config = self.get_config()
1940
location = config.get_user_option(name)
1946
def _set_parent_location(self, url):
1947
"""Set the parent branch"""
1948
self._set_config_location('parent_location', url, make_relative=True)
1951
def _get_parent_location(self):
1952
"""Set the parent branch"""
1953
return self._get_config_location('parent_location')
1955
def set_push_location(self, location):
1956
"""See Branch.set_push_location."""
1957
self._set_config_location('push_location', location)
1959
def set_bound_location(self, location):
1960
"""See Branch.set_push_location."""
1962
config = self.get_config()
1963
if location is None:
1964
if config.get_user_option('bound') != 'True':
1967
config.set_user_option('bound', 'False')
1970
self._set_config_location('bound_location', location,
1972
config.set_user_option('bound', 'True')
1975
def _get_bound_location(self, bound):
1976
"""Return the bound location in the config file.
1978
Return None if the bound parameter does not match"""
1979
config = self.get_config()
1980
config_bound = (config.get_user_option('bound') == 'True')
1981
if config_bound != bound:
1983
return self._get_config_location('bound_location', config=config)
1985
def get_bound_location(self):
1986
"""See Branch.set_push_location."""
1987
return self._get_bound_location(True)
1989
def get_old_bound_location(self):
1990
"""See Branch.get_old_bound_location"""
1991
return self._get_bound_location(False)
1993
def set_append_revisions_only(self, enabled):
1998
self.get_config().set_user_option('append_revisions_only', value)
2000
def _get_append_revisions_only(self):
2001
value = self.get_config().get_user_option('append_revisions_only')
2002
return value == 'True'
2004
def _synchronize_history(self, destination, revision_id):
2005
"""Synchronize last revision and revision history between branches.
2007
This version is most efficient when the destination is also a
2008
BzrBranch6, but works for BzrBranch5, as long as the destination's
2009
repository contains all the lefthand ancestors of the intended
2010
last_revision. If not, set_last_revision_info will fail.
2012
:param destination: The branch to copy the history into
2013
:param revision_id: The revision-id to truncate history at. May
2014
be None to copy complete history.
2016
if revision_id is None:
2017
revno, revision_id = self.last_revision_info()
2019
revno = self.revision_id_to_revno(revision_id)
2020
destination.set_last_revision_info(revno, revision_id)
2022
def _make_tags(self):
2023
return BasicTags(self)
2026
class BranchTestProviderAdapter(object):
2027
"""A tool to generate a suite testing multiple branch formats at once.
2029
This is done by copying the test once for each transport and injecting
2030
the transport_server, transport_readonly_server, and branch_format
2031
classes into each copy. Each copy is also given a new id() to make it
2035
def __init__(self, transport_server, transport_readonly_server, formats):
2036
self._transport_server = transport_server
2037
self._transport_readonly_server = transport_readonly_server
2038
self._formats = formats
2040
def adapt(self, test):
2041
result = TestSuite()
2042
for branch_format, bzrdir_format in self._formats:
2043
new_test = deepcopy(test)
2044
new_test.transport_server = self._transport_server
2045
new_test.transport_readonly_server = self._transport_readonly_server
2046
new_test.bzrdir_format = bzrdir_format
2047
new_test.branch_format = branch_format
2048
def make_new_test_id():
2049
# the format can be either a class or an instance
2050
name = getattr(branch_format, '__name__',
2051
branch_format.__class__.__name__)
2052
new_id = "%s(%s)" % (new_test.id(), name)
2053
return lambda: new_id
2054
new_test.id = make_new_test_id()
2055
result.addTest(new_test)
2059
######################################################################
2060
# results of operations
2063
class _Result(object):
2065
def _show_tag_conficts(self, to_file):
2066
if not getattr(self, 'tag_conflicts', None):
2068
to_file.write('Conflicting tags:\n')
2069
for name, value1, value2 in self.tag_conflicts:
2070
to_file.write(' %s\n' % (name, ))
2073
class PullResult(_Result):
2076
# DEPRECATED: pull used to return the change in revno
2077
return self.new_revno - self.old_revno
2079
def report(self, to_file):
2080
if self.old_revid == self.new_revid:
2081
to_file.write('No revisions to pull.\n')
2083
to_file.write('Now on revision %d.\n' % self.new_revno)
2084
self._show_tag_conficts(to_file)
2087
class PushResult(_Result):
2088
"""Describes the result of a Branch.push operation"""
2091
# DEPRECATED: push used to return the change in revno
2092
return self.new_revno - self.old_revno
2094
def report(self, to_file):
2095
"""Write a human-readable description of the result."""
2096
if self.old_revid == self.new_revid:
2097
to_file.write('No new revisions to push.\n')
2099
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2100
self._show_tag_conficts(to_file)
2103
class BranchCheckResult(object):
2104
"""Results of checking branch consistency.
2109
def __init__(self, branch):
2110
self.branch = branch
2112
def report_results(self, verbose):
2113
"""Report the check results via trace.note.
2115
:param verbose: Requests more detailed display of what was checked,
2118
note('checked branch %s format %s',
2120
self.branch._format)
2123
class Converter5to6(object):
2124
"""Perform an in-place upgrade of format 5 to format 6"""
2126
def convert(self, branch):
2127
# Data for 5 and 6 can peacefully coexist.
2128
format = BzrBranchFormat6()
2129
new_branch = format.open(branch.bzrdir, _found=True)
2131
# Copy source data into target
2132
new_branch.set_last_revision_info(*branch.last_revision_info())
2133
new_branch.set_parent(branch.get_parent())
2134
new_branch.set_bound_location(branch.get_bound_location())
2135
new_branch.set_push_location(branch.get_push_location())
2137
# Copying done; now update target format
2138
new_branch.control_files.put_utf8('format',
2139
format.get_format_string())
2141
# Clean up old files
2142
new_branch.control_files._transport.delete('revision-history')
2144
branch.set_parent(None)
2147
branch.set_bound_location(None)
added
removed
bzrlib/branch.py
