1
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
from bzrlib.lazy_import import lazy_import
19
lazy_import(globals(), """
23
config as _mod_config,
29
revision as _mod_revision,
35
from bzrlib.config import BranchConfig
36
from bzrlib.tag import (
42
from bzrlib.decorators import needs_read_lock, needs_write_lock
43
from bzrlib.hooks import Hooks
44
from bzrlib.symbol_versioning import (
48
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
51
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
52
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
53
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
56
# TODO: Maybe include checks for common corruption of newlines, etc?
58
# TODO: Some operations like log might retrieve the same revisions
59
# repeatedly to calculate deltas. We could perhaps have a weakref
60
# cache in memory to make this faster. In general anything can be
61
# cached in memory between lock and unlock operations. .. nb thats
62
# what the transaction identity map provides
65
######################################################################
69
"""Branch holding a history of revisions.
72
Base directory/url of the branch.
74
hooks: An instance of BranchHooks.
76
# this is really an instance variable - FIXME move it there
80
# override this to set the strategy for storing tags
82
return DisabledTags(self)
84
def __init__(self, *ignored, **ignored_too):
85
self.tags = self._make_tags()
86
self._revision_history_cache = None
87
self._revision_id_to_revno_cache = None
90
"""Break a lock if one is present from another instance.
92
Uses the ui factory to ask for confirmation if the lock may be from
95
This will probe the repository for its lock as well.
97
self.control_files.break_lock()
98
self.repository.break_lock()
99
master = self.get_master_branch()
100
if master is not None:
104
def open(base, _unsupported=False, possible_transports=None):
105
"""Open the branch rooted at base.
107
For instance, if the branch is at URL/.bzr/branch,
108
Branch.open(URL) -> a Branch instance.
110
control = bzrdir.BzrDir.open(base, _unsupported,
111
possible_transports=possible_transports)
112
return control.open_branch(_unsupported)
115
def open_from_transport(transport, _unsupported=False):
116
"""Open the branch rooted at transport"""
117
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
118
return control.open_branch(_unsupported)
121
def open_containing(url, possible_transports=None):
122
"""Open an existing branch which contains url.
124
This probes for a branch at url, and searches upwards from there.
126
Basically we keep looking up until we find the control directory or
127
run into the root. If there isn't one, raises NotBranchError.
128
If there is one and it is either an unrecognised format or an unsupported
129
format, UnknownFormatError or UnsupportedFormatError are raised.
130
If there is one, it is returned, along with the unused portion of url.
132
control, relpath = bzrdir.BzrDir.open_containing(url,
134
return control.open_branch(), relpath
136
def get_config(self):
137
return BranchConfig(self)
140
return self.get_config().get_nickname()
142
def _set_nick(self, nick):
143
self.get_config().set_user_option('nickname', nick, warn_masked=True)
145
nick = property(_get_nick, _set_nick)
148
raise NotImplementedError(self.is_locked)
150
def lock_write(self):
151
raise NotImplementedError(self.lock_write)
154
raise NotImplementedError(self.lock_read)
157
raise NotImplementedError(self.unlock)
159
def peek_lock_mode(self):
160
"""Return lock mode for the Branch: 'r', 'w' or None"""
161
raise NotImplementedError(self.peek_lock_mode)
163
def get_physical_lock_status(self):
164
raise NotImplementedError(self.get_physical_lock_status)
167
def get_revision_id_to_revno_map(self):
168
"""Return the revision_id => dotted revno map.
170
This will be regenerated on demand, but will be cached.
172
:return: A dictionary mapping revision_id => dotted revno.
173
This dictionary should not be modified by the caller.
175
if self._revision_id_to_revno_cache is not None:
176
mapping = self._revision_id_to_revno_cache
178
mapping = self._gen_revno_map()
179
self._cache_revision_id_to_revno(mapping)
180
# TODO: jam 20070417 Since this is being cached, should we be returning
182
# I would rather not, and instead just declare that users should not
183
# modify the return value.
186
def _gen_revno_map(self):
187
"""Create a new mapping from revision ids to dotted revnos.
189
Dotted revnos are generated based on the current tip in the revision
191
This is the worker function for get_revision_id_to_revno_map, which
192
just caches the return value.
194
:return: A dictionary mapping revision_id => dotted revno.
196
last_revision = self.last_revision()
197
revision_graph = repository._old_get_graph(self.repository,
199
merge_sorted_revisions = tsort.merge_sort(
204
revision_id_to_revno = dict((rev_id, revno)
205
for seq_num, rev_id, depth, revno, end_of_merge
206
in merge_sorted_revisions)
207
return revision_id_to_revno
209
def leave_lock_in_place(self):
210
"""Tell this branch object not to release the physical lock when this
213
If lock_write doesn't return a token, then this method is not supported.
215
self.control_files.leave_in_place()
217
def dont_leave_lock_in_place(self):
218
"""Tell this branch object to release the physical lock when this
219
object is unlocked, even if it didn't originally acquire it.
221
If lock_write doesn't return a token, then this method is not supported.
223
self.control_files.dont_leave_in_place()
225
@deprecated_method(deprecated_in((0, 16, 0)))
226
def abspath(self, name):
227
"""Return absolute filename for something in the branch
229
XXX: Robert Collins 20051017 what is this used for? why is it a branch
230
method and not a tree method.
232
raise NotImplementedError(self.abspath)
234
def bind(self, other):
235
"""Bind the local branch the other branch.
237
:param other: The branch to bind to
240
raise errors.UpgradeRequired(self.base)
243
def fetch(self, from_branch, last_revision=None, pb=None):
244
"""Copy revisions from from_branch into this branch.
246
:param from_branch: Where to copy from.
247
:param last_revision: What revision to stop at (None for at the end
249
:param pb: An optional progress bar to use.
251
Returns the copied revision count and the failed revisions in a tuple:
254
if self.base == from_branch.base:
257
nested_pb = ui.ui_factory.nested_progress_bar()
262
from_branch.lock_read()
264
if last_revision is None:
265
pb.update('get source history')
266
last_revision = from_branch.last_revision()
267
last_revision = _mod_revision.ensure_null(last_revision)
268
return self.repository.fetch(from_branch.repository,
269
revision_id=last_revision,
272
if nested_pb is not None:
276
def get_bound_location(self):
277
"""Return the URL of the branch we are bound to.
279
Older format branches cannot bind, please be sure to use a metadir
284
def get_old_bound_location(self):
285
"""Return the URL of the branch we used to be bound to
287
raise errors.UpgradeRequired(self.base)
289
def get_commit_builder(self, parents, config=None, timestamp=None,
290
timezone=None, committer=None, revprops=None,
292
"""Obtain a CommitBuilder for this branch.
294
:param parents: Revision ids of the parents of the new revision.
295
:param config: Optional configuration to use.
296
:param timestamp: Optional timestamp recorded for commit.
297
:param timezone: Optional timezone for timestamp.
298
:param committer: Optional committer to set for commit.
299
:param revprops: Optional dictionary of revision properties.
300
:param revision_id: Optional revision id.
304
config = self.get_config()
306
return self.repository.get_commit_builder(self, parents, config,
307
timestamp, timezone, committer, revprops, revision_id)
309
def get_master_branch(self, possible_transports=None):
310
"""Return the branch we are bound to.
312
:return: Either a Branch, or None
316
def get_revision_delta(self, revno):
317
"""Return the delta for one revision.
319
The delta is relative to its mainline predecessor, or the
320
empty tree for revision 1.
322
rh = self.revision_history()
323
if not (1 <= revno <= len(rh)):
324
raise errors.InvalidRevisionNumber(revno)
325
return self.repository.get_revision_delta(rh[revno-1])
327
def print_file(self, file, revision_id):
328
"""Print `file` to stdout."""
329
raise NotImplementedError(self.print_file)
331
def set_revision_history(self, rev_history):
332
raise NotImplementedError(self.set_revision_history)
334
def _cache_revision_history(self, rev_history):
335
"""Set the cached revision history to rev_history.
337
The revision_history method will use this cache to avoid regenerating
338
the revision history.
340
This API is semi-public; it only for use by subclasses, all other code
341
should consider it to be private.
343
self._revision_history_cache = rev_history
345
def _cache_revision_id_to_revno(self, revision_id_to_revno):
346
"""Set the cached revision_id => revno map to revision_id_to_revno.
348
This API is semi-public; it only for use by subclasses, all other code
349
should consider it to be private.
351
self._revision_id_to_revno_cache = revision_id_to_revno
353
def _clear_cached_state(self):
354
"""Clear any cached data on this branch, e.g. cached revision history.
356
This means the next call to revision_history will need to call
357
_gen_revision_history.
359
This API is semi-public; it only for use by subclasses, all other code
360
should consider it to be private.
362
self._revision_history_cache = None
363
self._revision_id_to_revno_cache = None
365
def _gen_revision_history(self):
366
"""Return sequence of revision hashes on to this branch.
368
Unlike revision_history, this method always regenerates or rereads the
369
revision history, i.e. it does not cache the result, so repeated calls
372
Concrete subclasses should override this instead of revision_history so
373
that subclasses do not need to deal with caching logic.
375
This API is semi-public; it only for use by subclasses, all other code
376
should consider it to be private.
378
raise NotImplementedError(self._gen_revision_history)
381
def revision_history(self):
382
"""Return sequence of revision ids on this branch.
384
This method will cache the revision history for as long as it is safe to
387
if 'evil' in debug.debug_flags:
388
mutter_callsite(3, "revision_history scales with history.")
389
if self._revision_history_cache is not None:
390
history = self._revision_history_cache
392
history = self._gen_revision_history()
393
self._cache_revision_history(history)
397
"""Return current revision number for this branch.
399
That is equivalent to the number of revisions committed to
402
return self.last_revision_info()[0]
405
"""Older format branches cannot bind or unbind."""
406
raise errors.UpgradeRequired(self.base)
408
def set_append_revisions_only(self, enabled):
409
"""Older format branches are never restricted to append-only"""
410
raise errors.UpgradeRequired(self.base)
412
def last_revision(self):
413
"""Return last revision id, or NULL_REVISION."""
414
return self.last_revision_info()[1]
416
def last_revision_info(self):
417
"""Return information about the last revision.
419
:return: A tuple (revno, last_revision_id).
421
rh = self.revision_history()
424
return (revno, rh[-1])
426
return (0, _mod_revision.NULL_REVISION)
428
@deprecated_method(deprecated_in((1, 6, 0)))
429
def missing_revisions(self, other, stop_revision=None):
430
"""Return a list of new revisions that would perfectly fit.
432
If self and other have not diverged, return a list of the revisions
433
present in other, but missing from self.
435
self_history = self.revision_history()
436
self_len = len(self_history)
437
other_history = other.revision_history()
438
other_len = len(other_history)
439
common_index = min(self_len, other_len) -1
440
if common_index >= 0 and \
441
self_history[common_index] != other_history[common_index]:
442
raise errors.DivergedBranches(self, other)
444
if stop_revision is None:
445
stop_revision = other_len
447
if stop_revision > other_len:
448
raise errors.NoSuchRevision(self, stop_revision)
449
return other_history[self_len:stop_revision]
452
def update_revisions(self, other, stop_revision=None, overwrite=False,
454
"""Pull in new perfect-fit revisions.
456
:param other: Another Branch to pull from
457
:param stop_revision: Updated until the given revision
458
:param overwrite: Always set the branch pointer, rather than checking
459
to see if it is a proper descendant.
460
:param graph: A Graph object that can be used to query history
461
information. This can be None.
466
other_revno, other_last_revision = other.last_revision_info()
467
stop_revno = None # unknown
468
if stop_revision is None:
469
stop_revision = other_last_revision
470
if _mod_revision.is_null(stop_revision):
471
# if there are no commits, we're done.
473
stop_revno = other_revno
475
# what's the current last revision, before we fetch [and change it
477
last_rev = _mod_revision.ensure_null(self.last_revision())
478
# we fetch here so that we don't process data twice in the common
479
# case of having something to pull, and so that the check for
480
# already merged can operate on the just fetched graph, which will
481
# be cached in memory.
482
self.fetch(other, stop_revision)
483
# Check to see if one is an ancestor of the other
486
graph = self.repository.get_graph()
487
if self._ensure_not_diverged(
488
stop_revision, last_rev, graph, other):
489
# stop_revision is a descendant of last_rev, but we aren't
490
# overwriting, so we're done.
492
if stop_revno is None:
494
graph = self.repository.get_graph()
495
this_revno, this_last_revision = self.last_revision_info()
496
stop_revno = graph.find_distance_to_null(stop_revision,
497
[(other_last_revision, other_revno),
498
(this_last_revision, this_revno)])
499
self.set_last_revision_info(stop_revno, stop_revision)
505
def revision_id_to_revno(self, revision_id):
506
"""Given a revision id, return its revno"""
507
if _mod_revision.is_null(revision_id):
509
history = self.revision_history()
511
return history.index(revision_id) + 1
513
raise errors.NoSuchRevision(self, revision_id)
515
def get_rev_id(self, revno, history=None):
516
"""Find the revision id of the specified revno."""
518
return _mod_revision.NULL_REVISION
520
history = self.revision_history()
521
if revno <= 0 or revno > len(history):
522
raise errors.NoSuchRevision(self, revno)
523
return history[revno - 1]
525
def pull(self, source, overwrite=False, stop_revision=None,
526
possible_transports=None, _override_hook_target=None):
527
"""Mirror source into this branch.
529
This branch is considered to be 'local', having low latency.
531
:returns: PullResult instance
533
raise NotImplementedError(self.pull)
535
def push(self, target, overwrite=False, stop_revision=None):
536
"""Mirror this branch into target.
538
This branch is considered to be 'local', having low latency.
540
raise NotImplementedError(self.push)
542
def basis_tree(self):
543
"""Return `Tree` object for last revision."""
544
return self.repository.revision_tree(self.last_revision())
546
def rename_one(self, from_rel, to_rel):
549
This can change the directory or the filename or both.
551
raise NotImplementedError(self.rename_one)
553
def move(self, from_paths, to_name):
556
to_name must exist as a versioned directory.
558
If to_name exists and is a directory, the files are moved into
559
it, keeping their old names. If it is a directory,
561
Note that to_name is only the last component of the new name;
562
this doesn't change the directory.
564
This returns a list of (from_path, to_path) pairs for each
567
raise NotImplementedError(self.move)
569
def get_parent(self):
570
"""Return the parent location of the branch.
572
This is the default location for push/pull/missing. The usual
573
pattern is that the user can override it by specifying a
576
raise NotImplementedError(self.get_parent)
578
def _set_config_location(self, name, url, config=None,
579
make_relative=False):
581
config = self.get_config()
585
url = urlutils.relative_url(self.base, url)
586
config.set_user_option(name, url, warn_masked=True)
588
def _get_config_location(self, name, config=None):
590
config = self.get_config()
591
location = config.get_user_option(name)
596
def get_submit_branch(self):
597
"""Return the submit location of the branch.
599
This is the default location for bundle. The usual
600
pattern is that the user can override it by specifying a
603
return self.get_config().get_user_option('submit_branch')
605
def set_submit_branch(self, location):
606
"""Return the submit location of the branch.
608
This is the default location for bundle. The usual
609
pattern is that the user can override it by specifying a
612
self.get_config().set_user_option('submit_branch', location,
615
def get_public_branch(self):
616
"""Return the public location of the branch.
618
This is is used by merge directives.
620
return self._get_config_location('public_branch')
622
def set_public_branch(self, location):
623
"""Return the submit location of the branch.
625
This is the default location for bundle. The usual
626
pattern is that the user can override it by specifying a
629
self._set_config_location('public_branch', location)
631
def get_push_location(self):
632
"""Return the None or the location to push this branch to."""
633
push_loc = self.get_config().get_user_option('push_location')
636
def set_push_location(self, location):
637
"""Set a new push location for this branch."""
638
raise NotImplementedError(self.set_push_location)
640
def set_parent(self, url):
641
raise NotImplementedError(self.set_parent)
645
"""Synchronise this branch with the master branch if any.
647
:return: None or the last_revision pivoted out during the update.
651
def check_revno(self, revno):
653
Check whether a revno corresponds to any revision.
654
Zero (the NULL revision) is considered valid.
657
self.check_real_revno(revno)
659
def check_real_revno(self, revno):
661
Check whether a revno corresponds to a real revision.
662
Zero (the NULL revision) is considered invalid
664
if revno < 1 or revno > self.revno():
665
raise errors.InvalidRevisionNumber(revno)
668
def clone(self, to_bzrdir, revision_id=None):
669
"""Clone this branch into to_bzrdir preserving all semantic values.
671
revision_id: if not None, the revision history in the new branch will
672
be truncated to end with revision_id.
674
result = self._format.initialize(to_bzrdir)
675
self.copy_content_into(result, revision_id=revision_id)
679
def sprout(self, to_bzrdir, revision_id=None):
680
"""Create a new line of development from the branch, into to_bzrdir.
682
revision_id: if not None, the revision history in the new branch will
683
be truncated to end with revision_id.
685
result = self._format.initialize(to_bzrdir)
686
self.copy_content_into(result, revision_id=revision_id)
687
result.set_parent(self.bzrdir.root_transport.base)
690
def _synchronize_history(self, destination, revision_id):
691
"""Synchronize last revision and revision history between branches.
693
This version is most efficient when the destination is also a
694
BzrBranch5, but works for BzrBranch6 as long as the revision
695
history is the true lefthand parent history, and all of the revisions
696
are in the destination's repository. If not, set_revision_history
699
:param destination: The branch to copy the history into
700
:param revision_id: The revision-id to truncate history at. May
701
be None to copy complete history.
703
if revision_id == _mod_revision.NULL_REVISION:
705
new_history = self.revision_history()
706
if revision_id is not None and new_history != []:
708
new_history = new_history[:new_history.index(revision_id) + 1]
710
rev = self.repository.get_revision(revision_id)
711
new_history = rev.get_history(self.repository)[1:]
712
destination.set_revision_history(new_history)
715
def copy_content_into(self, destination, revision_id=None):
716
"""Copy the content of self into destination.
718
revision_id: if not None, the revision history in the new branch will
719
be truncated to end with revision_id.
721
self._synchronize_history(destination, revision_id)
723
parent = self.get_parent()
724
except errors.InaccessibleParent, e:
725
mutter('parent was not accessible to copy: %s', e)
728
destination.set_parent(parent)
729
self.tags.merge_to(destination.tags)
733
"""Check consistency of the branch.
735
In particular this checks that revisions given in the revision-history
736
do actually match up in the revision graph, and that they're all
737
present in the repository.
739
Callers will typically also want to check the repository.
741
:return: A BranchCheckResult.
743
mainline_parent_id = None
744
last_revno, last_revision_id = self.last_revision_info()
745
real_rev_history = list(self.repository.iter_reverse_revision_history(
747
real_rev_history.reverse()
748
if len(real_rev_history) != last_revno:
749
raise errors.BzrCheckError('revno does not match len(mainline)'
750
' %s != %s' % (last_revno, len(real_rev_history)))
751
# TODO: We should probably also check that real_rev_history actually
752
# matches self.revision_history()
753
for revision_id in real_rev_history:
755
revision = self.repository.get_revision(revision_id)
756
except errors.NoSuchRevision, e:
757
raise errors.BzrCheckError("mainline revision {%s} not in repository"
759
# In general the first entry on the revision history has no parents.
760
# But it's not illegal for it to have parents listed; this can happen
761
# in imports from Arch when the parents weren't reachable.
762
if mainline_parent_id is not None:
763
if mainline_parent_id not in revision.parent_ids:
764
raise errors.BzrCheckError("previous revision {%s} not listed among "
766
% (mainline_parent_id, revision_id))
767
mainline_parent_id = revision_id
768
return BranchCheckResult(self)
770
def _get_checkout_format(self):
771
"""Return the most suitable metadir for a checkout of this branch.
772
Weaves are used if this branch's repository uses weaves.
774
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
775
from bzrlib.repofmt import weaverepo
776
format = bzrdir.BzrDirMetaFormat1()
777
format.repository_format = weaverepo.RepositoryFormat7()
779
format = self.repository.bzrdir.checkout_metadir()
780
format.set_branch_format(self._format)
783
def create_checkout(self, to_location, revision_id=None,
784
lightweight=False, accelerator_tree=None,
786
"""Create a checkout of a branch.
788
:param to_location: The url to produce the checkout at
789
:param revision_id: The revision to check out
790
:param lightweight: If True, produce a lightweight checkout, otherwise,
791
produce a bound branch (heavyweight checkout)
792
:param accelerator_tree: A tree which can be used for retrieving file
793
contents more quickly than the revision tree, i.e. a workingtree.
794
The revision tree will be used for cases where accelerator_tree's
795
content is different.
796
:param hardlink: If true, hard-link files from accelerator_tree,
798
:return: The tree of the created checkout
800
t = transport.get_transport(to_location)
803
format = self._get_checkout_format()
804
checkout = format.initialize_on_transport(t)
805
from_branch = BranchReferenceFormat().initialize(checkout, self)
807
format = self._get_checkout_format()
808
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
809
to_location, force_new_tree=False, format=format)
810
checkout = checkout_branch.bzrdir
811
checkout_branch.bind(self)
812
# pull up to the specified revision_id to set the initial
813
# branch tip correctly, and seed it with history.
814
checkout_branch.pull(self, stop_revision=revision_id)
816
tree = checkout.create_workingtree(revision_id,
817
from_branch=from_branch,
818
accelerator_tree=accelerator_tree,
820
basis_tree = tree.basis_tree()
821
basis_tree.lock_read()
823
for path, file_id in basis_tree.iter_references():
824
reference_parent = self.reference_parent(file_id, path)
825
reference_parent.create_checkout(tree.abspath(path),
826
basis_tree.get_reference_revision(file_id, path),
833
def reconcile(self, thorough=True):
834
"""Make sure the data stored in this branch is consistent."""
835
from bzrlib.reconcile import BranchReconciler
836
reconciler = BranchReconciler(self, thorough=thorough)
837
reconciler.reconcile()
840
def reference_parent(self, file_id, path):
841
"""Return the parent branch for a tree-reference file_id
842
:param file_id: The file_id of the tree reference
843
:param path: The path of the file_id in the tree
844
:return: A branch associated with the file_id
846
# FIXME should provide multiple branches, based on config
847
return Branch.open(self.bzrdir.root_transport.clone(path).base)
849
def supports_tags(self):
850
return self._format.supports_tags()
852
def _ensure_not_diverged(self, revision_a, revision_b, graph, other_branch):
853
"""Ensure that revision_b is a descendant of revision_a.
855
This is a helper function for update_revisions.
857
:raises: DivergedBranches if revision_b has diverged from revision_a.
858
:returns: True if revision_b is a descendant of revision_a.
860
relation = self._revision_relations(revision_a, revision_b, graph)
861
if relation == 'b_descends_from_a':
863
elif relation == 'diverged':
864
raise errors.DivergedBranches(self, other_branch)
865
elif relation == 'a_descends_from_b':
868
raise AssertionError("invalid heads: %r" % heads)
870
def _revision_relations(self, revision_a, revision_b, graph):
871
"""Determine the relationship between two revisions.
873
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
875
heads = graph.heads([revision_a, revision_b])
876
if heads == set([revision_b]):
877
return 'b_descends_from_a'
878
elif heads == set([revision_a, revision_b]):
879
# These branches have diverged
881
elif heads == set([revision_a]):
882
return 'a_descends_from_b'
884
raise AssertionError("invalid heads: %r" % heads)
887
class BranchFormat(object):
888
"""An encapsulation of the initialization and open routines for a format.
890
Formats provide three things:
891
* An initialization routine,
895
Formats are placed in an dict by their format string for reference
896
during branch opening. Its not required that these be instances, they
897
can be classes themselves with class methods - it simply depends on
898
whether state is needed for a given format or not.
900
Once a format is deprecated, just deprecate the initialize and open
901
methods on the format class. Do not deprecate the object, as the
902
object will be created every time regardless.
905
_default_format = None
906
"""The default format used for new branches."""
909
"""The known formats."""
911
def __eq__(self, other):
912
return self.__class__ is other.__class__
914
def __ne__(self, other):
915
return not (self == other)
918
def find_format(klass, a_bzrdir):
919
"""Return the format for the branch object in a_bzrdir."""
921
transport = a_bzrdir.get_branch_transport(None)
922
format_string = transport.get("format").read()
923
return klass._formats[format_string]
924
except errors.NoSuchFile:
925
raise errors.NotBranchError(path=transport.base)
927
raise errors.UnknownFormatError(format=format_string, kind='branch')
930
def get_default_format(klass):
931
"""Return the current default format."""
932
return klass._default_format
934
def get_reference(self, a_bzrdir):
935
"""Get the target reference of the branch in a_bzrdir.
937
format probing must have been completed before calling
938
this method - it is assumed that the format of the branch
939
in a_bzrdir is correct.
941
:param a_bzrdir: The bzrdir to get the branch data from.
942
:return: None if the branch is not a reference branch.
947
def set_reference(self, a_bzrdir, to_branch):
948
"""Set the target reference of the branch in a_bzrdir.
950
format probing must have been completed before calling
951
this method - it is assumed that the format of the branch
952
in a_bzrdir is correct.
954
:param a_bzrdir: The bzrdir to set the branch reference for.
955
:param to_branch: branch that the checkout is to reference
957
raise NotImplementedError(self.set_reference)
959
def get_format_string(self):
960
"""Return the ASCII format string that identifies this format."""
961
raise NotImplementedError(self.get_format_string)
963
def get_format_description(self):
964
"""Return the short format description for this format."""
965
raise NotImplementedError(self.get_format_description)
967
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
969
"""Initialize a branch in a bzrdir, with specified files
971
:param a_bzrdir: The bzrdir to initialize the branch in
972
:param utf8_files: The files to create as a list of
973
(filename, content) tuples
974
:param set_format: If True, set the format with
975
self.get_format_string. (BzrBranch4 has its format set
977
:return: a branch in this format
979
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
980
branch_transport = a_bzrdir.get_branch_transport(self)
982
'metadir': ('lock', lockdir.LockDir),
983
'branch4': ('branch-lock', lockable_files.TransportLock),
985
lock_name, lock_class = lock_map[lock_type]
986
control_files = lockable_files.LockableFiles(branch_transport,
987
lock_name, lock_class)
988
control_files.create_lock()
989
control_files.lock_write()
991
utf8_files += [('format', self.get_format_string())]
993
for (filename, content) in utf8_files:
994
branch_transport.put_bytes(
996
mode=a_bzrdir._get_file_mode())
998
control_files.unlock()
999
return self.open(a_bzrdir, _found=True)
1001
def initialize(self, a_bzrdir):
1002
"""Create a branch of this format in a_bzrdir."""
1003
raise NotImplementedError(self.initialize)
1005
def is_supported(self):
1006
"""Is this format supported?
1008
Supported formats can be initialized and opened.
1009
Unsupported formats may not support initialization or committing or
1010
some other features depending on the reason for not being supported.
1014
def open(self, a_bzrdir, _found=False):
1015
"""Return the branch object for a_bzrdir
1017
_found is a private parameter, do not use it. It is used to indicate
1018
if format probing has already be done.
1020
raise NotImplementedError(self.open)
1023
def register_format(klass, format):
1024
klass._formats[format.get_format_string()] = format
1027
def set_default_format(klass, format):
1028
klass._default_format = format
1031
def unregister_format(klass, format):
1032
del klass._formats[format.get_format_string()]
1035
return self.get_format_string().rstrip()
1037
def supports_tags(self):
1038
"""True if this format supports tags stored in the branch"""
1039
return False # by default
1042
class BranchHooks(Hooks):
1043
"""A dictionary mapping hook name to a list of callables for branch hooks.
1045
e.g. ['set_rh'] Is the list of items to be called when the
1046
set_revision_history function is invoked.
1050
"""Create the default hooks.
1052
These are all empty initially, because by default nothing should get
1055
Hooks.__init__(self)
1056
# Introduced in 0.15:
1057
# invoked whenever the revision history has been set
1058
# with set_revision_history. The api signature is
1059
# (branch, revision_history), and the branch will
1062
# invoked after a push operation completes.
1063
# the api signature is
1065
# containing the members
1066
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1067
# where local is the local target branch or None, master is the target
1068
# master branch, and the rest should be self explanatory. The source
1069
# is read locked and the target branches write locked. Source will
1070
# be the local low-latency branch.
1071
self['post_push'] = []
1072
# invoked after a pull operation completes.
1073
# the api signature is
1075
# containing the members
1076
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1077
# where local is the local branch or None, master is the target
1078
# master branch, and the rest should be self explanatory. The source
1079
# is read locked and the target branches write locked. The local
1080
# branch is the low-latency branch.
1081
self['post_pull'] = []
1082
# invoked before a commit operation takes place.
1083
# the api signature is
1084
# (local, master, old_revno, old_revid, future_revno, future_revid,
1085
# tree_delta, future_tree).
1086
# old_revid is NULL_REVISION for the first commit to a branch
1087
# tree_delta is a TreeDelta object describing changes from the basis
1088
# revision, hooks MUST NOT modify this delta
1089
# future_tree is an in-memory tree obtained from
1090
# CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
1091
self['pre_commit'] = []
1092
# invoked after a commit operation completes.
1093
# the api signature is
1094
# (local, master, old_revno, old_revid, new_revno, new_revid)
1095
# old_revid is NULL_REVISION for the first commit to a branch.
1096
self['post_commit'] = []
1097
# invoked after a uncommit operation completes.
1098
# the api signature is
1099
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1100
# local is the local branch or None, master is the target branch,
1101
# and an empty branch recieves new_revno of 0, new_revid of None.
1102
self['post_uncommit'] = []
1104
# Invoked after the tip of a branch changes.
1105
# the api signature is
1106
# (params) where params is a ChangeBranchTipParams with the members
1107
# (branch, old_revno, new_revno, old_revid, new_revid)
1108
self['post_change_branch_tip'] = []
1111
# install the default hooks into the Branch class.
1112
Branch.hooks = BranchHooks()
1115
class ChangeBranchTipParams(object):
1116
"""Object holding parameters passed to *_change_branch_tip hooks.
1118
There are 5 fields that hooks may wish to access:
1120
:ivar branch: the branch being changed
1121
:ivar old_revno: revision number before the change
1122
:ivar new_revno: revision number after the change
1123
:ivar old_revid: revision id before the change
1124
:ivar new_revid: revision id after the change
1126
The revid fields are strings. The revno fields are integers.
1129
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1130
"""Create a group of ChangeBranchTip parameters.
1132
:param branch: The branch being changed.
1133
:param old_revno: Revision number before the change.
1134
:param new_revno: Revision number after the change.
1135
:param old_revid: Tip revision id before the change.
1136
:param new_revid: Tip revision id after the change.
1138
self.branch = branch
1139
self.old_revno = old_revno
1140
self.new_revno = new_revno
1141
self.old_revid = old_revid
1142
self.new_revid = new_revid
1145
class BzrBranchFormat4(BranchFormat):
1146
"""Bzr branch format 4.
1149
- a revision-history file.
1150
- a branch-lock lock file [ to be shared with the bzrdir ]
1153
def get_format_description(self):
1154
"""See BranchFormat.get_format_description()."""
1155
return "Branch format 4"
1157
def initialize(self, a_bzrdir):
1158
"""Create a branch of this format in a_bzrdir."""
1159
utf8_files = [('revision-history', ''),
1160
('branch-name', ''),
1162
return self._initialize_helper(a_bzrdir, utf8_files,
1163
lock_type='branch4', set_format=False)
1166
super(BzrBranchFormat4, self).__init__()
1167
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1169
def open(self, a_bzrdir, _found=False):
1170
"""Return the branch object for a_bzrdir
1172
_found is a private parameter, do not use it. It is used to indicate
1173
if format probing has already be done.
1176
# we are being called directly and must probe.
1177
raise NotImplementedError
1178
return BzrBranch(_format=self,
1179
_control_files=a_bzrdir._control_files,
1181
_repository=a_bzrdir.open_repository())
1184
return "Bazaar-NG branch format 4"
1187
class BzrBranchFormat5(BranchFormat):
1188
"""Bzr branch format 5.
1191
- a revision-history file.
1193
- a lock dir guarding the branch itself
1194
- all of this stored in a branch/ subdirectory
1195
- works with shared repositories.
1197
This format is new in bzr 0.8.
1200
def get_format_string(self):
1201
"""See BranchFormat.get_format_string()."""
1202
return "Bazaar-NG branch format 5\n"
1204
def get_format_description(self):
1205
"""See BranchFormat.get_format_description()."""
1206
return "Branch format 5"
1208
def initialize(self, a_bzrdir):
1209
"""Create a branch of this format in a_bzrdir."""
1210
utf8_files = [('revision-history', ''),
1211
('branch-name', ''),
1213
return self._initialize_helper(a_bzrdir, utf8_files)
1216
super(BzrBranchFormat5, self).__init__()
1217
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1219
def open(self, a_bzrdir, _found=False):
1220
"""Return the branch object for a_bzrdir
1222
_found is a private parameter, do not use it. It is used to indicate
1223
if format probing has already be done.
1226
format = BranchFormat.find_format(a_bzrdir)
1227
if format.__class__ != self.__class__:
1228
raise AssertionError("wrong format %r found for %r" %
1231
transport = a_bzrdir.get_branch_transport(None)
1232
control_files = lockable_files.LockableFiles(transport, 'lock',
1234
return BzrBranch5(_format=self,
1235
_control_files=control_files,
1237
_repository=a_bzrdir.find_repository())
1238
except errors.NoSuchFile:
1239
raise errors.NotBranchError(path=transport.base)
1242
class BzrBranchFormat6(BzrBranchFormat5):
1243
"""Branch format with last-revision and tags.
1245
Unlike previous formats, this has no explicit revision history. Instead,
1246
this just stores the last-revision, and the left-hand history leading
1247
up to there is the history.
1249
This format was introduced in bzr 0.15
1250
and became the default in 0.91.
1253
def get_format_string(self):
1254
"""See BranchFormat.get_format_string()."""
1255
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1257
def get_format_description(self):
1258
"""See BranchFormat.get_format_description()."""
1259
return "Branch format 6"
1261
def initialize(self, a_bzrdir):
1262
"""Create a branch of this format in a_bzrdir."""
1263
utf8_files = [('last-revision', '0 null:\n'),
1264
('branch.conf', ''),
1267
return self._initialize_helper(a_bzrdir, utf8_files)
1269
def open(self, a_bzrdir, _found=False):
1270
"""Return the branch object for a_bzrdir
1272
_found is a private parameter, do not use it. It is used to indicate
1273
if format probing has already be done.
1276
format = BranchFormat.find_format(a_bzrdir)
1277
if format.__class__ != self.__class__:
1278
raise AssertionError("wrong format %r found for %r" %
1280
transport = a_bzrdir.get_branch_transport(None)
1281
control_files = lockable_files.LockableFiles(transport, 'lock',
1283
return BzrBranch6(_format=self,
1284
_control_files=control_files,
1286
_repository=a_bzrdir.find_repository())
1288
def supports_tags(self):
1292
class BranchReferenceFormat(BranchFormat):
1293
"""Bzr branch reference format.
1295
Branch references are used in implementing checkouts, they
1296
act as an alias to the real branch which is at some other url.
1303
def get_format_string(self):
1304
"""See BranchFormat.get_format_string()."""
1305
return "Bazaar-NG Branch Reference Format 1\n"
1307
def get_format_description(self):
1308
"""See BranchFormat.get_format_description()."""
1309
return "Checkout reference format 1"
1311
def get_reference(self, a_bzrdir):
1312
"""See BranchFormat.get_reference()."""
1313
transport = a_bzrdir.get_branch_transport(None)
1314
return transport.get('location').read()
1316
def set_reference(self, a_bzrdir, to_branch):
1317
"""See BranchFormat.set_reference()."""
1318
transport = a_bzrdir.get_branch_transport(None)
1319
location = transport.put_bytes('location', to_branch.base)
1321
def initialize(self, a_bzrdir, target_branch=None):
1322
"""Create a branch of this format in a_bzrdir."""
1323
if target_branch is None:
1324
# this format does not implement branch itself, thus the implicit
1325
# creation contract must see it as uninitializable
1326
raise errors.UninitializableFormat(self)
1327
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1328
branch_transport = a_bzrdir.get_branch_transport(self)
1329
branch_transport.put_bytes('location',
1330
target_branch.bzrdir.root_transport.base)
1331
branch_transport.put_bytes('format', self.get_format_string())
1333
a_bzrdir, _found=True,
1334
possible_transports=[target_branch.bzrdir.root_transport])
1337
super(BranchReferenceFormat, self).__init__()
1338
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1340
def _make_reference_clone_function(format, a_branch):
1341
"""Create a clone() routine for a branch dynamically."""
1342
def clone(to_bzrdir, revision_id=None):
1343
"""See Branch.clone()."""
1344
return format.initialize(to_bzrdir, a_branch)
1345
# cannot obey revision_id limits when cloning a reference ...
1346
# FIXME RBC 20060210 either nuke revision_id for clone, or
1347
# emit some sort of warning/error to the caller ?!
1350
def open(self, a_bzrdir, _found=False, location=None,
1351
possible_transports=None):
1352
"""Return the branch that the branch reference in a_bzrdir points at.
1354
_found is a private parameter, do not use it. It is used to indicate
1355
if format probing has already be done.
1358
format = BranchFormat.find_format(a_bzrdir)
1359
if format.__class__ != self.__class__:
1360
raise AssertionError("wrong format %r found for %r" %
1362
if location is None:
1363
location = self.get_reference(a_bzrdir)
1364
real_bzrdir = bzrdir.BzrDir.open(
1365
location, possible_transports=possible_transports)
1366
result = real_bzrdir.open_branch()
1367
# this changes the behaviour of result.clone to create a new reference
1368
# rather than a copy of the content of the branch.
1369
# I did not use a proxy object because that needs much more extensive
1370
# testing, and we are only changing one behaviour at the moment.
1371
# If we decide to alter more behaviours - i.e. the implicit nickname
1372
# then this should be refactored to introduce a tested proxy branch
1373
# and a subclass of that for use in overriding clone() and ....
1375
result.clone = self._make_reference_clone_function(result)
1379
# formats which have no format string are not discoverable
1380
# and not independently creatable, so are not registered.
1381
__format5 = BzrBranchFormat5()
1382
__format6 = BzrBranchFormat6()
1383
BranchFormat.register_format(__format5)
1384
BranchFormat.register_format(BranchReferenceFormat())
1385
BranchFormat.register_format(__format6)
1386
BranchFormat.set_default_format(__format6)
1387
_legacy_formats = [BzrBranchFormat4(),
1390
class BzrBranch(Branch):
1391
"""A branch stored in the actual filesystem.
1393
Note that it's "local" in the context of the filesystem; it doesn't
1394
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1395
it's writable, and can be accessed via the normal filesystem API.
1397
:ivar _transport: Transport for file operations on this branch's
1398
control files, typically pointing to the .bzr/branch directory.
1399
:ivar repository: Repository for this branch.
1400
:ivar base: The url of the base directory for this branch; the one
1401
containing the .bzr directory.
1404
def __init__(self, _format=None,
1405
_control_files=None, a_bzrdir=None, _repository=None):
1406
"""Create new branch object at a particular location."""
1407
Branch.__init__(self)
1408
if a_bzrdir is None:
1409
raise ValueError('a_bzrdir must be supplied')
1411
self.bzrdir = a_bzrdir
1412
self._base = self.bzrdir.transport.clone('..').base
1413
# XXX: We should be able to just do
1414
# self.base = self.bzrdir.root_transport.base
1415
# but this does not quite work yet -- mbp 20080522
1416
self._format = _format
1417
if _control_files is None:
1418
raise ValueError('BzrBranch _control_files is None')
1419
self.control_files = _control_files
1420
self._transport = _control_files._transport
1421
self.repository = _repository
1424
return '%s(%r)' % (self.__class__.__name__, self.base)
1428
def _get_base(self):
1429
"""Returns the directory containing the control directory."""
1432
base = property(_get_base, doc="The URL for the root of this branch.")
1434
@deprecated_method(deprecated_in((0, 16, 0)))
1435
def abspath(self, name):
1436
"""See Branch.abspath."""
1437
return self._transport.abspath(name)
1439
def is_locked(self):
1440
return self.control_files.is_locked()
1442
def lock_write(self, token=None):
1443
repo_token = self.repository.lock_write()
1445
token = self.control_files.lock_write(token=token)
1447
self.repository.unlock()
1451
def lock_read(self):
1452
self.repository.lock_read()
1454
self.control_files.lock_read()
1456
self.repository.unlock()
1460
# TODO: test for failed two phase locks. This is known broken.
1462
self.control_files.unlock()
1464
self.repository.unlock()
1465
if not self.control_files.is_locked():
1466
# we just released the lock
1467
self._clear_cached_state()
1469
def peek_lock_mode(self):
1470
if self.control_files._lock_count == 0:
1473
return self.control_files._lock_mode
1475
def get_physical_lock_status(self):
1476
return self.control_files.get_physical_lock_status()
1479
def print_file(self, file, revision_id):
1480
"""See Branch.print_file."""
1481
return self.repository.print_file(file, revision_id)
1483
def _write_revision_history(self, history):
1484
"""Factored out of set_revision_history.
1486
This performs the actual writing to disk.
1487
It is intended to be called by BzrBranch5.set_revision_history."""
1488
self._transport.put_bytes(
1489
'revision-history', '\n'.join(history),
1490
mode=self.bzrdir._get_file_mode())
1493
def set_revision_history(self, rev_history):
1494
"""See Branch.set_revision_history."""
1495
if 'evil' in debug.debug_flags:
1496
mutter_callsite(3, "set_revision_history scales with history.")
1497
self._write_revision_history(rev_history)
1498
self._clear_cached_state()
1499
self._cache_revision_history(rev_history)
1500
for hook in Branch.hooks['set_rh']:
1501
hook(self, rev_history)
1503
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1504
"""Run the post_change_branch_tip hooks."""
1505
hooks = Branch.hooks['post_change_branch_tip']
1508
new_revno, new_revid = self.last_revision_info()
1509
params = ChangeBranchTipParams(
1510
self, old_revno, new_revno, old_revid, new_revid)
1515
def set_last_revision_info(self, revno, revision_id):
1516
"""Set the last revision of this branch.
1518
The caller is responsible for checking that the revno is correct
1519
for this revision id.
1521
It may be possible to set the branch last revision to an id not
1522
present in the repository. However, branches can also be
1523
configured to check constraints on history, in which case this may not
1526
revision_id = _mod_revision.ensure_null(revision_id)
1527
old_revno, old_revid = self.last_revision_info()
1528
# this old format stores the full history, but this api doesn't
1529
# provide it, so we must generate, and might as well check it's
1531
history = self._lefthand_history(revision_id)
1532
if len(history) != revno:
1533
raise AssertionError('%d != %d' % (len(history), revno))
1534
self.set_revision_history(history)
1535
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1537
def _gen_revision_history(self):
1538
history = self._transport.get_bytes('revision-history').split('\n')
1539
if history[-1:] == ['']:
1540
# There shouldn't be a trailing newline, but just in case.
1544
def _lefthand_history(self, revision_id, last_rev=None,
1546
if 'evil' in debug.debug_flags:
1547
mutter_callsite(4, "_lefthand_history scales with history.")
1548
# stop_revision must be a descendant of last_revision
1549
graph = self.repository.get_graph()
1550
if last_rev is not None:
1551
if not graph.is_ancestor(last_rev, revision_id):
1552
# our previous tip is not merged into stop_revision
1553
raise errors.DivergedBranches(self, other_branch)
1554
# make a new revision history from the graph
1555
parents_map = graph.get_parent_map([revision_id])
1556
if revision_id not in parents_map:
1557
raise errors.NoSuchRevision(self, revision_id)
1558
current_rev_id = revision_id
1560
# Do not include ghosts or graph origin in revision_history
1561
while (current_rev_id in parents_map and
1562
len(parents_map[current_rev_id]) > 0):
1563
new_history.append(current_rev_id)
1564
current_rev_id = parents_map[current_rev_id][0]
1565
parents_map = graph.get_parent_map([current_rev_id])
1566
new_history.reverse()
1570
def generate_revision_history(self, revision_id, last_rev=None,
1572
"""Create a new revision history that will finish with revision_id.
1574
:param revision_id: the new tip to use.
1575
:param last_rev: The previous last_revision. If not None, then this
1576
must be a ancestory of revision_id, or DivergedBranches is raised.
1577
:param other_branch: The other branch that DivergedBranches should
1578
raise with respect to.
1580
self.set_revision_history(self._lefthand_history(revision_id,
1581
last_rev, other_branch))
1583
def basis_tree(self):
1584
"""See Branch.basis_tree."""
1585
return self.repository.revision_tree(self.last_revision())
1588
def pull(self, source, overwrite=False, stop_revision=None,
1589
_hook_master=None, run_hooks=True, possible_transports=None,
1590
_override_hook_target=None):
1593
:param _hook_master: Private parameter - set the branch to
1594
be supplied as the master to pull hooks.
1595
:param run_hooks: Private parameter - if false, this branch
1596
is being called because it's the master of the primary branch,
1597
so it should not run its hooks.
1598
:param _override_hook_target: Private parameter - set the branch to be
1599
supplied as the target_branch to pull hooks.
1601
result = PullResult()
1602
result.source_branch = source
1603
if _override_hook_target is None:
1604
result.target_branch = self
1606
result.target_branch = _override_hook_target
1609
# We assume that during 'pull' the local repository is closer than
1611
graph = self.repository.get_graph(source.repository)
1612
result.old_revno, result.old_revid = self.last_revision_info()
1613
self.update_revisions(source, stop_revision, overwrite=overwrite,
1615
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
1616
result.new_revno, result.new_revid = self.last_revision_info()
1618
result.master_branch = _hook_master
1619
result.local_branch = result.target_branch
1621
result.master_branch = result.target_branch
1622
result.local_branch = None
1624
for hook in Branch.hooks['post_pull']:
1630
def _get_parent_location(self):
1631
_locs = ['parent', 'pull', 'x-pull']
1634
return self._transport.get_bytes(l).strip('\n')
1635
except errors.NoSuchFile:
1640
def push(self, target, overwrite=False, stop_revision=None,
1641
_override_hook_source_branch=None):
1644
This is the basic concrete implementation of push()
1646
:param _override_hook_source_branch: If specified, run
1647
the hooks passing this Branch as the source, rather than self.
1648
This is for use of RemoteBranch, where push is delegated to the
1649
underlying vfs-based Branch.
1651
# TODO: Public option to disable running hooks - should be trivial but
1655
result = self._push_with_bound_branches(target, overwrite,
1657
_override_hook_source_branch=_override_hook_source_branch)
1662
def _push_with_bound_branches(self, target, overwrite,
1664
_override_hook_source_branch=None):
1665
"""Push from self into target, and into target's master if any.
1667
This is on the base BzrBranch class even though it doesn't support
1668
bound branches because the *target* might be bound.
1671
if _override_hook_source_branch:
1672
result.source_branch = _override_hook_source_branch
1673
for hook in Branch.hooks['post_push']:
1676
bound_location = target.get_bound_location()
1677
if bound_location and target.base != bound_location:
1678
# there is a master branch.
1680
# XXX: Why the second check? Is it even supported for a branch to
1681
# be bound to itself? -- mbp 20070507
1682
master_branch = target.get_master_branch()
1683
master_branch.lock_write()
1685
# push into the master from this branch.
1686
self._basic_push(master_branch, overwrite, stop_revision)
1687
# and push into the target branch from this. Note that we push from
1688
# this branch again, because its considered the highest bandwidth
1690
result = self._basic_push(target, overwrite, stop_revision)
1691
result.master_branch = master_branch
1692
result.local_branch = target
1696
master_branch.unlock()
1699
result = self._basic_push(target, overwrite, stop_revision)
1700
# TODO: Why set master_branch and local_branch if there's no
1701
# binding? Maybe cleaner to just leave them unset? -- mbp
1703
result.master_branch = target
1704
result.local_branch = None
1708
def _basic_push(self, target, overwrite, stop_revision):
1709
"""Basic implementation of push without bound branches or hooks.
1711
Must be called with self read locked and target write locked.
1713
result = PushResult()
1714
result.source_branch = self
1715
result.target_branch = target
1716
result.old_revno, result.old_revid = target.last_revision_info()
1718
# We assume that during 'push' this repository is closer than
1720
graph = self.repository.get_graph(target.repository)
1721
target.update_revisions(self, stop_revision, overwrite=overwrite,
1723
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
1724
result.new_revno, result.new_revid = target.last_revision_info()
1727
def get_parent(self):
1728
"""See Branch.get_parent."""
1729
parent = self._get_parent_location()
1732
# This is an old-format absolute path to a local branch
1733
# turn it into a url
1734
if parent.startswith('/'):
1735
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1737
return urlutils.join(self.base[:-1], parent)
1738
except errors.InvalidURLJoin, e:
1739
raise errors.InaccessibleParent(parent, self.base)
1741
def set_push_location(self, location):
1742
"""See Branch.set_push_location."""
1743
self.get_config().set_user_option(
1744
'push_location', location,
1745
store=_mod_config.STORE_LOCATION_NORECURSE)
1748
def set_parent(self, url):
1749
"""See Branch.set_parent."""
1750
# TODO: Maybe delete old location files?
1751
# URLs should never be unicode, even on the local fs,
1752
# FIXUP this and get_parent in a future branch format bump:
1753
# read and rewrite the file. RBC 20060125
1755
if isinstance(url, unicode):
1757
url = url.encode('ascii')
1758
except UnicodeEncodeError:
1759
raise errors.InvalidURL(url,
1760
"Urls must be 7-bit ascii, "
1761
"use bzrlib.urlutils.escape")
1762
url = urlutils.relative_url(self.base, url)
1763
self._set_parent_location(url)
1765
def _set_parent_location(self, url):
1767
self._transport.delete('parent')
1769
self._transport.put_bytes('parent', url + '\n',
1770
mode=self.bzrdir._get_file_mode())
1773
class BzrBranch5(BzrBranch):
1774
"""A format 5 branch. This supports new features over plain branches.
1776
It has support for a master_branch which is the data for bound branches.
1784
super(BzrBranch5, self).__init__(_format=_format,
1785
_control_files=_control_files,
1787
_repository=_repository)
1790
def pull(self, source, overwrite=False, stop_revision=None,
1791
run_hooks=True, possible_transports=None,
1792
_override_hook_target=None):
1793
"""Pull from source into self, updating my master if any.
1795
:param run_hooks: Private parameter - if false, this branch
1796
is being called because it's the master of the primary branch,
1797
so it should not run its hooks.
1799
bound_location = self.get_bound_location()
1800
master_branch = None
1801
if bound_location and source.base != bound_location:
1802
# not pulling from master, so we need to update master.
1803
master_branch = self.get_master_branch(possible_transports)
1804
master_branch.lock_write()
1807
# pull from source into master.
1808
master_branch.pull(source, overwrite, stop_revision,
1810
return super(BzrBranch5, self).pull(source, overwrite,
1811
stop_revision, _hook_master=master_branch,
1812
run_hooks=run_hooks,
1813
_override_hook_target=_override_hook_target)
1816
master_branch.unlock()
1818
def get_bound_location(self):
1820
return self._transport.get_bytes('bound')[:-1]
1821
except errors.NoSuchFile:
1825
def get_master_branch(self, possible_transports=None):
1826
"""Return the branch we are bound to.
1828
:return: Either a Branch, or None
1830
This could memoise the branch, but if thats done
1831
it must be revalidated on each new lock.
1832
So for now we just don't memoise it.
1833
# RBC 20060304 review this decision.
1835
bound_loc = self.get_bound_location()
1839
return Branch.open(bound_loc,
1840
possible_transports=possible_transports)
1841
except (errors.NotBranchError, errors.ConnectionError), e:
1842
raise errors.BoundBranchConnectionFailure(
1846
def set_bound_location(self, location):
1847
"""Set the target where this branch is bound to.
1849
:param location: URL to the target branch
1852
self._transport.put_bytes('bound', location+'\n',
1853
mode=self.bzrdir._get_file_mode())
1856
self._transport.delete('bound')
1857
except errors.NoSuchFile:
1862
def bind(self, other):
1863
"""Bind this branch to the branch other.
1865
This does not push or pull data between the branches, though it does
1866
check for divergence to raise an error when the branches are not
1867
either the same, or one a prefix of the other. That behaviour may not
1868
be useful, so that check may be removed in future.
1870
:param other: The branch to bind to
1873
# TODO: jam 20051230 Consider checking if the target is bound
1874
# It is debatable whether you should be able to bind to
1875
# a branch which is itself bound.
1876
# Committing is obviously forbidden,
1877
# but binding itself may not be.
1878
# Since we *have* to check at commit time, we don't
1879
# *need* to check here
1881
# we want to raise diverged if:
1882
# last_rev is not in the other_last_rev history, AND
1883
# other_last_rev is not in our history, and do it without pulling
1885
self.set_bound_location(other.base)
1889
"""If bound, unbind"""
1890
return self.set_bound_location(None)
1893
def update(self, possible_transports=None):
1894
"""Synchronise this branch with the master branch if any.
1896
:return: None or the last_revision that was pivoted out during the
1899
master = self.get_master_branch(possible_transports)
1900
if master is not None:
1901
old_tip = _mod_revision.ensure_null(self.last_revision())
1902
self.pull(master, overwrite=True)
1903
if self.repository.get_graph().is_ancestor(old_tip,
1904
_mod_revision.ensure_null(self.last_revision())):
1910
class BzrBranch6(BzrBranch5):
1912
def __init__(self, *args, **kwargs):
1913
super(BzrBranch6, self).__init__(*args, **kwargs)
1914
self._last_revision_info_cache = None
1915
self._partial_revision_history_cache = []
1917
def _clear_cached_state(self):
1918
super(BzrBranch6, self)._clear_cached_state()
1919
self._last_revision_info_cache = None
1920
self._partial_revision_history_cache = []
1923
def last_revision_info(self):
1924
"""Return information about the last revision.
1926
:return: A tuple (revno, revision_id).
1928
if self._last_revision_info_cache is None:
1929
self._last_revision_info_cache = self._last_revision_info()
1930
return self._last_revision_info_cache
1932
def _last_revision_info(self):
1933
revision_string = self._transport.get_bytes('last-revision')
1934
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1935
revision_id = cache_utf8.get_cached_utf8(revision_id)
1937
return revno, revision_id
1939
def _write_last_revision_info(self, revno, revision_id):
1940
"""Simply write out the revision id, with no checks.
1942
Use set_last_revision_info to perform this safely.
1944
Does not update the revision_history cache.
1945
Intended to be called by set_last_revision_info and
1946
_write_revision_history.
1948
revision_id = _mod_revision.ensure_null(revision_id)
1949
out_string = '%d %s\n' % (revno, revision_id)
1950
self._transport.put_bytes('last-revision', out_string,
1951
mode=self.bzrdir._get_file_mode())
1954
def set_last_revision_info(self, revno, revision_id):
1955
revision_id = _mod_revision.ensure_null(revision_id)
1956
old_revno, old_revid = self.last_revision_info()
1957
if self._get_append_revisions_only():
1958
self._check_history_violation(revision_id)
1959
self._write_last_revision_info(revno, revision_id)
1960
self._clear_cached_state()
1961
self._last_revision_info_cache = revno, revision_id
1962
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1964
def _check_history_violation(self, revision_id):
1965
last_revision = _mod_revision.ensure_null(self.last_revision())
1966
if _mod_revision.is_null(last_revision):
1968
if last_revision not in self._lefthand_history(revision_id):
1969
raise errors.AppendRevisionsOnlyViolation(self.base)
1971
def _gen_revision_history(self):
1972
"""Generate the revision history from last revision
1974
last_revno, last_revision = self.last_revision_info()
1975
self._extend_partial_history(stop_index=last_revno-1)
1976
return list(reversed(self._partial_revision_history_cache))
1978
def _extend_partial_history(self, stop_index=None, stop_revision=None):
1979
"""Extend the partial history to include a given index
1981
If a stop_index is supplied, stop when that index has been reached.
1982
If a stop_revision is supplied, stop when that revision is
1983
encountered. Otherwise, stop when the beginning of history is
1986
:param stop_index: The index which should be present. When it is
1987
present, history extension will stop.
1988
:param revision_id: The revision id which should be present. When
1989
it is encountered, history extension will stop.
1991
repo = self.repository
1992
if len(self._partial_revision_history_cache) == 0:
1993
iterator = repo.iter_reverse_revision_history(self.last_revision())
1995
start_revision = self._partial_revision_history_cache[-1]
1996
iterator = repo.iter_reverse_revision_history(start_revision)
1997
#skip the last revision in the list
1998
next_revision = iterator.next()
1999
for revision_id in iterator:
2000
self._partial_revision_history_cache.append(revision_id)
2001
if (stop_index is not None and
2002
len(self._partial_revision_history_cache) > stop_index):
2004
if revision_id == stop_revision:
2007
def _write_revision_history(self, history):
2008
"""Factored out of set_revision_history.
2010
This performs the actual writing to disk, with format-specific checks.
2011
It is intended to be called by BzrBranch5.set_revision_history.
2013
if len(history) == 0:
2014
last_revision = 'null:'
2016
if history != self._lefthand_history(history[-1]):
2017
raise errors.NotLefthandHistory(history)
2018
last_revision = history[-1]
2019
if self._get_append_revisions_only():
2020
self._check_history_violation(last_revision)
2021
self._write_last_revision_info(len(history), last_revision)
2024
def _set_parent_location(self, url):
2025
"""Set the parent branch"""
2026
self._set_config_location('parent_location', url, make_relative=True)
2029
def _get_parent_location(self):
2030
"""Set the parent branch"""
2031
return self._get_config_location('parent_location')
2033
def set_push_location(self, location):
2034
"""See Branch.set_push_location."""
2035
self._set_config_location('push_location', location)
2037
def set_bound_location(self, location):
2038
"""See Branch.set_push_location."""
2040
config = self.get_config()
2041
if location is None:
2042
if config.get_user_option('bound') != 'True':
2045
config.set_user_option('bound', 'False', warn_masked=True)
2048
self._set_config_location('bound_location', location,
2050
config.set_user_option('bound', 'True', warn_masked=True)
2053
def _get_bound_location(self, bound):
2054
"""Return the bound location in the config file.
2056
Return None if the bound parameter does not match"""
2057
config = self.get_config()
2058
config_bound = (config.get_user_option('bound') == 'True')
2059
if config_bound != bound:
2061
return self._get_config_location('bound_location', config=config)
2063
def get_bound_location(self):
2064
"""See Branch.set_push_location."""
2065
return self._get_bound_location(True)
2067
def get_old_bound_location(self):
2068
"""See Branch.get_old_bound_location"""
2069
return self._get_bound_location(False)
2071
def set_append_revisions_only(self, enabled):
2076
self.get_config().set_user_option('append_revisions_only', value,
2079
def _get_append_revisions_only(self):
2080
value = self.get_config().get_user_option('append_revisions_only')
2081
return value == 'True'
2083
def _synchronize_history(self, destination, revision_id):
2084
"""Synchronize last revision and revision history between branches.
2086
This version is most efficient when the destination is also a
2087
BzrBranch6, but works for BzrBranch5, as long as the destination's
2088
repository contains all the lefthand ancestors of the intended
2089
last_revision. If not, set_last_revision_info will fail.
2091
:param destination: The branch to copy the history into
2092
:param revision_id: The revision-id to truncate history at. May
2093
be None to copy complete history.
2095
source_revno, source_revision_id = self.last_revision_info()
2096
if revision_id is None:
2097
revno, revision_id = source_revno, source_revision_id
2098
elif source_revision_id == revision_id:
2099
# we know the revno without needing to walk all of history
2100
revno = source_revno
2102
# To figure out the revno for a random revision, we need to build
2103
# the revision history, and count its length.
2104
# We don't care about the order, just how long it is.
2105
# Alternatively, we could start at the current location, and count
2106
# backwards. But there is no guarantee that we will find it since
2107
# it may be a merged revision.
2108
revno = len(list(self.repository.iter_reverse_revision_history(
2110
destination.set_last_revision_info(revno, revision_id)
2112
def _make_tags(self):
2113
return BasicTags(self)
2116
def generate_revision_history(self, revision_id, last_rev=None,
2118
"""See BzrBranch5.generate_revision_history"""
2119
history = self._lefthand_history(revision_id, last_rev, other_branch)
2120
revno = len(history)
2121
self.set_last_revision_info(revno, revision_id)
2124
def get_rev_id(self, revno, history=None):
2125
"""Find the revision id of the specified revno."""
2127
return _mod_revision.NULL_REVISION
2129
last_revno, last_revision_id = self.last_revision_info()
2130
if revno <= 0 or revno > last_revno:
2131
raise errors.NoSuchRevision(self, revno)
2133
if history is not None:
2134
return history[revno - 1]
2136
index = last_revno - revno
2137
if len(self._partial_revision_history_cache) <= index:
2138
self._extend_partial_history(stop_index=index)
2139
if len(self._partial_revision_history_cache) > index:
2140
return self._partial_revision_history_cache[index]
2142
raise errors.NoSuchRevision(self, revno)
2145
def revision_id_to_revno(self, revision_id):
2146
"""Given a revision id, return its revno"""
2147
if _mod_revision.is_null(revision_id):
2150
index = self._partial_revision_history_cache.index(revision_id)
2152
self._extend_partial_history(stop_revision=revision_id)
2153
index = len(self._partial_revision_history_cache) - 1
2154
if self._partial_revision_history_cache[index] != revision_id:
2155
raise errors.NoSuchRevision(self, revision_id)
2156
return self.revno() - index
2159
######################################################################
2160
# results of operations
2163
class _Result(object):
2165
def _show_tag_conficts(self, to_file):
2166
if not getattr(self, 'tag_conflicts', None):
2168
to_file.write('Conflicting tags:\n')
2169
for name, value1, value2 in self.tag_conflicts:
2170
to_file.write(' %s\n' % (name, ))
2173
class PullResult(_Result):
2174
"""Result of a Branch.pull operation.
2176
:ivar old_revno: Revision number before pull.
2177
:ivar new_revno: Revision number after pull.
2178
:ivar old_revid: Tip revision id before pull.
2179
:ivar new_revid: Tip revision id after pull.
2180
:ivar source_branch: Source (local) branch object.
2181
:ivar master_branch: Master branch of the target, or the target if no
2183
:ivar local_branch: target branch if there is a Master, else None
2184
:ivar target_branch: Target/destination branch object.
2185
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2189
# DEPRECATED: pull used to return the change in revno
2190
return self.new_revno - self.old_revno
2192
def report(self, to_file):
2194
if self.old_revid == self.new_revid:
2195
to_file.write('No revisions to pull.\n')
2197
to_file.write('Now on revision %d.\n' % self.new_revno)
2198
self._show_tag_conficts(to_file)
2201
class PushResult(_Result):
2202
"""Result of a Branch.push operation.
2204
:ivar old_revno: Revision number before push.
2205
:ivar new_revno: Revision number after push.
2206
:ivar old_revid: Tip revision id before push.
2207
:ivar new_revid: Tip revision id after push.
2208
:ivar source_branch: Source branch object.
2209
:ivar master_branch: Master branch of the target, or None.
2210
:ivar target_branch: Target/destination branch object.
2214
# DEPRECATED: push used to return the change in revno
2215
return self.new_revno - self.old_revno
2217
def report(self, to_file):
2218
"""Write a human-readable description of the result."""
2219
if self.old_revid == self.new_revid:
2220
to_file.write('No new revisions to push.\n')
2222
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2223
self._show_tag_conficts(to_file)
2226
class BranchCheckResult(object):
2227
"""Results of checking branch consistency.
2232
def __init__(self, branch):
2233
self.branch = branch
2235
def report_results(self, verbose):
2236
"""Report the check results via trace.note.
2238
:param verbose: Requests more detailed display of what was checked,
2241
note('checked branch %s format %s',
2243
self.branch._format)
2246
class Converter5to6(object):
2247
"""Perform an in-place upgrade of format 5 to format 6"""
2249
def convert(self, branch):
2250
# Data for 5 and 6 can peacefully coexist.
2251
format = BzrBranchFormat6()
2252
new_branch = format.open(branch.bzrdir, _found=True)
2254
# Copy source data into target
2255
new_branch._write_last_revision_info(*branch.last_revision_info())
2256
new_branch.set_parent(branch.get_parent())
2257
new_branch.set_bound_location(branch.get_bound_location())
2258
new_branch.set_push_location(branch.get_push_location())
2260
# New branch has no tags by default
2261
new_branch.tags._set_tag_dict({})
2263
# Copying done; now update target format
2264
new_branch._transport.put_bytes('format',
2265
format.get_format_string(),
2266
mode=new_branch.bzrdir._get_file_mode())
2268
# Clean up old files
2269
new_branch._transport.delete('revision-history')
2271
branch.set_parent(None)
2272
except errors.NoSuchFile:
2274
branch.set_bound_location(None)
added
removed
bzrlib/branch.py
