1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
from 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 (deprecated_method,
47
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
50
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
51
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
52
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
55
# TODO: Maybe include checks for common corruption of newlines, etc?
57
# TODO: Some operations like log might retrieve the same revisions
58
# repeatedly to calculate deltas. We could perhaps have a weakref
59
# cache in memory to make this faster. In general anything can be
60
# cached in memory between lock and unlock operations. .. nb thats
61
# what the transaction identity map provides
64
######################################################################
68
"""Branch holding a history of revisions.
71
Base directory/url of the branch.
73
hooks: An instance of BranchHooks.
75
# this is really an instance variable - FIXME move it there
79
# override this to set the strategy for storing tags
81
return DisabledTags(self)
83
def __init__(self, *ignored, **ignored_too):
84
self.tags = self._make_tags()
85
self._revision_history_cache = None
86
self._revision_id_to_revno_cache = None
89
"""Break a lock if one is present from another instance.
91
Uses the ui factory to ask for confirmation if the lock may be from
94
This will probe the repository for its lock as well.
96
self.control_files.break_lock()
97
self.repository.break_lock()
98
master = self.get_master_branch()
99
if master is not None:
103
def open(base, _unsupported=False, possible_transports=None):
104
"""Open the branch rooted at base.
106
For instance, if the branch is at URL/.bzr/branch,
107
Branch.open(URL) -> a Branch instance.
109
control = bzrdir.BzrDir.open(base, _unsupported,
110
possible_transports=possible_transports)
111
return control.open_branch(_unsupported)
114
def open_from_transport(transport, _unsupported=False):
115
"""Open the branch rooted at transport"""
116
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
117
return control.open_branch(_unsupported)
120
def open_containing(url, possible_transports=None):
121
"""Open an existing branch which contains url.
123
This probes for a branch at url, and searches upwards from there.
125
Basically we keep looking up until we find the control directory or
126
run into the root. If there isn't one, raises NotBranchError.
127
If there is one and it is either an unrecognised format or an unsupported
128
format, UnknownFormatError or UnsupportedFormatError are raised.
129
If there is one, it is returned, along with the unused portion of url.
131
control, relpath = bzrdir.BzrDir.open_containing(url,
133
return control.open_branch(), relpath
135
def get_config(self):
136
return BranchConfig(self)
139
return self.get_config().get_nickname()
141
def _set_nick(self, nick):
142
self.get_config().set_user_option('nickname', nick, warn_masked=True)
144
nick = property(_get_nick, _set_nick)
147
raise NotImplementedError(self.is_locked)
149
def lock_write(self):
150
raise NotImplementedError(self.lock_write)
153
raise NotImplementedError(self.lock_read)
156
raise NotImplementedError(self.unlock)
158
def peek_lock_mode(self):
159
"""Return lock mode for the Branch: 'r', 'w' or None"""
160
raise NotImplementedError(self.peek_lock_mode)
162
def get_physical_lock_status(self):
163
raise NotImplementedError(self.get_physical_lock_status)
166
def get_revision_id_to_revno_map(self):
167
"""Return the revision_id => dotted revno map.
169
This will be regenerated on demand, but will be cached.
171
:return: A dictionary mapping revision_id => dotted revno.
172
This dictionary should not be modified by the caller.
174
if self._revision_id_to_revno_cache is not None:
175
mapping = self._revision_id_to_revno_cache
177
mapping = self._gen_revno_map()
178
self._cache_revision_id_to_revno(mapping)
179
# TODO: jam 20070417 Since this is being cached, should we be returning
181
# I would rather not, and instead just declare that users should not
182
# modify the return value.
185
def _gen_revno_map(self):
186
"""Create a new mapping from revision ids to dotted revnos.
188
Dotted revnos are generated based on the current tip in the revision
190
This is the worker function for get_revision_id_to_revno_map, which
191
just caches the return value.
193
:return: A dictionary mapping revision_id => dotted revno.
195
last_revision = self.last_revision()
196
revision_graph = repository._old_get_graph(self.repository,
198
merge_sorted_revisions = tsort.merge_sort(
203
revision_id_to_revno = dict((rev_id, revno)
204
for seq_num, rev_id, depth, revno, end_of_merge
205
in merge_sorted_revisions)
206
return revision_id_to_revno
208
def leave_lock_in_place(self):
209
"""Tell this branch object not to release the physical lock when this
212
If lock_write doesn't return a token, then this method is not supported.
214
self.control_files.leave_in_place()
216
def dont_leave_lock_in_place(self):
217
"""Tell this branch object to release the physical lock when this
218
object is unlocked, even if it didn't originally acquire it.
220
If lock_write doesn't return a token, then this method is not supported.
222
self.control_files.dont_leave_in_place()
224
def abspath(self, name):
225
"""Return absolute filename for something in the branch
227
XXX: Robert Collins 20051017 what is this used for? why is it a branch
228
method and not a tree method.
230
raise NotImplementedError(self.abspath)
232
def bind(self, other):
233
"""Bind the local branch the other branch.
235
:param other: The branch to bind to
238
raise errors.UpgradeRequired(self.base)
241
def fetch(self, from_branch, last_revision=None, pb=None):
242
"""Copy revisions from from_branch into this branch.
244
:param from_branch: Where to copy from.
245
:param last_revision: What revision to stop at (None for at the end
247
:param pb: An optional progress bar to use.
249
Returns the copied revision count and the failed revisions in a tuple:
252
if self.base == from_branch.base:
255
nested_pb = ui.ui_factory.nested_progress_bar()
260
from_branch.lock_read()
262
if last_revision is None:
263
pb.update('get source history')
264
last_revision = from_branch.last_revision()
265
last_revision = _mod_revision.ensure_null(last_revision)
266
return self.repository.fetch(from_branch.repository,
267
revision_id=last_revision,
270
if nested_pb is not None:
274
def get_bound_location(self):
275
"""Return the URL of the branch we are bound to.
277
Older format branches cannot bind, please be sure to use a metadir
282
def get_old_bound_location(self):
283
"""Return the URL of the branch we used to be bound to
285
raise errors.UpgradeRequired(self.base)
287
def get_commit_builder(self, parents, config=None, timestamp=None,
288
timezone=None, committer=None, revprops=None,
290
"""Obtain a CommitBuilder for this branch.
292
:param parents: Revision ids of the parents of the new revision.
293
:param config: Optional configuration to use.
294
:param timestamp: Optional timestamp recorded for commit.
295
:param timezone: Optional timezone for timestamp.
296
:param committer: Optional committer to set for commit.
297
:param revprops: Optional dictionary of revision properties.
298
:param revision_id: Optional revision id.
302
config = self.get_config()
304
return self.repository.get_commit_builder(self, parents, config,
305
timestamp, timezone, committer, revprops, revision_id)
307
def get_master_branch(self, possible_transports=None):
308
"""Return the branch we are bound to.
310
:return: Either a Branch, or None
314
def get_revision_delta(self, revno):
315
"""Return the delta for one revision.
317
The delta is relative to its mainline predecessor, or the
318
empty tree for revision 1.
320
assert isinstance(revno, int)
321
rh = self.revision_history()
322
if not (1 <= revno <= len(rh)):
323
raise errors.InvalidRevisionNumber(revno)
324
return self.repository.get_revision_delta(rh[revno-1])
326
@deprecated_method(zero_sixteen)
327
def get_root_id(self):
328
"""Return the id of this branches root
330
Deprecated: branches don't have root ids-- trees do.
331
Use basis_tree().get_root_id() instead.
333
raise NotImplementedError(self.get_root_id)
335
def print_file(self, file, revision_id):
336
"""Print `file` to stdout."""
337
raise NotImplementedError(self.print_file)
339
def set_revision_history(self, rev_history):
340
raise NotImplementedError(self.set_revision_history)
342
def _cache_revision_history(self, rev_history):
343
"""Set the cached revision history to rev_history.
345
The revision_history method will use this cache to avoid regenerating
346
the revision history.
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_history_cache = rev_history
353
def _cache_revision_id_to_revno(self, revision_id_to_revno):
354
"""Set the cached revision_id => revno map to revision_id_to_revno.
356
This API is semi-public; it only for use by subclasses, all other code
357
should consider it to be private.
359
self._revision_id_to_revno_cache = revision_id_to_revno
361
def _clear_cached_state(self):
362
"""Clear any cached data on this branch, e.g. cached revision history.
364
This means the next call to revision_history will need to call
365
_gen_revision_history.
367
This API is semi-public; it only for use by subclasses, all other code
368
should consider it to be private.
370
self._revision_history_cache = None
371
self._revision_id_to_revno_cache = None
373
def _gen_revision_history(self):
374
"""Return sequence of revision hashes on to this branch.
376
Unlike revision_history, this method always regenerates or rereads the
377
revision history, i.e. it does not cache the result, so repeated calls
380
Concrete subclasses should override this instead of revision_history so
381
that subclasses do not need to deal with caching logic.
383
This API is semi-public; it only for use by subclasses, all other code
384
should consider it to be private.
386
raise NotImplementedError(self._gen_revision_history)
389
def revision_history(self):
390
"""Return sequence of revision ids on this branch.
392
This method will cache the revision history for as long as it is safe to
395
if 'evil' in debug.debug_flags:
396
mutter_callsite(3, "revision_history scales with history.")
397
if self._revision_history_cache is not None:
398
history = self._revision_history_cache
400
history = self._gen_revision_history()
401
self._cache_revision_history(history)
405
"""Return current revision number for this branch.
407
That is equivalent to the number of revisions committed to
410
return self.last_revision_info()[0]
413
"""Older format branches cannot bind or unbind."""
414
raise errors.UpgradeRequired(self.base)
416
def set_append_revisions_only(self, enabled):
417
"""Older format branches are never restricted to append-only"""
418
raise errors.UpgradeRequired(self.base)
420
def last_revision(self):
421
"""Return last revision id, or NULL_REVISION."""
422
return self.last_revision_info()[1]
424
def last_revision_info(self):
425
"""Return information about the last revision.
427
:return: A tuple (revno, last_revision_id).
429
rh = self.revision_history()
432
return (revno, rh[-1])
434
return (0, _mod_revision.NULL_REVISION)
436
def missing_revisions(self, other, stop_revision=None):
437
"""Return a list of new revisions that would perfectly fit.
439
If self and other have not diverged, return a list of the revisions
440
present in other, but missing from self.
442
self_history = self.revision_history()
443
self_len = len(self_history)
444
other_history = other.revision_history()
445
other_len = len(other_history)
446
common_index = min(self_len, other_len) -1
447
if common_index >= 0 and \
448
self_history[common_index] != other_history[common_index]:
449
raise errors.DivergedBranches(self, other)
451
if stop_revision is None:
452
stop_revision = other_len
454
assert isinstance(stop_revision, int)
455
if stop_revision > other_len:
456
raise errors.NoSuchRevision(self, stop_revision)
457
return other_history[self_len:stop_revision]
459
def update_revisions(self, other, stop_revision=None):
460
"""Pull in new perfect-fit revisions.
462
:param other: Another Branch to pull from
463
:param stop_revision: Updated until the given revision
466
raise NotImplementedError(self.update_revisions)
468
def revision_id_to_revno(self, revision_id):
469
"""Given a revision id, return its revno"""
470
if _mod_revision.is_null(revision_id):
472
history = self.revision_history()
474
return history.index(revision_id) + 1
476
raise errors.NoSuchRevision(self, revision_id)
478
def get_rev_id(self, revno, history=None):
479
"""Find the revision id of the specified revno."""
481
return _mod_revision.NULL_REVISION
483
history = self.revision_history()
484
if revno <= 0 or revno > len(history):
485
raise errors.NoSuchRevision(self, revno)
486
return history[revno - 1]
488
def pull(self, source, overwrite=False, stop_revision=None,
489
possible_transports=None):
490
"""Mirror source into this branch.
492
This branch is considered to be 'local', having low latency.
494
:returns: PullResult instance
496
raise NotImplementedError(self.pull)
498
def push(self, target, overwrite=False, stop_revision=None):
499
"""Mirror this branch into target.
501
This branch is considered to be 'local', having low latency.
503
raise NotImplementedError(self.push)
505
def basis_tree(self):
506
"""Return `Tree` object for last revision."""
507
return self.repository.revision_tree(self.last_revision())
509
def rename_one(self, from_rel, to_rel):
512
This can change the directory or the filename or both.
514
raise NotImplementedError(self.rename_one)
516
def move(self, from_paths, to_name):
519
to_name must exist as a versioned directory.
521
If to_name exists and is a directory, the files are moved into
522
it, keeping their old names. If it is a directory,
524
Note that to_name is only the last component of the new name;
525
this doesn't change the directory.
527
This returns a list of (from_path, to_path) pairs for each
530
raise NotImplementedError(self.move)
532
def get_parent(self):
533
"""Return the parent location of the branch.
535
This is the default location for push/pull/missing. The usual
536
pattern is that the user can override it by specifying a
539
raise NotImplementedError(self.get_parent)
541
def _set_config_location(self, name, url, config=None,
542
make_relative=False):
544
config = self.get_config()
548
url = urlutils.relative_url(self.base, url)
549
config.set_user_option(name, url, warn_masked=True)
551
def _get_config_location(self, name, config=None):
553
config = self.get_config()
554
location = config.get_user_option(name)
559
def get_submit_branch(self):
560
"""Return the submit location of the branch.
562
This is the default location for bundle. The usual
563
pattern is that the user can override it by specifying a
566
return self.get_config().get_user_option('submit_branch')
568
def set_submit_branch(self, location):
569
"""Return the submit location of the branch.
571
This is the default location for bundle. The usual
572
pattern is that the user can override it by specifying a
575
self.get_config().set_user_option('submit_branch', location,
578
def get_public_branch(self):
579
"""Return the public location of the branch.
581
This is is used by merge directives.
583
return self._get_config_location('public_branch')
585
def set_public_branch(self, location):
586
"""Return the submit location of the branch.
588
This is the default location for bundle. The usual
589
pattern is that the user can override it by specifying a
592
self._set_config_location('public_branch', location)
594
def get_push_location(self):
595
"""Return the None or the location to push this branch to."""
596
push_loc = self.get_config().get_user_option('push_location')
599
def set_push_location(self, location):
600
"""Set a new push location for this branch."""
601
raise NotImplementedError(self.set_push_location)
603
def set_parent(self, url):
604
raise NotImplementedError(self.set_parent)
608
"""Synchronise this branch with the master branch if any.
610
:return: None or the last_revision pivoted out during the update.
614
def check_revno(self, revno):
616
Check whether a revno corresponds to any revision.
617
Zero (the NULL revision) is considered valid.
620
self.check_real_revno(revno)
622
def check_real_revno(self, revno):
624
Check whether a revno corresponds to a real revision.
625
Zero (the NULL revision) is considered invalid
627
if revno < 1 or revno > self.revno():
628
raise errors.InvalidRevisionNumber(revno)
631
def clone(self, to_bzrdir, revision_id=None):
632
"""Clone this branch into to_bzrdir preserving all semantic values.
634
revision_id: if not None, the revision history in the new branch will
635
be truncated to end with revision_id.
637
result = self._format.initialize(to_bzrdir)
638
self.copy_content_into(result, revision_id=revision_id)
642
def sprout(self, to_bzrdir, revision_id=None):
643
"""Create a new line of development from the branch, into to_bzrdir.
645
revision_id: if not None, the revision history in the new branch will
646
be truncated to end with revision_id.
648
result = self._format.initialize(to_bzrdir)
649
self.copy_content_into(result, revision_id=revision_id)
650
result.set_parent(self.bzrdir.root_transport.base)
653
def _synchronize_history(self, destination, revision_id):
654
"""Synchronize last revision and revision history between branches.
656
This version is most efficient when the destination is also a
657
BzrBranch5, but works for BzrBranch6 as long as the revision
658
history is the true lefthand parent history, and all of the revisions
659
are in the destination's repository. If not, set_revision_history
662
:param destination: The branch to copy the history into
663
:param revision_id: The revision-id to truncate history at. May
664
be None to copy complete history.
666
if revision_id == _mod_revision.NULL_REVISION:
668
new_history = self.revision_history()
669
if revision_id is not None and new_history != []:
671
new_history = new_history[:new_history.index(revision_id) + 1]
673
rev = self.repository.get_revision(revision_id)
674
new_history = rev.get_history(self.repository)[1:]
675
destination.set_revision_history(new_history)
678
def copy_content_into(self, destination, revision_id=None):
679
"""Copy the content of self into destination.
681
revision_id: if not None, the revision history in the new branch will
682
be truncated to end with revision_id.
684
self._synchronize_history(destination, revision_id)
686
parent = self.get_parent()
687
except errors.InaccessibleParent, e:
688
mutter('parent was not accessible to copy: %s', e)
691
destination.set_parent(parent)
692
self.tags.merge_to(destination.tags)
696
"""Check consistency of the branch.
698
In particular this checks that revisions given in the revision-history
699
do actually match up in the revision graph, and that they're all
700
present in the repository.
702
Callers will typically also want to check the repository.
704
:return: A BranchCheckResult.
706
mainline_parent_id = None
707
last_revno, last_revision_id = self.last_revision_info()
708
real_rev_history = list(self.repository.iter_reverse_revision_history(
710
real_rev_history.reverse()
711
if len(real_rev_history) != last_revno:
712
raise errors.BzrCheckError('revno does not match len(mainline)'
713
' %s != %s' % (last_revno, len(real_rev_history)))
714
# TODO: We should probably also check that real_rev_history actually
715
# matches self.revision_history()
716
for revision_id in real_rev_history:
718
revision = self.repository.get_revision(revision_id)
719
except errors.NoSuchRevision, e:
720
raise errors.BzrCheckError("mainline revision {%s} not in repository"
722
# In general the first entry on the revision history has no parents.
723
# But it's not illegal for it to have parents listed; this can happen
724
# in imports from Arch when the parents weren't reachable.
725
if mainline_parent_id is not None:
726
if mainline_parent_id not in revision.parent_ids:
727
raise errors.BzrCheckError("previous revision {%s} not listed among "
729
% (mainline_parent_id, revision_id))
730
mainline_parent_id = revision_id
731
return BranchCheckResult(self)
733
def _get_checkout_format(self):
734
"""Return the most suitable metadir for a checkout of this branch.
735
Weaves are used if this branch's repository uses weaves.
737
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
738
from bzrlib.repofmt import weaverepo
739
format = bzrdir.BzrDirMetaFormat1()
740
format.repository_format = weaverepo.RepositoryFormat7()
742
format = self.repository.bzrdir.checkout_metadir()
743
format.set_branch_format(self._format)
746
def create_checkout(self, to_location, revision_id=None,
747
lightweight=False, accelerator_tree=None,
749
"""Create a checkout of a branch.
751
:param to_location: The url to produce the checkout at
752
:param revision_id: The revision to check out
753
:param lightweight: If True, produce a lightweight checkout, otherwise,
754
produce a bound branch (heavyweight checkout)
755
:param accelerator_tree: A tree which can be used for retrieving file
756
contents more quickly than the revision tree, i.e. a workingtree.
757
The revision tree will be used for cases where accelerator_tree's
758
content is different.
759
:param hardlink: If true, hard-link files from accelerator_tree,
761
:return: The tree of the created checkout
763
t = transport.get_transport(to_location)
766
format = self._get_checkout_format()
767
checkout = format.initialize_on_transport(t)
768
from_branch = BranchReferenceFormat().initialize(checkout, self)
770
format = self._get_checkout_format()
771
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
772
to_location, force_new_tree=False, format=format)
773
checkout = checkout_branch.bzrdir
774
checkout_branch.bind(self)
775
# pull up to the specified revision_id to set the initial
776
# branch tip correctly, and seed it with history.
777
checkout_branch.pull(self, stop_revision=revision_id)
779
tree = checkout.create_workingtree(revision_id,
780
from_branch=from_branch,
781
accelerator_tree=accelerator_tree,
783
basis_tree = tree.basis_tree()
784
basis_tree.lock_read()
786
for path, file_id in basis_tree.iter_references():
787
reference_parent = self.reference_parent(file_id, path)
788
reference_parent.create_checkout(tree.abspath(path),
789
basis_tree.get_reference_revision(file_id, path),
796
def reconcile(self, thorough=True):
797
"""Make sure the data stored in this branch is consistent."""
798
"""Reconcile this repository."""
799
from bzrlib.reconcile import BranchReconciler
800
reconciler = BranchReconciler(self, thorough=thorough)
801
reconciler.reconcile()
804
def reference_parent(self, file_id, path):
805
"""Return the parent branch for a tree-reference file_id
806
:param file_id: The file_id of the tree reference
807
:param path: The path of the file_id in the tree
808
:return: A branch associated with the file_id
810
# FIXME should provide multiple branches, based on config
811
return Branch.open(self.bzrdir.root_transport.clone(path).base)
813
def supports_tags(self):
814
return self._format.supports_tags()
817
class BranchFormat(object):
818
"""An encapsulation of the initialization and open routines for a format.
820
Formats provide three things:
821
* An initialization routine,
825
Formats are placed in an dict by their format string for reference
826
during branch opening. Its not required that these be instances, they
827
can be classes themselves with class methods - it simply depends on
828
whether state is needed for a given format or not.
830
Once a format is deprecated, just deprecate the initialize and open
831
methods on the format class. Do not deprecate the object, as the
832
object will be created every time regardless.
835
_default_format = None
836
"""The default format used for new branches."""
839
"""The known formats."""
841
def __eq__(self, other):
842
return self.__class__ is other.__class__
844
def __ne__(self, other):
845
return not (self == other)
848
def find_format(klass, a_bzrdir):
849
"""Return the format for the branch object in a_bzrdir."""
851
transport = a_bzrdir.get_branch_transport(None)
852
format_string = transport.get("format").read()
853
return klass._formats[format_string]
854
except errors.NoSuchFile:
855
raise errors.NotBranchError(path=transport.base)
857
raise errors.UnknownFormatError(format=format_string, kind='branch')
860
def get_default_format(klass):
861
"""Return the current default format."""
862
return klass._default_format
864
def get_reference(self, a_bzrdir):
865
"""Get the target reference of the branch in a_bzrdir.
867
format probing must have been completed before calling
868
this method - it is assumed that the format of the branch
869
in a_bzrdir is correct.
871
:param a_bzrdir: The bzrdir to get the branch data from.
872
:return: None if the branch is not a reference branch.
877
def set_reference(self, a_bzrdir, to_branch):
878
"""Set the target reference of the branch in a_bzrdir.
880
format probing must have been completed before calling
881
this method - it is assumed that the format of the branch
882
in a_bzrdir is correct.
884
:param a_bzrdir: The bzrdir to set the branch reference for.
885
:param to_branch: branch that the checkout is to reference
887
raise NotImplementedError(self.set_reference)
889
def get_format_string(self):
890
"""Return the ASCII format string that identifies this format."""
891
raise NotImplementedError(self.get_format_string)
893
def get_format_description(self):
894
"""Return the short format description for this format."""
895
raise NotImplementedError(self.get_format_description)
897
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
899
"""Initialize a branch in a bzrdir, with specified files
901
:param a_bzrdir: The bzrdir to initialize the branch in
902
:param utf8_files: The files to create as a list of
903
(filename, content) tuples
904
:param set_format: If True, set the format with
905
self.get_format_string. (BzrBranch4 has its format set
907
:return: a branch in this format
909
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
910
branch_transport = a_bzrdir.get_branch_transport(self)
912
'metadir': ('lock', lockdir.LockDir),
913
'branch4': ('branch-lock', lockable_files.TransportLock),
915
lock_name, lock_class = lock_map[lock_type]
916
control_files = lockable_files.LockableFiles(branch_transport,
917
lock_name, lock_class)
918
control_files.create_lock()
919
control_files.lock_write()
921
control_files.put_utf8('format', self.get_format_string())
923
for file, content in utf8_files:
924
control_files.put_utf8(file, content)
926
control_files.unlock()
927
return self.open(a_bzrdir, _found=True)
929
def initialize(self, a_bzrdir):
930
"""Create a branch of this format in a_bzrdir."""
931
raise NotImplementedError(self.initialize)
933
def is_supported(self):
934
"""Is this format supported?
936
Supported formats can be initialized and opened.
937
Unsupported formats may not support initialization or committing or
938
some other features depending on the reason for not being supported.
942
def open(self, a_bzrdir, _found=False):
943
"""Return the branch object for a_bzrdir
945
_found is a private parameter, do not use it. It is used to indicate
946
if format probing has already be done.
948
raise NotImplementedError(self.open)
951
def register_format(klass, format):
952
klass._formats[format.get_format_string()] = format
955
def set_default_format(klass, format):
956
klass._default_format = format
959
def unregister_format(klass, format):
960
assert klass._formats[format.get_format_string()] is format
961
del klass._formats[format.get_format_string()]
964
return self.get_format_string().rstrip()
966
def supports_tags(self):
967
"""True if this format supports tags stored in the branch"""
968
return False # by default
970
# XXX: Probably doesn't really belong here -- mbp 20070212
971
def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
973
branch_transport = a_bzrdir.get_branch_transport(self)
974
control_files = lockable_files.LockableFiles(branch_transport,
975
lock_filename, lock_class)
976
control_files.create_lock()
977
control_files.lock_write()
979
for filename, content in utf8_files:
980
control_files.put_utf8(filename, content)
982
control_files.unlock()
985
class BranchHooks(Hooks):
986
"""A dictionary mapping hook name to a list of callables for branch hooks.
988
e.g. ['set_rh'] Is the list of items to be called when the
989
set_revision_history function is invoked.
993
"""Create the default hooks.
995
These are all empty initially, because by default nothing should get
999
# Introduced in 0.15:
1000
# invoked whenever the revision history has been set
1001
# with set_revision_history. The api signature is
1002
# (branch, revision_history), and the branch will
1005
# invoked after a push operation completes.
1006
# the api signature is
1008
# containing the members
1009
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1010
# where local is the local target branch or None, master is the target
1011
# master branch, and the rest should be self explanatory. The source
1012
# is read locked and the target branches write locked. Source will
1013
# be the local low-latency branch.
1014
self['post_push'] = []
1015
# invoked after a pull operation completes.
1016
# the api signature is
1018
# containing the members
1019
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1020
# where local is the local branch or None, master is the target
1021
# master branch, and the rest should be self explanatory. The source
1022
# is read locked and the target branches write locked. The local
1023
# branch is the low-latency branch.
1024
self['post_pull'] = []
1025
# invoked before a commit operation takes place.
1026
# the api signature is
1027
# (local, master, old_revno, old_revid, future_revno, future_revid,
1028
# tree_delta, future_tree).
1029
# old_revid is NULL_REVISION for the first commit to a branch
1030
# tree_delta is a TreeDelta object describing changes from the basis
1031
# revision, hooks MUST NOT modify this delta
1032
# future_tree is an in-memory tree obtained from
1033
# CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
1034
self['pre_commit'] = []
1035
# invoked after a commit operation completes.
1036
# the api signature is
1037
# (local, master, old_revno, old_revid, new_revno, new_revid)
1038
# old_revid is NULL_REVISION for the first commit to a branch.
1039
self['post_commit'] = []
1040
# invoked after a uncommit operation completes.
1041
# the api signature is
1042
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1043
# local is the local branch or None, master is the target branch,
1044
# and an empty branch recieves new_revno of 0, new_revid of None.
1045
self['post_uncommit'] = []
1047
# Invoked after the tip of a branch changes.
1048
# the api signature is
1049
# (params) where params is a ChangeBranchTipParams with the members
1050
# (branch, old_revno, new_revno, old_revid, new_revid)
1051
self['post_change_branch_tip'] = []
1054
# install the default hooks into the Branch class.
1055
Branch.hooks = BranchHooks()
1058
class ChangeBranchTipParams(object):
1059
"""Object holding parameters passed to *_change_branch_tip hooks.
1061
There are 5 fields that hooks may wish to access:
1063
:ivar branch: the branch being changed
1064
:ivar old_revno: revision number before the change
1065
:ivar new_revno: revision number after the change
1066
:ivar old_revid: revision id before the change
1067
:ivar new_revid: revision id after the change
1069
The revid fields are strings. The revno fields are integers.
1072
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1073
"""Create a group of ChangeBranchTip parameters.
1075
:param branch: The branch being changed.
1076
:param old_revno: Revision number before the change.
1077
:param new_revno: Revision number after the change.
1078
:param old_revid: Tip revision id before the change.
1079
:param new_revid: Tip revision id after the change.
1081
self.branch = branch
1082
self.old_revno = old_revno
1083
self.new_revno = new_revno
1084
self.old_revid = old_revid
1085
self.new_revid = new_revid
1088
class BzrBranchFormat4(BranchFormat):
1089
"""Bzr branch format 4.
1092
- a revision-history file.
1093
- a branch-lock lock file [ to be shared with the bzrdir ]
1096
def get_format_description(self):
1097
"""See BranchFormat.get_format_description()."""
1098
return "Branch format 4"
1100
def initialize(self, a_bzrdir):
1101
"""Create a branch of this format in a_bzrdir."""
1102
utf8_files = [('revision-history', ''),
1103
('branch-name', ''),
1105
return self._initialize_helper(a_bzrdir, utf8_files,
1106
lock_type='branch4', set_format=False)
1109
super(BzrBranchFormat4, self).__init__()
1110
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1112
def open(self, a_bzrdir, _found=False):
1113
"""Return the branch object for a_bzrdir
1115
_found is a private parameter, do not use it. It is used to indicate
1116
if format probing has already be done.
1119
# we are being called directly and must probe.
1120
raise NotImplementedError
1121
return BzrBranch(_format=self,
1122
_control_files=a_bzrdir._control_files,
1124
_repository=a_bzrdir.open_repository())
1127
return "Bazaar-NG branch format 4"
1130
class BzrBranchFormat5(BranchFormat):
1131
"""Bzr branch format 5.
1134
- a revision-history file.
1136
- a lock dir guarding the branch itself
1137
- all of this stored in a branch/ subdirectory
1138
- works with shared repositories.
1140
This format is new in bzr 0.8.
1143
def get_format_string(self):
1144
"""See BranchFormat.get_format_string()."""
1145
return "Bazaar-NG branch format 5\n"
1147
def get_format_description(self):
1148
"""See BranchFormat.get_format_description()."""
1149
return "Branch format 5"
1151
def initialize(self, a_bzrdir):
1152
"""Create a branch of this format in a_bzrdir."""
1153
utf8_files = [('revision-history', ''),
1154
('branch-name', ''),
1156
return self._initialize_helper(a_bzrdir, utf8_files)
1159
super(BzrBranchFormat5, self).__init__()
1160
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1162
def open(self, a_bzrdir, _found=False):
1163
"""Return the branch object for a_bzrdir
1165
_found is a private parameter, do not use it. It is used to indicate
1166
if format probing has already be done.
1169
format = BranchFormat.find_format(a_bzrdir)
1170
assert format.__class__ == self.__class__
1172
transport = a_bzrdir.get_branch_transport(None)
1173
control_files = lockable_files.LockableFiles(transport, 'lock',
1175
return BzrBranch5(_format=self,
1176
_control_files=control_files,
1178
_repository=a_bzrdir.find_repository())
1179
except errors.NoSuchFile:
1180
raise errors.NotBranchError(path=transport.base)
1183
class BzrBranchFormat6(BzrBranchFormat5):
1184
"""Branch format with last-revision and tags.
1186
Unlike previous formats, this has no explicit revision history. Instead,
1187
this just stores the last-revision, and the left-hand history leading
1188
up to there is the history.
1190
This format was introduced in bzr 0.15
1191
and became the default in 0.91.
1194
def get_format_string(self):
1195
"""See BranchFormat.get_format_string()."""
1196
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1198
def get_format_description(self):
1199
"""See BranchFormat.get_format_description()."""
1200
return "Branch format 6"
1202
def initialize(self, a_bzrdir):
1203
"""Create a branch of this format in a_bzrdir."""
1204
utf8_files = [('last-revision', '0 null:\n'),
1205
('branch.conf', ''),
1208
return self._initialize_helper(a_bzrdir, utf8_files)
1210
def open(self, a_bzrdir, _found=False):
1211
"""Return the branch object for a_bzrdir
1213
_found is a private parameter, do not use it. It is used to indicate
1214
if format probing has already be done.
1217
format = BranchFormat.find_format(a_bzrdir)
1218
assert format.__class__ == self.__class__
1219
transport = a_bzrdir.get_branch_transport(None)
1220
control_files = lockable_files.LockableFiles(transport, 'lock',
1222
return BzrBranch6(_format=self,
1223
_control_files=control_files,
1225
_repository=a_bzrdir.find_repository())
1227
def supports_tags(self):
1231
class BranchReferenceFormat(BranchFormat):
1232
"""Bzr branch reference format.
1234
Branch references are used in implementing checkouts, they
1235
act as an alias to the real branch which is at some other url.
1242
def get_format_string(self):
1243
"""See BranchFormat.get_format_string()."""
1244
return "Bazaar-NG Branch Reference Format 1\n"
1246
def get_format_description(self):
1247
"""See BranchFormat.get_format_description()."""
1248
return "Checkout reference format 1"
1250
def get_reference(self, a_bzrdir):
1251
"""See BranchFormat.get_reference()."""
1252
transport = a_bzrdir.get_branch_transport(None)
1253
return transport.get('location').read()
1255
def set_reference(self, a_bzrdir, to_branch):
1256
"""See BranchFormat.set_reference()."""
1257
transport = a_bzrdir.get_branch_transport(None)
1258
location = transport.put_bytes('location', to_branch.base)
1260
def initialize(self, a_bzrdir, target_branch=None):
1261
"""Create a branch of this format in a_bzrdir."""
1262
if target_branch is None:
1263
# this format does not implement branch itself, thus the implicit
1264
# creation contract must see it as uninitializable
1265
raise errors.UninitializableFormat(self)
1266
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1267
branch_transport = a_bzrdir.get_branch_transport(self)
1268
branch_transport.put_bytes('location',
1269
target_branch.bzrdir.root_transport.base)
1270
branch_transport.put_bytes('format', self.get_format_string())
1272
a_bzrdir, _found=True,
1273
possible_transports=[target_branch.bzrdir.root_transport])
1276
super(BranchReferenceFormat, self).__init__()
1277
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1279
def _make_reference_clone_function(format, a_branch):
1280
"""Create a clone() routine for a branch dynamically."""
1281
def clone(to_bzrdir, revision_id=None):
1282
"""See Branch.clone()."""
1283
return format.initialize(to_bzrdir, a_branch)
1284
# cannot obey revision_id limits when cloning a reference ...
1285
# FIXME RBC 20060210 either nuke revision_id for clone, or
1286
# emit some sort of warning/error to the caller ?!
1289
def open(self, a_bzrdir, _found=False, location=None,
1290
possible_transports=None):
1291
"""Return the branch that the branch reference in a_bzrdir points at.
1293
_found is a private parameter, do not use it. It is used to indicate
1294
if format probing has already be done.
1297
format = BranchFormat.find_format(a_bzrdir)
1298
assert format.__class__ == self.__class__
1299
if location is None:
1300
location = self.get_reference(a_bzrdir)
1301
real_bzrdir = bzrdir.BzrDir.open(
1302
location, possible_transports=possible_transports)
1303
result = real_bzrdir.open_branch()
1304
# this changes the behaviour of result.clone to create a new reference
1305
# rather than a copy of the content of the branch.
1306
# I did not use a proxy object because that needs much more extensive
1307
# testing, and we are only changing one behaviour at the moment.
1308
# If we decide to alter more behaviours - i.e. the implicit nickname
1309
# then this should be refactored to introduce a tested proxy branch
1310
# and a subclass of that for use in overriding clone() and ....
1312
result.clone = self._make_reference_clone_function(result)
1316
# formats which have no format string are not discoverable
1317
# and not independently creatable, so are not registered.
1318
__format5 = BzrBranchFormat5()
1319
__format6 = BzrBranchFormat6()
1320
BranchFormat.register_format(__format5)
1321
BranchFormat.register_format(BranchReferenceFormat())
1322
BranchFormat.register_format(__format6)
1323
BranchFormat.set_default_format(__format6)
1324
_legacy_formats = [BzrBranchFormat4(),
1327
class BzrBranch(Branch):
1328
"""A branch stored in the actual filesystem.
1330
Note that it's "local" in the context of the filesystem; it doesn't
1331
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1332
it's writable, and can be accessed via the normal filesystem API.
1335
def __init__(self, _format=None,
1336
_control_files=None, a_bzrdir=None, _repository=None):
1337
"""Create new branch object at a particular location."""
1338
Branch.__init__(self)
1339
if a_bzrdir is None:
1340
raise ValueError('a_bzrdir must be supplied')
1342
self.bzrdir = a_bzrdir
1343
# self._transport used to point to the directory containing the
1344
# control directory, but was not used - now it's just the transport
1345
# for the branch control files. mbp 20070212
1346
self._base = self.bzrdir.transport.clone('..').base
1347
self._format = _format
1348
if _control_files is None:
1349
raise ValueError('BzrBranch _control_files is None')
1350
self.control_files = _control_files
1351
self._transport = _control_files._transport
1352
self.repository = _repository
1355
return '%s(%r)' % (self.__class__.__name__, self.base)
1359
def _get_base(self):
1360
"""Returns the directory containing the control directory."""
1363
base = property(_get_base, doc="The URL for the root of this branch.")
1365
def abspath(self, name):
1366
"""See Branch.abspath."""
1367
return self.control_files._transport.abspath(name)
1370
@deprecated_method(zero_sixteen)
1372
def get_root_id(self):
1373
"""See Branch.get_root_id."""
1374
tree = self.repository.revision_tree(self.last_revision())
1375
return tree.get_root_id()
1377
def is_locked(self):
1378
return self.control_files.is_locked()
1380
def lock_write(self, token=None):
1381
repo_token = self.repository.lock_write()
1383
token = self.control_files.lock_write(token=token)
1385
self.repository.unlock()
1389
def lock_read(self):
1390
self.repository.lock_read()
1392
self.control_files.lock_read()
1394
self.repository.unlock()
1398
# TODO: test for failed two phase locks. This is known broken.
1400
self.control_files.unlock()
1402
self.repository.unlock()
1403
if not self.control_files.is_locked():
1404
# we just released the lock
1405
self._clear_cached_state()
1407
def peek_lock_mode(self):
1408
if self.control_files._lock_count == 0:
1411
return self.control_files._lock_mode
1413
def get_physical_lock_status(self):
1414
return self.control_files.get_physical_lock_status()
1417
def print_file(self, file, revision_id):
1418
"""See Branch.print_file."""
1419
return self.repository.print_file(file, revision_id)
1421
def _write_revision_history(self, history):
1422
"""Factored out of set_revision_history.
1424
This performs the actual writing to disk.
1425
It is intended to be called by BzrBranch5.set_revision_history."""
1426
self.control_files.put_bytes(
1427
'revision-history', '\n'.join(history))
1430
def set_revision_history(self, rev_history):
1431
"""See Branch.set_revision_history."""
1432
if 'evil' in debug.debug_flags:
1433
mutter_callsite(3, "set_revision_history scales with history.")
1434
self._write_revision_history(rev_history)
1435
self._clear_cached_state()
1436
self._cache_revision_history(rev_history)
1437
for hook in Branch.hooks['set_rh']:
1438
hook(self, rev_history)
1440
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1441
"""Run the post_change_branch_tip hooks."""
1442
hooks = Branch.hooks['post_change_branch_tip']
1445
new_revno, new_revid = self.last_revision_info()
1446
params = ChangeBranchTipParams(
1447
self, old_revno, new_revno, old_revid, new_revid)
1452
def set_last_revision_info(self, revno, revision_id):
1453
"""Set the last revision of this branch.
1455
The caller is responsible for checking that the revno is correct
1456
for this revision id.
1458
It may be possible to set the branch last revision to an id not
1459
present in the repository. However, branches can also be
1460
configured to check constraints on history, in which case this may not
1463
revision_id = _mod_revision.ensure_null(revision_id)
1464
old_revno, old_revid = self.last_revision_info()
1465
history = self._lefthand_history(revision_id)
1466
assert len(history) == revno, '%d != %d' % (len(history), revno)
1467
self.set_revision_history(history)
1468
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1470
def _gen_revision_history(self):
1471
history = self.control_files.get('revision-history').read().split('\n')
1472
if history[-1:] == ['']:
1473
# There shouldn't be a trailing newline, but just in case.
1477
def _lefthand_history(self, revision_id, last_rev=None,
1479
if 'evil' in debug.debug_flags:
1480
mutter_callsite(4, "_lefthand_history scales with history.")
1481
# stop_revision must be a descendant of last_revision
1482
graph = self.repository.get_graph()
1483
if last_rev is not None:
1484
if not graph.is_ancestor(last_rev, revision_id):
1485
# our previous tip is not merged into stop_revision
1486
raise errors.DivergedBranches(self, other_branch)
1487
# make a new revision history from the graph
1488
parents_map = graph.get_parent_map([revision_id])
1489
if revision_id not in parents_map:
1490
raise errors.NoSuchRevision(self, revision_id)
1491
current_rev_id = revision_id
1493
# Do not include ghosts or graph origin in revision_history
1494
while (current_rev_id in parents_map and
1495
len(parents_map[current_rev_id]) > 0):
1496
new_history.append(current_rev_id)
1497
current_rev_id = parents_map[current_rev_id][0]
1498
parents_map = graph.get_parent_map([current_rev_id])
1499
new_history.reverse()
1503
def generate_revision_history(self, revision_id, last_rev=None,
1505
"""Create a new revision history that will finish with revision_id.
1507
:param revision_id: the new tip to use.
1508
:param last_rev: The previous last_revision. If not None, then this
1509
must be a ancestory of revision_id, or DivergedBranches is raised.
1510
:param other_branch: The other branch that DivergedBranches should
1511
raise with respect to.
1513
self.set_revision_history(self._lefthand_history(revision_id,
1514
last_rev, other_branch))
1517
def update_revisions(self, other, stop_revision=None, overwrite=False):
1518
"""See Branch.update_revisions."""
1521
other_last_revno, other_last_revision = other.last_revision_info()
1522
if stop_revision is None:
1523
stop_revision = other_last_revision
1524
if _mod_revision.is_null(stop_revision):
1525
# if there are no commits, we're done.
1527
# whats the current last revision, before we fetch [and change it
1529
last_rev = _mod_revision.ensure_null(self.last_revision())
1530
# we fetch here so that we don't process data twice in the common
1531
# case of having something to pull, and so that the check for
1532
# already merged can operate on the just fetched graph, which will
1533
# be cached in memory.
1534
self.fetch(other, stop_revision)
1535
# Check to see if one is an ancestor of the other
1537
heads = self.repository.get_graph().heads([stop_revision,
1539
if heads == set([last_rev]):
1540
# The current revision is a decendent of the target,
1543
elif heads == set([stop_revision, last_rev]):
1544
# These branches have diverged
1545
raise errors.DivergedBranches(self, other)
1546
assert heads == set([stop_revision])
1547
if other_last_revision == stop_revision:
1548
self.set_last_revision_info(other_last_revno,
1549
other_last_revision)
1551
# TODO: jam 2007-11-29 Is there a way to determine the
1552
# revno without searching all of history??
1554
self.generate_revision_history(stop_revision)
1556
self.generate_revision_history(stop_revision,
1557
last_rev=last_rev, other_branch=other)
1561
def basis_tree(self):
1562
"""See Branch.basis_tree."""
1563
return self.repository.revision_tree(self.last_revision())
1566
def pull(self, source, overwrite=False, stop_revision=None,
1567
_hook_master=None, run_hooks=True, possible_transports=None):
1570
:param _hook_master: Private parameter - set the branch to
1571
be supplied as the master to push hooks.
1572
:param run_hooks: Private parameter - if false, this branch
1573
is being called because it's the master of the primary branch,
1574
so it should not run its hooks.
1576
result = PullResult()
1577
result.source_branch = source
1578
result.target_branch = self
1581
result.old_revno, result.old_revid = self.last_revision_info()
1582
self.update_revisions(source, stop_revision, overwrite=overwrite)
1583
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
1584
result.new_revno, result.new_revid = self.last_revision_info()
1586
result.master_branch = _hook_master
1587
result.local_branch = self
1589
result.master_branch = self
1590
result.local_branch = None
1592
for hook in Branch.hooks['post_pull']:
1598
def _get_parent_location(self):
1599
_locs = ['parent', 'pull', 'x-pull']
1602
return self.control_files.get(l).read().strip('\n')
1603
except errors.NoSuchFile:
1608
def push(self, target, overwrite=False, stop_revision=None,
1609
_override_hook_source_branch=None):
1612
This is the basic concrete implementation of push()
1614
:param _override_hook_source_branch: If specified, run
1615
the hooks passing this Branch as the source, rather than self.
1616
This is for use of RemoteBranch, where push is delegated to the
1617
underlying vfs-based Branch.
1619
# TODO: Public option to disable running hooks - should be trivial but
1623
result = self._push_with_bound_branches(target, overwrite,
1625
_override_hook_source_branch=_override_hook_source_branch)
1630
def _push_with_bound_branches(self, target, overwrite,
1632
_override_hook_source_branch=None):
1633
"""Push from self into target, and into target's master if any.
1635
This is on the base BzrBranch class even though it doesn't support
1636
bound branches because the *target* might be bound.
1639
if _override_hook_source_branch:
1640
result.source_branch = _override_hook_source_branch
1641
for hook in Branch.hooks['post_push']:
1644
bound_location = target.get_bound_location()
1645
if bound_location and target.base != bound_location:
1646
# there is a master branch.
1648
# XXX: Why the second check? Is it even supported for a branch to
1649
# be bound to itself? -- mbp 20070507
1650
master_branch = target.get_master_branch()
1651
master_branch.lock_write()
1653
# push into the master from this branch.
1654
self._basic_push(master_branch, overwrite, stop_revision)
1655
# and push into the target branch from this. Note that we push from
1656
# this branch again, because its considered the highest bandwidth
1658
result = self._basic_push(target, overwrite, stop_revision)
1659
result.master_branch = master_branch
1660
result.local_branch = target
1664
master_branch.unlock()
1667
result = self._basic_push(target, overwrite, stop_revision)
1668
# TODO: Why set master_branch and local_branch if there's no
1669
# binding? Maybe cleaner to just leave them unset? -- mbp
1671
result.master_branch = target
1672
result.local_branch = None
1676
def _basic_push(self, target, overwrite, stop_revision):
1677
"""Basic implementation of push without bound branches or hooks.
1679
Must be called with self read locked and target write locked.
1681
result = PushResult()
1682
result.source_branch = self
1683
result.target_branch = target
1684
result.old_revno, result.old_revid = target.last_revision_info()
1686
target.update_revisions(self, stop_revision)
1687
except errors.DivergedBranches:
1691
target.set_revision_history(self.revision_history())
1692
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
1693
result.new_revno, result.new_revid = target.last_revision_info()
1696
def get_parent(self):
1697
"""See Branch.get_parent."""
1699
assert self.base[-1] == '/'
1700
parent = self._get_parent_location()
1703
# This is an old-format absolute path to a local branch
1704
# turn it into a url
1705
if parent.startswith('/'):
1706
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1708
return urlutils.join(self.base[:-1], parent)
1709
except errors.InvalidURLJoin, e:
1710
raise errors.InaccessibleParent(parent, self.base)
1712
def set_push_location(self, location):
1713
"""See Branch.set_push_location."""
1714
self.get_config().set_user_option(
1715
'push_location', location,
1716
store=_mod_config.STORE_LOCATION_NORECURSE)
1719
def set_parent(self, url):
1720
"""See Branch.set_parent."""
1721
# TODO: Maybe delete old location files?
1722
# URLs should never be unicode, even on the local fs,
1723
# FIXUP this and get_parent in a future branch format bump:
1724
# read and rewrite the file, and have the new format code read
1725
# using .get not .get_utf8. RBC 20060125
1727
if isinstance(url, unicode):
1729
url = url.encode('ascii')
1730
except UnicodeEncodeError:
1731
raise errors.InvalidURL(url,
1732
"Urls must be 7-bit ascii, "
1733
"use bzrlib.urlutils.escape")
1734
url = urlutils.relative_url(self.base, url)
1735
self._set_parent_location(url)
1737
def _set_parent_location(self, url):
1739
self.control_files._transport.delete('parent')
1741
assert isinstance(url, str)
1742
self.control_files.put_bytes('parent', url + '\n')
1745
class BzrBranch5(BzrBranch):
1746
"""A format 5 branch. This supports new features over plain branches.
1748
It has support for a master_branch which is the data for bound branches.
1756
super(BzrBranch5, self).__init__(_format=_format,
1757
_control_files=_control_files,
1759
_repository=_repository)
1762
def pull(self, source, overwrite=False, stop_revision=None,
1763
run_hooks=True, possible_transports=None):
1764
"""Pull from source into self, updating my master if any.
1766
:param run_hooks: Private parameter - if false, this branch
1767
is being called because it's the master of the primary branch,
1768
so it should not run its hooks.
1770
bound_location = self.get_bound_location()
1771
master_branch = None
1772
if bound_location and source.base != bound_location:
1773
# not pulling from master, so we need to update master.
1774
master_branch = self.get_master_branch(possible_transports)
1775
master_branch.lock_write()
1778
# pull from source into master.
1779
master_branch.pull(source, overwrite, stop_revision,
1781
return super(BzrBranch5, self).pull(source, overwrite,
1782
stop_revision, _hook_master=master_branch,
1783
run_hooks=run_hooks)
1786
master_branch.unlock()
1788
def get_bound_location(self):
1790
return self.control_files.get_utf8('bound').read()[:-1]
1791
except errors.NoSuchFile:
1795
def get_master_branch(self, possible_transports=None):
1796
"""Return the branch we are bound to.
1798
:return: Either a Branch, or None
1800
This could memoise the branch, but if thats done
1801
it must be revalidated on each new lock.
1802
So for now we just don't memoise it.
1803
# RBC 20060304 review this decision.
1805
bound_loc = self.get_bound_location()
1809
return Branch.open(bound_loc,
1810
possible_transports=possible_transports)
1811
except (errors.NotBranchError, errors.ConnectionError), e:
1812
raise errors.BoundBranchConnectionFailure(
1816
def set_bound_location(self, location):
1817
"""Set the target where this branch is bound to.
1819
:param location: URL to the target branch
1822
self.control_files.put_utf8('bound', location+'\n')
1825
self.control_files._transport.delete('bound')
1826
except errors.NoSuchFile:
1831
def bind(self, other):
1832
"""Bind this branch to the branch other.
1834
This does not push or pull data between the branches, though it does
1835
check for divergence to raise an error when the branches are not
1836
either the same, or one a prefix of the other. That behaviour may not
1837
be useful, so that check may be removed in future.
1839
:param other: The branch to bind to
1842
# TODO: jam 20051230 Consider checking if the target is bound
1843
# It is debatable whether you should be able to bind to
1844
# a branch which is itself bound.
1845
# Committing is obviously forbidden,
1846
# but binding itself may not be.
1847
# Since we *have* to check at commit time, we don't
1848
# *need* to check here
1850
# we want to raise diverged if:
1851
# last_rev is not in the other_last_rev history, AND
1852
# other_last_rev is not in our history, and do it without pulling
1854
self.set_bound_location(other.base)
1858
"""If bound, unbind"""
1859
return self.set_bound_location(None)
1862
def update(self, possible_transports=None):
1863
"""Synchronise this branch with the master branch if any.
1865
:return: None or the last_revision that was pivoted out during the
1868
master = self.get_master_branch(possible_transports)
1869
if master is not None:
1870
old_tip = _mod_revision.ensure_null(self.last_revision())
1871
self.pull(master, overwrite=True)
1872
if self.repository.get_graph().is_ancestor(old_tip,
1873
_mod_revision.ensure_null(self.last_revision())):
1879
class BzrBranch6(BzrBranch5):
1881
def __init__(self, *args, **kwargs):
1882
super(BzrBranch6, self).__init__(*args, **kwargs)
1883
self._last_revision_info_cache = None
1884
self._partial_revision_history_cache = []
1886
def _clear_cached_state(self):
1887
super(BzrBranch6, self)._clear_cached_state()
1888
self._last_revision_info_cache = None
1889
self._partial_revision_history_cache = []
1892
def last_revision_info(self):
1893
"""Return information about the last revision.
1895
:return: A tuple (revno, revision_id).
1897
if self._last_revision_info_cache is None:
1898
self._last_revision_info_cache = self._last_revision_info()
1899
return self._last_revision_info_cache
1901
def _last_revision_info(self):
1902
revision_string = self.control_files.get('last-revision').read()
1903
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1904
revision_id = cache_utf8.get_cached_utf8(revision_id)
1906
return revno, revision_id
1908
def _write_last_revision_info(self, revno, revision_id):
1909
"""Simply write out the revision id, with no checks.
1911
Use set_last_revision_info to perform this safely.
1913
Does not update the revision_history cache.
1914
Intended to be called by set_last_revision_info and
1915
_write_revision_history.
1917
assert revision_id is not None, "Use NULL_REVISION, not None"
1918
out_string = '%d %s\n' % (revno, revision_id)
1919
self.control_files.put_bytes('last-revision', out_string)
1922
def set_last_revision_info(self, revno, revision_id):
1923
revision_id = _mod_revision.ensure_null(revision_id)
1924
old_revno, old_revid = self.last_revision_info()
1925
if self._get_append_revisions_only():
1926
self._check_history_violation(revision_id)
1927
self._write_last_revision_info(revno, revision_id)
1928
self._clear_cached_state()
1929
self._last_revision_info_cache = revno, revision_id
1930
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1932
def _check_history_violation(self, revision_id):
1933
last_revision = _mod_revision.ensure_null(self.last_revision())
1934
if _mod_revision.is_null(last_revision):
1936
if last_revision not in self._lefthand_history(revision_id):
1937
raise errors.AppendRevisionsOnlyViolation(self.base)
1939
def _gen_revision_history(self):
1940
"""Generate the revision history from last revision
1942
self._extend_partial_history()
1943
return list(reversed(self._partial_revision_history_cache))
1945
def _extend_partial_history(self, stop_index=None, stop_revision=None):
1946
"""Extend the partial history to include a given index
1948
If a stop_index is supplied, stop when that index has been reached.
1949
If a stop_revision is supplied, stop when that revision is
1950
encountered. Otherwise, stop when the beginning of history is
1953
:param stop_index: The index which should be present. When it is
1954
present, history extension will stop.
1955
:param revision_id: The revision id which should be present. When
1956
it is encountered, history extension will stop.
1958
repo = self.repository
1959
if len(self._partial_revision_history_cache) == 0:
1960
iterator = repo.iter_reverse_revision_history(self.last_revision())
1962
start_revision = self._partial_revision_history_cache[-1]
1963
iterator = repo.iter_reverse_revision_history(start_revision)
1964
#skip the last revision in the list
1965
next_revision = iterator.next()
1966
assert next_revision == start_revision
1967
for revision_id in iterator:
1968
self._partial_revision_history_cache.append(revision_id)
1969
if (stop_index is not None and
1970
len(self._partial_revision_history_cache) > stop_index):
1972
if revision_id == stop_revision:
1975
def _write_revision_history(self, history):
1976
"""Factored out of set_revision_history.
1978
This performs the actual writing to disk, with format-specific checks.
1979
It is intended to be called by BzrBranch5.set_revision_history.
1981
if len(history) == 0:
1982
last_revision = 'null:'
1984
if history != self._lefthand_history(history[-1]):
1985
raise errors.NotLefthandHistory(history)
1986
last_revision = history[-1]
1987
if self._get_append_revisions_only():
1988
self._check_history_violation(last_revision)
1989
self._write_last_revision_info(len(history), last_revision)
1992
def _set_parent_location(self, url):
1993
"""Set the parent branch"""
1994
self._set_config_location('parent_location', url, make_relative=True)
1997
def _get_parent_location(self):
1998
"""Set the parent branch"""
1999
return self._get_config_location('parent_location')
2001
def set_push_location(self, location):
2002
"""See Branch.set_push_location."""
2003
self._set_config_location('push_location', location)
2005
def set_bound_location(self, location):
2006
"""See Branch.set_push_location."""
2008
config = self.get_config()
2009
if location is None:
2010
if config.get_user_option('bound') != 'True':
2013
config.set_user_option('bound', 'False', warn_masked=True)
2016
self._set_config_location('bound_location', location,
2018
config.set_user_option('bound', 'True', warn_masked=True)
2021
def _get_bound_location(self, bound):
2022
"""Return the bound location in the config file.
2024
Return None if the bound parameter does not match"""
2025
config = self.get_config()
2026
config_bound = (config.get_user_option('bound') == 'True')
2027
if config_bound != bound:
2029
return self._get_config_location('bound_location', config=config)
2031
def get_bound_location(self):
2032
"""See Branch.set_push_location."""
2033
return self._get_bound_location(True)
2035
def get_old_bound_location(self):
2036
"""See Branch.get_old_bound_location"""
2037
return self._get_bound_location(False)
2039
def set_append_revisions_only(self, enabled):
2044
self.get_config().set_user_option('append_revisions_only', value,
2047
def _get_append_revisions_only(self):
2048
value = self.get_config().get_user_option('append_revisions_only')
2049
return value == 'True'
2051
def _synchronize_history(self, destination, revision_id):
2052
"""Synchronize last revision and revision history between branches.
2054
This version is most efficient when the destination is also a
2055
BzrBranch6, but works for BzrBranch5, as long as the destination's
2056
repository contains all the lefthand ancestors of the intended
2057
last_revision. If not, set_last_revision_info will fail.
2059
:param destination: The branch to copy the history into
2060
:param revision_id: The revision-id to truncate history at. May
2061
be None to copy complete history.
2063
source_revno, source_revision_id = self.last_revision_info()
2064
if revision_id is None:
2065
revno, revision_id = source_revno, source_revision_id
2066
elif source_revision_id == revision_id:
2067
# we know the revno without needing to walk all of history
2068
revno = source_revno
2070
# To figure out the revno for a random revision, we need to build
2071
# the revision history, and count its length.
2072
# We don't care about the order, just how long it is.
2073
# Alternatively, we could start at the current location, and count
2074
# backwards. But there is no guarantee that we will find it since
2075
# it may be a merged revision.
2076
revno = len(list(self.repository.iter_reverse_revision_history(
2078
destination.set_last_revision_info(revno, revision_id)
2080
def _make_tags(self):
2081
return BasicTags(self)
2084
def generate_revision_history(self, revision_id, last_rev=None,
2086
"""See BzrBranch5.generate_revision_history"""
2087
history = self._lefthand_history(revision_id, last_rev, other_branch)
2088
revno = len(history)
2089
self.set_last_revision_info(revno, revision_id)
2092
def get_rev_id(self, revno, history=None):
2093
"""Find the revision id of the specified revno."""
2095
return _mod_revision.NULL_REVISION
2097
last_revno, last_revision_id = self.last_revision_info()
2098
if revno <= 0 or revno > last_revno:
2099
raise errors.NoSuchRevision(self, revno)
2101
if history is not None:
2102
assert len(history) == last_revno, 'revno/history mismatch'
2103
return history[revno - 1]
2105
index = last_revno - revno
2106
if len(self._partial_revision_history_cache) <= index:
2107
self._extend_partial_history(stop_index=index)
2108
if len(self._partial_revision_history_cache) > index:
2109
return self._partial_revision_history_cache[index]
2111
raise errors.NoSuchRevision(self, revno)
2114
def revision_id_to_revno(self, revision_id):
2115
"""Given a revision id, return its revno"""
2116
if _mod_revision.is_null(revision_id):
2119
index = self._partial_revision_history_cache.index(revision_id)
2121
self._extend_partial_history(stop_revision=revision_id)
2122
index = len(self._partial_revision_history_cache) - 1
2123
if self._partial_revision_history_cache[index] != revision_id:
2124
raise errors.NoSuchRevision(self, revision_id)
2125
return self.revno() - index
2128
######################################################################
2129
# results of operations
2132
class _Result(object):
2134
def _show_tag_conficts(self, to_file):
2135
if not getattr(self, 'tag_conflicts', None):
2137
to_file.write('Conflicting tags:\n')
2138
for name, value1, value2 in self.tag_conflicts:
2139
to_file.write(' %s\n' % (name, ))
2142
class PullResult(_Result):
2143
"""Result of a Branch.pull operation.
2145
:ivar old_revno: Revision number before pull.
2146
:ivar new_revno: Revision number after pull.
2147
:ivar old_revid: Tip revision id before pull.
2148
:ivar new_revid: Tip revision id after pull.
2149
:ivar source_branch: Source (local) branch object.
2150
:ivar master_branch: Master branch of the target, or None.
2151
:ivar target_branch: Target/destination branch object.
2155
# DEPRECATED: pull used to return the change in revno
2156
return self.new_revno - self.old_revno
2158
def report(self, to_file):
2160
if self.old_revid == self.new_revid:
2161
to_file.write('No revisions to pull.\n')
2163
to_file.write('Now on revision %d.\n' % self.new_revno)
2164
self._show_tag_conficts(to_file)
2167
class PushResult(_Result):
2168
"""Result of a Branch.push operation.
2170
:ivar old_revno: Revision number before push.
2171
:ivar new_revno: Revision number after push.
2172
:ivar old_revid: Tip revision id before push.
2173
:ivar new_revid: Tip revision id after push.
2174
:ivar source_branch: Source branch object.
2175
:ivar master_branch: Master branch of the target, or None.
2176
:ivar target_branch: Target/destination branch object.
2180
# DEPRECATED: push used to return the change in revno
2181
return self.new_revno - self.old_revno
2183
def report(self, to_file):
2184
"""Write a human-readable description of the result."""
2185
if self.old_revid == self.new_revid:
2186
to_file.write('No new revisions to push.\n')
2188
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2189
self._show_tag_conficts(to_file)
2192
class BranchCheckResult(object):
2193
"""Results of checking branch consistency.
2198
def __init__(self, branch):
2199
self.branch = branch
2201
def report_results(self, verbose):
2202
"""Report the check results via trace.note.
2204
:param verbose: Requests more detailed display of what was checked,
2207
note('checked branch %s format %s',
2209
self.branch._format)
2212
class Converter5to6(object):
2213
"""Perform an in-place upgrade of format 5 to format 6"""
2215
def convert(self, branch):
2216
# Data for 5 and 6 can peacefully coexist.
2217
format = BzrBranchFormat6()
2218
new_branch = format.open(branch.bzrdir, _found=True)
2220
# Copy source data into target
2221
new_branch._write_last_revision_info(*branch.last_revision_info())
2222
new_branch.set_parent(branch.get_parent())
2223
new_branch.set_bound_location(branch.get_bound_location())
2224
new_branch.set_push_location(branch.get_push_location())
2226
# New branch has no tags by default
2227
new_branch.tags._set_tag_dict({})
2229
# Copying done; now update target format
2230
new_branch.control_files.put_utf8('format',
2231
format.get_format_string())
2233
# Clean up old files
2234
new_branch.control_files._transport.delete('revision-history')
2236
branch.set_parent(None)
2237
except errors.NoSuchFile:
2239
branch.set_bound_location(None)
added
removed
bzrlib/branch.py
