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
1065
def unregister_format(klass, format):
1066
del klass._formats[format.get_format_string()]
1069
return self.get_format_string().rstrip()
1071
def supports_tags(self):
1072
"""True if this format supports tags stored in the branch"""
1073
return False # by default
1076
class BranchHooks(Hooks):
1077
"""A dictionary mapping hook name to a list of callables for branch hooks.
1079
e.g. ['set_rh'] Is the list of items to be called when the
1080
set_revision_history function is invoked.
1084
"""Create the default hooks.
1086
These are all empty initially, because by default nothing should get
1089
Hooks.__init__(self)
1090
# Introduced in 0.15:
1091
# invoked whenever the revision history has been set
1092
# with set_revision_history. The api signature is
1093
# (branch, revision_history), and the branch will
1096
# invoked after a push operation completes.
1097
# the api signature is
1099
# containing the members
1100
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1101
# where local is the local target branch or None, master is the target
1102
# master branch, and the rest should be self explanatory. The source
1103
# is read locked and the target branches write locked. Source will
1104
# be the local low-latency branch.
1105
self['post_push'] = []
1106
# invoked after a pull operation completes.
1107
# the api signature is
1109
# containing the members
1110
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1111
# where local is the local branch or None, master is the target
1112
# master branch, and the rest should be self explanatory. The source
1113
# is read locked and the target branches write locked. The local
1114
# branch is the low-latency branch.
1115
self['post_pull'] = []
1116
# invoked before a commit operation takes place.
1117
# the api signature is
1118
# (local, master, old_revno, old_revid, future_revno, future_revid,
1119
# tree_delta, future_tree).
1120
# old_revid is NULL_REVISION for the first commit to a branch
1121
# tree_delta is a TreeDelta object describing changes from the basis
1122
# revision, hooks MUST NOT modify this delta
1123
# future_tree is an in-memory tree obtained from
1124
# CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
1125
self['pre_commit'] = []
1126
# invoked after a commit operation completes.
1127
# the api signature is
1128
# (local, master, old_revno, old_revid, new_revno, new_revid)
1129
# old_revid is NULL_REVISION for the first commit to a branch.
1130
self['post_commit'] = []
1131
# invoked after a uncommit operation completes.
1132
# the api signature is
1133
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1134
# local is the local branch or None, master is the target branch,
1135
# and an empty branch recieves new_revno of 0, new_revid of None.
1136
self['post_uncommit'] = []
1138
# Invoked before the tip of a branch changes.
1139
# the api signature is
1140
# (params) where params is a ChangeBranchTipParams with the members
1141
# (branch, old_revno, new_revno, old_revid, new_revid)
1142
self['pre_change_branch_tip'] = []
1144
# Invoked after the tip of a branch changes.
1145
# the api signature is
1146
# (params) where params is a ChangeBranchTipParams with the members
1147
# (branch, old_revno, new_revno, old_revid, new_revid)
1148
self['post_change_branch_tip'] = []
1151
# install the default hooks into the Branch class.
1152
Branch.hooks = BranchHooks()
1155
class ChangeBranchTipParams(object):
1156
"""Object holding parameters passed to *_change_branch_tip hooks.
1158
There are 5 fields that hooks may wish to access:
1160
:ivar branch: the branch being changed
1161
:ivar old_revno: revision number before the change
1162
:ivar new_revno: revision number after the change
1163
:ivar old_revid: revision id before the change
1164
:ivar new_revid: revision id after the change
1166
The revid fields are strings. The revno fields are integers.
1169
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1170
"""Create a group of ChangeBranchTip parameters.
1172
:param branch: The branch being changed.
1173
:param old_revno: Revision number before the change.
1174
:param new_revno: Revision number after the change.
1175
:param old_revid: Tip revision id before the change.
1176
:param new_revid: Tip revision id after the change.
1178
self.branch = branch
1179
self.old_revno = old_revno
1180
self.new_revno = new_revno
1181
self.old_revid = old_revid
1182
self.new_revid = new_revid
1184
def __eq__(self, other):
1185
return self.__dict__ == other.__dict__
1188
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1189
self.__class__.__name__, self.branch,
1190
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1193
class BzrBranchFormat4(BranchFormat):
1194
"""Bzr branch format 4.
1197
- a revision-history file.
1198
- a branch-lock lock file [ to be shared with the bzrdir ]
1201
def get_format_description(self):
1202
"""See BranchFormat.get_format_description()."""
1203
return "Branch format 4"
1205
def initialize(self, a_bzrdir):
1206
"""Create a branch of this format in a_bzrdir."""
1207
utf8_files = [('revision-history', ''),
1208
('branch-name', ''),
1210
return self._initialize_helper(a_bzrdir, utf8_files,
1211
lock_type='branch4', set_format=False)
1214
super(BzrBranchFormat4, self).__init__()
1215
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1217
def open(self, a_bzrdir, _found=False):
1218
"""Return the branch object for a_bzrdir
1220
_found is a private parameter, do not use it. It is used to indicate
1221
if format probing has already be done.
1224
# we are being called directly and must probe.
1225
raise NotImplementedError
1226
return BzrBranch(_format=self,
1227
_control_files=a_bzrdir._control_files,
1229
_repository=a_bzrdir.open_repository())
1232
return "Bazaar-NG branch format 4"
1235
class BranchFormatMetadir(BranchFormat):
1236
"""Common logic for meta-dir based branch formats."""
1238
def _branch_class(self):
1239
"""What class to instantiate on open calls."""
1240
raise NotImplementedError(self._branch_class)
1242
def open(self, a_bzrdir, _found=False):
1243
"""Return the branch object for a_bzrdir.
1245
_found is a private parameter, do not use it. It is used to indicate
1246
if format probing has already be done.
1249
format = BranchFormat.find_format(a_bzrdir)
1250
if format.__class__ != self.__class__:
1251
raise AssertionError("wrong format %r found for %r" %
1254
transport = a_bzrdir.get_branch_transport(None)
1255
control_files = lockable_files.LockableFiles(transport, 'lock',
1257
return self._branch_class()(_format=self,
1258
_control_files=control_files,
1260
_repository=a_bzrdir.find_repository())
1261
except errors.NoSuchFile:
1262
raise errors.NotBranchError(path=transport.base)
1265
super(BranchFormatMetadir, self).__init__()
1266
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1268
def supports_tags(self):
1272
class BzrBranchFormat5(BranchFormatMetadir):
1273
"""Bzr branch format 5.
1276
- a revision-history file.
1278
- a lock dir guarding the branch itself
1279
- all of this stored in a branch/ subdirectory
1280
- works with shared repositories.
1282
This format is new in bzr 0.8.
1285
def _branch_class(self):
1288
def get_format_string(self):
1289
"""See BranchFormat.get_format_string()."""
1290
return "Bazaar-NG branch format 5\n"
1292
def get_format_description(self):
1293
"""See BranchFormat.get_format_description()."""
1294
return "Branch format 5"
1296
def initialize(self, a_bzrdir):
1297
"""Create a branch of this format in a_bzrdir."""
1298
utf8_files = [('revision-history', ''),
1299
('branch-name', ''),
1301
return self._initialize_helper(a_bzrdir, utf8_files)
1303
def supports_tags(self):
1307
class BzrBranchFormat6(BranchFormatMetadir):
1308
"""Branch format with last-revision and tags.
1310
Unlike previous formats, this has no explicit revision history. Instead,
1311
this just stores the last-revision, and the left-hand history leading
1312
up to there is the history.
1314
This format was introduced in bzr 0.15
1315
and became the default in 0.91.
1318
def _branch_class(self):
1321
def get_format_string(self):
1322
"""See BranchFormat.get_format_string()."""
1323
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1325
def get_format_description(self):
1326
"""See BranchFormat.get_format_description()."""
1327
return "Branch format 6"
1329
def initialize(self, a_bzrdir):
1330
"""Create a branch of this format in a_bzrdir."""
1331
utf8_files = [('last-revision', '0 null:\n'),
1332
('branch.conf', ''),
1335
return self._initialize_helper(a_bzrdir, utf8_files)
1338
class BzrBranchFormat7(BranchFormatMetadir):
1339
"""Branch format with last-revision, tags, and a stacked location pointer.
1341
The stacked location pointer is passed down to the repository and requires
1342
a repository format with supports_external_lookups = True.
1344
This format was introduced in bzr 1.6.
1347
def _branch_class(self):
1350
def get_format_string(self):
1351
"""See BranchFormat.get_format_string()."""
1352
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
1354
def get_format_description(self):
1355
"""See BranchFormat.get_format_description()."""
1356
return "Branch format 7"
1358
def initialize(self, a_bzrdir):
1359
"""Create a branch of this format in a_bzrdir."""
1360
utf8_files = [('last-revision', '0 null:\n'),
1361
('branch.conf', ''),
1364
return self._initialize_helper(a_bzrdir, utf8_files)
1367
super(BzrBranchFormat7, self).__init__()
1368
self._matchingbzrdir.repository_format = \
1369
RepositoryFormatPackDevelopment1Subtree()
1372
class BranchReferenceFormat(BranchFormat):
1373
"""Bzr branch reference format.
1375
Branch references are used in implementing checkouts, they
1376
act as an alias to the real branch which is at some other url.
1383
def get_format_string(self):
1384
"""See BranchFormat.get_format_string()."""
1385
return "Bazaar-NG Branch Reference Format 1\n"
1387
def get_format_description(self):
1388
"""See BranchFormat.get_format_description()."""
1389
return "Checkout reference format 1"
1391
def get_reference(self, a_bzrdir):
1392
"""See BranchFormat.get_reference()."""
1393
transport = a_bzrdir.get_branch_transport(None)
1394
return transport.get('location').read()
1396
def set_reference(self, a_bzrdir, to_branch):
1397
"""See BranchFormat.set_reference()."""
1398
transport = a_bzrdir.get_branch_transport(None)
1399
location = transport.put_bytes('location', to_branch.base)
1401
def initialize(self, a_bzrdir, target_branch=None):
1402
"""Create a branch of this format in a_bzrdir."""
1403
if target_branch is None:
1404
# this format does not implement branch itself, thus the implicit
1405
# creation contract must see it as uninitializable
1406
raise errors.UninitializableFormat(self)
1407
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1408
branch_transport = a_bzrdir.get_branch_transport(self)
1409
branch_transport.put_bytes('location',
1410
target_branch.bzrdir.root_transport.base)
1411
branch_transport.put_bytes('format', self.get_format_string())
1413
a_bzrdir, _found=True,
1414
possible_transports=[target_branch.bzrdir.root_transport])
1417
super(BranchReferenceFormat, self).__init__()
1418
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1420
def _make_reference_clone_function(format, a_branch):
1421
"""Create a clone() routine for a branch dynamically."""
1422
def clone(to_bzrdir, revision_id=None):
1423
"""See Branch.clone()."""
1424
return format.initialize(to_bzrdir, a_branch)
1425
# cannot obey revision_id limits when cloning a reference ...
1426
# FIXME RBC 20060210 either nuke revision_id for clone, or
1427
# emit some sort of warning/error to the caller ?!
1430
def open(self, a_bzrdir, _found=False, location=None,
1431
possible_transports=None):
1432
"""Return the branch that the branch reference in a_bzrdir points at.
1434
_found is a private parameter, do not use it. It is used to indicate
1435
if format probing has already be done.
1438
format = BranchFormat.find_format(a_bzrdir)
1439
if format.__class__ != self.__class__:
1440
raise AssertionError("wrong format %r found for %r" %
1442
if location is None:
1443
location = self.get_reference(a_bzrdir)
1444
real_bzrdir = bzrdir.BzrDir.open(
1445
location, possible_transports=possible_transports)
1446
result = real_bzrdir.open_branch()
1447
# this changes the behaviour of result.clone to create a new reference
1448
# rather than a copy of the content of the branch.
1449
# I did not use a proxy object because that needs much more extensive
1450
# testing, and we are only changing one behaviour at the moment.
1451
# If we decide to alter more behaviours - i.e. the implicit nickname
1452
# then this should be refactored to introduce a tested proxy branch
1453
# and a subclass of that for use in overriding clone() and ....
1455
result.clone = self._make_reference_clone_function(result)
1459
# formats which have no format string are not discoverable
1460
# and not independently creatable, so are not registered.
1461
__format5 = BzrBranchFormat5()
1462
__format6 = BzrBranchFormat6()
1463
__format7 = BzrBranchFormat7()
1464
BranchFormat.register_format(__format5)
1465
BranchFormat.register_format(BranchReferenceFormat())
1466
BranchFormat.register_format(__format6)
1467
BranchFormat.register_format(__format7)
1468
BranchFormat.set_default_format(__format6)
1469
_legacy_formats = [BzrBranchFormat4(),
1472
class BzrBranch(Branch):
1473
"""A branch stored in the actual filesystem.
1475
Note that it's "local" in the context of the filesystem; it doesn't
1476
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1477
it's writable, and can be accessed via the normal filesystem API.
1479
:ivar _transport: Transport for file operations on this branch's
1480
control files, typically pointing to the .bzr/branch directory.
1481
:ivar repository: Repository for this branch.
1482
:ivar base: The url of the base directory for this branch; the one
1483
containing the .bzr directory.
1486
def __init__(self, _format=None,
1487
_control_files=None, a_bzrdir=None, _repository=None):
1488
"""Create new branch object at a particular location."""
1489
if a_bzrdir is None:
1490
raise ValueError('a_bzrdir must be supplied')
1492
self.bzrdir = a_bzrdir
1493
self._base = self.bzrdir.transport.clone('..').base
1494
# XXX: We should be able to just do
1495
# self.base = self.bzrdir.root_transport.base
1496
# but this does not quite work yet -- mbp 20080522
1497
self._format = _format
1498
if _control_files is None:
1499
raise ValueError('BzrBranch _control_files is None')
1500
self.control_files = _control_files
1501
self._transport = _control_files._transport
1502
self.repository = _repository
1503
Branch.__init__(self)
1506
return '%s(%r)' % (self.__class__.__name__, self.base)
1510
def _get_base(self):
1511
"""Returns the directory containing the control directory."""
1514
base = property(_get_base, doc="The URL for the root of this branch.")
1516
@deprecated_method(deprecated_in((0, 16, 0)))
1517
def abspath(self, name):
1518
"""See Branch.abspath."""
1519
return self._transport.abspath(name)
1521
def is_locked(self):
1522
return self.control_files.is_locked()
1524
def lock_write(self, token=None):
1525
repo_token = self.repository.lock_write()
1527
token = self.control_files.lock_write(token=token)
1529
self.repository.unlock()
1533
def lock_read(self):
1534
self.repository.lock_read()
1536
self.control_files.lock_read()
1538
self.repository.unlock()
1542
# TODO: test for failed two phase locks. This is known broken.
1544
self.control_files.unlock()
1546
self.repository.unlock()
1547
if not self.control_files.is_locked():
1548
# we just released the lock
1549
self._clear_cached_state()
1551
def peek_lock_mode(self):
1552
if self.control_files._lock_count == 0:
1555
return self.control_files._lock_mode
1557
def get_physical_lock_status(self):
1558
return self.control_files.get_physical_lock_status()
1561
def print_file(self, file, revision_id):
1562
"""See Branch.print_file."""
1563
return self.repository.print_file(file, revision_id)
1565
def _write_revision_history(self, history):
1566
"""Factored out of set_revision_history.
1568
This performs the actual writing to disk.
1569
It is intended to be called by BzrBranch5.set_revision_history."""
1570
self._transport.put_bytes(
1571
'revision-history', '\n'.join(history),
1572
mode=self.bzrdir._get_file_mode())
1575
def set_revision_history(self, rev_history):
1576
"""See Branch.set_revision_history."""
1577
if 'evil' in debug.debug_flags:
1578
mutter_callsite(3, "set_revision_history scales with history.")
1579
check_not_reserved_id = _mod_revision.check_not_reserved_id
1580
for rev_id in rev_history:
1581
check_not_reserved_id(rev_id)
1582
self._write_revision_history(rev_history)
1583
self._clear_cached_state()
1584
self._cache_revision_history(rev_history)
1585
for hook in Branch.hooks['set_rh']:
1586
hook(self, rev_history)
1588
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
1589
"""Run the pre_change_branch_tip hooks."""
1590
hooks = Branch.hooks['pre_change_branch_tip']
1593
old_revno, old_revid = self.last_revision_info()
1594
params = ChangeBranchTipParams(
1595
self, old_revno, new_revno, old_revid, new_revid)
1599
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1600
"""Run the post_change_branch_tip hooks."""
1601
hooks = Branch.hooks['post_change_branch_tip']
1604
new_revno, new_revid = self.last_revision_info()
1605
params = ChangeBranchTipParams(
1606
self, old_revno, new_revno, old_revid, new_revid)
1611
def set_last_revision_info(self, revno, revision_id):
1612
"""Set the last revision of this branch.
1614
The caller is responsible for checking that the revno is correct
1615
for this revision id.
1617
It may be possible to set the branch last revision to an id not
1618
present in the repository. However, branches can also be
1619
configured to check constraints on history, in which case this may not
1622
revision_id = _mod_revision.ensure_null(revision_id)
1623
old_revno, old_revid = self.last_revision_info()
1624
# this old format stores the full history, but this api doesn't
1625
# provide it, so we must generate, and might as well check it's
1627
history = self._lefthand_history(revision_id)
1628
if len(history) != revno:
1629
raise AssertionError('%d != %d' % (len(history), revno))
1630
self._run_pre_change_branch_tip_hooks(revno, revision_id)
1631
self.set_revision_history(history)
1632
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1634
def _gen_revision_history(self):
1635
history = self._transport.get_bytes('revision-history').split('\n')
1636
if history[-1:] == ['']:
1637
# There shouldn't be a trailing newline, but just in case.
1641
def _lefthand_history(self, revision_id, last_rev=None,
1643
if 'evil' in debug.debug_flags:
1644
mutter_callsite(4, "_lefthand_history scales with history.")
1645
# stop_revision must be a descendant of last_revision
1646
graph = self.repository.get_graph()
1647
if last_rev is not None:
1648
if not graph.is_ancestor(last_rev, revision_id):
1649
# our previous tip is not merged into stop_revision
1650
raise errors.DivergedBranches(self, other_branch)
1651
# make a new revision history from the graph
1652
parents_map = graph.get_parent_map([revision_id])
1653
if revision_id not in parents_map:
1654
raise errors.NoSuchRevision(self, revision_id)
1655
current_rev_id = revision_id
1657
check_not_reserved_id = _mod_revision.check_not_reserved_id
1658
# Do not include ghosts or graph origin in revision_history
1659
while (current_rev_id in parents_map and
1660
len(parents_map[current_rev_id]) > 0):
1661
check_not_reserved_id(current_rev_id)
1662
new_history.append(current_rev_id)
1663
current_rev_id = parents_map[current_rev_id][0]
1664
parents_map = graph.get_parent_map([current_rev_id])
1665
new_history.reverse()
1669
def generate_revision_history(self, revision_id, last_rev=None,
1671
"""Create a new revision history that will finish with revision_id.
1673
:param revision_id: the new tip to use.
1674
:param last_rev: The previous last_revision. If not None, then this
1675
must be a ancestory of revision_id, or DivergedBranches is raised.
1676
:param other_branch: The other branch that DivergedBranches should
1677
raise with respect to.
1679
self.set_revision_history(self._lefthand_history(revision_id,
1680
last_rev, other_branch))
1682
def basis_tree(self):
1683
"""See Branch.basis_tree."""
1684
return self.repository.revision_tree(self.last_revision())
1687
def pull(self, source, overwrite=False, stop_revision=None,
1688
_hook_master=None, run_hooks=True, possible_transports=None,
1689
_override_hook_target=None):
1692
:param _hook_master: Private parameter - set the branch to
1693
be supplied as the master to pull hooks.
1694
:param run_hooks: Private parameter - if false, this branch
1695
is being called because it's the master of the primary branch,
1696
so it should not run its hooks.
1697
:param _override_hook_target: Private parameter - set the branch to be
1698
supplied as the target_branch to pull hooks.
1700
result = PullResult()
1701
result.source_branch = source
1702
if _override_hook_target is None:
1703
result.target_branch = self
1705
result.target_branch = _override_hook_target
1708
# We assume that during 'pull' the local repository is closer than
1710
graph = self.repository.get_graph(source.repository)
1711
result.old_revno, result.old_revid = self.last_revision_info()
1712
self.update_revisions(source, stop_revision, overwrite=overwrite,
1714
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
1715
result.new_revno, result.new_revid = self.last_revision_info()
1717
result.master_branch = _hook_master
1718
result.local_branch = result.target_branch
1720
result.master_branch = result.target_branch
1721
result.local_branch = None
1723
for hook in Branch.hooks['post_pull']:
1729
def _get_parent_location(self):
1730
_locs = ['parent', 'pull', 'x-pull']
1733
return self._transport.get_bytes(l).strip('\n')
1734
except errors.NoSuchFile:
1739
def push(self, target, overwrite=False, stop_revision=None,
1740
_override_hook_source_branch=None):
1743
This is the basic concrete implementation of push()
1745
:param _override_hook_source_branch: If specified, run
1746
the hooks passing this Branch as the source, rather than self.
1747
This is for use of RemoteBranch, where push is delegated to the
1748
underlying vfs-based Branch.
1750
# TODO: Public option to disable running hooks - should be trivial but
1754
result = self._push_with_bound_branches(target, overwrite,
1756
_override_hook_source_branch=_override_hook_source_branch)
1761
def _push_with_bound_branches(self, target, overwrite,
1763
_override_hook_source_branch=None):
1764
"""Push from self into target, and into target's master if any.
1766
This is on the base BzrBranch class even though it doesn't support
1767
bound branches because the *target* might be bound.
1770
if _override_hook_source_branch:
1771
result.source_branch = _override_hook_source_branch
1772
for hook in Branch.hooks['post_push']:
1775
bound_location = target.get_bound_location()
1776
if bound_location and target.base != bound_location:
1777
# there is a master branch.
1779
# XXX: Why the second check? Is it even supported for a branch to
1780
# be bound to itself? -- mbp 20070507
1781
master_branch = target.get_master_branch()
1782
master_branch.lock_write()
1784
# push into the master from this branch.
1785
self._basic_push(master_branch, overwrite, stop_revision)
1786
# and push into the target branch from this. Note that we push from
1787
# this branch again, because its considered the highest bandwidth
1789
result = self._basic_push(target, overwrite, stop_revision)
1790
result.master_branch = master_branch
1791
result.local_branch = target
1795
master_branch.unlock()
1798
result = self._basic_push(target, overwrite, stop_revision)
1799
# TODO: Why set master_branch and local_branch if there's no
1800
# binding? Maybe cleaner to just leave them unset? -- mbp
1802
result.master_branch = target
1803
result.local_branch = None
1807
def _basic_push(self, target, overwrite, stop_revision):
1808
"""Basic implementation of push without bound branches or hooks.
1810
Must be called with self read locked and target write locked.
1812
result = PushResult()
1813
result.source_branch = self
1814
result.target_branch = target
1815
result.old_revno, result.old_revid = target.last_revision_info()
1817
# We assume that during 'push' this repository is closer than
1819
graph = self.repository.get_graph(target.repository)
1820
target.update_revisions(self, stop_revision, overwrite=overwrite,
1822
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
1823
result.new_revno, result.new_revid = target.last_revision_info()
1826
def get_parent(self):
1827
"""See Branch.get_parent."""
1828
parent = self._get_parent_location()
1831
# This is an old-format absolute path to a local branch
1832
# turn it into a url
1833
if parent.startswith('/'):
1834
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1836
return urlutils.join(self.base[:-1], parent)
1837
except errors.InvalidURLJoin, e:
1838
raise errors.InaccessibleParent(parent, self.base)
1840
def get_stacked_on_url(self):
1841
raise errors.UnstackableBranchFormat(self._format, self.base)
1843
def set_push_location(self, location):
1844
"""See Branch.set_push_location."""
1845
self.get_config().set_user_option(
1846
'push_location', location,
1847
store=_mod_config.STORE_LOCATION_NORECURSE)
1850
def set_parent(self, url):
1851
"""See Branch.set_parent."""
1852
# TODO: Maybe delete old location files?
1853
# URLs should never be unicode, even on the local fs,
1854
# FIXUP this and get_parent in a future branch format bump:
1855
# read and rewrite the file. RBC 20060125
1857
if isinstance(url, unicode):
1859
url = url.encode('ascii')
1860
except UnicodeEncodeError:
1861
raise errors.InvalidURL(url,
1862
"Urls must be 7-bit ascii, "
1863
"use bzrlib.urlutils.escape")
1864
url = urlutils.relative_url(self.base, url)
1865
self._set_parent_location(url)
1867
def _set_parent_location(self, url):
1869
self._transport.delete('parent')
1871
self._transport.put_bytes('parent', url + '\n',
1872
mode=self.bzrdir._get_file_mode())
1874
def set_stacked_on_url(self, url):
1875
raise errors.UnstackableBranchFormat(self._format, self.base)
1878
class BzrBranch5(BzrBranch):
1879
"""A format 5 branch. This supports new features over plain branches.
1881
It has support for a master_branch which is the data for bound branches.
1885
def pull(self, source, overwrite=False, stop_revision=None,
1886
run_hooks=True, possible_transports=None,
1887
_override_hook_target=None):
1888
"""Pull from source into self, updating my master if any.
1890
:param run_hooks: Private parameter - if false, this branch
1891
is being called because it's the master of the primary branch,
1892
so it should not run its hooks.
1894
bound_location = self.get_bound_location()
1895
master_branch = None
1896
if bound_location and source.base != bound_location:
1897
# not pulling from master, so we need to update master.
1898
master_branch = self.get_master_branch(possible_transports)
1899
master_branch.lock_write()
1902
# pull from source into master.
1903
master_branch.pull(source, overwrite, stop_revision,
1905
return super(BzrBranch5, self).pull(source, overwrite,
1906
stop_revision, _hook_master=master_branch,
1907
run_hooks=run_hooks,
1908
_override_hook_target=_override_hook_target)
1911
master_branch.unlock()
1913
def get_bound_location(self):
1915
return self._transport.get_bytes('bound')[:-1]
1916
except errors.NoSuchFile:
1920
def get_master_branch(self, possible_transports=None):
1921
"""Return the branch we are bound to.
1923
:return: Either a Branch, or None
1925
This could memoise the branch, but if thats done
1926
it must be revalidated on each new lock.
1927
So for now we just don't memoise it.
1928
# RBC 20060304 review this decision.
1930
bound_loc = self.get_bound_location()
1934
return Branch.open(bound_loc,
1935
possible_transports=possible_transports)
1936
except (errors.NotBranchError, errors.ConnectionError), e:
1937
raise errors.BoundBranchConnectionFailure(
1941
def set_bound_location(self, location):
1942
"""Set the target where this branch is bound to.
1944
:param location: URL to the target branch
1947
self._transport.put_bytes('bound', location+'\n',
1948
mode=self.bzrdir._get_file_mode())
1951
self._transport.delete('bound')
1952
except errors.NoSuchFile:
1957
def bind(self, other):
1958
"""Bind this branch to the branch other.
1960
This does not push or pull data between the branches, though it does
1961
check for divergence to raise an error when the branches are not
1962
either the same, or one a prefix of the other. That behaviour may not
1963
be useful, so that check may be removed in future.
1965
:param other: The branch to bind to
1968
# TODO: jam 20051230 Consider checking if the target is bound
1969
# It is debatable whether you should be able to bind to
1970
# a branch which is itself bound.
1971
# Committing is obviously forbidden,
1972
# but binding itself may not be.
1973
# Since we *have* to check at commit time, we don't
1974
# *need* to check here
1976
# we want to raise diverged if:
1977
# last_rev is not in the other_last_rev history, AND
1978
# other_last_rev is not in our history, and do it without pulling
1980
self.set_bound_location(other.base)
1984
"""If bound, unbind"""
1985
return self.set_bound_location(None)
1988
def update(self, possible_transports=None):
1989
"""Synchronise this branch with the master branch if any.
1991
:return: None or the last_revision that was pivoted out during the
1994
master = self.get_master_branch(possible_transports)
1995
if master is not None:
1996
old_tip = _mod_revision.ensure_null(self.last_revision())
1997
self.pull(master, overwrite=True)
1998
if self.repository.get_graph().is_ancestor(old_tip,
1999
_mod_revision.ensure_null(self.last_revision())):
2005
class BzrBranch7(BzrBranch5):
2006
"""A branch with support for a fallback repository."""
2008
def _get_fallback_repository(self, url):
2009
"""Get the repository we fallback to at url."""
2010
url = urlutils.join(self.base, url)
2011
return bzrdir.BzrDir.open(url).open_branch().repository
2013
def _activate_fallback_location(self, url):
2014
"""Activate the branch/repository from url as a fallback repository."""
2015
self.repository.add_fallback_repository(
2016
self._get_fallback_repository(url))
2018
def _open_hook(self):
2020
url = self.get_stacked_on_url()
2021
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2022
errors.UnstackableBranchFormat):
2025
self._activate_fallback_location(url)
2027
def _check_stackable_repo(self):
2028
if not self.repository._format.supports_external_lookups:
2029
raise errors.UnstackableRepositoryFormat(self.repository._format,
2030
self.repository.base)
2032
def __init__(self, *args, **kwargs):
2033
super(BzrBranch7, self).__init__(*args, **kwargs)
2034
self._last_revision_info_cache = None
2035
self._partial_revision_history_cache = []
2037
def _clear_cached_state(self):
2038
super(BzrBranch7, self)._clear_cached_state()
2039
self._last_revision_info_cache = None
2040
self._partial_revision_history_cache = []
2042
def _last_revision_info(self):
2043
revision_string = self._transport.get_bytes('last-revision')
2044
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2045
revision_id = cache_utf8.get_cached_utf8(revision_id)
2047
return revno, revision_id
2049
def _write_last_revision_info(self, revno, revision_id):
2050
"""Simply write out the revision id, with no checks.
2052
Use set_last_revision_info to perform this safely.
2054
Does not update the revision_history cache.
2055
Intended to be called by set_last_revision_info and
2056
_write_revision_history.
2058
revision_id = _mod_revision.ensure_null(revision_id)
2059
out_string = '%d %s\n' % (revno, revision_id)
2060
self._transport.put_bytes('last-revision', out_string,
2061
mode=self.bzrdir._get_file_mode())
2064
def set_last_revision_info(self, revno, revision_id):
2065
revision_id = _mod_revision.ensure_null(revision_id)
2066
old_revno, old_revid = self.last_revision_info()
2067
if self._get_append_revisions_only():
2068
self._check_history_violation(revision_id)
2069
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2070
self._write_last_revision_info(revno, revision_id)
2071
self._clear_cached_state()
2072
self._last_revision_info_cache = revno, revision_id
2073
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2075
def _check_history_violation(self, revision_id):
2076
last_revision = _mod_revision.ensure_null(self.last_revision())
2077
if _mod_revision.is_null(last_revision):
2079
if last_revision not in self._lefthand_history(revision_id):
2080
raise errors.AppendRevisionsOnlyViolation(self.base)
2082
def _gen_revision_history(self):
2083
"""Generate the revision history from last revision
2085
last_revno, last_revision = self.last_revision_info()
2086
self._extend_partial_history(stop_index=last_revno-1)
2087
return list(reversed(self._partial_revision_history_cache))
2089
def _extend_partial_history(self, stop_index=None, stop_revision=None):
2090
"""Extend the partial history to include a given index
2092
If a stop_index is supplied, stop when that index has been reached.
2093
If a stop_revision is supplied, stop when that revision is
2094
encountered. Otherwise, stop when the beginning of history is
2097
:param stop_index: The index which should be present. When it is
2098
present, history extension will stop.
2099
:param revision_id: The revision id which should be present. When
2100
it is encountered, history extension will stop.
2102
repo = self.repository
2103
if len(self._partial_revision_history_cache) == 0:
2104
iterator = repo.iter_reverse_revision_history(self.last_revision())
2106
start_revision = self._partial_revision_history_cache[-1]
2107
iterator = repo.iter_reverse_revision_history(start_revision)
2108
#skip the last revision in the list
2109
next_revision = iterator.next()
2110
for revision_id in iterator:
2111
self._partial_revision_history_cache.append(revision_id)
2112
if (stop_index is not None and
2113
len(self._partial_revision_history_cache) > stop_index):
2115
if revision_id == stop_revision:
2118
def _write_revision_history(self, history):
2119
"""Factored out of set_revision_history.
2121
This performs the actual writing to disk, with format-specific checks.
2122
It is intended to be called by BzrBranch5.set_revision_history.
2124
if len(history) == 0:
2125
last_revision = 'null:'
2127
if history != self._lefthand_history(history[-1]):
2128
raise errors.NotLefthandHistory(history)
2129
last_revision = history[-1]
2130
if self._get_append_revisions_only():
2131
self._check_history_violation(last_revision)
2132
self._write_last_revision_info(len(history), last_revision)
2135
def _set_parent_location(self, url):
2136
"""Set the parent branch"""
2137
self._set_config_location('parent_location', url, make_relative=True)
2140
def _get_parent_location(self):
2141
"""Set the parent branch"""
2142
return self._get_config_location('parent_location')
2144
def set_push_location(self, location):
2145
"""See Branch.set_push_location."""
2146
self._set_config_location('push_location', location)
2148
def set_bound_location(self, location):
2149
"""See Branch.set_push_location."""
2151
config = self.get_config()
2152
if location is None:
2153
if config.get_user_option('bound') != 'True':
2156
config.set_user_option('bound', 'False', warn_masked=True)
2159
self._set_config_location('bound_location', location,
2161
config.set_user_option('bound', 'True', warn_masked=True)
2164
def _get_bound_location(self, bound):
2165
"""Return the bound location in the config file.
2167
Return None if the bound parameter does not match"""
2168
config = self.get_config()
2169
config_bound = (config.get_user_option('bound') == 'True')
2170
if config_bound != bound:
2172
return self._get_config_location('bound_location', config=config)
2174
def get_bound_location(self):
2175
"""See Branch.set_push_location."""
2176
return self._get_bound_location(True)
2178
def get_old_bound_location(self):
2179
"""See Branch.get_old_bound_location"""
2180
return self._get_bound_location(False)
2182
def get_stacked_on_url(self):
2183
self._check_stackable_repo()
2184
stacked_url = self._get_config_location('stacked_on_location')
2185
if stacked_url is None:
2186
raise errors.NotStacked(self)
2189
def set_append_revisions_only(self, enabled):
2194
self.get_config().set_user_option('append_revisions_only', value,
2197
def set_stacked_on_url(self, url):
2198
self._check_stackable_repo()
2201
old_url = self.get_stacked_on_url()
2202
except (errors.NotStacked, errors.UnstackableBranchFormat,
2203
errors.UnstackableRepositoryFormat):
2206
# repositories don't offer an interface to remove fallback
2207
# repositories today; take the conceptually simpler option and just
2209
self.repository = self.bzrdir.find_repository()
2210
# for every revision reference the branch has, ensure it is pulled
2212
source_repository = self._get_fallback_repository(old_url)
2213
for revision_id in chain([self.last_revision()],
2214
self.tags.get_reverse_tag_dict()):
2215
self.repository.fetch(source_repository, revision_id,
2218
self._activate_fallback_location(url)
2219
# write this out after the repository is stacked to avoid setting a
2220
# stacked config that doesn't work.
2221
self._set_config_location('stacked_on_location', url)
2223
def _get_append_revisions_only(self):
2224
value = self.get_config().get_user_option('append_revisions_only')
2225
return value == 'True'
2227
def _synchronize_history(self, destination, revision_id):
2228
"""Synchronize last revision and revision history between branches.
2230
This version is most efficient when the destination is also a
2231
BzrBranch6, but works for BzrBranch5, as long as the destination's
2232
repository contains all the lefthand ancestors of the intended
2233
last_revision. If not, set_last_revision_info will fail.
2235
:param destination: The branch to copy the history into
2236
:param revision_id: The revision-id to truncate history at. May
2237
be None to copy complete history.
2239
source_revno, source_revision_id = self.last_revision_info()
2240
if revision_id is None:
2241
revno, revision_id = source_revno, source_revision_id
2242
elif source_revision_id == revision_id:
2243
# we know the revno without needing to walk all of history
2244
revno = source_revno
2246
# To figure out the revno for a random revision, we need to build
2247
# the revision history, and count its length.
2248
# We don't care about the order, just how long it is.
2249
# Alternatively, we could start at the current location, and count
2250
# backwards. But there is no guarantee that we will find it since
2251
# it may be a merged revision.
2252
revno = len(list(self.repository.iter_reverse_revision_history(
2254
destination.set_last_revision_info(revno, revision_id)
2256
def _make_tags(self):
2257
return BasicTags(self)
2260
def generate_revision_history(self, revision_id, last_rev=None,
2262
"""See BzrBranch5.generate_revision_history"""
2263
history = self._lefthand_history(revision_id, last_rev, other_branch)
2264
revno = len(history)
2265
self.set_last_revision_info(revno, revision_id)
2268
def get_rev_id(self, revno, history=None):
2269
"""Find the revision id of the specified revno."""
2271
return _mod_revision.NULL_REVISION
2273
last_revno, last_revision_id = self.last_revision_info()
2274
if revno <= 0 or revno > last_revno:
2275
raise errors.NoSuchRevision(self, revno)
2277
if history is not None:
2278
return history[revno - 1]
2280
index = last_revno - revno
2281
if len(self._partial_revision_history_cache) <= index:
2282
self._extend_partial_history(stop_index=index)
2283
if len(self._partial_revision_history_cache) > index:
2284
return self._partial_revision_history_cache[index]
2286
raise errors.NoSuchRevision(self, revno)
2289
def revision_id_to_revno(self, revision_id):
2290
"""Given a revision id, return its revno"""
2291
if _mod_revision.is_null(revision_id):
2294
index = self._partial_revision_history_cache.index(revision_id)
2296
self._extend_partial_history(stop_revision=revision_id)
2297
index = len(self._partial_revision_history_cache) - 1
2298
if self._partial_revision_history_cache[index] != revision_id:
2299
raise errors.NoSuchRevision(self, revision_id)
2300
return self.revno() - index
2303
class BzrBranch6(BzrBranch7):
2304
"""See BzrBranchFormat6 for the capabilities of this branch.
2306
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
2310
def get_stacked_on_url(self):
2311
raise errors.UnstackableBranchFormat(self._format, self.base)
2313
def set_stacked_on_url(self, url):
2314
raise errors.UnstackableBranchFormat(self._format, self.base)
2317
######################################################################
2318
# results of operations
2321
class _Result(object):
2323
def _show_tag_conficts(self, to_file):
2324
if not getattr(self, 'tag_conflicts', None):
2326
to_file.write('Conflicting tags:\n')
2327
for name, value1, value2 in self.tag_conflicts:
2328
to_file.write(' %s\n' % (name, ))
2331
class PullResult(_Result):
2332
"""Result of a Branch.pull operation.
2334
:ivar old_revno: Revision number before pull.
2335
:ivar new_revno: Revision number after pull.
2336
:ivar old_revid: Tip revision id before pull.
2337
:ivar new_revid: Tip revision id after pull.
2338
:ivar source_branch: Source (local) branch object.
2339
:ivar master_branch: Master branch of the target, or the target if no
2341
:ivar local_branch: target branch if there is a Master, else None
2342
:ivar target_branch: Target/destination branch object.
2343
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2347
# DEPRECATED: pull used to return the change in revno
2348
return self.new_revno - self.old_revno
2350
def report(self, to_file):
2352
if self.old_revid == self.new_revid:
2353
to_file.write('No revisions to pull.\n')
2355
to_file.write('Now on revision %d.\n' % self.new_revno)
2356
self._show_tag_conficts(to_file)
2359
class PushResult(_Result):
2360
"""Result of a Branch.push operation.
2362
:ivar old_revno: Revision number before push.
2363
:ivar new_revno: Revision number after push.
2364
:ivar old_revid: Tip revision id before push.
2365
:ivar new_revid: Tip revision id after push.
2366
:ivar source_branch: Source branch object.
2367
:ivar master_branch: Master branch of the target, or None.
2368
:ivar target_branch: Target/destination branch object.
2372
# DEPRECATED: push used to return the change in revno
2373
return self.new_revno - self.old_revno
2375
def report(self, to_file):
2376
"""Write a human-readable description of the result."""
2377
if self.old_revid == self.new_revid:
2378
to_file.write('No new revisions to push.\n')
2380
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2381
self._show_tag_conficts(to_file)
2384
class BranchCheckResult(object):
2385
"""Results of checking branch consistency.
2390
def __init__(self, branch):
2391
self.branch = branch
2393
def report_results(self, verbose):
2394
"""Report the check results via trace.note.
2396
:param verbose: Requests more detailed display of what was checked,
2399
note('checked branch %s format %s',
2401
self.branch._format)
2404
class Converter5to6(object):
2405
"""Perform an in-place upgrade of format 5 to format 6"""
2407
def convert(self, branch):
2408
# Data for 5 and 6 can peacefully coexist.
2409
format = BzrBranchFormat6()
2410
new_branch = format.open(branch.bzrdir, _found=True)
2412
# Copy source data into target
2413
new_branch._write_last_revision_info(*branch.last_revision_info())
2414
new_branch.set_parent(branch.get_parent())
2415
new_branch.set_bound_location(branch.get_bound_location())
2416
new_branch.set_push_location(branch.get_push_location())
2418
# New branch has no tags by default
2419
new_branch.tags._set_tag_dict({})
2421
# Copying done; now update target format
2422
new_branch._transport.put_bytes('format',
2423
format.get_format_string(),
2424
mode=new_branch.bzrdir._get_file_mode())
2426
# Clean up old files
2427
new_branch._transport.delete('revision-history')
2429
branch.set_parent(None)
2430
except errors.NoSuchFile:
2432
branch.set_bound_location(None)
2435
class Converter6to7(object):
2436
"""Perform an in-place upgrade of format 6 to format 7"""
2438
def convert(self, branch):
2439
format = BzrBranchFormat7()
2440
branch._set_config_location('stacked_on_location', '')
2441
# update target format
2442
branch._transport.put_bytes('format', format.get_format_string())
added
removed
bzrlib/branch.py
