1
# Copyright (C) 2005, 2006, 2007, 2008 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 bzrlib.lazy_import import lazy_import
19
lazy_import(globals(), """
23
config as _mod_config,
29
revision as _mod_revision,
35
from bzrlib.config import BranchConfig
36
from bzrlib.tag import (
42
from bzrlib.decorators import needs_read_lock, needs_write_lock
43
from bzrlib.hooks import Hooks
44
from bzrlib.symbol_versioning import (
48
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
51
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
52
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
53
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
56
# TODO: Maybe include checks for common corruption of newlines, etc?
58
# TODO: Some operations like log might retrieve the same revisions
59
# repeatedly to calculate deltas. We could perhaps have a weakref
60
# cache in memory to make this faster. In general anything can be
61
# cached in memory between lock and unlock operations. .. nb thats
62
# what the transaction identity map provides
65
######################################################################
69
"""Branch holding a history of revisions.
72
Base directory/url of the branch.
74
hooks: An instance of BranchHooks.
76
# this is really an instance variable - FIXME move it there
80
# override this to set the strategy for storing tags
82
return DisabledTags(self)
84
def __init__(self, *ignored, **ignored_too):
85
self.tags = self._make_tags()
86
self._revision_history_cache = None
87
self._revision_id_to_revno_cache = None
90
"""Break a lock if one is present from another instance.
92
Uses the ui factory to ask for confirmation if the lock may be from
95
This will probe the repository for its lock as well.
97
self.control_files.break_lock()
98
self.repository.break_lock()
99
master = self.get_master_branch()
100
if master is not None:
104
def open(base, _unsupported=False, possible_transports=None):
105
"""Open the branch rooted at base.
107
For instance, if the branch is at URL/.bzr/branch,
108
Branch.open(URL) -> a Branch instance.
110
control = bzrdir.BzrDir.open(base, _unsupported,
111
possible_transports=possible_transports)
112
return control.open_branch(_unsupported)
115
def open_from_transport(transport, _unsupported=False):
116
"""Open the branch rooted at transport"""
117
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
118
return control.open_branch(_unsupported)
121
def open_containing(url, possible_transports=None):
122
"""Open an existing branch which contains url.
124
This probes for a branch at url, and searches upwards from there.
126
Basically we keep looking up until we find the control directory or
127
run into the root. If there isn't one, raises NotBranchError.
128
If there is one and it is either an unrecognised format or an unsupported
129
format, UnknownFormatError or UnsupportedFormatError are raised.
130
If there is one, it is returned, along with the unused portion of url.
132
control, relpath = bzrdir.BzrDir.open_containing(url,
134
return control.open_branch(), relpath
136
def get_config(self):
137
return BranchConfig(self)
140
return self.get_config().get_nickname()
142
def _set_nick(self, nick):
143
self.get_config().set_user_option('nickname', nick, warn_masked=True)
145
nick = property(_get_nick, _set_nick)
148
raise NotImplementedError(self.is_locked)
150
def lock_write(self):
151
raise NotImplementedError(self.lock_write)
154
raise NotImplementedError(self.lock_read)
157
raise NotImplementedError(self.unlock)
159
def peek_lock_mode(self):
160
"""Return lock mode for the Branch: 'r', 'w' or None"""
161
raise NotImplementedError(self.peek_lock_mode)
163
def get_physical_lock_status(self):
164
raise NotImplementedError(self.get_physical_lock_status)
167
def get_revision_id_to_revno_map(self):
168
"""Return the revision_id => dotted revno map.
170
This will be regenerated on demand, but will be cached.
172
:return: A dictionary mapping revision_id => dotted revno.
173
This dictionary should not be modified by the caller.
175
if self._revision_id_to_revno_cache is not None:
176
mapping = self._revision_id_to_revno_cache
178
mapping = self._gen_revno_map()
179
self._cache_revision_id_to_revno(mapping)
180
# TODO: jam 20070417 Since this is being cached, should we be returning
182
# I would rather not, and instead just declare that users should not
183
# modify the return value.
186
def _gen_revno_map(self):
187
"""Create a new mapping from revision ids to dotted revnos.
189
Dotted revnos are generated based on the current tip in the revision
191
This is the worker function for get_revision_id_to_revno_map, which
192
just caches the return value.
194
:return: A dictionary mapping revision_id => dotted revno.
196
last_revision = self.last_revision()
197
revision_graph = repository._old_get_graph(self.repository,
199
merge_sorted_revisions = tsort.merge_sort(
204
revision_id_to_revno = dict((rev_id, revno)
205
for seq_num, rev_id, depth, revno, end_of_merge
206
in merge_sorted_revisions)
207
return revision_id_to_revno
209
def leave_lock_in_place(self):
210
"""Tell this branch object not to release the physical lock when this
213
If lock_write doesn't return a token, then this method is not supported.
215
self.control_files.leave_in_place()
217
def dont_leave_lock_in_place(self):
218
"""Tell this branch object to release the physical lock when this
219
object is unlocked, even if it didn't originally acquire it.
221
If lock_write doesn't return a token, then this method is not supported.
223
self.control_files.dont_leave_in_place()
225
@deprecated_method(deprecated_in((0, 16, 0)))
226
def abspath(self, name):
227
"""Return absolute filename for something in the branch
229
XXX: Robert Collins 20051017 what is this used for? why is it a branch
230
method and not a tree method.
232
raise NotImplementedError(self.abspath)
234
def bind(self, other):
235
"""Bind the local branch the other branch.
237
:param other: The branch to bind to
240
raise errors.UpgradeRequired(self.base)
243
def fetch(self, from_branch, last_revision=None, pb=None):
244
"""Copy revisions from from_branch into this branch.
246
:param from_branch: Where to copy from.
247
:param last_revision: What revision to stop at (None for at the end
249
:param pb: An optional progress bar to use.
251
Returns the copied revision count and the failed revisions in a tuple:
254
if self.base == from_branch.base:
257
nested_pb = ui.ui_factory.nested_progress_bar()
262
from_branch.lock_read()
264
if last_revision is None:
265
pb.update('get source history')
266
last_revision = from_branch.last_revision()
267
last_revision = _mod_revision.ensure_null(last_revision)
268
return self.repository.fetch(from_branch.repository,
269
revision_id=last_revision,
272
if nested_pb is not None:
276
def get_bound_location(self):
277
"""Return the URL of the branch we are bound to.
279
Older format branches cannot bind, please be sure to use a metadir
284
def get_old_bound_location(self):
285
"""Return the URL of the branch we used to be bound to
287
raise errors.UpgradeRequired(self.base)
289
def get_commit_builder(self, parents, config=None, timestamp=None,
290
timezone=None, committer=None, revprops=None,
292
"""Obtain a CommitBuilder for this branch.
294
:param parents: Revision ids of the parents of the new revision.
295
:param config: Optional configuration to use.
296
:param timestamp: Optional timestamp recorded for commit.
297
:param timezone: Optional timezone for timestamp.
298
:param committer: Optional committer to set for commit.
299
:param revprops: Optional dictionary of revision properties.
300
:param revision_id: Optional revision id.
304
config = self.get_config()
306
return self.repository.get_commit_builder(self, parents, config,
307
timestamp, timezone, committer, revprops, revision_id)
309
def get_master_branch(self, possible_transports=None):
310
"""Return the branch we are bound to.
312
:return: Either a Branch, or None
316
def get_revision_delta(self, revno):
317
"""Return the delta for one revision.
319
The delta is relative to its mainline predecessor, or the
320
empty tree for revision 1.
322
rh = self.revision_history()
323
if not (1 <= revno <= len(rh)):
324
raise errors.InvalidRevisionNumber(revno)
325
return self.repository.get_revision_delta(rh[revno-1])
327
def print_file(self, file, revision_id):
328
"""Print `file` to stdout."""
329
raise NotImplementedError(self.print_file)
331
def set_revision_history(self, rev_history):
332
raise NotImplementedError(self.set_revision_history)
334
def _cache_revision_history(self, rev_history):
335
"""Set the cached revision history to rev_history.
337
The revision_history method will use this cache to avoid regenerating
338
the revision history.
340
This API is semi-public; it only for use by subclasses, all other code
341
should consider it to be private.
343
self._revision_history_cache = rev_history
345
def _cache_revision_id_to_revno(self, revision_id_to_revno):
346
"""Set the cached revision_id => revno map to revision_id_to_revno.
348
This API is semi-public; it only for use by subclasses, all other code
349
should consider it to be private.
351
self._revision_id_to_revno_cache = revision_id_to_revno
353
def _clear_cached_state(self):
354
"""Clear any cached data on this branch, e.g. cached revision history.
356
This means the next call to revision_history will need to call
357
_gen_revision_history.
359
This API is semi-public; it only for use by subclasses, all other code
360
should consider it to be private.
362
self._revision_history_cache = None
363
self._revision_id_to_revno_cache = None
365
def _gen_revision_history(self):
366
"""Return sequence of revision hashes on to this branch.
368
Unlike revision_history, this method always regenerates or rereads the
369
revision history, i.e. it does not cache the result, so repeated calls
372
Concrete subclasses should override this instead of revision_history so
373
that subclasses do not need to deal with caching logic.
375
This API is semi-public; it only for use by subclasses, all other code
376
should consider it to be private.
378
raise NotImplementedError(self._gen_revision_history)
381
def revision_history(self):
382
"""Return sequence of revision ids on this branch.
384
This method will cache the revision history for as long as it is safe to
387
if 'evil' in debug.debug_flags:
388
mutter_callsite(3, "revision_history scales with history.")
389
if self._revision_history_cache is not None:
390
history = self._revision_history_cache
392
history = self._gen_revision_history()
393
self._cache_revision_history(history)
397
"""Return current revision number for this branch.
399
That is equivalent to the number of revisions committed to
402
return self.last_revision_info()[0]
405
"""Older format branches cannot bind or unbind."""
406
raise errors.UpgradeRequired(self.base)
408
def set_append_revisions_only(self, enabled):
409
"""Older format branches are never restricted to append-only"""
410
raise errors.UpgradeRequired(self.base)
412
def last_revision(self):
413
"""Return last revision id, or NULL_REVISION."""
414
return self.last_revision_info()[1]
416
def last_revision_info(self):
417
"""Return information about the last revision.
419
:return: A tuple (revno, last_revision_id).
421
rh = self.revision_history()
424
return (revno, rh[-1])
426
return (0, _mod_revision.NULL_REVISION)
428
@deprecated_method(deprecated_in((1, 6, 0)))
429
def missing_revisions(self, other, stop_revision=None):
430
"""Return a list of new revisions that would perfectly fit.
432
If self and other have not diverged, return a list of the revisions
433
present in other, but missing from self.
435
self_history = self.revision_history()
436
self_len = len(self_history)
437
other_history = other.revision_history()
438
other_len = len(other_history)
439
common_index = min(self_len, other_len) -1
440
if common_index >= 0 and \
441
self_history[common_index] != other_history[common_index]:
442
raise errors.DivergedBranches(self, other)
444
if stop_revision is None:
445
stop_revision = other_len
447
if stop_revision > other_len:
448
raise errors.NoSuchRevision(self, stop_revision)
449
return other_history[self_len:stop_revision]
451
def update_revisions(self, other, stop_revision=None, overwrite=False,
453
"""Pull in new perfect-fit revisions.
455
:param other: Another Branch to pull from
456
:param stop_revision: Updated until the given revision
457
:param overwrite: Always set the branch pointer, rather than checking
458
to see if it is a proper descendant.
459
:param graph: A Graph object that can be used to query history
460
information. This can be None.
463
raise NotImplementedError(self.update_revisions)
465
def revision_id_to_revno(self, revision_id):
466
"""Given a revision id, return its revno"""
467
if _mod_revision.is_null(revision_id):
469
history = self.revision_history()
471
return history.index(revision_id) + 1
473
raise errors.NoSuchRevision(self, revision_id)
475
def get_rev_id(self, revno, history=None):
476
"""Find the revision id of the specified revno."""
478
return _mod_revision.NULL_REVISION
480
history = self.revision_history()
481
if revno <= 0 or revno > len(history):
482
raise errors.NoSuchRevision(self, revno)
483
return history[revno - 1]
485
def pull(self, source, overwrite=False, stop_revision=None,
486
possible_transports=None):
487
"""Mirror source into this branch.
489
This branch is considered to be 'local', having low latency.
491
:returns: PullResult instance
493
raise NotImplementedError(self.pull)
495
def push(self, target, overwrite=False, stop_revision=None):
496
"""Mirror this branch into target.
498
This branch is considered to be 'local', having low latency.
500
raise NotImplementedError(self.push)
502
def basis_tree(self):
503
"""Return `Tree` object for last revision."""
504
return self.repository.revision_tree(self.last_revision())
506
def rename_one(self, from_rel, to_rel):
509
This can change the directory or the filename or both.
511
raise NotImplementedError(self.rename_one)
513
def move(self, from_paths, to_name):
516
to_name must exist as a versioned directory.
518
If to_name exists and is a directory, the files are moved into
519
it, keeping their old names. If it is a directory,
521
Note that to_name is only the last component of the new name;
522
this doesn't change the directory.
524
This returns a list of (from_path, to_path) pairs for each
527
raise NotImplementedError(self.move)
529
def get_parent(self):
530
"""Return the parent location of the branch.
532
This is the default location for push/pull/missing. The usual
533
pattern is that the user can override it by specifying a
536
raise NotImplementedError(self.get_parent)
538
def _set_config_location(self, name, url, config=None,
539
make_relative=False):
541
config = self.get_config()
545
url = urlutils.relative_url(self.base, url)
546
config.set_user_option(name, url, warn_masked=True)
548
def _get_config_location(self, name, config=None):
550
config = self.get_config()
551
location = config.get_user_option(name)
556
def get_submit_branch(self):
557
"""Return the submit location of the branch.
559
This is the default location for bundle. The usual
560
pattern is that the user can override it by specifying a
563
return self.get_config().get_user_option('submit_branch')
565
def set_submit_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.get_config().set_user_option('submit_branch', location,
575
def get_public_branch(self):
576
"""Return the public location of the branch.
578
This is is used by merge directives.
580
return self._get_config_location('public_branch')
582
def set_public_branch(self, location):
583
"""Return the submit location of the branch.
585
This is the default location for bundle. The usual
586
pattern is that the user can override it by specifying a
589
self._set_config_location('public_branch', location)
591
def get_push_location(self):
592
"""Return the None or the location to push this branch to."""
593
push_loc = self.get_config().get_user_option('push_location')
596
def set_push_location(self, location):
597
"""Set a new push location for this branch."""
598
raise NotImplementedError(self.set_push_location)
600
def set_parent(self, url):
601
raise NotImplementedError(self.set_parent)
605
"""Synchronise this branch with the master branch if any.
607
:return: None or the last_revision pivoted out during the update.
611
def check_revno(self, revno):
613
Check whether a revno corresponds to any revision.
614
Zero (the NULL revision) is considered valid.
617
self.check_real_revno(revno)
619
def check_real_revno(self, revno):
621
Check whether a revno corresponds to a real revision.
622
Zero (the NULL revision) is considered invalid
624
if revno < 1 or revno > self.revno():
625
raise errors.InvalidRevisionNumber(revno)
628
def clone(self, to_bzrdir, revision_id=None):
629
"""Clone this branch into to_bzrdir preserving all semantic values.
631
revision_id: if not None, the revision history in the new branch will
632
be truncated to end with revision_id.
634
result = self._format.initialize(to_bzrdir)
635
self.copy_content_into(result, revision_id=revision_id)
639
def sprout(self, to_bzrdir, revision_id=None):
640
"""Create a new line of development from the branch, into to_bzrdir.
642
revision_id: if not None, the revision history in the new branch will
643
be truncated to end with revision_id.
645
result = self._format.initialize(to_bzrdir)
646
self.copy_content_into(result, revision_id=revision_id)
647
result.set_parent(self.bzrdir.root_transport.base)
650
def _synchronize_history(self, destination, revision_id):
651
"""Synchronize last revision and revision history between branches.
653
This version is most efficient when the destination is also a
654
BzrBranch5, but works for BzrBranch6 as long as the revision
655
history is the true lefthand parent history, and all of the revisions
656
are in the destination's repository. If not, set_revision_history
659
:param destination: The branch to copy the history into
660
:param revision_id: The revision-id to truncate history at. May
661
be None to copy complete history.
663
if revision_id == _mod_revision.NULL_REVISION:
665
new_history = self.revision_history()
666
if revision_id is not None and new_history != []:
668
new_history = new_history[:new_history.index(revision_id) + 1]
670
rev = self.repository.get_revision(revision_id)
671
new_history = rev.get_history(self.repository)[1:]
672
destination.set_revision_history(new_history)
675
def copy_content_into(self, destination, revision_id=None):
676
"""Copy the content of self into destination.
678
revision_id: if not None, the revision history in the new branch will
679
be truncated to end with revision_id.
681
self._synchronize_history(destination, revision_id)
683
parent = self.get_parent()
684
except errors.InaccessibleParent, e:
685
mutter('parent was not accessible to copy: %s', e)
688
destination.set_parent(parent)
689
self.tags.merge_to(destination.tags)
693
"""Check consistency of the branch.
695
In particular this checks that revisions given in the revision-history
696
do actually match up in the revision graph, and that they're all
697
present in the repository.
699
Callers will typically also want to check the repository.
701
:return: A BranchCheckResult.
703
mainline_parent_id = None
704
last_revno, last_revision_id = self.last_revision_info()
705
real_rev_history = list(self.repository.iter_reverse_revision_history(
707
real_rev_history.reverse()
708
if len(real_rev_history) != last_revno:
709
raise errors.BzrCheckError('revno does not match len(mainline)'
710
' %s != %s' % (last_revno, len(real_rev_history)))
711
# TODO: We should probably also check that real_rev_history actually
712
# matches self.revision_history()
713
for revision_id in real_rev_history:
715
revision = self.repository.get_revision(revision_id)
716
except errors.NoSuchRevision, e:
717
raise errors.BzrCheckError("mainline revision {%s} not in repository"
719
# In general the first entry on the revision history has no parents.
720
# But it's not illegal for it to have parents listed; this can happen
721
# in imports from Arch when the parents weren't reachable.
722
if mainline_parent_id is not None:
723
if mainline_parent_id not in revision.parent_ids:
724
raise errors.BzrCheckError("previous revision {%s} not listed among "
726
% (mainline_parent_id, revision_id))
727
mainline_parent_id = revision_id
728
return BranchCheckResult(self)
730
def _get_checkout_format(self):
731
"""Return the most suitable metadir for a checkout of this branch.
732
Weaves are used if this branch's repository uses weaves.
734
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
735
from bzrlib.repofmt import weaverepo
736
format = bzrdir.BzrDirMetaFormat1()
737
format.repository_format = weaverepo.RepositoryFormat7()
739
format = self.repository.bzrdir.checkout_metadir()
740
format.set_branch_format(self._format)
743
def create_checkout(self, to_location, revision_id=None,
744
lightweight=False, accelerator_tree=None,
746
"""Create a checkout of a branch.
748
:param to_location: The url to produce the checkout at
749
:param revision_id: The revision to check out
750
:param lightweight: If True, produce a lightweight checkout, otherwise,
751
produce a bound branch (heavyweight checkout)
752
:param accelerator_tree: A tree which can be used for retrieving file
753
contents more quickly than the revision tree, i.e. a workingtree.
754
The revision tree will be used for cases where accelerator_tree's
755
content is different.
756
:param hardlink: If true, hard-link files from accelerator_tree,
758
:return: The tree of the created checkout
760
t = transport.get_transport(to_location)
763
format = self._get_checkout_format()
764
checkout = format.initialize_on_transport(t)
765
from_branch = BranchReferenceFormat().initialize(checkout, self)
767
format = self._get_checkout_format()
768
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
769
to_location, force_new_tree=False, format=format)
770
checkout = checkout_branch.bzrdir
771
checkout_branch.bind(self)
772
# pull up to the specified revision_id to set the initial
773
# branch tip correctly, and seed it with history.
774
checkout_branch.pull(self, stop_revision=revision_id)
776
tree = checkout.create_workingtree(revision_id,
777
from_branch=from_branch,
778
accelerator_tree=accelerator_tree,
780
basis_tree = tree.basis_tree()
781
basis_tree.lock_read()
783
for path, file_id in basis_tree.iter_references():
784
reference_parent = self.reference_parent(file_id, path)
785
reference_parent.create_checkout(tree.abspath(path),
786
basis_tree.get_reference_revision(file_id, path),
793
def reconcile(self, thorough=True):
794
"""Make sure the data stored in this branch is consistent."""
795
from bzrlib.reconcile import BranchReconciler
796
reconciler = BranchReconciler(self, thorough=thorough)
797
reconciler.reconcile()
800
def reference_parent(self, file_id, path):
801
"""Return the parent branch for a tree-reference file_id
802
:param file_id: The file_id of the tree reference
803
:param path: The path of the file_id in the tree
804
:return: A branch associated with the file_id
806
# FIXME should provide multiple branches, based on config
807
return Branch.open(self.bzrdir.root_transport.clone(path).base)
809
def supports_tags(self):
810
return self._format.supports_tags()
813
class BranchFormat(object):
814
"""An encapsulation of the initialization and open routines for a format.
816
Formats provide three things:
817
* An initialization routine,
821
Formats are placed in an dict by their format string for reference
822
during branch opening. Its not required that these be instances, they
823
can be classes themselves with class methods - it simply depends on
824
whether state is needed for a given format or not.
826
Once a format is deprecated, just deprecate the initialize and open
827
methods on the format class. Do not deprecate the object, as the
828
object will be created every time regardless.
831
_default_format = None
832
"""The default format used for new branches."""
835
"""The known formats."""
837
def __eq__(self, other):
838
return self.__class__ is other.__class__
840
def __ne__(self, other):
841
return not (self == other)
844
def find_format(klass, a_bzrdir):
845
"""Return the format for the branch object in a_bzrdir."""
847
transport = a_bzrdir.get_branch_transport(None)
848
format_string = transport.get("format").read()
849
return klass._formats[format_string]
850
except errors.NoSuchFile:
851
raise errors.NotBranchError(path=transport.base)
853
raise errors.UnknownFormatError(format=format_string, kind='branch')
856
def get_default_format(klass):
857
"""Return the current default format."""
858
return klass._default_format
860
def get_reference(self, a_bzrdir):
861
"""Get the target reference of the branch in a_bzrdir.
863
format probing must have been completed before calling
864
this method - it is assumed that the format of the branch
865
in a_bzrdir is correct.
867
:param a_bzrdir: The bzrdir to get the branch data from.
868
:return: None if the branch is not a reference branch.
873
def set_reference(self, a_bzrdir, to_branch):
874
"""Set the target reference of the branch in a_bzrdir.
876
format probing must have been completed before calling
877
this method - it is assumed that the format of the branch
878
in a_bzrdir is correct.
880
:param a_bzrdir: The bzrdir to set the branch reference for.
881
:param to_branch: branch that the checkout is to reference
883
raise NotImplementedError(self.set_reference)
885
def get_format_string(self):
886
"""Return the ASCII format string that identifies this format."""
887
raise NotImplementedError(self.get_format_string)
889
def get_format_description(self):
890
"""Return the short format description for this format."""
891
raise NotImplementedError(self.get_format_description)
893
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
895
"""Initialize a branch in a bzrdir, with specified files
897
:param a_bzrdir: The bzrdir to initialize the branch in
898
:param utf8_files: The files to create as a list of
899
(filename, content) tuples
900
:param set_format: If True, set the format with
901
self.get_format_string. (BzrBranch4 has its format set
903
:return: a branch in this format
905
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
906
branch_transport = a_bzrdir.get_branch_transport(self)
908
'metadir': ('lock', lockdir.LockDir),
909
'branch4': ('branch-lock', lockable_files.TransportLock),
911
lock_name, lock_class = lock_map[lock_type]
912
control_files = lockable_files.LockableFiles(branch_transport,
913
lock_name, lock_class)
914
control_files.create_lock()
915
control_files.lock_write()
917
utf8_files += [('format', self.get_format_string())]
919
for (filename, content) in utf8_files:
920
branch_transport.put_bytes(
922
mode=control_files._file_mode)
924
control_files.unlock()
925
return self.open(a_bzrdir, _found=True)
927
def initialize(self, a_bzrdir):
928
"""Create a branch of this format in a_bzrdir."""
929
raise NotImplementedError(self.initialize)
931
def is_supported(self):
932
"""Is this format supported?
934
Supported formats can be initialized and opened.
935
Unsupported formats may not support initialization or committing or
936
some other features depending on the reason for not being supported.
940
def open(self, a_bzrdir, _found=False):
941
"""Return the branch object for a_bzrdir
943
_found is a private parameter, do not use it. It is used to indicate
944
if format probing has already be done.
946
raise NotImplementedError(self.open)
949
def register_format(klass, format):
950
klass._formats[format.get_format_string()] = format
953
def set_default_format(klass, format):
954
klass._default_format = format
957
def unregister_format(klass, format):
958
del klass._formats[format.get_format_string()]
961
return self.get_format_string().rstrip()
963
def supports_tags(self):
964
"""True if this format supports tags stored in the branch"""
965
return False # by default
968
class BranchHooks(Hooks):
969
"""A dictionary mapping hook name to a list of callables for branch hooks.
971
e.g. ['set_rh'] Is the list of items to be called when the
972
set_revision_history function is invoked.
976
"""Create the default hooks.
978
These are all empty initially, because by default nothing should get
982
# Introduced in 0.15:
983
# invoked whenever the revision history has been set
984
# with set_revision_history. The api signature is
985
# (branch, revision_history), and the branch will
988
# invoked after a push operation completes.
989
# the api signature is
991
# containing the members
992
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
993
# where local is the local target branch or None, master is the target
994
# master branch, and the rest should be self explanatory. The source
995
# is read locked and the target branches write locked. Source will
996
# be the local low-latency branch.
997
self['post_push'] = []
998
# invoked after a pull operation completes.
999
# the api signature is
1001
# containing the members
1002
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1003
# where local is the local branch or None, master is the target
1004
# master branch, and the rest should be self explanatory. The source
1005
# is read locked and the target branches write locked. The local
1006
# branch is the low-latency branch.
1007
self['post_pull'] = []
1008
# invoked before a commit operation takes place.
1009
# the api signature is
1010
# (local, master, old_revno, old_revid, future_revno, future_revid,
1011
# tree_delta, future_tree).
1012
# old_revid is NULL_REVISION for the first commit to a branch
1013
# tree_delta is a TreeDelta object describing changes from the basis
1014
# revision, hooks MUST NOT modify this delta
1015
# future_tree is an in-memory tree obtained from
1016
# CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
1017
self['pre_commit'] = []
1018
# invoked after a commit operation completes.
1019
# the api signature is
1020
# (local, master, old_revno, old_revid, new_revno, new_revid)
1021
# old_revid is NULL_REVISION for the first commit to a branch.
1022
self['post_commit'] = []
1023
# invoked after a uncommit operation completes.
1024
# the api signature is
1025
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1026
# local is the local branch or None, master is the target branch,
1027
# and an empty branch recieves new_revno of 0, new_revid of None.
1028
self['post_uncommit'] = []
1030
# Invoked after the tip of a branch changes.
1031
# the api signature is
1032
# (params) where params is a ChangeBranchTipParams with the members
1033
# (branch, old_revno, new_revno, old_revid, new_revid)
1034
self['post_change_branch_tip'] = []
1037
# install the default hooks into the Branch class.
1038
Branch.hooks = BranchHooks()
1041
class ChangeBranchTipParams(object):
1042
"""Object holding parameters passed to *_change_branch_tip hooks.
1044
There are 5 fields that hooks may wish to access:
1046
:ivar branch: the branch being changed
1047
:ivar old_revno: revision number before the change
1048
:ivar new_revno: revision number after the change
1049
:ivar old_revid: revision id before the change
1050
:ivar new_revid: revision id after the change
1052
The revid fields are strings. The revno fields are integers.
1055
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1056
"""Create a group of ChangeBranchTip parameters.
1058
:param branch: The branch being changed.
1059
:param old_revno: Revision number before the change.
1060
:param new_revno: Revision number after the change.
1061
:param old_revid: Tip revision id before the change.
1062
:param new_revid: Tip revision id after the change.
1064
self.branch = branch
1065
self.old_revno = old_revno
1066
self.new_revno = new_revno
1067
self.old_revid = old_revid
1068
self.new_revid = new_revid
1071
class BzrBranchFormat4(BranchFormat):
1072
"""Bzr branch format 4.
1075
- a revision-history file.
1076
- a branch-lock lock file [ to be shared with the bzrdir ]
1079
def get_format_description(self):
1080
"""See BranchFormat.get_format_description()."""
1081
return "Branch format 4"
1083
def initialize(self, a_bzrdir):
1084
"""Create a branch of this format in a_bzrdir."""
1085
utf8_files = [('revision-history', ''),
1086
('branch-name', ''),
1088
return self._initialize_helper(a_bzrdir, utf8_files,
1089
lock_type='branch4', set_format=False)
1092
super(BzrBranchFormat4, self).__init__()
1093
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1095
def open(self, a_bzrdir, _found=False):
1096
"""Return the branch object for a_bzrdir
1098
_found is a private parameter, do not use it. It is used to indicate
1099
if format probing has already be done.
1102
# we are being called directly and must probe.
1103
raise NotImplementedError
1104
return BzrBranch(_format=self,
1105
_control_files=a_bzrdir._control_files,
1107
_repository=a_bzrdir.open_repository())
1110
return "Bazaar-NG branch format 4"
1113
class BzrBranchFormat5(BranchFormat):
1114
"""Bzr branch format 5.
1117
- a revision-history file.
1119
- a lock dir guarding the branch itself
1120
- all of this stored in a branch/ subdirectory
1121
- works with shared repositories.
1123
This format is new in bzr 0.8.
1126
def get_format_string(self):
1127
"""See BranchFormat.get_format_string()."""
1128
return "Bazaar-NG branch format 5\n"
1130
def get_format_description(self):
1131
"""See BranchFormat.get_format_description()."""
1132
return "Branch format 5"
1134
def initialize(self, a_bzrdir):
1135
"""Create a branch of this format in a_bzrdir."""
1136
utf8_files = [('revision-history', ''),
1137
('branch-name', ''),
1139
return self._initialize_helper(a_bzrdir, utf8_files)
1142
super(BzrBranchFormat5, self).__init__()
1143
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1145
def open(self, a_bzrdir, _found=False):
1146
"""Return the branch object for a_bzrdir
1148
_found is a private parameter, do not use it. It is used to indicate
1149
if format probing has already be done.
1152
format = BranchFormat.find_format(a_bzrdir)
1153
if format.__class__ != self.__class__:
1154
raise AssertionError("wrong format %r found for %r" %
1157
transport = a_bzrdir.get_branch_transport(None)
1158
control_files = lockable_files.LockableFiles(transport, 'lock',
1160
return BzrBranch5(_format=self,
1161
_control_files=control_files,
1163
_repository=a_bzrdir.find_repository())
1164
except errors.NoSuchFile:
1165
raise errors.NotBranchError(path=transport.base)
1168
class BzrBranchFormat6(BzrBranchFormat5):
1169
"""Branch format with last-revision and tags.
1171
Unlike previous formats, this has no explicit revision history. Instead,
1172
this just stores the last-revision, and the left-hand history leading
1173
up to there is the history.
1175
This format was introduced in bzr 0.15
1176
and became the default in 0.91.
1179
def get_format_string(self):
1180
"""See BranchFormat.get_format_string()."""
1181
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1183
def get_format_description(self):
1184
"""See BranchFormat.get_format_description()."""
1185
return "Branch format 6"
1187
def initialize(self, a_bzrdir):
1188
"""Create a branch of this format in a_bzrdir."""
1189
utf8_files = [('last-revision', '0 null:\n'),
1190
('branch.conf', ''),
1193
return self._initialize_helper(a_bzrdir, utf8_files)
1195
def open(self, a_bzrdir, _found=False):
1196
"""Return the branch object for a_bzrdir
1198
_found is a private parameter, do not use it. It is used to indicate
1199
if format probing has already be done.
1202
format = BranchFormat.find_format(a_bzrdir)
1203
if format.__class__ != self.__class__:
1204
raise AssertionError("wrong format %r found for %r" %
1206
transport = a_bzrdir.get_branch_transport(None)
1207
control_files = lockable_files.LockableFiles(transport, 'lock',
1209
return BzrBranch6(_format=self,
1210
_control_files=control_files,
1212
_repository=a_bzrdir.find_repository())
1214
def supports_tags(self):
1218
class BranchReferenceFormat(BranchFormat):
1219
"""Bzr branch reference format.
1221
Branch references are used in implementing checkouts, they
1222
act as an alias to the real branch which is at some other url.
1229
def get_format_string(self):
1230
"""See BranchFormat.get_format_string()."""
1231
return "Bazaar-NG Branch Reference Format 1\n"
1233
def get_format_description(self):
1234
"""See BranchFormat.get_format_description()."""
1235
return "Checkout reference format 1"
1237
def get_reference(self, a_bzrdir):
1238
"""See BranchFormat.get_reference()."""
1239
transport = a_bzrdir.get_branch_transport(None)
1240
return transport.get('location').read()
1242
def set_reference(self, a_bzrdir, to_branch):
1243
"""See BranchFormat.set_reference()."""
1244
transport = a_bzrdir.get_branch_transport(None)
1245
location = transport.put_bytes('location', to_branch.base)
1247
def initialize(self, a_bzrdir, target_branch=None):
1248
"""Create a branch of this format in a_bzrdir."""
1249
if target_branch is None:
1250
# this format does not implement branch itself, thus the implicit
1251
# creation contract must see it as uninitializable
1252
raise errors.UninitializableFormat(self)
1253
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1254
branch_transport = a_bzrdir.get_branch_transport(self)
1255
branch_transport.put_bytes('location',
1256
target_branch.bzrdir.root_transport.base)
1257
branch_transport.put_bytes('format', self.get_format_string())
1259
a_bzrdir, _found=True,
1260
possible_transports=[target_branch.bzrdir.root_transport])
1263
super(BranchReferenceFormat, self).__init__()
1264
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1266
def _make_reference_clone_function(format, a_branch):
1267
"""Create a clone() routine for a branch dynamically."""
1268
def clone(to_bzrdir, revision_id=None):
1269
"""See Branch.clone()."""
1270
return format.initialize(to_bzrdir, a_branch)
1271
# cannot obey revision_id limits when cloning a reference ...
1272
# FIXME RBC 20060210 either nuke revision_id for clone, or
1273
# emit some sort of warning/error to the caller ?!
1276
def open(self, a_bzrdir, _found=False, location=None,
1277
possible_transports=None):
1278
"""Return the branch that the branch reference in a_bzrdir points at.
1280
_found is a private parameter, do not use it. It is used to indicate
1281
if format probing has already be done.
1284
format = BranchFormat.find_format(a_bzrdir)
1285
if format.__class__ != self.__class__:
1286
raise AssertionError("wrong format %r found for %r" %
1288
if location is None:
1289
location = self.get_reference(a_bzrdir)
1290
real_bzrdir = bzrdir.BzrDir.open(
1291
location, possible_transports=possible_transports)
1292
result = real_bzrdir.open_branch()
1293
# this changes the behaviour of result.clone to create a new reference
1294
# rather than a copy of the content of the branch.
1295
# I did not use a proxy object because that needs much more extensive
1296
# testing, and we are only changing one behaviour at the moment.
1297
# If we decide to alter more behaviours - i.e. the implicit nickname
1298
# then this should be refactored to introduce a tested proxy branch
1299
# and a subclass of that for use in overriding clone() and ....
1301
result.clone = self._make_reference_clone_function(result)
1305
# formats which have no format string are not discoverable
1306
# and not independently creatable, so are not registered.
1307
__format5 = BzrBranchFormat5()
1308
__format6 = BzrBranchFormat6()
1309
BranchFormat.register_format(__format5)
1310
BranchFormat.register_format(BranchReferenceFormat())
1311
BranchFormat.register_format(__format6)
1312
BranchFormat.set_default_format(__format6)
1313
_legacy_formats = [BzrBranchFormat4(),
1316
class BzrBranch(Branch):
1317
"""A branch stored in the actual filesystem.
1319
Note that it's "local" in the context of the filesystem; it doesn't
1320
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1321
it's writable, and can be accessed via the normal filesystem API.
1323
:ivar _transport: Transport for file operations on this branch's
1324
control files, typically pointing to the .bzr/branch directory.
1325
:ivar repository: Repository for this branch.
1326
:ivar base: The url of the base directory for this branch; the one
1327
containing the .bzr directory.
1330
def __init__(self, _format=None,
1331
_control_files=None, a_bzrdir=None, _repository=None):
1332
"""Create new branch object at a particular location."""
1333
Branch.__init__(self)
1334
if a_bzrdir is None:
1335
raise ValueError('a_bzrdir must be supplied')
1337
self.bzrdir = a_bzrdir
1338
self._base = self.bzrdir.transport.clone('..').base
1339
# XXX: We should be able to just do
1340
# self.base = self.bzrdir.root_transport.base
1341
# but this does not quite work yet -- mbp 20080522
1342
self._format = _format
1343
if _control_files is None:
1344
raise ValueError('BzrBranch _control_files is None')
1345
self.control_files = _control_files
1346
self._transport = _control_files._transport
1347
self.repository = _repository
1350
return '%s(%r)' % (self.__class__.__name__, self.base)
1354
def _get_base(self):
1355
"""Returns the directory containing the control directory."""
1358
base = property(_get_base, doc="The URL for the root of this branch.")
1360
@deprecated_method(deprecated_in((0, 16, 0)))
1361
def abspath(self, name):
1362
"""See Branch.abspath."""
1363
return self._transport.abspath(name)
1365
def is_locked(self):
1366
return self.control_files.is_locked()
1368
def lock_write(self, token=None):
1369
repo_token = self.repository.lock_write()
1371
token = self.control_files.lock_write(token=token)
1373
self.repository.unlock()
1377
def lock_read(self):
1378
self.repository.lock_read()
1380
self.control_files.lock_read()
1382
self.repository.unlock()
1386
# TODO: test for failed two phase locks. This is known broken.
1388
self.control_files.unlock()
1390
self.repository.unlock()
1391
if not self.control_files.is_locked():
1392
# we just released the lock
1393
self._clear_cached_state()
1395
def peek_lock_mode(self):
1396
if self.control_files._lock_count == 0:
1399
return self.control_files._lock_mode
1401
def get_physical_lock_status(self):
1402
return self.control_files.get_physical_lock_status()
1405
def print_file(self, file, revision_id):
1406
"""See Branch.print_file."""
1407
return self.repository.print_file(file, revision_id)
1409
def _write_revision_history(self, history):
1410
"""Factored out of set_revision_history.
1412
This performs the actual writing to disk.
1413
It is intended to be called by BzrBranch5.set_revision_history."""
1414
self._transport.put_bytes(
1415
'revision-history', '\n'.join(history),
1416
mode=self.control_files._file_mode)
1419
def set_revision_history(self, rev_history):
1420
"""See Branch.set_revision_history."""
1421
if 'evil' in debug.debug_flags:
1422
mutter_callsite(3, "set_revision_history scales with history.")
1423
self._write_revision_history(rev_history)
1424
self._clear_cached_state()
1425
self._cache_revision_history(rev_history)
1426
for hook in Branch.hooks['set_rh']:
1427
hook(self, rev_history)
1429
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1430
"""Run the post_change_branch_tip hooks."""
1431
hooks = Branch.hooks['post_change_branch_tip']
1434
new_revno, new_revid = self.last_revision_info()
1435
params = ChangeBranchTipParams(
1436
self, old_revno, new_revno, old_revid, new_revid)
1441
def set_last_revision_info(self, revno, revision_id):
1442
"""Set the last revision of this branch.
1444
The caller is responsible for checking that the revno is correct
1445
for this revision id.
1447
It may be possible to set the branch last revision to an id not
1448
present in the repository. However, branches can also be
1449
configured to check constraints on history, in which case this may not
1452
revision_id = _mod_revision.ensure_null(revision_id)
1453
old_revno, old_revid = self.last_revision_info()
1454
# this old format stores the full history, but this api doesn't
1455
# provide it, so we must generate, and might as well check it's
1457
history = self._lefthand_history(revision_id)
1458
if len(history) != revno:
1459
raise AssertionError('%d != %d' % (len(history), revno))
1460
self.set_revision_history(history)
1461
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1463
def _gen_revision_history(self):
1464
history = self._transport.get_bytes('revision-history').split('\n')
1465
if history[-1:] == ['']:
1466
# There shouldn't be a trailing newline, but just in case.
1470
def _lefthand_history(self, revision_id, last_rev=None,
1472
if 'evil' in debug.debug_flags:
1473
mutter_callsite(4, "_lefthand_history scales with history.")
1474
# stop_revision must be a descendant of last_revision
1475
graph = self.repository.get_graph()
1476
if last_rev is not None:
1477
if not graph.is_ancestor(last_rev, revision_id):
1478
# our previous tip is not merged into stop_revision
1479
raise errors.DivergedBranches(self, other_branch)
1480
# make a new revision history from the graph
1481
parents_map = graph.get_parent_map([revision_id])
1482
if revision_id not in parents_map:
1483
raise errors.NoSuchRevision(self, revision_id)
1484
current_rev_id = revision_id
1486
# Do not include ghosts or graph origin in revision_history
1487
while (current_rev_id in parents_map and
1488
len(parents_map[current_rev_id]) > 0):
1489
new_history.append(current_rev_id)
1490
current_rev_id = parents_map[current_rev_id][0]
1491
parents_map = graph.get_parent_map([current_rev_id])
1492
new_history.reverse()
1496
def generate_revision_history(self, revision_id, last_rev=None,
1498
"""Create a new revision history that will finish with revision_id.
1500
:param revision_id: the new tip to use.
1501
:param last_rev: The previous last_revision. If not None, then this
1502
must be a ancestory of revision_id, or DivergedBranches is raised.
1503
:param other_branch: The other branch that DivergedBranches should
1504
raise with respect to.
1506
self.set_revision_history(self._lefthand_history(revision_id,
1507
last_rev, other_branch))
1510
def update_revisions(self, other, stop_revision=None, overwrite=False,
1512
"""See Branch.update_revisions."""
1515
other_revno, other_last_revision = other.last_revision_info()
1516
stop_revno = None # unknown
1517
if stop_revision is None:
1518
stop_revision = other_last_revision
1519
if _mod_revision.is_null(stop_revision):
1520
# if there are no commits, we're done.
1522
stop_revno = other_revno
1524
# what's the current last revision, before we fetch [and change it
1526
last_rev = _mod_revision.ensure_null(self.last_revision())
1527
# we fetch here so that we don't process data twice in the common
1528
# case of having something to pull, and so that the check for
1529
# already merged can operate on the just fetched graph, which will
1530
# be cached in memory.
1531
self.fetch(other, stop_revision)
1532
# Check to see if one is an ancestor of the other
1535
graph = self.repository.get_graph()
1536
heads = graph.heads([stop_revision, last_rev])
1537
if heads == set([last_rev]):
1538
# The current revision is a decendent of the target,
1541
elif heads == set([stop_revision, last_rev]):
1542
# These branches have diverged
1543
raise errors.DivergedBranches(self, other)
1544
elif heads != set([stop_revision]):
1545
raise AssertionError("invalid heads: %r" % heads)
1546
if stop_revno is None:
1548
graph = self.repository.get_graph()
1549
this_revno, this_last_revision = self.last_revision_info()
1550
stop_revno = graph.find_distance_to_null(stop_revision,
1551
[(other_last_revision, other_revno),
1552
(this_last_revision, this_revno)])
1553
self.set_last_revision_info(stop_revno, stop_revision)
1557
def basis_tree(self):
1558
"""See Branch.basis_tree."""
1559
return self.repository.revision_tree(self.last_revision())
1562
def pull(self, source, overwrite=False, stop_revision=None,
1563
_hook_master=None, run_hooks=True, possible_transports=None):
1566
:param _hook_master: Private parameter - set the branch to
1567
be supplied as the master to push hooks.
1568
:param run_hooks: Private parameter - if false, this branch
1569
is being called because it's the master of the primary branch,
1570
so it should not run its hooks.
1572
result = PullResult()
1573
result.source_branch = source
1574
result.target_branch = self
1577
# We assume that during 'pull' the local repository is closer than
1579
graph = self.repository.get_graph(source.repository)
1580
result.old_revno, result.old_revid = self.last_revision_info()
1581
self.update_revisions(source, stop_revision, overwrite=overwrite,
1583
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
1584
result.new_revno, result.new_revid = self.last_revision_info()
1586
result.master_branch = _hook_master
1587
result.local_branch = self
1589
result.master_branch = self
1590
result.local_branch = None
1592
for hook in Branch.hooks['post_pull']:
1598
def _get_parent_location(self):
1599
_locs = ['parent', 'pull', 'x-pull']
1602
return self._transport.get_bytes(l).strip('\n')
1603
except errors.NoSuchFile:
1608
def push(self, target, overwrite=False, stop_revision=None,
1609
_override_hook_source_branch=None):
1612
This is the basic concrete implementation of push()
1614
:param _override_hook_source_branch: If specified, run
1615
the hooks passing this Branch as the source, rather than self.
1616
This is for use of RemoteBranch, where push is delegated to the
1617
underlying vfs-based Branch.
1619
# TODO: Public option to disable running hooks - should be trivial but
1623
result = self._push_with_bound_branches(target, overwrite,
1625
_override_hook_source_branch=_override_hook_source_branch)
1630
def _push_with_bound_branches(self, target, overwrite,
1632
_override_hook_source_branch=None):
1633
"""Push from self into target, and into target's master if any.
1635
This is on the base BzrBranch class even though it doesn't support
1636
bound branches because the *target* might be bound.
1639
if _override_hook_source_branch:
1640
result.source_branch = _override_hook_source_branch
1641
for hook in Branch.hooks['post_push']:
1644
bound_location = target.get_bound_location()
1645
if bound_location and target.base != bound_location:
1646
# there is a master branch.
1648
# XXX: Why the second check? Is it even supported for a branch to
1649
# be bound to itself? -- mbp 20070507
1650
master_branch = target.get_master_branch()
1651
master_branch.lock_write()
1653
# push into the master from this branch.
1654
self._basic_push(master_branch, overwrite, stop_revision)
1655
# and push into the target branch from this. Note that we push from
1656
# this branch again, because its considered the highest bandwidth
1658
result = self._basic_push(target, overwrite, stop_revision)
1659
result.master_branch = master_branch
1660
result.local_branch = target
1664
master_branch.unlock()
1667
result = self._basic_push(target, overwrite, stop_revision)
1668
# TODO: Why set master_branch and local_branch if there's no
1669
# binding? Maybe cleaner to just leave them unset? -- mbp
1671
result.master_branch = target
1672
result.local_branch = None
1676
def _basic_push(self, target, overwrite, stop_revision):
1677
"""Basic implementation of push without bound branches or hooks.
1679
Must be called with self read locked and target write locked.
1681
result = PushResult()
1682
result.source_branch = self
1683
result.target_branch = target
1684
result.old_revno, result.old_revid = target.last_revision_info()
1686
# We assume that during 'push' this repository is closer than
1688
graph = self.repository.get_graph(target.repository)
1689
target.update_revisions(self, stop_revision, overwrite=overwrite,
1691
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
1692
result.new_revno, result.new_revid = target.last_revision_info()
1695
def get_parent(self):
1696
"""See Branch.get_parent."""
1697
parent = self._get_parent_location()
1700
# This is an old-format absolute path to a local branch
1701
# turn it into a url
1702
if parent.startswith('/'):
1703
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1705
return urlutils.join(self.base[:-1], parent)
1706
except errors.InvalidURLJoin, e:
1707
raise errors.InaccessibleParent(parent, self.base)
1709
def set_push_location(self, location):
1710
"""See Branch.set_push_location."""
1711
self.get_config().set_user_option(
1712
'push_location', location,
1713
store=_mod_config.STORE_LOCATION_NORECURSE)
1716
def set_parent(self, url):
1717
"""See Branch.set_parent."""
1718
# TODO: Maybe delete old location files?
1719
# URLs should never be unicode, even on the local fs,
1720
# FIXUP this and get_parent in a future branch format bump:
1721
# read and rewrite the file. RBC 20060125
1723
if isinstance(url, unicode):
1725
url = url.encode('ascii')
1726
except UnicodeEncodeError:
1727
raise errors.InvalidURL(url,
1728
"Urls must be 7-bit ascii, "
1729
"use bzrlib.urlutils.escape")
1730
url = urlutils.relative_url(self.base, url)
1731
self._set_parent_location(url)
1733
def _set_parent_location(self, url):
1735
self._transport.delete('parent')
1737
self._transport.put_bytes('parent', url + '\n',
1738
mode=self.control_files._file_mode)
1741
class BzrBranch5(BzrBranch):
1742
"""A format 5 branch. This supports new features over plain branches.
1744
It has support for a master_branch which is the data for bound branches.
1752
super(BzrBranch5, self).__init__(_format=_format,
1753
_control_files=_control_files,
1755
_repository=_repository)
1758
def pull(self, source, overwrite=False, stop_revision=None,
1759
run_hooks=True, possible_transports=None):
1760
"""Pull from source into self, updating my master if any.
1762
:param run_hooks: Private parameter - if false, this branch
1763
is being called because it's the master of the primary branch,
1764
so it should not run its hooks.
1766
bound_location = self.get_bound_location()
1767
master_branch = None
1768
if bound_location and source.base != bound_location:
1769
# not pulling from master, so we need to update master.
1770
master_branch = self.get_master_branch(possible_transports)
1771
master_branch.lock_write()
1774
# pull from source into master.
1775
master_branch.pull(source, overwrite, stop_revision,
1777
return super(BzrBranch5, self).pull(source, overwrite,
1778
stop_revision, _hook_master=master_branch,
1779
run_hooks=run_hooks)
1782
master_branch.unlock()
1784
def get_bound_location(self):
1786
return self._transport.get_bytes('bound')[:-1]
1787
except errors.NoSuchFile:
1791
def get_master_branch(self, possible_transports=None):
1792
"""Return the branch we are bound to.
1794
:return: Either a Branch, or None
1796
This could memoise the branch, but if thats done
1797
it must be revalidated on each new lock.
1798
So for now we just don't memoise it.
1799
# RBC 20060304 review this decision.
1801
bound_loc = self.get_bound_location()
1805
return Branch.open(bound_loc,
1806
possible_transports=possible_transports)
1807
except (errors.NotBranchError, errors.ConnectionError), e:
1808
raise errors.BoundBranchConnectionFailure(
1812
def set_bound_location(self, location):
1813
"""Set the target where this branch is bound to.
1815
:param location: URL to the target branch
1818
self._transport.put_bytes('bound', location+'\n',
1819
mode=self.bzrdir._get_file_mode())
1822
self._transport.delete('bound')
1823
except errors.NoSuchFile:
1828
def bind(self, other):
1829
"""Bind this branch to the branch other.
1831
This does not push or pull data between the branches, though it does
1832
check for divergence to raise an error when the branches are not
1833
either the same, or one a prefix of the other. That behaviour may not
1834
be useful, so that check may be removed in future.
1836
:param other: The branch to bind to
1839
# TODO: jam 20051230 Consider checking if the target is bound
1840
# It is debatable whether you should be able to bind to
1841
# a branch which is itself bound.
1842
# Committing is obviously forbidden,
1843
# but binding itself may not be.
1844
# Since we *have* to check at commit time, we don't
1845
# *need* to check here
1847
# we want to raise diverged if:
1848
# last_rev is not in the other_last_rev history, AND
1849
# other_last_rev is not in our history, and do it without pulling
1851
self.set_bound_location(other.base)
1855
"""If bound, unbind"""
1856
return self.set_bound_location(None)
1859
def update(self, possible_transports=None):
1860
"""Synchronise this branch with the master branch if any.
1862
:return: None or the last_revision that was pivoted out during the
1865
master = self.get_master_branch(possible_transports)
1866
if master is not None:
1867
old_tip = _mod_revision.ensure_null(self.last_revision())
1868
self.pull(master, overwrite=True)
1869
if self.repository.get_graph().is_ancestor(old_tip,
1870
_mod_revision.ensure_null(self.last_revision())):
1876
class BzrBranch6(BzrBranch5):
1878
def __init__(self, *args, **kwargs):
1879
super(BzrBranch6, self).__init__(*args, **kwargs)
1880
self._last_revision_info_cache = None
1881
self._partial_revision_history_cache = []
1883
def _clear_cached_state(self):
1884
super(BzrBranch6, self)._clear_cached_state()
1885
self._last_revision_info_cache = None
1886
self._partial_revision_history_cache = []
1889
def last_revision_info(self):
1890
"""Return information about the last revision.
1892
:return: A tuple (revno, revision_id).
1894
if self._last_revision_info_cache is None:
1895
self._last_revision_info_cache = self._last_revision_info()
1896
return self._last_revision_info_cache
1898
def _last_revision_info(self):
1899
revision_string = self._transport.get_bytes('last-revision')
1900
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1901
revision_id = cache_utf8.get_cached_utf8(revision_id)
1903
return revno, revision_id
1905
def _write_last_revision_info(self, revno, revision_id):
1906
"""Simply write out the revision id, with no checks.
1908
Use set_last_revision_info to perform this safely.
1910
Does not update the revision_history cache.
1911
Intended to be called by set_last_revision_info and
1912
_write_revision_history.
1914
revision_id = _mod_revision.ensure_null(revision_id)
1915
out_string = '%d %s\n' % (revno, revision_id)
1916
self._transport.put_bytes('last-revision', out_string,
1917
mode=self.control_files._file_mode)
1920
def set_last_revision_info(self, revno, revision_id):
1921
revision_id = _mod_revision.ensure_null(revision_id)
1922
old_revno, old_revid = self.last_revision_info()
1923
if self._get_append_revisions_only():
1924
self._check_history_violation(revision_id)
1925
self._write_last_revision_info(revno, revision_id)
1926
self._clear_cached_state()
1927
self._last_revision_info_cache = revno, revision_id
1928
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1930
def _check_history_violation(self, revision_id):
1931
last_revision = _mod_revision.ensure_null(self.last_revision())
1932
if _mod_revision.is_null(last_revision):
1934
if last_revision not in self._lefthand_history(revision_id):
1935
raise errors.AppendRevisionsOnlyViolation(self.base)
1937
def _gen_revision_history(self):
1938
"""Generate the revision history from last revision
1940
self._extend_partial_history()
1941
return list(reversed(self._partial_revision_history_cache))
1943
def _extend_partial_history(self, stop_index=None, stop_revision=None):
1944
"""Extend the partial history to include a given index
1946
If a stop_index is supplied, stop when that index has been reached.
1947
If a stop_revision is supplied, stop when that revision is
1948
encountered. Otherwise, stop when the beginning of history is
1951
:param stop_index: The index which should be present. When it is
1952
present, history extension will stop.
1953
:param revision_id: The revision id which should be present. When
1954
it is encountered, history extension will stop.
1956
repo = self.repository
1957
if len(self._partial_revision_history_cache) == 0:
1958
iterator = repo.iter_reverse_revision_history(self.last_revision())
1960
start_revision = self._partial_revision_history_cache[-1]
1961
iterator = repo.iter_reverse_revision_history(start_revision)
1962
#skip the last revision in the list
1963
next_revision = iterator.next()
1964
for revision_id in iterator:
1965
self._partial_revision_history_cache.append(revision_id)
1966
if (stop_index is not None and
1967
len(self._partial_revision_history_cache) > stop_index):
1969
if revision_id == stop_revision:
1972
def _write_revision_history(self, history):
1973
"""Factored out of set_revision_history.
1975
This performs the actual writing to disk, with format-specific checks.
1976
It is intended to be called by BzrBranch5.set_revision_history.
1978
if len(history) == 0:
1979
last_revision = 'null:'
1981
if history != self._lefthand_history(history[-1]):
1982
raise errors.NotLefthandHistory(history)
1983
last_revision = history[-1]
1984
if self._get_append_revisions_only():
1985
self._check_history_violation(last_revision)
1986
self._write_last_revision_info(len(history), last_revision)
1989
def _set_parent_location(self, url):
1990
"""Set the parent branch"""
1991
self._set_config_location('parent_location', url, make_relative=True)
1994
def _get_parent_location(self):
1995
"""Set the parent branch"""
1996
return self._get_config_location('parent_location')
1998
def set_push_location(self, location):
1999
"""See Branch.set_push_location."""
2000
self._set_config_location('push_location', location)
2002
def set_bound_location(self, location):
2003
"""See Branch.set_push_location."""
2005
config = self.get_config()
2006
if location is None:
2007
if config.get_user_option('bound') != 'True':
2010
config.set_user_option('bound', 'False', warn_masked=True)
2013
self._set_config_location('bound_location', location,
2015
config.set_user_option('bound', 'True', warn_masked=True)
2018
def _get_bound_location(self, bound):
2019
"""Return the bound location in the config file.
2021
Return None if the bound parameter does not match"""
2022
config = self.get_config()
2023
config_bound = (config.get_user_option('bound') == 'True')
2024
if config_bound != bound:
2026
return self._get_config_location('bound_location', config=config)
2028
def get_bound_location(self):
2029
"""See Branch.set_push_location."""
2030
return self._get_bound_location(True)
2032
def get_old_bound_location(self):
2033
"""See Branch.get_old_bound_location"""
2034
return self._get_bound_location(False)
2036
def set_append_revisions_only(self, enabled):
2041
self.get_config().set_user_option('append_revisions_only', value,
2044
def _get_append_revisions_only(self):
2045
value = self.get_config().get_user_option('append_revisions_only')
2046
return value == 'True'
2048
def _synchronize_history(self, destination, revision_id):
2049
"""Synchronize last revision and revision history between branches.
2051
This version is most efficient when the destination is also a
2052
BzrBranch6, but works for BzrBranch5, as long as the destination's
2053
repository contains all the lefthand ancestors of the intended
2054
last_revision. If not, set_last_revision_info will fail.
2056
:param destination: The branch to copy the history into
2057
:param revision_id: The revision-id to truncate history at. May
2058
be None to copy complete history.
2060
source_revno, source_revision_id = self.last_revision_info()
2061
if revision_id is None:
2062
revno, revision_id = source_revno, source_revision_id
2063
elif source_revision_id == revision_id:
2064
# we know the revno without needing to walk all of history
2065
revno = source_revno
2067
# To figure out the revno for a random revision, we need to build
2068
# the revision history, and count its length.
2069
# We don't care about the order, just how long it is.
2070
# Alternatively, we could start at the current location, and count
2071
# backwards. But there is no guarantee that we will find it since
2072
# it may be a merged revision.
2073
revno = len(list(self.repository.iter_reverse_revision_history(
2075
destination.set_last_revision_info(revno, revision_id)
2077
def _make_tags(self):
2078
return BasicTags(self)
2081
def generate_revision_history(self, revision_id, last_rev=None,
2083
"""See BzrBranch5.generate_revision_history"""
2084
history = self._lefthand_history(revision_id, last_rev, other_branch)
2085
revno = len(history)
2086
self.set_last_revision_info(revno, revision_id)
2089
def get_rev_id(self, revno, history=None):
2090
"""Find the revision id of the specified revno."""
2092
return _mod_revision.NULL_REVISION
2094
last_revno, last_revision_id = self.last_revision_info()
2095
if revno <= 0 or revno > last_revno:
2096
raise errors.NoSuchRevision(self, revno)
2098
if history is not None:
2099
return history[revno - 1]
2101
index = last_revno - revno
2102
if len(self._partial_revision_history_cache) <= index:
2103
self._extend_partial_history(stop_index=index)
2104
if len(self._partial_revision_history_cache) > index:
2105
return self._partial_revision_history_cache[index]
2107
raise errors.NoSuchRevision(self, revno)
2110
def revision_id_to_revno(self, revision_id):
2111
"""Given a revision id, return its revno"""
2112
if _mod_revision.is_null(revision_id):
2115
index = self._partial_revision_history_cache.index(revision_id)
2117
self._extend_partial_history(stop_revision=revision_id)
2118
index = len(self._partial_revision_history_cache) - 1
2119
if self._partial_revision_history_cache[index] != revision_id:
2120
raise errors.NoSuchRevision(self, revision_id)
2121
return self.revno() - index
2124
######################################################################
2125
# results of operations
2128
class _Result(object):
2130
def _show_tag_conficts(self, to_file):
2131
if not getattr(self, 'tag_conflicts', None):
2133
to_file.write('Conflicting tags:\n')
2134
for name, value1, value2 in self.tag_conflicts:
2135
to_file.write(' %s\n' % (name, ))
2138
class PullResult(_Result):
2139
"""Result of a Branch.pull operation.
2141
:ivar old_revno: Revision number before pull.
2142
:ivar new_revno: Revision number after pull.
2143
:ivar old_revid: Tip revision id before pull.
2144
:ivar new_revid: Tip revision id after pull.
2145
:ivar source_branch: Source (local) branch object.
2146
:ivar master_branch: Master branch of the target, or None.
2147
:ivar target_branch: Target/destination branch object.
2151
# DEPRECATED: pull used to return the change in revno
2152
return self.new_revno - self.old_revno
2154
def report(self, to_file):
2156
if self.old_revid == self.new_revid:
2157
to_file.write('No revisions to pull.\n')
2159
to_file.write('Now on revision %d.\n' % self.new_revno)
2160
self._show_tag_conficts(to_file)
2163
class PushResult(_Result):
2164
"""Result of a Branch.push operation.
2166
:ivar old_revno: Revision number before push.
2167
:ivar new_revno: Revision number after push.
2168
:ivar old_revid: Tip revision id before push.
2169
:ivar new_revid: Tip revision id after push.
2170
:ivar source_branch: Source branch object.
2171
:ivar master_branch: Master branch of the target, or None.
2172
:ivar target_branch: Target/destination branch object.
2176
# DEPRECATED: push used to return the change in revno
2177
return self.new_revno - self.old_revno
2179
def report(self, to_file):
2180
"""Write a human-readable description of the result."""
2181
if self.old_revid == self.new_revid:
2182
to_file.write('No new revisions to push.\n')
2184
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2185
self._show_tag_conficts(to_file)
2188
class BranchCheckResult(object):
2189
"""Results of checking branch consistency.
2194
def __init__(self, branch):
2195
self.branch = branch
2197
def report_results(self, verbose):
2198
"""Report the check results via trace.note.
2200
:param verbose: Requests more detailed display of what was checked,
2203
note('checked branch %s format %s',
2205
self.branch._format)
2208
class Converter5to6(object):
2209
"""Perform an in-place upgrade of format 5 to format 6"""
2211
def convert(self, branch):
2212
# Data for 5 and 6 can peacefully coexist.
2213
format = BzrBranchFormat6()
2214
new_branch = format.open(branch.bzrdir, _found=True)
2216
# Copy source data into target
2217
new_branch._write_last_revision_info(*branch.last_revision_info())
2218
new_branch.set_parent(branch.get_parent())
2219
new_branch.set_bound_location(branch.get_bound_location())
2220
new_branch.set_push_location(branch.get_push_location())
2222
# New branch has no tags by default
2223
new_branch.tags._set_tag_dict({})
2225
# Copying done; now update target format
2226
new_branch._transport.put_bytes('format',
2227
format.get_format_string(),
2228
mode=new_branch.control_files._file_mode)
2230
# Clean up old files
2231
new_branch._transport.delete('revision-history')
2233
branch.set_parent(None)
2234
except errors.NoSuchFile:
2236
branch.set_bound_location(None)
added
removed
bzrlib/branch.py
