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(), """
20
from itertools import chain
24
config as _mod_config,
30
revision as _mod_revision,
36
from bzrlib.config import BranchConfig
37
from bzrlib.repofmt.pack_repo import RepositoryFormatPackDevelopment1Subtree
38
from bzrlib.tag import (
44
from bzrlib.decorators import needs_read_lock, needs_write_lock
45
from bzrlib.hooks import Hooks
46
from bzrlib.symbol_versioning import (
50
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
53
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
54
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
55
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
58
# TODO: Maybe include checks for common corruption of newlines, etc?
60
# TODO: Some operations like log might retrieve the same revisions
61
# repeatedly to calculate deltas. We could perhaps have a weakref
62
# cache in memory to make this faster. In general anything can be
63
# cached in memory between lock and unlock operations. .. nb thats
64
# what the transaction identity map provides
67
######################################################################
71
"""Branch holding a history of revisions.
74
Base directory/url of the branch.
76
hooks: An instance of BranchHooks.
78
# this is really an instance variable - FIXME move it there
82
# override this to set the strategy for storing tags
84
return DisabledTags(self)
86
def __init__(self, *ignored, **ignored_too):
87
self.tags = self._make_tags()
88
self._revision_history_cache = None
89
self._revision_id_to_revno_cache = None
90
self._last_revision_info_cache = None
94
"""Called by init to allow simpler extension of the base class."""
97
"""Break a lock if one is present from another instance.
99
Uses the ui factory to ask for confirmation if the lock may be from
102
This will probe the repository for its lock as well.
104
self.control_files.break_lock()
105
self.repository.break_lock()
106
master = self.get_master_branch()
107
if master is not None:
111
def open(base, _unsupported=False, possible_transports=None):
112
"""Open the branch rooted at base.
114
For instance, if the branch is at URL/.bzr/branch,
115
Branch.open(URL) -> a Branch instance.
117
control = bzrdir.BzrDir.open(base, _unsupported,
118
possible_transports=possible_transports)
119
return control.open_branch(_unsupported)
122
def open_from_transport(transport, _unsupported=False):
123
"""Open the branch rooted at transport"""
124
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
125
return control.open_branch(_unsupported)
128
def open_containing(url, possible_transports=None):
129
"""Open an existing branch which contains url.
131
This probes for a branch at url, and searches upwards from there.
133
Basically we keep looking up until we find the control directory or
134
run into the root. If there isn't one, raises NotBranchError.
135
If there is one and it is either an unrecognised format or an unsupported
136
format, UnknownFormatError or UnsupportedFormatError are raised.
137
If there is one, it is returned, along with the unused portion of url.
139
control, relpath = bzrdir.BzrDir.open_containing(url,
141
return control.open_branch(), relpath
143
def get_config(self):
144
return BranchConfig(self)
147
return self.get_config().get_nickname()
149
def _set_nick(self, nick):
150
self.get_config().set_user_option('nickname', nick, warn_masked=True)
152
nick = property(_get_nick, _set_nick)
155
raise NotImplementedError(self.is_locked)
157
def lock_write(self):
158
raise NotImplementedError(self.lock_write)
161
raise NotImplementedError(self.lock_read)
164
raise NotImplementedError(self.unlock)
166
def peek_lock_mode(self):
167
"""Return lock mode for the Branch: 'r', 'w' or None"""
168
raise NotImplementedError(self.peek_lock_mode)
170
def get_physical_lock_status(self):
171
raise NotImplementedError(self.get_physical_lock_status)
174
def get_revision_id_to_revno_map(self):
175
"""Return the revision_id => dotted revno map.
177
This will be regenerated on demand, but will be cached.
179
:return: A dictionary mapping revision_id => dotted revno.
180
This dictionary should not be modified by the caller.
182
if self._revision_id_to_revno_cache is not None:
183
mapping = self._revision_id_to_revno_cache
185
mapping = self._gen_revno_map()
186
self._cache_revision_id_to_revno(mapping)
187
# TODO: jam 20070417 Since this is being cached, should we be returning
189
# I would rather not, and instead just declare that users should not
190
# modify the return value.
193
def _gen_revno_map(self):
194
"""Create a new mapping from revision ids to dotted revnos.
196
Dotted revnos are generated based on the current tip in the revision
198
This is the worker function for get_revision_id_to_revno_map, which
199
just caches the return value.
201
:return: A dictionary mapping revision_id => dotted revno.
203
last_revision = self.last_revision()
204
revision_graph = repository._old_get_graph(self.repository,
206
merge_sorted_revisions = tsort.merge_sort(
211
revision_id_to_revno = dict((rev_id, revno)
212
for seq_num, rev_id, depth, revno, end_of_merge
213
in merge_sorted_revisions)
214
return revision_id_to_revno
216
def leave_lock_in_place(self):
217
"""Tell this branch object not to release the physical lock when this
220
If lock_write doesn't return a token, then this method is not supported.
222
self.control_files.leave_in_place()
224
def dont_leave_lock_in_place(self):
225
"""Tell this branch object to release the physical lock when this
226
object is unlocked, even if it didn't originally acquire it.
228
If lock_write doesn't return a token, then this method is not supported.
230
self.control_files.dont_leave_in_place()
232
@deprecated_method(deprecated_in((0, 16, 0)))
233
def abspath(self, name):
234
"""Return absolute filename for something in the branch
236
XXX: Robert Collins 20051017 what is this used for? why is it a branch
237
method and not a tree method.
239
raise NotImplementedError(self.abspath)
241
def bind(self, other):
242
"""Bind the local branch the other branch.
244
:param other: The branch to bind to
247
raise errors.UpgradeRequired(self.base)
250
def fetch(self, from_branch, last_revision=None, pb=None):
251
"""Copy revisions from from_branch into this branch.
253
:param from_branch: Where to copy from.
254
:param last_revision: What revision to stop at (None for at the end
256
:param pb: An optional progress bar to use.
258
Returns the copied revision count and the failed revisions in a tuple:
261
if self.base == from_branch.base:
264
nested_pb = ui.ui_factory.nested_progress_bar()
269
from_branch.lock_read()
271
if last_revision is None:
272
pb.update('get source history')
273
last_revision = from_branch.last_revision()
274
last_revision = _mod_revision.ensure_null(last_revision)
275
return self.repository.fetch(from_branch.repository,
276
revision_id=last_revision,
279
if nested_pb is not None:
283
def get_bound_location(self):
284
"""Return the URL of the branch we are bound to.
286
Older format branches cannot bind, please be sure to use a metadir
291
def get_old_bound_location(self):
292
"""Return the URL of the branch we used to be bound to
294
raise errors.UpgradeRequired(self.base)
296
def get_commit_builder(self, parents, config=None, timestamp=None,
297
timezone=None, committer=None, revprops=None,
299
"""Obtain a CommitBuilder for this branch.
301
:param parents: Revision ids of the parents of the new revision.
302
:param config: Optional configuration to use.
303
:param timestamp: Optional timestamp recorded for commit.
304
:param timezone: Optional timezone for timestamp.
305
:param committer: Optional committer to set for commit.
306
:param revprops: Optional dictionary of revision properties.
307
:param revision_id: Optional revision id.
311
config = self.get_config()
313
return self.repository.get_commit_builder(self, parents, config,
314
timestamp, timezone, committer, revprops, revision_id)
316
def get_master_branch(self, possible_transports=None):
317
"""Return the branch we are bound to.
319
:return: Either a Branch, or None
323
def get_revision_delta(self, revno):
324
"""Return the delta for one revision.
326
The delta is relative to its mainline predecessor, or the
327
empty tree for revision 1.
329
rh = self.revision_history()
330
if not (1 <= revno <= len(rh)):
331
raise errors.InvalidRevisionNumber(revno)
332
return self.repository.get_revision_delta(rh[revno-1])
334
def get_stacked_on_url(self):
335
"""Get the URL this branch is stacked against.
337
:raises NotStacked: If the branch is not stacked.
338
:raises UnstackableBranchFormat: If the branch does not support
341
raise NotImplementedError(self.get_stacked_on_url)
343
def print_file(self, file, revision_id):
344
"""Print `file` to stdout."""
345
raise NotImplementedError(self.print_file)
347
def set_revision_history(self, rev_history):
348
raise NotImplementedError(self.set_revision_history)
350
def set_stacked_on_url(self, url):
351
"""Set the URL this branch is stacked against.
353
:raises UnstackableBranchFormat: If the branch does not support
355
:raises UnstackableRepositoryFormat: If the repository does not support
358
raise NotImplementedError(self.set_stacked_on_url)
360
def _cache_revision_history(self, rev_history):
361
"""Set the cached revision history to rev_history.
363
The revision_history method will use this cache to avoid regenerating
364
the revision history.
366
This API is semi-public; it only for use by subclasses, all other code
367
should consider it to be private.
369
self._revision_history_cache = rev_history
371
def _cache_revision_id_to_revno(self, revision_id_to_revno):
372
"""Set the cached revision_id => revno map to revision_id_to_revno.
374
This API is semi-public; it only for use by subclasses, all other code
375
should consider it to be private.
377
self._revision_id_to_revno_cache = revision_id_to_revno
379
def _clear_cached_state(self):
380
"""Clear any cached data on this branch, e.g. cached revision history.
382
This means the next call to revision_history will need to call
383
_gen_revision_history.
385
This API is semi-public; it only for use by subclasses, all other code
386
should consider it to be private.
388
self._revision_history_cache = None
389
self._revision_id_to_revno_cache = None
390
self._last_revision_info_cache = None
392
def _gen_revision_history(self):
393
"""Return sequence of revision hashes on to this branch.
395
Unlike revision_history, this method always regenerates or rereads the
396
revision history, i.e. it does not cache the result, so repeated calls
399
Concrete subclasses should override this instead of revision_history so
400
that subclasses do not need to deal with caching logic.
402
This API is semi-public; it only for use by subclasses, all other code
403
should consider it to be private.
405
raise NotImplementedError(self._gen_revision_history)
408
def revision_history(self):
409
"""Return sequence of revision ids on this branch.
411
This method will cache the revision history for as long as it is safe to
414
if 'evil' in debug.debug_flags:
415
mutter_callsite(3, "revision_history scales with history.")
416
if self._revision_history_cache is not None:
417
history = self._revision_history_cache
419
history = self._gen_revision_history()
420
self._cache_revision_history(history)
424
"""Return current revision number for this branch.
426
That is equivalent to the number of revisions committed to
429
return self.last_revision_info()[0]
432
"""Older format branches cannot bind or unbind."""
433
raise errors.UpgradeRequired(self.base)
435
def set_append_revisions_only(self, enabled):
436
"""Older format branches are never restricted to append-only"""
437
raise errors.UpgradeRequired(self.base)
439
def last_revision(self):
440
"""Return last revision id, or NULL_REVISION."""
441
return self.last_revision_info()[1]
444
def last_revision_info(self):
445
"""Return information about the last revision.
447
:return: A tuple (revno, revision_id).
449
if self._last_revision_info_cache is None:
450
self._last_revision_info_cache = self._last_revision_info()
451
return self._last_revision_info_cache
453
def _last_revision_info(self):
454
rh = self.revision_history()
457
return (revno, rh[-1])
459
return (0, _mod_revision.NULL_REVISION)
461
@deprecated_method(deprecated_in((1, 6, 0)))
462
def missing_revisions(self, other, stop_revision=None):
463
"""Return a list of new revisions that would perfectly fit.
465
If self and other have not diverged, return a list of the revisions
466
present in other, but missing from self.
468
self_history = self.revision_history()
469
self_len = len(self_history)
470
other_history = other.revision_history()
471
other_len = len(other_history)
472
common_index = min(self_len, other_len) -1
473
if common_index >= 0 and \
474
self_history[common_index] != other_history[common_index]:
475
raise errors.DivergedBranches(self, other)
477
if stop_revision is None:
478
stop_revision = other_len
480
if stop_revision > other_len:
481
raise errors.NoSuchRevision(self, stop_revision)
482
return other_history[self_len:stop_revision]
485
def update_revisions(self, other, stop_revision=None, overwrite=False,
487
"""Pull in new perfect-fit revisions.
489
:param other: Another Branch to pull from
490
:param stop_revision: Updated until the given revision
491
:param overwrite: Always set the branch pointer, rather than checking
492
to see if it is a proper descendant.
493
:param graph: A Graph object that can be used to query history
494
information. This can be None.
499
other_revno, other_last_revision = other.last_revision_info()
500
stop_revno = None # unknown
501
if stop_revision is None:
502
stop_revision = other_last_revision
503
if _mod_revision.is_null(stop_revision):
504
# if there are no commits, we're done.
506
stop_revno = other_revno
508
# what's the current last revision, before we fetch [and change it
510
last_rev = _mod_revision.ensure_null(self.last_revision())
511
# we fetch here so that we don't process data twice in the common
512
# case of having something to pull, and so that the check for
513
# already merged can operate on the just fetched graph, which will
514
# be cached in memory.
515
self.fetch(other, stop_revision)
516
# Check to see if one is an ancestor of the other
519
graph = self.repository.get_graph()
520
if self._check_if_descendant_or_diverged(
521
stop_revision, last_rev, graph, other):
522
# stop_revision is a descendant of last_rev, but we aren't
523
# overwriting, so we're done.
525
if stop_revno is None:
527
graph = self.repository.get_graph()
528
this_revno, this_last_revision = self.last_revision_info()
529
stop_revno = graph.find_distance_to_null(stop_revision,
530
[(other_last_revision, other_revno),
531
(this_last_revision, this_revno)])
532
self.set_last_revision_info(stop_revno, stop_revision)
538
def revision_id_to_revno(self, revision_id):
539
"""Given a revision id, return its revno"""
540
if _mod_revision.is_null(revision_id):
542
history = self.revision_history()
544
return history.index(revision_id) + 1
546
raise errors.NoSuchRevision(self, revision_id)
548
def get_rev_id(self, revno, history=None):
549
"""Find the revision id of the specified revno."""
551
return _mod_revision.NULL_REVISION
553
history = self.revision_history()
554
if revno <= 0 or revno > len(history):
555
raise errors.NoSuchRevision(self, revno)
556
return history[revno - 1]
558
def pull(self, source, overwrite=False, stop_revision=None,
559
possible_transports=None, _override_hook_target=None):
560
"""Mirror source into this branch.
562
This branch is considered to be 'local', having low latency.
564
:returns: PullResult instance
566
raise NotImplementedError(self.pull)
568
def push(self, target, overwrite=False, stop_revision=None):
569
"""Mirror this branch into target.
571
This branch is considered to be 'local', having low latency.
573
raise NotImplementedError(self.push)
575
def basis_tree(self):
576
"""Return `Tree` object for last revision."""
577
return self.repository.revision_tree(self.last_revision())
579
def rename_one(self, from_rel, to_rel):
582
This can change the directory or the filename or both.
584
raise NotImplementedError(self.rename_one)
586
def move(self, from_paths, to_name):
589
to_name must exist as a versioned directory.
591
If to_name exists and is a directory, the files are moved into
592
it, keeping their old names. If it is a directory,
594
Note that to_name is only the last component of the new name;
595
this doesn't change the directory.
597
This returns a list of (from_path, to_path) pairs for each
600
raise NotImplementedError(self.move)
602
def get_parent(self):
603
"""Return the parent location of the branch.
605
This is the default location for push/pull/missing. The usual
606
pattern is that the user can override it by specifying a
609
raise NotImplementedError(self.get_parent)
611
def _set_config_location(self, name, url, config=None,
612
make_relative=False):
614
config = self.get_config()
618
url = urlutils.relative_url(self.base, url)
619
config.set_user_option(name, url, warn_masked=True)
621
def _get_config_location(self, name, config=None):
623
config = self.get_config()
624
location = config.get_user_option(name)
629
def get_submit_branch(self):
630
"""Return the submit location of the branch.
632
This is the default location for bundle. The usual
633
pattern is that the user can override it by specifying a
636
return self.get_config().get_user_option('submit_branch')
638
def set_submit_branch(self, location):
639
"""Return the submit location of the branch.
641
This is the default location for bundle. The usual
642
pattern is that the user can override it by specifying a
645
self.get_config().set_user_option('submit_branch', location,
648
def get_public_branch(self):
649
"""Return the public location of the branch.
651
This is is used by merge directives.
653
return self._get_config_location('public_branch')
655
def set_public_branch(self, location):
656
"""Return the submit location of the branch.
658
This is the default location for bundle. The usual
659
pattern is that the user can override it by specifying a
662
self._set_config_location('public_branch', location)
664
def get_push_location(self):
665
"""Return the None or the location to push this branch to."""
666
push_loc = self.get_config().get_user_option('push_location')
669
def set_push_location(self, location):
670
"""Set a new push location for this branch."""
671
raise NotImplementedError(self.set_push_location)
673
def set_parent(self, url):
674
raise NotImplementedError(self.set_parent)
678
"""Synchronise this branch with the master branch if any.
680
:return: None or the last_revision pivoted out during the update.
684
def check_revno(self, revno):
686
Check whether a revno corresponds to any revision.
687
Zero (the NULL revision) is considered valid.
690
self.check_real_revno(revno)
692
def check_real_revno(self, revno):
694
Check whether a revno corresponds to a real revision.
695
Zero (the NULL revision) is considered invalid
697
if revno < 1 or revno > self.revno():
698
raise errors.InvalidRevisionNumber(revno)
701
def clone(self, to_bzrdir, revision_id=None):
702
"""Clone this branch into to_bzrdir preserving all semantic values.
704
revision_id: if not None, the revision history in the new branch will
705
be truncated to end with revision_id.
707
result = self._format.initialize(to_bzrdir)
708
self.copy_content_into(result, revision_id=revision_id)
712
def sprout(self, to_bzrdir, revision_id=None):
713
"""Create a new line of development from the branch, into to_bzrdir.
715
revision_id: if not None, the revision history in the new branch will
716
be truncated to end with revision_id.
718
result = self._format.initialize(to_bzrdir)
719
self.copy_content_into(result, revision_id=revision_id)
720
result.set_parent(self.bzrdir.root_transport.base)
723
def _synchronize_history(self, destination, revision_id):
724
"""Synchronize last revision and revision history between branches.
726
This version is most efficient when the destination is also a
727
BzrBranch5, but works for BzrBranch6 as long as the revision
728
history is the true lefthand parent history, and all of the revisions
729
are in the destination's repository. If not, set_revision_history
732
:param destination: The branch to copy the history into
733
:param revision_id: The revision-id to truncate history at. May
734
be None to copy complete history.
736
if revision_id == _mod_revision.NULL_REVISION:
738
new_history = self.revision_history()
739
if revision_id is not None and new_history != []:
741
new_history = new_history[:new_history.index(revision_id) + 1]
743
rev = self.repository.get_revision(revision_id)
744
new_history = rev.get_history(self.repository)[1:]
745
destination.set_revision_history(new_history)
748
def copy_content_into(self, destination, revision_id=None):
749
"""Copy the content of self into destination.
751
revision_id: if not None, the revision history in the new branch will
752
be truncated to end with revision_id.
754
self._synchronize_history(destination, revision_id)
756
parent = self.get_parent()
757
except errors.InaccessibleParent, e:
758
mutter('parent was not accessible to copy: %s', e)
761
destination.set_parent(parent)
762
self.tags.merge_to(destination.tags)
766
"""Check consistency of the branch.
768
In particular this checks that revisions given in the revision-history
769
do actually match up in the revision graph, and that they're all
770
present in the repository.
772
Callers will typically also want to check the repository.
774
:return: A BranchCheckResult.
776
mainline_parent_id = None
777
last_revno, last_revision_id = self.last_revision_info()
778
real_rev_history = list(self.repository.iter_reverse_revision_history(
780
real_rev_history.reverse()
781
if len(real_rev_history) != last_revno:
782
raise errors.BzrCheckError('revno does not match len(mainline)'
783
' %s != %s' % (last_revno, len(real_rev_history)))
784
# TODO: We should probably also check that real_rev_history actually
785
# matches self.revision_history()
786
for revision_id in real_rev_history:
788
revision = self.repository.get_revision(revision_id)
789
except errors.NoSuchRevision, e:
790
raise errors.BzrCheckError("mainline revision {%s} not in repository"
792
# In general the first entry on the revision history has no parents.
793
# But it's not illegal for it to have parents listed; this can happen
794
# in imports from Arch when the parents weren't reachable.
795
if mainline_parent_id is not None:
796
if mainline_parent_id not in revision.parent_ids:
797
raise errors.BzrCheckError("previous revision {%s} not listed among "
799
% (mainline_parent_id, revision_id))
800
mainline_parent_id = revision_id
801
return BranchCheckResult(self)
803
def _get_checkout_format(self):
804
"""Return the most suitable metadir for a checkout of this branch.
805
Weaves are used if this branch's repository uses weaves.
807
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
808
from bzrlib.repofmt import weaverepo
809
format = bzrdir.BzrDirMetaFormat1()
810
format.repository_format = weaverepo.RepositoryFormat7()
812
format = self.repository.bzrdir.checkout_metadir()
813
format.set_branch_format(self._format)
816
def create_checkout(self, to_location, revision_id=None,
817
lightweight=False, accelerator_tree=None,
819
"""Create a checkout of a branch.
821
:param to_location: The url to produce the checkout at
822
:param revision_id: The revision to check out
823
:param lightweight: If True, produce a lightweight checkout, otherwise,
824
produce a bound branch (heavyweight checkout)
825
:param accelerator_tree: A tree which can be used for retrieving file
826
contents more quickly than the revision tree, i.e. a workingtree.
827
The revision tree will be used for cases where accelerator_tree's
828
content is different.
829
:param hardlink: If true, hard-link files from accelerator_tree,
831
:return: The tree of the created checkout
833
t = transport.get_transport(to_location)
836
format = self._get_checkout_format()
837
checkout = format.initialize_on_transport(t)
838
from_branch = BranchReferenceFormat().initialize(checkout, self)
840
format = self._get_checkout_format()
841
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
842
to_location, force_new_tree=False, format=format)
843
checkout = checkout_branch.bzrdir
844
checkout_branch.bind(self)
845
# pull up to the specified revision_id to set the initial
846
# branch tip correctly, and seed it with history.
847
checkout_branch.pull(self, stop_revision=revision_id)
849
tree = checkout.create_workingtree(revision_id,
850
from_branch=from_branch,
851
accelerator_tree=accelerator_tree,
853
basis_tree = tree.basis_tree()
854
basis_tree.lock_read()
856
for path, file_id in basis_tree.iter_references():
857
reference_parent = self.reference_parent(file_id, path)
858
reference_parent.create_checkout(tree.abspath(path),
859
basis_tree.get_reference_revision(file_id, path),
866
def reconcile(self, thorough=True):
867
"""Make sure the data stored in this branch is consistent."""
868
from bzrlib.reconcile import BranchReconciler
869
reconciler = BranchReconciler(self, thorough=thorough)
870
reconciler.reconcile()
873
def reference_parent(self, file_id, path):
874
"""Return the parent branch for a tree-reference file_id
875
:param file_id: The file_id of the tree reference
876
:param path: The path of the file_id in the tree
877
:return: A branch associated with the file_id
879
# FIXME should provide multiple branches, based on config
880
return Branch.open(self.bzrdir.root_transport.clone(path).base)
882
def supports_tags(self):
883
return self._format.supports_tags()
885
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
887
"""Ensure that revision_b is a descendant of revision_a.
889
This is a helper function for update_revisions.
891
:raises: DivergedBranches if revision_b has diverged from revision_a.
892
:returns: True if revision_b is a descendant of revision_a.
894
relation = self._revision_relations(revision_a, revision_b, graph)
895
if relation == 'b_descends_from_a':
897
elif relation == 'diverged':
898
raise errors.DivergedBranches(self, other_branch)
899
elif relation == 'a_descends_from_b':
902
raise AssertionError("invalid heads: %r" % heads)
904
def _revision_relations(self, revision_a, revision_b, graph):
905
"""Determine the relationship between two revisions.
907
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
909
heads = graph.heads([revision_a, revision_b])
910
if heads == set([revision_b]):
911
return 'b_descends_from_a'
912
elif heads == set([revision_a, revision_b]):
913
# These branches have diverged
915
elif heads == set([revision_a]):
916
return 'a_descends_from_b'
918
raise AssertionError("invalid heads: %r" % heads)
921
class BranchFormat(object):
922
"""An encapsulation of the initialization and open routines for a format.
924
Formats provide three things:
925
* An initialization routine,
929
Formats are placed in an dict by their format string for reference
930
during branch opening. Its not required that these be instances, they
931
can be classes themselves with class methods - it simply depends on
932
whether state is needed for a given format or not.
934
Once a format is deprecated, just deprecate the initialize and open
935
methods on the format class. Do not deprecate the object, as the
936
object will be created every time regardless.
939
_default_format = None
940
"""The default format used for new branches."""
943
"""The known formats."""
945
def __eq__(self, other):
946
return self.__class__ is other.__class__
948
def __ne__(self, other):
949
return not (self == other)
952
def find_format(klass, a_bzrdir):
953
"""Return the format for the branch object in a_bzrdir."""
955
transport = a_bzrdir.get_branch_transport(None)
956
format_string = transport.get("format").read()
957
return klass._formats[format_string]
958
except errors.NoSuchFile:
959
raise errors.NotBranchError(path=transport.base)
961
raise errors.UnknownFormatError(format=format_string, kind='branch')
964
def get_default_format(klass):
965
"""Return the current default format."""
966
return klass._default_format
968
def get_reference(self, a_bzrdir):
969
"""Get the target reference of the branch in a_bzrdir.
971
format probing must have been completed before calling
972
this method - it is assumed that the format of the branch
973
in a_bzrdir is correct.
975
:param a_bzrdir: The bzrdir to get the branch data from.
976
:return: None if the branch is not a reference branch.
981
def set_reference(self, a_bzrdir, to_branch):
982
"""Set the target reference of the branch in a_bzrdir.
984
format probing must have been completed before calling
985
this method - it is assumed that the format of the branch
986
in a_bzrdir is correct.
988
:param a_bzrdir: The bzrdir to set the branch reference for.
989
:param to_branch: branch that the checkout is to reference
991
raise NotImplementedError(self.set_reference)
993
def get_format_string(self):
994
"""Return the ASCII format string that identifies this format."""
995
raise NotImplementedError(self.get_format_string)
997
def get_format_description(self):
998
"""Return the short format description for this format."""
999
raise NotImplementedError(self.get_format_description)
1001
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
1003
"""Initialize a branch in a bzrdir, with specified files
1005
:param a_bzrdir: The bzrdir to initialize the branch in
1006
:param utf8_files: The files to create as a list of
1007
(filename, content) tuples
1008
:param set_format: If True, set the format with
1009
self.get_format_string. (BzrBranch4 has its format set
1011
:return: a branch in this format
1013
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1014
branch_transport = a_bzrdir.get_branch_transport(self)
1016
'metadir': ('lock', lockdir.LockDir),
1017
'branch4': ('branch-lock', lockable_files.TransportLock),
1019
lock_name, lock_class = lock_map[lock_type]
1020
control_files = lockable_files.LockableFiles(branch_transport,
1021
lock_name, lock_class)
1022
control_files.create_lock()
1023
control_files.lock_write()
1025
utf8_files += [('format', self.get_format_string())]
1027
for (filename, content) in utf8_files:
1028
branch_transport.put_bytes(
1030
mode=a_bzrdir._get_file_mode())
1032
control_files.unlock()
1033
return self.open(a_bzrdir, _found=True)
1035
def initialize(self, a_bzrdir):
1036
"""Create a branch of this format in a_bzrdir."""
1037
raise NotImplementedError(self.initialize)
1039
def is_supported(self):
1040
"""Is this format supported?
1042
Supported formats can be initialized and opened.
1043
Unsupported formats may not support initialization or committing or
1044
some other features depending on the reason for not being supported.
1048
def open(self, a_bzrdir, _found=False):
1049
"""Return the branch object for a_bzrdir
1051
_found is a private parameter, do not use it. It is used to indicate
1052
if format probing has already be done.
1054
raise NotImplementedError(self.open)
1057
def register_format(klass, format):
1058
klass._formats[format.get_format_string()] = format
1061
def set_default_format(klass, format):
1062
klass._default_format = format
1064
def supports_stacking(self):
1065
"""True if this format records a stacked-on branch."""
1069
def unregister_format(klass, format):
1070
del klass._formats[format.get_format_string()]
1073
return self.get_format_string().rstrip()
1075
def supports_tags(self):
1076
"""True if this format supports tags stored in the branch"""
1077
return False # by default
1080
class BranchHooks(Hooks):
1081
"""A dictionary mapping hook name to a list of callables for branch hooks.
1083
e.g. ['set_rh'] Is the list of items to be called when the
1084
set_revision_history function is invoked.
1088
"""Create the default hooks.
1090
These are all empty initially, because by default nothing should get
1093
Hooks.__init__(self)
1094
# Introduced in 0.15:
1095
# invoked whenever the revision history has been set
1096
# with set_revision_history. The api signature is
1097
# (branch, revision_history), and the branch will
1100
# invoked after a push operation completes.
1101
# the api signature is
1103
# containing the members
1104
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1105
# where local is the local target branch or None, master is the target
1106
# master branch, and the rest should be self explanatory. The source
1107
# is read locked and the target branches write locked. Source will
1108
# be the local low-latency branch.
1109
self['post_push'] = []
1110
# invoked after a pull operation completes.
1111
# the api signature is
1113
# containing the members
1114
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1115
# where local is the local branch or None, master is the target
1116
# master branch, and the rest should be self explanatory. The source
1117
# is read locked and the target branches write locked. The local
1118
# branch is the low-latency branch.
1119
self['post_pull'] = []
1120
# invoked before a commit operation takes place.
1121
# the api signature is
1122
# (local, master, old_revno, old_revid, future_revno, future_revid,
1123
# tree_delta, future_tree).
1124
# old_revid is NULL_REVISION for the first commit to a branch
1125
# tree_delta is a TreeDelta object describing changes from the basis
1126
# revision, hooks MUST NOT modify this delta
1127
# future_tree is an in-memory tree obtained from
1128
# CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
1129
self['pre_commit'] = []
1130
# invoked after a commit operation completes.
1131
# the api signature is
1132
# (local, master, old_revno, old_revid, new_revno, new_revid)
1133
# old_revid is NULL_REVISION for the first commit to a branch.
1134
self['post_commit'] = []
1135
# invoked after a uncommit operation completes.
1136
# the api signature is
1137
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1138
# local is the local branch or None, master is the target branch,
1139
# and an empty branch recieves new_revno of 0, new_revid of None.
1140
self['post_uncommit'] = []
1142
# Invoked before the tip of a branch changes.
1143
# the api signature is
1144
# (params) where params is a ChangeBranchTipParams with the members
1145
# (branch, old_revno, new_revno, old_revid, new_revid)
1146
self['pre_change_branch_tip'] = []
1148
# Invoked after the tip of a branch changes.
1149
# the api signature is
1150
# (params) where params is a ChangeBranchTipParams with the members
1151
# (branch, old_revno, new_revno, old_revid, new_revid)
1152
self['post_change_branch_tip'] = []
1155
# install the default hooks into the Branch class.
1156
Branch.hooks = BranchHooks()
1159
class ChangeBranchTipParams(object):
1160
"""Object holding parameters passed to *_change_branch_tip hooks.
1162
There are 5 fields that hooks may wish to access:
1164
:ivar branch: the branch being changed
1165
:ivar old_revno: revision number before the change
1166
:ivar new_revno: revision number after the change
1167
:ivar old_revid: revision id before the change
1168
:ivar new_revid: revision id after the change
1170
The revid fields are strings. The revno fields are integers.
1173
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1174
"""Create a group of ChangeBranchTip parameters.
1176
:param branch: The branch being changed.
1177
:param old_revno: Revision number before the change.
1178
:param new_revno: Revision number after the change.
1179
:param old_revid: Tip revision id before the change.
1180
:param new_revid: Tip revision id after the change.
1182
self.branch = branch
1183
self.old_revno = old_revno
1184
self.new_revno = new_revno
1185
self.old_revid = old_revid
1186
self.new_revid = new_revid
1188
def __eq__(self, other):
1189
return self.__dict__ == other.__dict__
1192
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1193
self.__class__.__name__, self.branch,
1194
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1197
class BzrBranchFormat4(BranchFormat):
1198
"""Bzr branch format 4.
1201
- a revision-history file.
1202
- a branch-lock lock file [ to be shared with the bzrdir ]
1205
def get_format_description(self):
1206
"""See BranchFormat.get_format_description()."""
1207
return "Branch format 4"
1209
def initialize(self, a_bzrdir):
1210
"""Create a branch of this format in a_bzrdir."""
1211
utf8_files = [('revision-history', ''),
1212
('branch-name', ''),
1214
return self._initialize_helper(a_bzrdir, utf8_files,
1215
lock_type='branch4', set_format=False)
1218
super(BzrBranchFormat4, self).__init__()
1219
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1221
def open(self, a_bzrdir, _found=False):
1222
"""Return the branch object for a_bzrdir
1224
_found is a private parameter, do not use it. It is used to indicate
1225
if format probing has already be done.
1228
# we are being called directly and must probe.
1229
raise NotImplementedError
1230
return BzrBranch(_format=self,
1231
_control_files=a_bzrdir._control_files,
1233
_repository=a_bzrdir.open_repository())
1236
return "Bazaar-NG branch format 4"
1239
class BranchFormatMetadir(BranchFormat):
1240
"""Common logic for meta-dir based branch formats."""
1242
def _branch_class(self):
1243
"""What class to instantiate on open calls."""
1244
raise NotImplementedError(self._branch_class)
1246
def open(self, a_bzrdir, _found=False):
1247
"""Return the branch object for a_bzrdir.
1249
_found is a private parameter, do not use it. It is used to indicate
1250
if format probing has already be done.
1253
format = BranchFormat.find_format(a_bzrdir)
1254
if format.__class__ != self.__class__:
1255
raise AssertionError("wrong format %r found for %r" %
1258
transport = a_bzrdir.get_branch_transport(None)
1259
control_files = lockable_files.LockableFiles(transport, 'lock',
1261
return self._branch_class()(_format=self,
1262
_control_files=control_files,
1264
_repository=a_bzrdir.find_repository())
1265
except errors.NoSuchFile:
1266
raise errors.NotBranchError(path=transport.base)
1269
super(BranchFormatMetadir, self).__init__()
1270
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1272
def supports_tags(self):
1276
class BzrBranchFormat5(BranchFormatMetadir):
1277
"""Bzr branch format 5.
1280
- a revision-history file.
1282
- a lock dir guarding the branch itself
1283
- all of this stored in a branch/ subdirectory
1284
- works with shared repositories.
1286
This format is new in bzr 0.8.
1289
def _branch_class(self):
1292
def get_format_string(self):
1293
"""See BranchFormat.get_format_string()."""
1294
return "Bazaar-NG branch format 5\n"
1296
def get_format_description(self):
1297
"""See BranchFormat.get_format_description()."""
1298
return "Branch format 5"
1300
def initialize(self, a_bzrdir):
1301
"""Create a branch of this format in a_bzrdir."""
1302
utf8_files = [('revision-history', ''),
1303
('branch-name', ''),
1305
return self._initialize_helper(a_bzrdir, utf8_files)
1307
def supports_tags(self):
1311
class BzrBranchFormat6(BranchFormatMetadir):
1312
"""Branch format with last-revision and tags.
1314
Unlike previous formats, this has no explicit revision history. Instead,
1315
this just stores the last-revision, and the left-hand history leading
1316
up to there is the history.
1318
This format was introduced in bzr 0.15
1319
and became the default in 0.91.
1322
def _branch_class(self):
1325
def get_format_string(self):
1326
"""See BranchFormat.get_format_string()."""
1327
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1329
def get_format_description(self):
1330
"""See BranchFormat.get_format_description()."""
1331
return "Branch format 6"
1333
def initialize(self, a_bzrdir):
1334
"""Create a branch of this format in a_bzrdir."""
1335
utf8_files = [('last-revision', '0 null:\n'),
1336
('branch.conf', ''),
1339
return self._initialize_helper(a_bzrdir, utf8_files)
1342
class BzrBranchFormat7(BranchFormatMetadir):
1343
"""Branch format with last-revision, tags, and a stacked location pointer.
1345
The stacked location pointer is passed down to the repository and requires
1346
a repository format with supports_external_lookups = True.
1348
This format was introduced in bzr 1.6.
1351
def _branch_class(self):
1354
def get_format_string(self):
1355
"""See BranchFormat.get_format_string()."""
1356
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
1358
def get_format_description(self):
1359
"""See BranchFormat.get_format_description()."""
1360
return "Branch format 7"
1362
def initialize(self, a_bzrdir):
1363
"""Create a branch of this format in a_bzrdir."""
1364
utf8_files = [('last-revision', '0 null:\n'),
1365
('branch.conf', ''),
1368
return self._initialize_helper(a_bzrdir, utf8_files)
1371
super(BzrBranchFormat7, self).__init__()
1372
self._matchingbzrdir.repository_format = \
1373
RepositoryFormatPackDevelopment1Subtree()
1375
def supports_stacking(self):
1379
class BranchReferenceFormat(BranchFormat):
1380
"""Bzr branch reference format.
1382
Branch references are used in implementing checkouts, they
1383
act as an alias to the real branch which is at some other url.
1390
def get_format_string(self):
1391
"""See BranchFormat.get_format_string()."""
1392
return "Bazaar-NG Branch Reference Format 1\n"
1394
def get_format_description(self):
1395
"""See BranchFormat.get_format_description()."""
1396
return "Checkout reference format 1"
1398
def get_reference(self, a_bzrdir):
1399
"""See BranchFormat.get_reference()."""
1400
transport = a_bzrdir.get_branch_transport(None)
1401
return transport.get('location').read()
1403
def set_reference(self, a_bzrdir, to_branch):
1404
"""See BranchFormat.set_reference()."""
1405
transport = a_bzrdir.get_branch_transport(None)
1406
location = transport.put_bytes('location', to_branch.base)
1408
def initialize(self, a_bzrdir, target_branch=None):
1409
"""Create a branch of this format in a_bzrdir."""
1410
if target_branch is None:
1411
# this format does not implement branch itself, thus the implicit
1412
# creation contract must see it as uninitializable
1413
raise errors.UninitializableFormat(self)
1414
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1415
branch_transport = a_bzrdir.get_branch_transport(self)
1416
branch_transport.put_bytes('location',
1417
target_branch.bzrdir.root_transport.base)
1418
branch_transport.put_bytes('format', self.get_format_string())
1420
a_bzrdir, _found=True,
1421
possible_transports=[target_branch.bzrdir.root_transport])
1424
super(BranchReferenceFormat, self).__init__()
1425
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1427
def _make_reference_clone_function(format, a_branch):
1428
"""Create a clone() routine for a branch dynamically."""
1429
def clone(to_bzrdir, revision_id=None):
1430
"""See Branch.clone()."""
1431
return format.initialize(to_bzrdir, a_branch)
1432
# cannot obey revision_id limits when cloning a reference ...
1433
# FIXME RBC 20060210 either nuke revision_id for clone, or
1434
# emit some sort of warning/error to the caller ?!
1437
def open(self, a_bzrdir, _found=False, location=None,
1438
possible_transports=None):
1439
"""Return the branch that the branch reference in a_bzrdir points at.
1441
_found is a private parameter, do not use it. It is used to indicate
1442
if format probing has already be done.
1445
format = BranchFormat.find_format(a_bzrdir)
1446
if format.__class__ != self.__class__:
1447
raise AssertionError("wrong format %r found for %r" %
1449
if location is None:
1450
location = self.get_reference(a_bzrdir)
1451
real_bzrdir = bzrdir.BzrDir.open(
1452
location, possible_transports=possible_transports)
1453
result = real_bzrdir.open_branch()
1454
# this changes the behaviour of result.clone to create a new reference
1455
# rather than a copy of the content of the branch.
1456
# I did not use a proxy object because that needs much more extensive
1457
# testing, and we are only changing one behaviour at the moment.
1458
# If we decide to alter more behaviours - i.e. the implicit nickname
1459
# then this should be refactored to introduce a tested proxy branch
1460
# and a subclass of that for use in overriding clone() and ....
1462
result.clone = self._make_reference_clone_function(result)
1466
# formats which have no format string are not discoverable
1467
# and not independently creatable, so are not registered.
1468
__format5 = BzrBranchFormat5()
1469
__format6 = BzrBranchFormat6()
1470
__format7 = BzrBranchFormat7()
1471
BranchFormat.register_format(__format5)
1472
BranchFormat.register_format(BranchReferenceFormat())
1473
BranchFormat.register_format(__format6)
1474
BranchFormat.register_format(__format7)
1475
BranchFormat.set_default_format(__format6)
1476
_legacy_formats = [BzrBranchFormat4(),
1479
class BzrBranch(Branch):
1480
"""A branch stored in the actual filesystem.
1482
Note that it's "local" in the context of the filesystem; it doesn't
1483
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1484
it's writable, and can be accessed via the normal filesystem API.
1486
:ivar _transport: Transport for file operations on this branch's
1487
control files, typically pointing to the .bzr/branch directory.
1488
:ivar repository: Repository for this branch.
1489
:ivar base: The url of the base directory for this branch; the one
1490
containing the .bzr directory.
1493
def __init__(self, _format=None,
1494
_control_files=None, a_bzrdir=None, _repository=None):
1495
"""Create new branch object at a particular location."""
1496
if a_bzrdir is None:
1497
raise ValueError('a_bzrdir must be supplied')
1499
self.bzrdir = a_bzrdir
1500
self._base = self.bzrdir.transport.clone('..').base
1501
# XXX: We should be able to just do
1502
# self.base = self.bzrdir.root_transport.base
1503
# but this does not quite work yet -- mbp 20080522
1504
self._format = _format
1505
if _control_files is None:
1506
raise ValueError('BzrBranch _control_files is None')
1507
self.control_files = _control_files
1508
self._transport = _control_files._transport
1509
self.repository = _repository
1510
Branch.__init__(self)
1513
return '%s(%r)' % (self.__class__.__name__, self.base)
1517
def _get_base(self):
1518
"""Returns the directory containing the control directory."""
1521
base = property(_get_base, doc="The URL for the root of this branch.")
1523
@deprecated_method(deprecated_in((0, 16, 0)))
1524
def abspath(self, name):
1525
"""See Branch.abspath."""
1526
return self._transport.abspath(name)
1528
def is_locked(self):
1529
return self.control_files.is_locked()
1531
def lock_write(self, token=None):
1532
repo_token = self.repository.lock_write()
1534
token = self.control_files.lock_write(token=token)
1536
self.repository.unlock()
1540
def lock_read(self):
1541
self.repository.lock_read()
1543
self.control_files.lock_read()
1545
self.repository.unlock()
1549
# TODO: test for failed two phase locks. This is known broken.
1551
self.control_files.unlock()
1553
self.repository.unlock()
1554
if not self.control_files.is_locked():
1555
# we just released the lock
1556
self._clear_cached_state()
1558
def peek_lock_mode(self):
1559
if self.control_files._lock_count == 0:
1562
return self.control_files._lock_mode
1564
def get_physical_lock_status(self):
1565
return self.control_files.get_physical_lock_status()
1568
def print_file(self, file, revision_id):
1569
"""See Branch.print_file."""
1570
return self.repository.print_file(file, revision_id)
1572
def _write_revision_history(self, history):
1573
"""Factored out of set_revision_history.
1575
This performs the actual writing to disk.
1576
It is intended to be called by BzrBranch5.set_revision_history."""
1577
self._transport.put_bytes(
1578
'revision-history', '\n'.join(history),
1579
mode=self.bzrdir._get_file_mode())
1582
def set_revision_history(self, rev_history):
1583
"""See Branch.set_revision_history."""
1584
if 'evil' in debug.debug_flags:
1585
mutter_callsite(3, "set_revision_history scales with history.")
1586
check_not_reserved_id = _mod_revision.check_not_reserved_id
1587
for rev_id in rev_history:
1588
check_not_reserved_id(rev_id)
1589
self._write_revision_history(rev_history)
1590
self._clear_cached_state()
1591
self._cache_revision_history(rev_history)
1592
for hook in Branch.hooks['set_rh']:
1593
hook(self, rev_history)
1595
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
1596
"""Run the pre_change_branch_tip hooks."""
1597
hooks = Branch.hooks['pre_change_branch_tip']
1600
old_revno, old_revid = self.last_revision_info()
1601
params = ChangeBranchTipParams(
1602
self, old_revno, new_revno, old_revid, new_revid)
1606
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1607
"""Run the post_change_branch_tip hooks."""
1608
hooks = Branch.hooks['post_change_branch_tip']
1611
new_revno, new_revid = self.last_revision_info()
1612
params = ChangeBranchTipParams(
1613
self, old_revno, new_revno, old_revid, new_revid)
1618
def set_last_revision_info(self, revno, revision_id):
1619
"""Set the last revision of this branch.
1621
The caller is responsible for checking that the revno is correct
1622
for this revision id.
1624
It may be possible to set the branch last revision to an id not
1625
present in the repository. However, branches can also be
1626
configured to check constraints on history, in which case this may not
1629
revision_id = _mod_revision.ensure_null(revision_id)
1630
old_revno, old_revid = self.last_revision_info()
1631
# this old format stores the full history, but this api doesn't
1632
# provide it, so we must generate, and might as well check it's
1634
history = self._lefthand_history(revision_id)
1635
if len(history) != revno:
1636
raise AssertionError('%d != %d' % (len(history), revno))
1637
self._run_pre_change_branch_tip_hooks(revno, revision_id)
1638
self.set_revision_history(history)
1639
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1641
def _gen_revision_history(self):
1642
history = self._transport.get_bytes('revision-history').split('\n')
1643
if history[-1:] == ['']:
1644
# There shouldn't be a trailing newline, but just in case.
1648
def _lefthand_history(self, revision_id, last_rev=None,
1650
if 'evil' in debug.debug_flags:
1651
mutter_callsite(4, "_lefthand_history scales with history.")
1652
# stop_revision must be a descendant of last_revision
1653
graph = self.repository.get_graph()
1654
if last_rev is not None:
1655
if not graph.is_ancestor(last_rev, revision_id):
1656
# our previous tip is not merged into stop_revision
1657
raise errors.DivergedBranches(self, other_branch)
1658
# make a new revision history from the graph
1659
parents_map = graph.get_parent_map([revision_id])
1660
if revision_id not in parents_map:
1661
raise errors.NoSuchRevision(self, revision_id)
1662
current_rev_id = revision_id
1664
check_not_reserved_id = _mod_revision.check_not_reserved_id
1665
# Do not include ghosts or graph origin in revision_history
1666
while (current_rev_id in parents_map and
1667
len(parents_map[current_rev_id]) > 0):
1668
check_not_reserved_id(current_rev_id)
1669
new_history.append(current_rev_id)
1670
current_rev_id = parents_map[current_rev_id][0]
1671
parents_map = graph.get_parent_map([current_rev_id])
1672
new_history.reverse()
1676
def generate_revision_history(self, revision_id, last_rev=None,
1678
"""Create a new revision history that will finish with revision_id.
1680
:param revision_id: the new tip to use.
1681
:param last_rev: The previous last_revision. If not None, then this
1682
must be a ancestory of revision_id, or DivergedBranches is raised.
1683
:param other_branch: The other branch that DivergedBranches should
1684
raise with respect to.
1686
self.set_revision_history(self._lefthand_history(revision_id,
1687
last_rev, other_branch))
1689
def basis_tree(self):
1690
"""See Branch.basis_tree."""
1691
return self.repository.revision_tree(self.last_revision())
1694
def pull(self, source, overwrite=False, stop_revision=None,
1695
_hook_master=None, run_hooks=True, possible_transports=None,
1696
_override_hook_target=None):
1699
:param _hook_master: Private parameter - set the branch to
1700
be supplied as the master to pull hooks.
1701
:param run_hooks: Private parameter - if false, this branch
1702
is being called because it's the master of the primary branch,
1703
so it should not run its hooks.
1704
:param _override_hook_target: Private parameter - set the branch to be
1705
supplied as the target_branch to pull hooks.
1707
result = PullResult()
1708
result.source_branch = source
1709
if _override_hook_target is None:
1710
result.target_branch = self
1712
result.target_branch = _override_hook_target
1715
# We assume that during 'pull' the local repository is closer than
1717
graph = self.repository.get_graph(source.repository)
1718
result.old_revno, result.old_revid = self.last_revision_info()
1719
self.update_revisions(source, stop_revision, overwrite=overwrite,
1721
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
1722
result.new_revno, result.new_revid = self.last_revision_info()
1724
result.master_branch = _hook_master
1725
result.local_branch = result.target_branch
1727
result.master_branch = result.target_branch
1728
result.local_branch = None
1730
for hook in Branch.hooks['post_pull']:
1736
def _get_parent_location(self):
1737
_locs = ['parent', 'pull', 'x-pull']
1740
return self._transport.get_bytes(l).strip('\n')
1741
except errors.NoSuchFile:
1746
def push(self, target, overwrite=False, stop_revision=None,
1747
_override_hook_source_branch=None):
1750
This is the basic concrete implementation of push()
1752
:param _override_hook_source_branch: If specified, run
1753
the hooks passing this Branch as the source, rather than self.
1754
This is for use of RemoteBranch, where push is delegated to the
1755
underlying vfs-based Branch.
1757
# TODO: Public option to disable running hooks - should be trivial but
1761
result = self._push_with_bound_branches(target, overwrite,
1763
_override_hook_source_branch=_override_hook_source_branch)
1768
def _push_with_bound_branches(self, target, overwrite,
1770
_override_hook_source_branch=None):
1771
"""Push from self into target, and into target's master if any.
1773
This is on the base BzrBranch class even though it doesn't support
1774
bound branches because the *target* might be bound.
1777
if _override_hook_source_branch:
1778
result.source_branch = _override_hook_source_branch
1779
for hook in Branch.hooks['post_push']:
1782
bound_location = target.get_bound_location()
1783
if bound_location and target.base != bound_location:
1784
# there is a master branch.
1786
# XXX: Why the second check? Is it even supported for a branch to
1787
# be bound to itself? -- mbp 20070507
1788
master_branch = target.get_master_branch()
1789
master_branch.lock_write()
1791
# push into the master from this branch.
1792
self._basic_push(master_branch, overwrite, stop_revision)
1793
# and push into the target branch from this. Note that we push from
1794
# this branch again, because its considered the highest bandwidth
1796
result = self._basic_push(target, overwrite, stop_revision)
1797
result.master_branch = master_branch
1798
result.local_branch = target
1802
master_branch.unlock()
1805
result = self._basic_push(target, overwrite, stop_revision)
1806
# TODO: Why set master_branch and local_branch if there's no
1807
# binding? Maybe cleaner to just leave them unset? -- mbp
1809
result.master_branch = target
1810
result.local_branch = None
1814
def _basic_push(self, target, overwrite, stop_revision):
1815
"""Basic implementation of push without bound branches or hooks.
1817
Must be called with self read locked and target write locked.
1819
result = PushResult()
1820
result.source_branch = self
1821
result.target_branch = target
1822
result.old_revno, result.old_revid = target.last_revision_info()
1824
# We assume that during 'push' this repository is closer than
1826
graph = self.repository.get_graph(target.repository)
1827
target.update_revisions(self, stop_revision, overwrite=overwrite,
1829
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
1830
result.new_revno, result.new_revid = target.last_revision_info()
1833
def get_parent(self):
1834
"""See Branch.get_parent."""
1835
parent = self._get_parent_location()
1838
# This is an old-format absolute path to a local branch
1839
# turn it into a url
1840
if parent.startswith('/'):
1841
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1843
return urlutils.join(self.base[:-1], parent)
1844
except errors.InvalidURLJoin, e:
1845
raise errors.InaccessibleParent(parent, self.base)
1847
def get_stacked_on_url(self):
1848
raise errors.UnstackableBranchFormat(self._format, self.base)
1850
def set_push_location(self, location):
1851
"""See Branch.set_push_location."""
1852
self.get_config().set_user_option(
1853
'push_location', location,
1854
store=_mod_config.STORE_LOCATION_NORECURSE)
1857
def set_parent(self, url):
1858
"""See Branch.set_parent."""
1859
# TODO: Maybe delete old location files?
1860
# URLs should never be unicode, even on the local fs,
1861
# FIXUP this and get_parent in a future branch format bump:
1862
# read and rewrite the file. RBC 20060125
1864
if isinstance(url, unicode):
1866
url = url.encode('ascii')
1867
except UnicodeEncodeError:
1868
raise errors.InvalidURL(url,
1869
"Urls must be 7-bit ascii, "
1870
"use bzrlib.urlutils.escape")
1871
url = urlutils.relative_url(self.base, url)
1872
self._set_parent_location(url)
1874
def _set_parent_location(self, url):
1876
self._transport.delete('parent')
1878
self._transport.put_bytes('parent', url + '\n',
1879
mode=self.bzrdir._get_file_mode())
1881
def set_stacked_on_url(self, url):
1882
raise errors.UnstackableBranchFormat(self._format, self.base)
1885
class BzrBranch5(BzrBranch):
1886
"""A format 5 branch. This supports new features over plain branches.
1888
It has support for a master_branch which is the data for bound branches.
1892
def pull(self, source, overwrite=False, stop_revision=None,
1893
run_hooks=True, possible_transports=None,
1894
_override_hook_target=None):
1895
"""Pull from source into self, updating my master if any.
1897
:param run_hooks: Private parameter - if false, this branch
1898
is being called because it's the master of the primary branch,
1899
so it should not run its hooks.
1901
bound_location = self.get_bound_location()
1902
master_branch = None
1903
if bound_location and source.base != bound_location:
1904
# not pulling from master, so we need to update master.
1905
master_branch = self.get_master_branch(possible_transports)
1906
master_branch.lock_write()
1909
# pull from source into master.
1910
master_branch.pull(source, overwrite, stop_revision,
1912
return super(BzrBranch5, self).pull(source, overwrite,
1913
stop_revision, _hook_master=master_branch,
1914
run_hooks=run_hooks,
1915
_override_hook_target=_override_hook_target)
1918
master_branch.unlock()
1920
def get_bound_location(self):
1922
return self._transport.get_bytes('bound')[:-1]
1923
except errors.NoSuchFile:
1927
def get_master_branch(self, possible_transports=None):
1928
"""Return the branch we are bound to.
1930
:return: Either a Branch, or None
1932
This could memoise the branch, but if thats done
1933
it must be revalidated on each new lock.
1934
So for now we just don't memoise it.
1935
# RBC 20060304 review this decision.
1937
bound_loc = self.get_bound_location()
1941
return Branch.open(bound_loc,
1942
possible_transports=possible_transports)
1943
except (errors.NotBranchError, errors.ConnectionError), e:
1944
raise errors.BoundBranchConnectionFailure(
1948
def set_bound_location(self, location):
1949
"""Set the target where this branch is bound to.
1951
:param location: URL to the target branch
1954
self._transport.put_bytes('bound', location+'\n',
1955
mode=self.bzrdir._get_file_mode())
1958
self._transport.delete('bound')
1959
except errors.NoSuchFile:
1964
def bind(self, other):
1965
"""Bind this branch to the branch other.
1967
This does not push or pull data between the branches, though it does
1968
check for divergence to raise an error when the branches are not
1969
either the same, or one a prefix of the other. That behaviour may not
1970
be useful, so that check may be removed in future.
1972
:param other: The branch to bind to
1975
# TODO: jam 20051230 Consider checking if the target is bound
1976
# It is debatable whether you should be able to bind to
1977
# a branch which is itself bound.
1978
# Committing is obviously forbidden,
1979
# but binding itself may not be.
1980
# Since we *have* to check at commit time, we don't
1981
# *need* to check here
1983
# we want to raise diverged if:
1984
# last_rev is not in the other_last_rev history, AND
1985
# other_last_rev is not in our history, and do it without pulling
1987
self.set_bound_location(other.base)
1991
"""If bound, unbind"""
1992
return self.set_bound_location(None)
1995
def update(self, possible_transports=None):
1996
"""Synchronise this branch with the master branch if any.
1998
:return: None or the last_revision that was pivoted out during the
2001
master = self.get_master_branch(possible_transports)
2002
if master is not None:
2003
old_tip = _mod_revision.ensure_null(self.last_revision())
2004
self.pull(master, overwrite=True)
2005
if self.repository.get_graph().is_ancestor(old_tip,
2006
_mod_revision.ensure_null(self.last_revision())):
2012
class BzrBranch7(BzrBranch5):
2013
"""A branch with support for a fallback repository."""
2015
def _get_fallback_repository(self, url):
2016
"""Get the repository we fallback to at url."""
2017
url = urlutils.join(self.base, url)
2018
return bzrdir.BzrDir.open(url).open_branch().repository
2020
def _activate_fallback_location(self, url):
2021
"""Activate the branch/repository from url as a fallback repository."""
2022
self.repository.add_fallback_repository(
2023
self._get_fallback_repository(url))
2025
def _open_hook(self):
2027
url = self.get_stacked_on_url()
2028
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2029
errors.UnstackableBranchFormat):
2032
self._activate_fallback_location(url)
2034
def _check_stackable_repo(self):
2035
if not self.repository._format.supports_external_lookups:
2036
raise errors.UnstackableRepositoryFormat(self.repository._format,
2037
self.repository.base)
2039
def __init__(self, *args, **kwargs):
2040
super(BzrBranch7, self).__init__(*args, **kwargs)
2041
self._last_revision_info_cache = None
2042
self._partial_revision_history_cache = []
2044
def _clear_cached_state(self):
2045
super(BzrBranch7, self)._clear_cached_state()
2046
self._last_revision_info_cache = None
2047
self._partial_revision_history_cache = []
2049
def _last_revision_info(self):
2050
revision_string = self._transport.get_bytes('last-revision')
2051
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2052
revision_id = cache_utf8.get_cached_utf8(revision_id)
2054
return revno, revision_id
2056
def _write_last_revision_info(self, revno, revision_id):
2057
"""Simply write out the revision id, with no checks.
2059
Use set_last_revision_info to perform this safely.
2061
Does not update the revision_history cache.
2062
Intended to be called by set_last_revision_info and
2063
_write_revision_history.
2065
revision_id = _mod_revision.ensure_null(revision_id)
2066
out_string = '%d %s\n' % (revno, revision_id)
2067
self._transport.put_bytes('last-revision', out_string,
2068
mode=self.bzrdir._get_file_mode())
2071
def set_last_revision_info(self, revno, revision_id):
2072
revision_id = _mod_revision.ensure_null(revision_id)
2073
old_revno, old_revid = self.last_revision_info()
2074
if self._get_append_revisions_only():
2075
self._check_history_violation(revision_id)
2076
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2077
self._write_last_revision_info(revno, revision_id)
2078
self._clear_cached_state()
2079
self._last_revision_info_cache = revno, revision_id
2080
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2082
def _check_history_violation(self, revision_id):
2083
last_revision = _mod_revision.ensure_null(self.last_revision())
2084
if _mod_revision.is_null(last_revision):
2086
if last_revision not in self._lefthand_history(revision_id):
2087
raise errors.AppendRevisionsOnlyViolation(self.base)
2089
def _gen_revision_history(self):
2090
"""Generate the revision history from last revision
2092
last_revno, last_revision = self.last_revision_info()
2093
self._extend_partial_history(stop_index=last_revno-1)
2094
return list(reversed(self._partial_revision_history_cache))
2096
def _extend_partial_history(self, stop_index=None, stop_revision=None):
2097
"""Extend the partial history to include a given index
2099
If a stop_index is supplied, stop when that index has been reached.
2100
If a stop_revision is supplied, stop when that revision is
2101
encountered. Otherwise, stop when the beginning of history is
2104
:param stop_index: The index which should be present. When it is
2105
present, history extension will stop.
2106
:param revision_id: The revision id which should be present. When
2107
it is encountered, history extension will stop.
2109
repo = self.repository
2110
if len(self._partial_revision_history_cache) == 0:
2111
iterator = repo.iter_reverse_revision_history(self.last_revision())
2113
start_revision = self._partial_revision_history_cache[-1]
2114
iterator = repo.iter_reverse_revision_history(start_revision)
2115
#skip the last revision in the list
2116
next_revision = iterator.next()
2117
for revision_id in iterator:
2118
self._partial_revision_history_cache.append(revision_id)
2119
if (stop_index is not None and
2120
len(self._partial_revision_history_cache) > stop_index):
2122
if revision_id == stop_revision:
2125
def _write_revision_history(self, history):
2126
"""Factored out of set_revision_history.
2128
This performs the actual writing to disk, with format-specific checks.
2129
It is intended to be called by BzrBranch5.set_revision_history.
2131
if len(history) == 0:
2132
last_revision = 'null:'
2134
if history != self._lefthand_history(history[-1]):
2135
raise errors.NotLefthandHistory(history)
2136
last_revision = history[-1]
2137
if self._get_append_revisions_only():
2138
self._check_history_violation(last_revision)
2139
self._write_last_revision_info(len(history), last_revision)
2142
def _set_parent_location(self, url):
2143
"""Set the parent branch"""
2144
self._set_config_location('parent_location', url, make_relative=True)
2147
def _get_parent_location(self):
2148
"""Set the parent branch"""
2149
return self._get_config_location('parent_location')
2151
def set_push_location(self, location):
2152
"""See Branch.set_push_location."""
2153
self._set_config_location('push_location', location)
2155
def set_bound_location(self, location):
2156
"""See Branch.set_push_location."""
2158
config = self.get_config()
2159
if location is None:
2160
if config.get_user_option('bound') != 'True':
2163
config.set_user_option('bound', 'False', warn_masked=True)
2166
self._set_config_location('bound_location', location,
2168
config.set_user_option('bound', 'True', warn_masked=True)
2171
def _get_bound_location(self, bound):
2172
"""Return the bound location in the config file.
2174
Return None if the bound parameter does not match"""
2175
config = self.get_config()
2176
config_bound = (config.get_user_option('bound') == 'True')
2177
if config_bound != bound:
2179
return self._get_config_location('bound_location', config=config)
2181
def get_bound_location(self):
2182
"""See Branch.set_push_location."""
2183
return self._get_bound_location(True)
2185
def get_old_bound_location(self):
2186
"""See Branch.get_old_bound_location"""
2187
return self._get_bound_location(False)
2189
def get_stacked_on_url(self):
2190
self._check_stackable_repo()
2191
stacked_url = self._get_config_location('stacked_on_location')
2192
if stacked_url is None:
2193
raise errors.NotStacked(self)
2196
def set_append_revisions_only(self, enabled):
2201
self.get_config().set_user_option('append_revisions_only', value,
2204
def set_stacked_on_url(self, url):
2205
self._check_stackable_repo()
2208
old_url = self.get_stacked_on_url()
2209
except (errors.NotStacked, errors.UnstackableBranchFormat,
2210
errors.UnstackableRepositoryFormat):
2213
# repositories don't offer an interface to remove fallback
2214
# repositories today; take the conceptually simpler option and just
2216
self.repository = self.bzrdir.find_repository()
2217
# for every revision reference the branch has, ensure it is pulled
2219
source_repository = self._get_fallback_repository(old_url)
2220
for revision_id in chain([self.last_revision()],
2221
self.tags.get_reverse_tag_dict()):
2222
self.repository.fetch(source_repository, revision_id,
2225
self._activate_fallback_location(url)
2226
# write this out after the repository is stacked to avoid setting a
2227
# stacked config that doesn't work.
2228
self._set_config_location('stacked_on_location', url)
2230
def _get_append_revisions_only(self):
2231
value = self.get_config().get_user_option('append_revisions_only')
2232
return value == 'True'
2234
def _synchronize_history(self, destination, revision_id):
2235
"""Synchronize last revision and revision history between branches.
2237
This version is most efficient when the destination is also a
2238
BzrBranch6, but works for BzrBranch5, as long as the destination's
2239
repository contains all the lefthand ancestors of the intended
2240
last_revision. If not, set_last_revision_info will fail.
2242
:param destination: The branch to copy the history into
2243
:param revision_id: The revision-id to truncate history at. May
2244
be None to copy complete history.
2246
source_revno, source_revision_id = self.last_revision_info()
2247
if revision_id is None:
2248
revno, revision_id = source_revno, source_revision_id
2249
elif source_revision_id == revision_id:
2250
# we know the revno without needing to walk all of history
2251
revno = source_revno
2253
# To figure out the revno for a random revision, we need to build
2254
# the revision history, and count its length.
2255
# We don't care about the order, just how long it is.
2256
# Alternatively, we could start at the current location, and count
2257
# backwards. But there is no guarantee that we will find it since
2258
# it may be a merged revision.
2259
revno = len(list(self.repository.iter_reverse_revision_history(
2261
destination.set_last_revision_info(revno, revision_id)
2263
def _make_tags(self):
2264
return BasicTags(self)
2267
def generate_revision_history(self, revision_id, last_rev=None,
2269
"""See BzrBranch5.generate_revision_history"""
2270
history = self._lefthand_history(revision_id, last_rev, other_branch)
2271
revno = len(history)
2272
self.set_last_revision_info(revno, revision_id)
2275
def get_rev_id(self, revno, history=None):
2276
"""Find the revision id of the specified revno."""
2278
return _mod_revision.NULL_REVISION
2280
last_revno, last_revision_id = self.last_revision_info()
2281
if revno <= 0 or revno > last_revno:
2282
raise errors.NoSuchRevision(self, revno)
2284
if history is not None:
2285
return history[revno - 1]
2287
index = last_revno - revno
2288
if len(self._partial_revision_history_cache) <= index:
2289
self._extend_partial_history(stop_index=index)
2290
if len(self._partial_revision_history_cache) > index:
2291
return self._partial_revision_history_cache[index]
2293
raise errors.NoSuchRevision(self, revno)
2296
def revision_id_to_revno(self, revision_id):
2297
"""Given a revision id, return its revno"""
2298
if _mod_revision.is_null(revision_id):
2301
index = self._partial_revision_history_cache.index(revision_id)
2303
self._extend_partial_history(stop_revision=revision_id)
2304
index = len(self._partial_revision_history_cache) - 1
2305
if self._partial_revision_history_cache[index] != revision_id:
2306
raise errors.NoSuchRevision(self, revision_id)
2307
return self.revno() - index
2310
class BzrBranch6(BzrBranch7):
2311
"""See BzrBranchFormat6 for the capabilities of this branch.
2313
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
2317
def get_stacked_on_url(self):
2318
raise errors.UnstackableBranchFormat(self._format, self.base)
2320
def set_stacked_on_url(self, url):
2321
raise errors.UnstackableBranchFormat(self._format, self.base)
2324
######################################################################
2325
# results of operations
2328
class _Result(object):
2330
def _show_tag_conficts(self, to_file):
2331
if not getattr(self, 'tag_conflicts', None):
2333
to_file.write('Conflicting tags:\n')
2334
for name, value1, value2 in self.tag_conflicts:
2335
to_file.write(' %s\n' % (name, ))
2338
class PullResult(_Result):
2339
"""Result of a Branch.pull operation.
2341
:ivar old_revno: Revision number before pull.
2342
:ivar new_revno: Revision number after pull.
2343
:ivar old_revid: Tip revision id before pull.
2344
:ivar new_revid: Tip revision id after pull.
2345
:ivar source_branch: Source (local) branch object.
2346
:ivar master_branch: Master branch of the target, or the target if no
2348
:ivar local_branch: target branch if there is a Master, else None
2349
:ivar target_branch: Target/destination branch object.
2350
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2354
# DEPRECATED: pull used to return the change in revno
2355
return self.new_revno - self.old_revno
2357
def report(self, to_file):
2359
if self.old_revid == self.new_revid:
2360
to_file.write('No revisions to pull.\n')
2362
to_file.write('Now on revision %d.\n' % self.new_revno)
2363
self._show_tag_conficts(to_file)
2366
class PushResult(_Result):
2367
"""Result of a Branch.push operation.
2369
:ivar old_revno: Revision number before push.
2370
:ivar new_revno: Revision number after push.
2371
:ivar old_revid: Tip revision id before push.
2372
:ivar new_revid: Tip revision id after push.
2373
:ivar source_branch: Source branch object.
2374
:ivar master_branch: Master branch of the target, or None.
2375
:ivar target_branch: Target/destination branch object.
2379
# DEPRECATED: push used to return the change in revno
2380
return self.new_revno - self.old_revno
2382
def report(self, to_file):
2383
"""Write a human-readable description of the result."""
2384
if self.old_revid == self.new_revid:
2385
to_file.write('No new revisions to push.\n')
2387
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2388
self._show_tag_conficts(to_file)
2391
class BranchCheckResult(object):
2392
"""Results of checking branch consistency.
2397
def __init__(self, branch):
2398
self.branch = branch
2400
def report_results(self, verbose):
2401
"""Report the check results via trace.note.
2403
:param verbose: Requests more detailed display of what was checked,
2406
note('checked branch %s format %s',
2408
self.branch._format)
2411
class Converter5to6(object):
2412
"""Perform an in-place upgrade of format 5 to format 6"""
2414
def convert(self, branch):
2415
# Data for 5 and 6 can peacefully coexist.
2416
format = BzrBranchFormat6()
2417
new_branch = format.open(branch.bzrdir, _found=True)
2419
# Copy source data into target
2420
new_branch._write_last_revision_info(*branch.last_revision_info())
2421
new_branch.set_parent(branch.get_parent())
2422
new_branch.set_bound_location(branch.get_bound_location())
2423
new_branch.set_push_location(branch.get_push_location())
2425
# New branch has no tags by default
2426
new_branch.tags._set_tag_dict({})
2428
# Copying done; now update target format
2429
new_branch._transport.put_bytes('format',
2430
format.get_format_string(),
2431
mode=new_branch.bzrdir._get_file_mode())
2433
# Clean up old files
2434
new_branch._transport.delete('revision-history')
2436
branch.set_parent(None)
2437
except errors.NoSuchFile:
2439
branch.set_bound_location(None)
2442
class Converter6to7(object):
2443
"""Perform an in-place upgrade of format 6 to format 7"""
2445
def convert(self, branch):
2446
format = BzrBranchFormat7()
2447
branch._set_config_location('stacked_on_location', '')
2448
# update target format
2449
branch._transport.put_bytes('format', format.get_format_string())
added
removed
bzrlib/branch.py
