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 Branch Format 6 (bzr 0.15)\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()
101
self._revision_history_cache = None
103
def break_lock(self):
104
"""Break a lock if one is present from another instance.
106
Uses the ui factory to ask for confirmation if the lock may be from
109
This will probe the repository for its lock as well.
111
self.control_files.break_lock()
112
self.repository.break_lock()
113
master = self.get_master_branch()
114
if master is not None:
118
@deprecated_method(zero_eight)
119
def open_downlevel(base):
120
"""Open a branch which may be of an old format."""
121
return Branch.open(base, _unsupported=True)
124
def open(base, _unsupported=False):
125
"""Open the branch rooted at base.
127
For instance, if the branch is at URL/.bzr/branch,
128
Branch.open(URL) -> a Branch instance.
130
control = bzrdir.BzrDir.open(base, _unsupported)
131
return control.open_branch(_unsupported)
134
def open_containing(url):
135
"""Open an existing branch which contains url.
137
This probes for a branch at url, and searches upwards from there.
139
Basically we keep looking up until we find the control directory or
140
run into the root. If there isn't one, raises NotBranchError.
141
If there is one and it is either an unrecognised format or an unsupported
142
format, UnknownFormatError or UnsupportedFormatError are raised.
143
If there is one, it is returned, along with the unused portion of url.
145
control, relpath = bzrdir.BzrDir.open_containing(url)
146
return control.open_branch(), relpath
149
@deprecated_function(zero_eight)
150
def initialize(base):
151
"""Create a new working tree and branch, rooted at 'base' (url)
153
NOTE: This will soon be deprecated in favour of creation
156
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
158
@deprecated_function(zero_eight)
159
def setup_caching(self, cache_root):
160
"""Subclasses that care about caching should override this, and set
161
up cached stores located under cache_root.
163
NOTE: This is unused.
167
def get_config(self):
168
return BranchConfig(self)
171
return self.get_config().get_nickname()
173
def _set_nick(self, nick):
174
self.get_config().set_user_option('nickname', nick)
176
nick = property(_get_nick, _set_nick)
179
raise NotImplementedError(self.is_locked)
181
def lock_write(self):
182
raise NotImplementedError(self.lock_write)
185
raise NotImplementedError(self.lock_read)
188
raise NotImplementedError(self.unlock)
190
def peek_lock_mode(self):
191
"""Return lock mode for the Branch: 'r', 'w' or None"""
192
raise NotImplementedError(self.peek_lock_mode)
194
def get_physical_lock_status(self):
195
raise NotImplementedError(self.get_physical_lock_status)
197
def leave_lock_in_place(self):
198
"""Tell this branch object not to release the physical lock when this
201
If lock_write doesn't return a token, then this method is not supported.
203
self.control_files.leave_in_place()
205
def dont_leave_lock_in_place(self):
206
"""Tell this branch object to release the physical lock when this
207
object is unlocked, even if it didn't originally acquire it.
209
If lock_write doesn't return a token, then this method is not supported.
211
self.control_files.dont_leave_in_place()
213
def abspath(self, name):
214
"""Return absolute filename for something in the branch
216
XXX: Robert Collins 20051017 what is this used for? why is it a branch
217
method and not a tree method.
219
raise NotImplementedError(self.abspath)
221
def bind(self, other):
222
"""Bind the local branch the other branch.
224
:param other: The branch to bind to
227
raise errors.UpgradeRequired(self.base)
230
def fetch(self, from_branch, last_revision=None, pb=None):
231
"""Copy revisions from from_branch into this branch.
233
:param from_branch: Where to copy from.
234
:param last_revision: What revision to stop at (None for at the end
236
:param pb: An optional progress bar to use.
238
Returns the copied revision count and the failed revisions in a tuple:
241
if self.base == from_branch.base:
244
nested_pb = ui.ui_factory.nested_progress_bar()
249
from_branch.lock_read()
251
if last_revision is None:
252
pb.update('get source history')
253
last_revision = from_branch.last_revision()
254
if last_revision is None:
255
last_revision = _mod_revision.NULL_REVISION
256
return self.repository.fetch(from_branch.repository,
257
revision_id=last_revision,
260
if nested_pb is not None:
264
def get_bound_location(self):
265
"""Return the URL of the branch we are bound to.
267
Older format branches cannot bind, please be sure to use a metadir
272
def get_old_bound_location(self):
273
"""Return the URL of the branch we used to be bound to
275
raise errors.UpgradeRequired(self.base)
277
def get_commit_builder(self, parents, config=None, timestamp=None,
278
timezone=None, committer=None, revprops=None,
280
"""Obtain a CommitBuilder for this branch.
282
:param parents: Revision ids of the parents of the new revision.
283
:param config: Optional configuration to use.
284
:param timestamp: Optional timestamp recorded for commit.
285
:param timezone: Optional timezone for timestamp.
286
:param committer: Optional committer to set for commit.
287
:param revprops: Optional dictionary of revision properties.
288
:param revision_id: Optional revision id.
292
config = self.get_config()
294
return self.repository.get_commit_builder(self, parents, config,
295
timestamp, timezone, committer, revprops, revision_id)
297
def get_master_branch(self):
298
"""Return the branch we are bound to.
300
:return: Either a Branch, or None
304
def get_revision_delta(self, revno):
305
"""Return the delta for one revision.
307
The delta is relative to its mainline predecessor, or the
308
empty tree for revision 1.
310
assert isinstance(revno, int)
311
rh = self.revision_history()
312
if not (1 <= revno <= len(rh)):
313
raise InvalidRevisionNumber(revno)
314
return self.repository.get_revision_delta(rh[revno-1])
316
def get_root_id(self):
317
"""Return the id of this branches root"""
318
raise NotImplementedError(self.get_root_id)
320
def print_file(self, file, revision_id):
321
"""Print `file` to stdout."""
322
raise NotImplementedError(self.print_file)
324
def append_revision(self, *revision_ids):
325
raise NotImplementedError(self.append_revision)
327
def set_revision_history(self, rev_history):
328
raise NotImplementedError(self.set_revision_history)
330
def _cache_revision_history(self, rev_history):
331
"""Set the cached revision history to rev_history.
333
The revision_history method will use this cache to avoid regenerating
334
the revision history.
336
This API is semi-public; it only for use by subclasses, all other code
337
should consider it to be private.
339
self._revision_history_cache = rev_history
341
def _clear_cached_state(self):
342
"""Clear any cached data on this branch, e.g. cached revision history.
344
This means the next call to revision_history will need to call
345
_gen_revision_history.
347
This API is semi-public; it only for use by subclasses, all other code
348
should consider it to be private.
350
self._revision_history_cache = None
352
def _gen_revision_history(self):
353
"""Return sequence of revision hashes on to this branch.
355
Unlike revision_history, this method always regenerates or rereads the
356
revision history, i.e. it does not cache the result, so repeated calls
359
Concrete subclasses should override this instead of revision_history so
360
that subclasses do not need to deal with caching logic.
362
This API is semi-public; it only for use by subclasses, all other code
363
should consider it to be private.
365
raise NotImplementedError(self._gen_revision_history)
368
def revision_history(self):
369
"""Return sequence of revision hashes on to this branch.
371
This method will cache the revision history for as long as it is safe to
374
if self._revision_history_cache is not None:
375
history = self._revision_history_cache
377
history = self._gen_revision_history()
378
self._cache_revision_history(history)
382
"""Return current revision number for this branch.
384
That is equivalent to the number of revisions committed to
387
return len(self.revision_history())
390
"""Older format branches cannot bind or unbind."""
391
raise errors.UpgradeRequired(self.base)
393
def set_append_revisions_only(self, enabled):
394
"""Older format branches are never restricted to append-only"""
395
raise errors.UpgradeRequired(self.base)
397
def last_revision(self):
398
"""Return last revision id, or None"""
399
ph = self.revision_history()
405
def last_revision_info(self):
406
"""Return information about the last revision.
408
:return: A tuple (revno, last_revision_id).
410
rh = self.revision_history()
413
return (revno, rh[-1])
415
return (0, _mod_revision.NULL_REVISION)
417
def missing_revisions(self, other, stop_revision=None):
418
"""Return a list of new revisions that would perfectly fit.
420
If self and other have not diverged, return a list of the revisions
421
present in other, but missing from self.
423
self_history = self.revision_history()
424
self_len = len(self_history)
425
other_history = other.revision_history()
426
other_len = len(other_history)
427
common_index = min(self_len, other_len) -1
428
if common_index >= 0 and \
429
self_history[common_index] != other_history[common_index]:
430
raise DivergedBranches(self, other)
432
if stop_revision is None:
433
stop_revision = other_len
435
assert isinstance(stop_revision, int)
436
if stop_revision > other_len:
437
raise errors.NoSuchRevision(self, stop_revision)
438
return other_history[self_len:stop_revision]
440
def update_revisions(self, other, stop_revision=None):
441
"""Pull in new perfect-fit revisions.
443
:param other: Another Branch to pull from
444
:param stop_revision: Updated until the given revision
447
raise NotImplementedError(self.update_revisions)
449
def revision_id_to_revno(self, revision_id):
450
"""Given a revision id, return its revno"""
451
if revision_id is None:
453
revision_id = osutils.safe_revision_id(revision_id)
454
history = self.revision_history()
456
return history.index(revision_id) + 1
458
raise bzrlib.errors.NoSuchRevision(self, revision_id)
460
def get_rev_id(self, revno, history=None):
461
"""Find the revision id of the specified revno."""
465
history = self.revision_history()
466
if revno <= 0 or revno > len(history):
467
raise bzrlib.errors.NoSuchRevision(self, revno)
468
return history[revno - 1]
470
def pull(self, source, overwrite=False, stop_revision=None):
471
"""Mirror source into this branch.
473
This branch is considered to be 'local', having low latency.
475
:returns: PullResult instance
477
raise NotImplementedError(self.pull)
479
def push(self, target, overwrite=False, stop_revision=None):
480
"""Mirror this branch into target.
482
This branch is considered to be 'local', having low latency.
484
raise NotImplementedError(self.push)
486
def basis_tree(self):
487
"""Return `Tree` object for last revision."""
488
return self.repository.revision_tree(self.last_revision())
490
def rename_one(self, from_rel, to_rel):
493
This can change the directory or the filename or both.
495
raise NotImplementedError(self.rename_one)
497
def move(self, from_paths, to_name):
500
to_name must exist as a versioned directory.
502
If to_name exists and is a directory, the files are moved into
503
it, keeping their old names. If it is a directory,
505
Note that to_name is only the last component of the new name;
506
this doesn't change the directory.
508
This returns a list of (from_path, to_path) pairs for each
511
raise NotImplementedError(self.move)
513
def get_parent(self):
514
"""Return the parent location of the branch.
516
This is the default location for push/pull/missing. The usual
517
pattern is that the user can override it by specifying a
520
raise NotImplementedError(self.get_parent)
522
def _set_config_location(self, name, url, config=None,
523
make_relative=False):
525
config = self.get_config()
529
url = urlutils.relative_url(self.base, url)
530
config.set_user_option(name, url)
532
def _get_config_location(self, name, config=None):
534
config = self.get_config()
535
location = config.get_user_option(name)
540
def get_submit_branch(self):
541
"""Return the submit location of the branch.
543
This is the default location for bundle. The usual
544
pattern is that the user can override it by specifying a
547
return self.get_config().get_user_option('submit_branch')
549
def set_submit_branch(self, location):
550
"""Return the submit location of the branch.
552
This is the default location for bundle. The usual
553
pattern is that the user can override it by specifying a
556
self.get_config().set_user_option('submit_branch', location)
558
def get_public_branch(self):
559
"""Return the public location of the branch.
561
This is is used by merge directives.
563
return self._get_config_location('public_branch')
565
def set_public_branch(self, location):
566
"""Return the submit location of the branch.
568
This is the default location for bundle. The usual
569
pattern is that the user can override it by specifying a
572
self._set_config_location('public_branch', location)
574
def get_push_location(self):
575
"""Return the None or the location to push this branch to."""
576
push_loc = self.get_config().get_user_option('push_location')
579
def set_push_location(self, location):
580
"""Set a new push location for this branch."""
581
raise NotImplementedError(self.set_push_location)
583
def set_parent(self, url):
584
raise NotImplementedError(self.set_parent)
588
"""Synchronise this branch with the master branch if any.
590
:return: None or the last_revision pivoted out during the update.
594
def check_revno(self, revno):
596
Check whether a revno corresponds to any revision.
597
Zero (the NULL revision) is considered valid.
600
self.check_real_revno(revno)
602
def check_real_revno(self, revno):
604
Check whether a revno corresponds to a real revision.
605
Zero (the NULL revision) is considered invalid
607
if revno < 1 or revno > self.revno():
608
raise InvalidRevisionNumber(revno)
611
def clone(self, *args, **kwargs):
612
"""Clone this branch into to_bzrdir preserving all semantic values.
614
revision_id: if not None, the revision history in the new branch will
615
be truncated to end with revision_id.
617
# for API compatibility, until 0.8 releases we provide the old api:
618
# def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
619
# after 0.8 releases, the *args and **kwargs should be changed:
620
# def clone(self, to_bzrdir, revision_id=None):
621
if (kwargs.get('to_location', None) or
622
kwargs.get('revision', None) or
623
kwargs.get('basis_branch', None) or
624
(len(args) and isinstance(args[0], basestring))):
625
# backwards compatibility api:
626
warn("Branch.clone() has been deprecated for BzrDir.clone() from"
627
" bzrlib 0.8.", DeprecationWarning, stacklevel=3)
630
basis_branch = args[2]
632
basis_branch = kwargs.get('basis_branch', None)
634
basis = basis_branch.bzrdir
639
revision_id = args[1]
641
revision_id = kwargs.get('revision', None)
646
# no default to raise if not provided.
647
url = kwargs.get('to_location')
648
return self.bzrdir.clone(url,
649
revision_id=revision_id,
650
basis=basis).open_branch()
652
# generate args by hand
654
revision_id = args[1]
656
revision_id = kwargs.get('revision_id', None)
660
# no default to raise if not provided.
661
to_bzrdir = kwargs.get('to_bzrdir')
662
result = self._format.initialize(to_bzrdir)
663
self.copy_content_into(result, revision_id=revision_id)
667
def sprout(self, to_bzrdir, revision_id=None):
668
"""Create a new line of development from the branch, into to_bzrdir.
670
revision_id: if not None, the revision history in the new branch will
671
be truncated to end with revision_id.
673
result = self._format.initialize(to_bzrdir)
674
self.copy_content_into(result, revision_id=revision_id)
675
result.set_parent(self.bzrdir.root_transport.base)
678
def _synchronize_history(self, destination, revision_id):
679
"""Synchronize last revision and revision history between branches.
681
This version is most efficient when the destination is also a
682
BzrBranch5, but works for BzrBranch6 as long as the revision
683
history is the true lefthand parent history, and all of the revisions
684
are in the destination's repository. If not, set_revision_history
687
:param destination: The branch to copy the history into
688
:param revision_id: The revision-id to truncate history at. May
689
be None to copy complete history.
691
new_history = self.revision_history()
692
if revision_id is not None:
693
revision_id = osutils.safe_revision_id(revision_id)
695
new_history = new_history[:new_history.index(revision_id) + 1]
697
rev = self.repository.get_revision(revision_id)
698
new_history = rev.get_history(self.repository)[1:]
699
destination.set_revision_history(new_history)
702
def copy_content_into(self, destination, revision_id=None):
703
"""Copy the content of self into destination.
705
revision_id: if not None, the revision history in the new branch will
706
be truncated to end with revision_id.
708
self._synchronize_history(destination, revision_id)
710
parent = self.get_parent()
711
except errors.InaccessibleParent, e:
712
mutter('parent was not accessible to copy: %s', e)
715
destination.set_parent(parent)
716
self.tags.merge_to(destination.tags)
720
"""Check consistency of the branch.
722
In particular this checks that revisions given in the revision-history
723
do actually match up in the revision graph, and that they're all
724
present in the repository.
726
Callers will typically also want to check the repository.
728
:return: A BranchCheckResult.
730
mainline_parent_id = None
731
for revision_id in self.revision_history():
733
revision = self.repository.get_revision(revision_id)
734
except errors.NoSuchRevision, e:
735
raise errors.BzrCheckError("mainline revision {%s} not in repository"
737
# In general the first entry on the revision history has no parents.
738
# But it's not illegal for it to have parents listed; this can happen
739
# in imports from Arch when the parents weren't reachable.
740
if mainline_parent_id is not None:
741
if mainline_parent_id not in revision.parent_ids:
742
raise errors.BzrCheckError("previous revision {%s} not listed among "
744
% (mainline_parent_id, revision_id))
745
mainline_parent_id = revision_id
746
return BranchCheckResult(self)
748
def _get_checkout_format(self):
749
"""Return the most suitable metadir for a checkout of this branch.
750
Weaves are used if this branch's repository uses weaves.
752
from bzrlib.remote import RemoteBzrDir
753
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
754
from bzrlib.repofmt import weaverepo
755
format = bzrdir.BzrDirMetaFormat1()
756
format.repository_format = weaverepo.RepositoryFormat7()
757
elif isinstance(self.bzrdir, RemoteBzrDir):
758
format = bzrdir.BzrDirMetaFormat1()
760
format = self.repository.bzrdir.checkout_metadir()
761
format.set_branch_format(self._format)
764
def create_checkout(self, to_location, revision_id=None,
766
"""Create a checkout of a branch.
768
:param to_location: The url to produce the checkout at
769
:param revision_id: The revision to check out
770
:param lightweight: If True, produce a lightweight checkout, otherwise,
771
produce a bound branch (heavyweight checkout)
772
:return: The tree of the created checkout
774
t = transport.get_transport(to_location)
777
except errors.FileExists:
780
format = self._get_checkout_format()
781
checkout = format.initialize_on_transport(t)
782
BranchReferenceFormat().initialize(checkout, self)
784
format = self._get_checkout_format()
785
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
786
to_location, force_new_tree=False, format=format)
787
checkout = checkout_branch.bzrdir
788
checkout_branch.bind(self)
789
# pull up to the specified revision_id to set the initial
790
# branch tip correctly, and seed it with history.
791
checkout_branch.pull(self, stop_revision=revision_id)
792
tree = checkout.create_workingtree(revision_id)
793
basis_tree = tree.basis_tree()
794
basis_tree.lock_read()
796
for path, file_id in basis_tree.iter_references():
797
reference_parent = self.reference_parent(file_id, path)
798
reference_parent.create_checkout(tree.abspath(path),
799
basis_tree.get_reference_revision(file_id, path),
805
def reference_parent(self, file_id, path):
806
"""Return the parent branch for a tree-reference file_id
807
:param file_id: The file_id of the tree reference
808
:param path: The path of the file_id in the tree
809
:return: A branch associated with the file_id
811
# FIXME should provide multiple branches, based on config
812
return Branch.open(self.bzrdir.root_transport.clone(path).base)
814
def supports_tags(self):
815
return self._format.supports_tags()
818
class BranchFormat(object):
819
"""An encapsulation of the initialization and open routines for a format.
821
Formats provide three things:
822
* An initialization routine,
826
Formats are placed in an dict by their format string for reference
827
during branch opening. Its not required that these be instances, they
828
can be classes themselves with class methods - it simply depends on
829
whether state is needed for a given format or not.
831
Once a format is deprecated, just deprecate the initialize and open
832
methods on the format class. Do not deprecate the object, as the
833
object will be created every time regardless.
836
_default_format = None
837
"""The default format used for new branches."""
840
"""The known formats."""
843
def find_format(klass, a_bzrdir):
844
"""Return the format for the branch object in a_bzrdir."""
846
transport = a_bzrdir.get_branch_transport(None)
847
format_string = transport.get("format").read()
848
return klass._formats[format_string]
850
raise NotBranchError(path=transport.base)
852
raise errors.UnknownFormatError(format=format_string)
855
def get_default_format(klass):
856
"""Return the current default format."""
857
return klass._default_format
859
def get_format_string(self):
860
"""Return the ASCII format string that identifies this format."""
861
raise NotImplementedError(self.get_format_string)
863
def get_format_description(self):
864
"""Return the short format description for this format."""
865
raise NotImplementedError(self.get_format_description)
867
def get_reference(self, a_bzrdir):
868
"""Get the target reference of the branch in a_bzrdir.
870
format probing must have been completed before calling
871
this method - it is assumed that the format of the branch
872
in a_bzrdir is correct.
874
:param a_bzrdir: The bzrdir to get the branch data from.
875
:return: None if the branch is not a reference branch.
879
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
881
"""Initialize a branch in a bzrdir, with specified files
883
:param a_bzrdir: The bzrdir to initialize the branch in
884
:param utf8_files: The files to create as a list of
885
(filename, content) tuples
886
:param set_format: If True, set the format with
887
self.get_format_string. (BzrBranch4 has its format set
889
:return: a branch in this format
891
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
892
branch_transport = a_bzrdir.get_branch_transport(self)
894
'metadir': ('lock', lockdir.LockDir),
895
'branch4': ('branch-lock', lockable_files.TransportLock),
897
lock_name, lock_class = lock_map[lock_type]
898
control_files = lockable_files.LockableFiles(branch_transport,
899
lock_name, lock_class)
900
control_files.create_lock()
901
control_files.lock_write()
903
control_files.put_utf8('format', self.get_format_string())
905
for file, content in utf8_files:
906
control_files.put_utf8(file, content)
908
control_files.unlock()
909
return self.open(a_bzrdir, _found=True)
911
def initialize(self, a_bzrdir):
912
"""Create a branch of this format in a_bzrdir."""
913
raise NotImplementedError(self.initialize)
915
def is_supported(self):
916
"""Is this format supported?
918
Supported formats can be initialized and opened.
919
Unsupported formats may not support initialization or committing or
920
some other features depending on the reason for not being supported.
924
def open(self, a_bzrdir, _found=False):
925
"""Return the branch object for a_bzrdir
927
_found is a private parameter, do not use it. It is used to indicate
928
if format probing has already be done.
930
raise NotImplementedError(self.open)
933
def register_format(klass, format):
934
klass._formats[format.get_format_string()] = format
937
def set_default_format(klass, format):
938
klass._default_format = format
941
def unregister_format(klass, format):
942
assert klass._formats[format.get_format_string()] is format
943
del klass._formats[format.get_format_string()]
946
return self.get_format_string().rstrip()
948
def supports_tags(self):
949
"""True if this format supports tags stored in the branch"""
950
return False # by default
952
# XXX: Probably doesn't really belong here -- mbp 20070212
953
def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
955
branch_transport = a_bzrdir.get_branch_transport(self)
956
control_files = lockable_files.LockableFiles(branch_transport,
957
lock_filename, lock_class)
958
control_files.create_lock()
959
control_files.lock_write()
961
for filename, content in utf8_files:
962
control_files.put_utf8(filename, content)
964
control_files.unlock()
967
class BranchHooks(dict):
968
"""A dictionary mapping hook name to a list of callables for branch hooks.
970
e.g. ['set_rh'] Is the list of items to be called when the
971
set_revision_history function is invoked.
975
"""Create the default hooks.
977
These are all empty initially, because by default nothing should get
981
# Introduced in 0.15:
982
# invoked whenever the revision history has been set
983
# with set_revision_history. The api signature is
984
# (branch, revision_history), and the branch will
987
# invoked after a push operation completes.
988
# the api signature is
990
# containing the members
991
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
992
# where local is the local branch or None, master is the target
993
# master branch, and the rest should be self explanatory. The source
994
# is read locked and the target branches write locked. Source will
995
# be the local low-latency branch.
996
self['post_push'] = []
997
# invoked after a pull operation completes.
998
# the api signature is
1000
# containing the members
1001
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1002
# where local is the local branch or None, master is the target
1003
# master branch, and the rest should be self explanatory. The source
1004
# is read locked and the target branches write locked. The local
1005
# branch is the low-latency branch.
1006
self['post_pull'] = []
1007
# invoked after a commit operation completes.
1008
# the api signature is
1009
# (local, master, old_revno, old_revid, new_revno, new_revid)
1010
# old_revid is NULL_REVISION for the first commit to a branch.
1011
self['post_commit'] = []
1012
# invoked after a uncommit operation completes.
1013
# the api signature is
1014
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1015
# local is the local branch or None, master is the target branch,
1016
# and an empty branch recieves new_revno of 0, new_revid of None.
1017
self['post_uncommit'] = []
1019
def install_hook(self, hook_name, a_callable):
1020
"""Install a_callable in to the hook hook_name.
1022
:param hook_name: A hook name. See the __init__ method of BranchHooks
1023
for the complete list of hooks.
1024
:param a_callable: The callable to be invoked when the hook triggers.
1025
The exact signature will depend on the hook - see the __init__
1026
method of BranchHooks for details on each hook.
1029
self[hook_name].append(a_callable)
1031
raise errors.UnknownHook('branch', hook_name)
1034
# install the default hooks into the Branch class.
1035
Branch.hooks = BranchHooks()
1038
class BzrBranchFormat4(BranchFormat):
1039
"""Bzr branch format 4.
1042
- a revision-history file.
1043
- a branch-lock lock file [ to be shared with the bzrdir ]
1046
def get_format_description(self):
1047
"""See BranchFormat.get_format_description()."""
1048
return "Branch format 4"
1050
def initialize(self, a_bzrdir):
1051
"""Create a branch of this format in a_bzrdir."""
1052
utf8_files = [('revision-history', ''),
1053
('branch-name', ''),
1055
return self._initialize_helper(a_bzrdir, utf8_files,
1056
lock_type='branch4', set_format=False)
1059
super(BzrBranchFormat4, self).__init__()
1060
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1062
def open(self, a_bzrdir, _found=False):
1063
"""Return the branch object for a_bzrdir
1065
_found is a private parameter, do not use it. It is used to indicate
1066
if format probing has already be done.
1069
# we are being called directly and must probe.
1070
raise NotImplementedError
1071
return BzrBranch(_format=self,
1072
_control_files=a_bzrdir._control_files,
1074
_repository=a_bzrdir.open_repository())
1077
return "Bazaar-NG branch format 4"
1080
class BzrBranchFormat5(BranchFormat):
1081
"""Bzr branch format 5.
1084
- a revision-history file.
1086
- a lock dir guarding the branch itself
1087
- all of this stored in a branch/ subdirectory
1088
- works with shared repositories.
1090
This format is new in bzr 0.8.
1093
def get_format_string(self):
1094
"""See BranchFormat.get_format_string()."""
1095
return "Bazaar-NG branch format 5\n"
1097
def get_format_description(self):
1098
"""See BranchFormat.get_format_description()."""
1099
return "Branch format 5"
1101
def initialize(self, a_bzrdir):
1102
"""Create a branch of this format in a_bzrdir."""
1103
utf8_files = [('revision-history', ''),
1104
('branch-name', ''),
1106
return self._initialize_helper(a_bzrdir, utf8_files)
1109
super(BzrBranchFormat5, self).__init__()
1110
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1112
def open(self, a_bzrdir, _found=False):
1113
"""Return the branch object for a_bzrdir
1115
_found is a private parameter, do not use it. It is used to indicate
1116
if format probing has already be done.
1119
format = BranchFormat.find_format(a_bzrdir)
1120
assert format.__class__ == self.__class__
1122
transport = a_bzrdir.get_branch_transport(None)
1123
control_files = lockable_files.LockableFiles(transport, 'lock',
1125
return BzrBranch5(_format=self,
1126
_control_files=control_files,
1128
_repository=a_bzrdir.find_repository())
1130
raise NotBranchError(path=transport.base)
1133
class BzrBranchFormat6(BzrBranchFormat5):
1134
"""Branch format with last-revision
1136
Unlike previous formats, this has no explicit revision history. Instead,
1137
this just stores the last-revision, and the left-hand history leading
1138
up to there is the history.
1140
This format was introduced in bzr 0.15
1143
def get_format_string(self):
1144
"""See BranchFormat.get_format_string()."""
1145
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1147
def get_format_description(self):
1148
"""See BranchFormat.get_format_description()."""
1149
return "Branch format 6"
1151
def initialize(self, a_bzrdir):
1152
"""Create a branch of this format in a_bzrdir."""
1153
utf8_files = [('last-revision', '0 null:\n'),
1154
('branch-name', ''),
1155
('branch.conf', ''),
1158
return self._initialize_helper(a_bzrdir, utf8_files)
1160
def open(self, a_bzrdir, _found=False):
1161
"""Return the branch object for a_bzrdir
1163
_found is a private parameter, do not use it. It is used to indicate
1164
if format probing has already be done.
1167
format = BranchFormat.find_format(a_bzrdir)
1168
assert format.__class__ == self.__class__
1169
transport = a_bzrdir.get_branch_transport(None)
1170
control_files = lockable_files.LockableFiles(transport, 'lock',
1172
return BzrBranch6(_format=self,
1173
_control_files=control_files,
1175
_repository=a_bzrdir.find_repository())
1177
def supports_tags(self):
1181
class BranchReferenceFormat(BranchFormat):
1182
"""Bzr branch reference format.
1184
Branch references are used in implementing checkouts, they
1185
act as an alias to the real branch which is at some other url.
1192
def get_format_string(self):
1193
"""See BranchFormat.get_format_string()."""
1194
return "Bazaar-NG Branch Reference Format 1\n"
1196
def get_format_description(self):
1197
"""See BranchFormat.get_format_description()."""
1198
return "Checkout reference format 1"
1200
def get_reference(self, a_bzrdir):
1201
"""See BranchFormat.get_reference()."""
1202
transport = a_bzrdir.get_branch_transport(None)
1203
return transport.get('location').read()
1205
def initialize(self, a_bzrdir, target_branch=None):
1206
"""Create a branch of this format in a_bzrdir."""
1207
if target_branch is None:
1208
# this format does not implement branch itself, thus the implicit
1209
# creation contract must see it as uninitializable
1210
raise errors.UninitializableFormat(self)
1211
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1212
branch_transport = a_bzrdir.get_branch_transport(self)
1213
branch_transport.put_bytes('location',
1214
target_branch.bzrdir.root_transport.base)
1215
branch_transport.put_bytes('format', self.get_format_string())
1216
return self.open(a_bzrdir, _found=True)
1219
super(BranchReferenceFormat, self).__init__()
1220
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1222
def _make_reference_clone_function(format, a_branch):
1223
"""Create a clone() routine for a branch dynamically."""
1224
def clone(to_bzrdir, revision_id=None):
1225
"""See Branch.clone()."""
1226
return format.initialize(to_bzrdir, a_branch)
1227
# cannot obey revision_id limits when cloning a reference ...
1228
# FIXME RBC 20060210 either nuke revision_id for clone, or
1229
# emit some sort of warning/error to the caller ?!
1232
def open(self, a_bzrdir, _found=False, location=None):
1233
"""Return the branch that the branch reference in a_bzrdir points at.
1235
_found is a private parameter, do not use it. It is used to indicate
1236
if format probing has already be done.
1239
format = BranchFormat.find_format(a_bzrdir)
1240
assert format.__class__ == self.__class__
1241
if location is None:
1242
location = self.get_reference(a_bzrdir)
1243
real_bzrdir = bzrdir.BzrDir.open(location)
1244
result = real_bzrdir.open_branch()
1245
# this changes the behaviour of result.clone to create a new reference
1246
# rather than a copy of the content of the branch.
1247
# I did not use a proxy object because that needs much more extensive
1248
# testing, and we are only changing one behaviour at the moment.
1249
# If we decide to alter more behaviours - i.e. the implicit nickname
1250
# then this should be refactored to introduce a tested proxy branch
1251
# and a subclass of that for use in overriding clone() and ....
1253
result.clone = self._make_reference_clone_function(result)
1257
# formats which have no format string are not discoverable
1258
# and not independently creatable, so are not registered.
1259
__default_format = BzrBranchFormat5()
1260
BranchFormat.register_format(__default_format)
1261
BranchFormat.register_format(BranchReferenceFormat())
1262
BranchFormat.register_format(BzrBranchFormat6())
1263
BranchFormat.set_default_format(__default_format)
1264
_legacy_formats = [BzrBranchFormat4(),
1267
class BzrBranch(Branch):
1268
"""A branch stored in the actual filesystem.
1270
Note that it's "local" in the context of the filesystem; it doesn't
1271
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1272
it's writable, and can be accessed via the normal filesystem API.
1275
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
1276
relax_version_check=DEPRECATED_PARAMETER, _format=None,
1277
_control_files=None, a_bzrdir=None, _repository=None):
1278
"""Create new branch object at a particular location.
1280
transport -- A Transport object, defining how to access files.
1282
init -- If True, create new control files in a previously
1283
unversioned directory. If False, the branch must already
1286
relax_version_check -- If true, the usual check for the branch
1287
version is not applied. This is intended only for
1288
upgrade/recovery type use; it's not guaranteed that
1289
all operations will work on old format branches.
1291
Branch.__init__(self)
1292
if a_bzrdir is None:
1293
self.bzrdir = bzrdir.BzrDir.open(transport.base)
1295
self.bzrdir = a_bzrdir
1296
# self._transport used to point to the directory containing the
1297
# control directory, but was not used - now it's just the transport
1298
# for the branch control files. mbp 20070212
1299
self._base = self.bzrdir.transport.clone('..').base
1300
self._format = _format
1301
if _control_files is None:
1302
raise ValueError('BzrBranch _control_files is None')
1303
self.control_files = _control_files
1304
self._transport = _control_files._transport
1305
if deprecated_passed(init):
1306
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
1307
"deprecated as of bzr 0.8. Please use Branch.create().",
1311
# this is slower than before deprecation, oh well never mind.
1312
# -> its deprecated.
1313
self._initialize(transport.base)
1314
self._check_format(_format)
1315
if deprecated_passed(relax_version_check):
1316
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
1317
"relax_version_check parameter is deprecated as of bzr 0.8. "
1318
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
1322
if (not relax_version_check
1323
and not self._format.is_supported()):
1324
raise errors.UnsupportedFormatError(format=fmt)
1325
if deprecated_passed(transport):
1326
warn("BzrBranch.__init__(transport=XXX...): The transport "
1327
"parameter is deprecated as of bzr 0.8. "
1328
"Please use Branch.open, or bzrdir.open_branch().",
1331
self.repository = _repository
1334
return '%s(%r)' % (self.__class__.__name__, self.base)
1338
def _get_base(self):
1339
"""Returns the directory containing the control directory."""
1342
base = property(_get_base, doc="The URL for the root of this branch.")
1344
def abspath(self, name):
1345
"""See Branch.abspath."""
1346
return self.control_files._transport.abspath(name)
1348
def _check_format(self, format):
1349
"""Identify the branch format if needed.
1351
The format is stored as a reference to the format object in
1352
self._format for code that needs to check it later.
1354
The format parameter is either None or the branch format class
1355
used to open this branch.
1357
FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
1360
format = BranchFormat.find_format(self.bzrdir)
1361
self._format = format
1362
mutter("got branch format %s", self._format)
1365
def get_root_id(self):
1366
"""See Branch.get_root_id."""
1367
tree = self.repository.revision_tree(self.last_revision())
1368
return tree.inventory.root.file_id
1370
def is_locked(self):
1371
return self.control_files.is_locked()
1373
def lock_write(self, tokens=None):
1374
if tokens is not None:
1375
branch_token, repo_token = tokens
1377
branch_token = repo_token = None
1378
repo_token = self.repository.lock_write(token=repo_token)
1380
branch_token = self.control_files.lock_write(token=branch_token)
1382
self.repository.unlock()
1385
tokens = (branch_token, repo_token)
1386
assert tokens == (None, None) or None not in tokens, (
1387
'Both branch and repository locks must return tokens, or else '
1388
'neither must return tokens. Got %r.' % (tokens,))
1389
if tokens == (None, None):
1394
def lock_read(self):
1395
self.repository.lock_read()
1397
self.control_files.lock_read()
1399
self.repository.unlock()
1403
# TODO: test for failed two phase locks. This is known broken.
1405
self.control_files.unlock()
1407
self.repository.unlock()
1408
if not self.control_files.is_locked():
1409
# we just released the lock
1410
self._clear_cached_state()
1412
def peek_lock_mode(self):
1413
if self.control_files._lock_count == 0:
1416
return self.control_files._lock_mode
1418
def get_physical_lock_status(self):
1419
return self.control_files.get_physical_lock_status()
1422
def print_file(self, file, revision_id):
1423
"""See Branch.print_file."""
1424
return self.repository.print_file(file, revision_id)
1427
def append_revision(self, *revision_ids):
1428
"""See Branch.append_revision."""
1429
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1430
for revision_id in revision_ids:
1431
_mod_revision.check_not_reserved_id(revision_id)
1432
mutter("add {%s} to revision-history" % revision_id)
1433
rev_history = self.revision_history()
1434
rev_history.extend(revision_ids)
1435
self.set_revision_history(rev_history)
1437
def _write_revision_history(self, history):
1438
"""Factored out of set_revision_history.
1440
This performs the actual writing to disk.
1441
It is intended to be called by BzrBranch5.set_revision_history."""
1442
self.control_files.put_bytes(
1443
'revision-history', '\n'.join(history))
1446
def set_revision_history(self, rev_history):
1447
"""See Branch.set_revision_history."""
1448
rev_history = [osutils.safe_revision_id(r) for r in rev_history]
1449
self._write_revision_history(rev_history)
1450
self._cache_revision_history(rev_history)
1451
for hook in Branch.hooks['set_rh']:
1452
hook(self, rev_history)
1455
def set_last_revision_info(self, revno, revision_id):
1456
revision_id = osutils.safe_revision_id(revision_id)
1457
history = self._lefthand_history(revision_id)
1458
assert len(history) == revno, '%d != %d' % (len(history), revno)
1459
self.set_revision_history(history)
1461
def _gen_revision_history(self):
1462
history = self.control_files.get('revision-history').read().split('\n')
1463
if history[-1:] == ['']:
1464
# There shouldn't be a trailing newline, but just in case.
1468
def _lefthand_history(self, revision_id, last_rev=None,
1470
# stop_revision must be a descendant of last_revision
1471
stop_graph = self.repository.get_revision_graph(revision_id)
1472
if last_rev is not None and last_rev not in stop_graph:
1473
# our previous tip is not merged into stop_revision
1474
raise errors.DivergedBranches(self, other_branch)
1475
# make a new revision history from the graph
1476
current_rev_id = revision_id
1478
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1479
new_history.append(current_rev_id)
1480
current_rev_id_parents = stop_graph[current_rev_id]
1482
current_rev_id = current_rev_id_parents[0]
1484
current_rev_id = None
1485
new_history.reverse()
1489
def generate_revision_history(self, revision_id, last_rev=None,
1491
"""Create a new revision history that will finish with revision_id.
1493
:param revision_id: the new tip to use.
1494
:param last_rev: The previous last_revision. If not None, then this
1495
must be a ancestory of revision_id, or DivergedBranches is raised.
1496
:param other_branch: The other branch that DivergedBranches should
1497
raise with respect to.
1499
revision_id = osutils.safe_revision_id(revision_id)
1500
self.set_revision_history(self._lefthand_history(revision_id,
1501
last_rev, other_branch))
1504
def update_revisions(self, other, stop_revision=None):
1505
"""See Branch.update_revisions."""
1508
if stop_revision is None:
1509
stop_revision = other.last_revision()
1510
if stop_revision is None:
1511
# if there are no commits, we're done.
1514
stop_revision = osutils.safe_revision_id(stop_revision)
1515
# whats the current last revision, before we fetch [and change it
1517
last_rev = self.last_revision()
1518
# we fetch here regardless of whether we need to so that we pickup
1520
self.fetch(other, stop_revision)
1521
my_ancestry = self.repository.get_ancestry(last_rev)
1522
if stop_revision in my_ancestry:
1523
# last_revision is a descendant of stop_revision
1525
self.generate_revision_history(stop_revision, last_rev=last_rev,
1530
def basis_tree(self):
1531
"""See Branch.basis_tree."""
1532
return self.repository.revision_tree(self.last_revision())
1534
@deprecated_method(zero_eight)
1535
def working_tree(self):
1536
"""Create a Working tree object for this branch."""
1538
from bzrlib.transport.local import LocalTransport
1539
if (self.base.find('://') != -1 or
1540
not isinstance(self._transport, LocalTransport)):
1541
raise NoWorkingTree(self.base)
1542
return self.bzrdir.open_workingtree()
1545
def pull(self, source, overwrite=False, stop_revision=None,
1546
_hook_master=None, _run_hooks=True):
1549
:param _hook_master: Private parameter - set the branch to
1550
be supplied as the master to push hooks.
1551
:param _run_hooks: Private parameter - allow disabling of
1552
hooks, used when pushing to a master branch.
1554
result = PullResult()
1555
result.source_branch = source
1556
result.target_branch = self
1559
result.old_revno, result.old_revid = self.last_revision_info()
1561
self.update_revisions(source, stop_revision)
1562
except DivergedBranches:
1566
if stop_revision is None:
1567
stop_revision = source.last_revision()
1568
self.generate_revision_history(stop_revision)
1569
result.tag_conflicts = source.tags.merge_to(self.tags)
1570
result.new_revno, result.new_revid = self.last_revision_info()
1572
result.master_branch = _hook_master
1573
result.local_branch = self
1575
result.master_branch = self
1576
result.local_branch = None
1578
for hook in Branch.hooks['post_pull']:
1584
def _get_parent_location(self):
1585
_locs = ['parent', 'pull', 'x-pull']
1588
return self.control_files.get(l).read().strip('\n')
1594
def push(self, target, overwrite=False, stop_revision=None,
1595
_hook_master=None, _run_hooks=True):
1598
:param _hook_master: Private parameter - set the branch to
1599
be supplied as the master to push hooks.
1600
:param _run_hooks: Private parameter - allow disabling of
1601
hooks, used when pushing to a master branch.
1603
result = PushResult()
1604
result.source_branch = self
1605
result.target_branch = target
1608
result.old_revno, result.old_revid = target.last_revision_info()
1610
target.update_revisions(self, stop_revision)
1611
except DivergedBranches:
1615
target.set_revision_history(self.revision_history())
1616
result.tag_conflicts = self.tags.merge_to(target.tags)
1617
result.new_revno, result.new_revid = target.last_revision_info()
1619
result.master_branch = _hook_master
1620
result.local_branch = target
1622
result.master_branch = target
1623
result.local_branch = None
1625
for hook in Branch.hooks['post_push']:
1631
def get_parent(self):
1632
"""See Branch.get_parent."""
1634
assert self.base[-1] == '/'
1635
parent = self._get_parent_location()
1638
# This is an old-format absolute path to a local branch
1639
# turn it into a url
1640
if parent.startswith('/'):
1641
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1643
return urlutils.join(self.base[:-1], parent)
1644
except errors.InvalidURLJoin, e:
1645
raise errors.InaccessibleParent(parent, self.base)
1647
def set_push_location(self, location):
1648
"""See Branch.set_push_location."""
1649
self.get_config().set_user_option(
1650
'push_location', location,
1651
store=_mod_config.STORE_LOCATION_NORECURSE)
1654
def set_parent(self, url):
1655
"""See Branch.set_parent."""
1656
# TODO: Maybe delete old location files?
1657
# URLs should never be unicode, even on the local fs,
1658
# FIXUP this and get_parent in a future branch format bump:
1659
# read and rewrite the file, and have the new format code read
1660
# using .get not .get_utf8. RBC 20060125
1662
if isinstance(url, unicode):
1664
url = url.encode('ascii')
1665
except UnicodeEncodeError:
1666
raise bzrlib.errors.InvalidURL(url,
1667
"Urls must be 7-bit ascii, "
1668
"use bzrlib.urlutils.escape")
1669
url = urlutils.relative_url(self.base, url)
1670
self._set_parent_location(url)
1672
def _set_parent_location(self, url):
1674
self.control_files._transport.delete('parent')
1676
assert isinstance(url, str)
1677
self.control_files.put_bytes('parent', url + '\n')
1679
@deprecated_function(zero_nine)
1680
def tree_config(self):
1681
"""DEPRECATED; call get_config instead.
1682
TreeConfig has become part of BranchConfig."""
1683
return TreeConfig(self)
1686
class BzrBranch5(BzrBranch):
1687
"""A format 5 branch. This supports new features over plan branches.
1689
It has support for a master_branch which is the data for bound branches.
1697
super(BzrBranch5, self).__init__(_format=_format,
1698
_control_files=_control_files,
1700
_repository=_repository)
1703
def pull(self, source, overwrite=False, stop_revision=None,
1705
"""Extends branch.pull to be bound branch aware.
1707
:param _run_hooks: Private parameter used to force hook running
1708
off during bound branch double-pushing.
1710
bound_location = self.get_bound_location()
1711
master_branch = None
1712
if bound_location and source.base != bound_location:
1713
# not pulling from master, so we need to update master.
1714
master_branch = self.get_master_branch()
1715
master_branch.lock_write()
1718
# pull from source into master.
1719
master_branch.pull(source, overwrite, stop_revision,
1721
return super(BzrBranch5, self).pull(source, overwrite,
1722
stop_revision, _hook_master=master_branch,
1723
_run_hooks=_run_hooks)
1726
master_branch.unlock()
1729
def push(self, target, overwrite=False, stop_revision=None):
1730
"""Updates branch.push to be bound branch aware."""
1731
bound_location = target.get_bound_location()
1732
master_branch = None
1733
if bound_location and target.base != bound_location:
1734
# not pushing to master, so we need to update master.
1735
master_branch = target.get_master_branch()
1736
master_branch.lock_write()
1739
# push into the master from this branch.
1740
super(BzrBranch5, self).push(master_branch, overwrite,
1741
stop_revision, _run_hooks=False)
1742
# and push into the target branch from this. Note that we push from
1743
# this branch again, because its considered the highest bandwidth
1745
return super(BzrBranch5, self).push(target, overwrite,
1746
stop_revision, _hook_master=master_branch)
1749
master_branch.unlock()
1751
def get_bound_location(self):
1753
return self.control_files.get_utf8('bound').read()[:-1]
1754
except errors.NoSuchFile:
1758
def get_master_branch(self):
1759
"""Return the branch we are bound to.
1761
:return: Either a Branch, or None
1763
This could memoise the branch, but if thats done
1764
it must be revalidated on each new lock.
1765
So for now we just don't memoise it.
1766
# RBC 20060304 review this decision.
1768
bound_loc = self.get_bound_location()
1772
return Branch.open(bound_loc)
1773
except (errors.NotBranchError, errors.ConnectionError), e:
1774
raise errors.BoundBranchConnectionFailure(
1778
def set_bound_location(self, location):
1779
"""Set the target where this branch is bound to.
1781
:param location: URL to the target branch
1784
self.control_files.put_utf8('bound', location+'\n')
1787
self.control_files._transport.delete('bound')
1793
def bind(self, other):
1794
"""Bind this branch to the branch other.
1796
This does not push or pull data between the branches, though it does
1797
check for divergence to raise an error when the branches are not
1798
either the same, or one a prefix of the other. That behaviour may not
1799
be useful, so that check may be removed in future.
1801
:param other: The branch to bind to
1804
# TODO: jam 20051230 Consider checking if the target is bound
1805
# It is debatable whether you should be able to bind to
1806
# a branch which is itself bound.
1807
# Committing is obviously forbidden,
1808
# but binding itself may not be.
1809
# Since we *have* to check at commit time, we don't
1810
# *need* to check here
1812
# we want to raise diverged if:
1813
# last_rev is not in the other_last_rev history, AND
1814
# other_last_rev is not in our history, and do it without pulling
1816
last_rev = self.last_revision()
1817
if last_rev is not None:
1820
other_last_rev = other.last_revision()
1821
if other_last_rev is not None:
1822
# neither branch is new, we have to do some work to
1823
# ascertain diversion.
1824
remote_graph = other.repository.get_revision_graph(
1826
local_graph = self.repository.get_revision_graph(last_rev)
1827
if (last_rev not in remote_graph and
1828
other_last_rev not in local_graph):
1829
raise errors.DivergedBranches(self, other)
1832
self.set_bound_location(other.base)
1836
"""If bound, unbind"""
1837
return self.set_bound_location(None)
1841
"""Synchronise this branch with the master branch if any.
1843
:return: None or the last_revision that was pivoted out during the
1846
master = self.get_master_branch()
1847
if master is not None:
1848
old_tip = self.last_revision()
1849
self.pull(master, overwrite=True)
1850
if old_tip in self.repository.get_ancestry(self.last_revision()):
1856
class BzrBranchExperimental(BzrBranch5):
1857
"""Bzr experimental branch format
1860
- a revision-history file.
1862
- a lock dir guarding the branch itself
1863
- all of this stored in a branch/ subdirectory
1864
- works with shared repositories.
1865
- a tag dictionary in the branch
1867
This format is new in bzr 0.15, but shouldn't be used for real data,
1870
This class acts as it's own BranchFormat.
1873
_matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1876
def get_format_string(cls):
1877
"""See BranchFormat.get_format_string()."""
1878
return "Bazaar-NG branch format experimental\n"
1881
def get_format_description(cls):
1882
"""See BranchFormat.get_format_description()."""
1883
return "Experimental branch format"
1886
def _initialize_control_files(cls, a_bzrdir, utf8_files, lock_filename,
1888
branch_transport = a_bzrdir.get_branch_transport(cls)
1889
control_files = lockable_files.LockableFiles(branch_transport,
1890
lock_filename, lock_class)
1891
control_files.create_lock()
1892
control_files.lock_write()
1894
for filename, content in utf8_files:
1895
control_files.put_utf8(filename, content)
1897
control_files.unlock()
1900
def initialize(cls, a_bzrdir):
1901
"""Create a branch of this format in a_bzrdir."""
1902
utf8_files = [('format', cls.get_format_string()),
1903
('revision-history', ''),
1904
('branch-name', ''),
1907
cls._initialize_control_files(a_bzrdir, utf8_files,
1908
'lock', lockdir.LockDir)
1909
return cls.open(a_bzrdir, _found=True)
1912
def open(cls, a_bzrdir, _found=False):
1913
"""Return the branch object for a_bzrdir
1915
_found is a private parameter, do not use it. It is used to indicate
1916
if format probing has already be done.
1919
format = BranchFormat.find_format(a_bzrdir)
1920
assert format.__class__ == cls
1921
transport = a_bzrdir.get_branch_transport(None)
1922
control_files = lockable_files.LockableFiles(transport, 'lock',
1924
return cls(_format=cls,
1925
_control_files=control_files,
1927
_repository=a_bzrdir.find_repository())
1930
def is_supported(cls):
1933
def _make_tags(self):
1934
return BasicTags(self)
1937
def supports_tags(cls):
1941
BranchFormat.register_format(BzrBranchExperimental)
1944
class BzrBranch6(BzrBranch5):
1947
def last_revision_info(self):
1948
revision_string = self.control_files.get('last-revision').read()
1949
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1950
revision_id = cache_utf8.get_cached_utf8(revision_id)
1952
return revno, revision_id
1954
def last_revision(self):
1955
"""Return last revision id, or None"""
1956
revision_id = self.last_revision_info()[1]
1957
if revision_id == _mod_revision.NULL_REVISION:
1961
def _write_last_revision_info(self, revno, revision_id):
1962
"""Simply write out the revision id, with no checks.
1964
Use set_last_revision_info to perform this safely.
1966
Does not update the revision_history cache.
1967
Intended to be called by set_last_revision_info and
1968
_write_revision_history.
1970
if revision_id is None:
1971
revision_id = 'null:'
1972
out_string = '%d %s\n' % (revno, revision_id)
1973
self.control_files.put_bytes('last-revision', out_string)
1976
def set_last_revision_info(self, revno, revision_id):
1977
revision_id = osutils.safe_revision_id(revision_id)
1978
if self._get_append_revisions_only():
1979
self._check_history_violation(revision_id)
1980
self._write_last_revision_info(revno, revision_id)
1981
self._clear_cached_state()
1983
def _check_history_violation(self, revision_id):
1984
last_revision = self.last_revision()
1985
if last_revision is None:
1987
if last_revision not in self._lefthand_history(revision_id):
1988
raise errors.AppendRevisionsOnlyViolation(self.base)
1990
def _gen_revision_history(self):
1991
"""Generate the revision history from last revision
1993
history = list(self.repository.iter_reverse_revision_history(
1994
self.last_revision()))
1998
def _write_revision_history(self, history):
1999
"""Factored out of set_revision_history.
2001
This performs the actual writing to disk, with format-specific checks.
2002
It is intended to be called by BzrBranch5.set_revision_history.
2004
if len(history) == 0:
2005
last_revision = 'null:'
2007
if history != self._lefthand_history(history[-1]):
2008
raise errors.NotLefthandHistory(history)
2009
last_revision = history[-1]
2010
if self._get_append_revisions_only():
2011
self._check_history_violation(last_revision)
2012
self._write_last_revision_info(len(history), last_revision)
2015
def append_revision(self, *revision_ids):
2016
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
2017
if len(revision_ids) == 0:
2019
prev_revno, prev_revision = self.last_revision_info()
2020
for revision in self.repository.get_revisions(revision_ids):
2021
if prev_revision == _mod_revision.NULL_REVISION:
2022
if revision.parent_ids != []:
2023
raise errors.NotLeftParentDescendant(self, prev_revision,
2024
revision.revision_id)
2026
if revision.parent_ids[0] != prev_revision:
2027
raise errors.NotLeftParentDescendant(self, prev_revision,
2028
revision.revision_id)
2029
prev_revision = revision.revision_id
2030
self.set_last_revision_info(prev_revno + len(revision_ids),
2034
def _set_parent_location(self, url):
2035
"""Set the parent branch"""
2036
self._set_config_location('parent_location', url, make_relative=True)
2039
def _get_parent_location(self):
2040
"""Set the parent branch"""
2041
return self._get_config_location('parent_location')
2043
def set_push_location(self, location):
2044
"""See Branch.set_push_location."""
2045
self._set_config_location('push_location', location)
2047
def set_bound_location(self, location):
2048
"""See Branch.set_push_location."""
2050
config = self.get_config()
2051
if location is None:
2052
if config.get_user_option('bound') != 'True':
2055
config.set_user_option('bound', 'False')
2058
self._set_config_location('bound_location', location,
2060
config.set_user_option('bound', 'True')
2063
def _get_bound_location(self, bound):
2064
"""Return the bound location in the config file.
2066
Return None if the bound parameter does not match"""
2067
config = self.get_config()
2068
config_bound = (config.get_user_option('bound') == 'True')
2069
if config_bound != bound:
2071
return self._get_config_location('bound_location', config=config)
2073
def get_bound_location(self):
2074
"""See Branch.set_push_location."""
2075
return self._get_bound_location(True)
2077
def get_old_bound_location(self):
2078
"""See Branch.get_old_bound_location"""
2079
return self._get_bound_location(False)
2081
def set_append_revisions_only(self, enabled):
2086
self.get_config().set_user_option('append_revisions_only', value)
2088
def _get_append_revisions_only(self):
2089
value = self.get_config().get_user_option('append_revisions_only')
2090
return value == 'True'
2092
def _synchronize_history(self, destination, revision_id):
2093
"""Synchronize last revision and revision history between branches.
2095
This version is most efficient when the destination is also a
2096
BzrBranch6, but works for BzrBranch5, as long as the destination's
2097
repository contains all the lefthand ancestors of the intended
2098
last_revision. If not, set_last_revision_info will fail.
2100
:param destination: The branch to copy the history into
2101
:param revision_id: The revision-id to truncate history at. May
2102
be None to copy complete history.
2104
if revision_id is None:
2105
revno, revision_id = self.last_revision_info()
2107
revno = self.revision_id_to_revno(revision_id)
2108
destination.set_last_revision_info(revno, revision_id)
2110
def _make_tags(self):
2111
return BasicTags(self)
2114
class BranchTestProviderAdapter(object):
2115
"""A tool to generate a suite testing multiple branch formats at once.
2117
This is done by copying the test once for each transport and injecting
2118
the transport_server, transport_readonly_server, and branch_format
2119
classes into each copy. Each copy is also given a new id() to make it
2123
def __init__(self, transport_server, transport_readonly_server, formats,
2124
vfs_transport_factory=None):
2125
self._transport_server = transport_server
2126
self._transport_readonly_server = transport_readonly_server
2127
self._formats = formats
2128
self._vfs_transport_factory = vfs_transport_factory
2130
def adapt(self, test):
2131
result = TestSuite()
2132
for branch_format, bzrdir_format in self._formats:
2133
new_test = deepcopy(test)
2134
new_test.transport_server = self._transport_server
2135
new_test.transport_readonly_server = self._transport_readonly_server
2136
if self._vfs_transport_factory:
2137
new_test.vfs_transport_factory = self._vfs_transport_factory
2138
new_test.bzrdir_format = bzrdir_format
2139
new_test.branch_format = branch_format
2140
def make_new_test_id():
2141
# the format can be either a class or an instance
2142
name = getattr(branch_format, '__name__',
2143
branch_format.__class__.__name__)
2144
new_id = "%s(%s)" % (new_test.id(), name)
2145
return lambda: new_id
2146
new_test.id = make_new_test_id()
2147
result.addTest(new_test)
2151
######################################################################
2152
# results of operations
2155
class _Result(object):
2157
def _show_tag_conficts(self, to_file):
2158
if not getattr(self, 'tag_conflicts', None):
2160
to_file.write('Conflicting tags:\n')
2161
for name, value1, value2 in self.tag_conflicts:
2162
to_file.write(' %s\n' % (name, ))
2165
class PullResult(_Result):
2166
"""Result of a Branch.pull operation.
2168
:ivar old_revno: Revision number before pull.
2169
:ivar new_revno: Revision number after pull.
2170
:ivar old_revid: Tip revision id before pull.
2171
:ivar new_revid: Tip revision id after pull.
2172
:ivar source_branch: Source (local) branch object.
2173
:ivar master_branch: Master branch of the target, or None.
2174
:ivar target_branch: Target/destination branch object.
2178
# DEPRECATED: pull used to return the change in revno
2179
return self.new_revno - self.old_revno
2181
def report(self, to_file):
2182
if self.old_revid == self.new_revid:
2183
to_file.write('No revisions to pull.\n')
2185
to_file.write('Now on revision %d.\n' % self.new_revno)
2186
self._show_tag_conficts(to_file)
2189
class PushResult(_Result):
2190
"""Result of a Branch.push operation.
2192
:ivar old_revno: Revision number before push.
2193
:ivar new_revno: Revision number after push.
2194
:ivar old_revid: Tip revision id before push.
2195
:ivar new_revid: Tip revision id after push.
2196
:ivar source_branch: Source branch object.
2197
:ivar master_branch: Master branch of the target, or None.
2198
:ivar target_branch: Target/destination branch object.
2202
# DEPRECATED: push used to return the change in revno
2203
return self.new_revno - self.old_revno
2205
def report(self, to_file):
2206
"""Write a human-readable description of the result."""
2207
if self.old_revid == self.new_revid:
2208
to_file.write('No new revisions to push.\n')
2210
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2211
self._show_tag_conficts(to_file)
2214
class BranchCheckResult(object):
2215
"""Results of checking branch consistency.
2220
def __init__(self, branch):
2221
self.branch = branch
2223
def report_results(self, verbose):
2224
"""Report the check results via trace.note.
2226
:param verbose: Requests more detailed display of what was checked,
2229
note('checked branch %s format %s',
2231
self.branch._format)
2234
class Converter5to6(object):
2235
"""Perform an in-place upgrade of format 5 to format 6"""
2237
def convert(self, branch):
2238
# Data for 5 and 6 can peacefully coexist.
2239
format = BzrBranchFormat6()
2240
new_branch = format.open(branch.bzrdir, _found=True)
2242
# Copy source data into target
2243
new_branch.set_last_revision_info(*branch.last_revision_info())
2244
new_branch.set_parent(branch.get_parent())
2245
new_branch.set_bound_location(branch.get_bound_location())
2246
new_branch.set_push_location(branch.get_push_location())
2248
# New branch has no tags by default
2249
new_branch.tags._set_tag_dict({})
2251
# Copying done; now update target format
2252
new_branch.control_files.put_utf8('format',
2253
format.get_format_string())
2255
# Clean up old files
2256
new_branch.control_files._transport.delete('revision-history')
2258
branch.set_parent(None)
2261
branch.set_bound_location(None)
added
removed
bzrlib/branch.py
