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
from bzrlib.reconcile import BranchReconciler
799
reconciler = BranchReconciler(self, thorough=thorough)
800
reconciler.reconcile()
803
def reference_parent(self, file_id, path):
804
"""Return the parent branch for a tree-reference file_id
805
:param file_id: The file_id of the tree reference
806
:param path: The path of the file_id in the tree
807
:return: A branch associated with the file_id
809
# FIXME should provide multiple branches, based on config
810
return Branch.open(self.bzrdir.root_transport.clone(path).base)
812
def supports_tags(self):
813
return self._format.supports_tags()
816
class BranchFormat(object):
817
"""An encapsulation of the initialization and open routines for a format.
819
Formats provide three things:
820
* An initialization routine,
824
Formats are placed in an dict by their format string for reference
825
during branch opening. Its not required that these be instances, they
826
can be classes themselves with class methods - it simply depends on
827
whether state is needed for a given format or not.
829
Once a format is deprecated, just deprecate the initialize and open
830
methods on the format class. Do not deprecate the object, as the
831
object will be created every time regardless.
834
_default_format = None
835
"""The default format used for new branches."""
838
"""The known formats."""
840
def __eq__(self, other):
841
return self.__class__ is other.__class__
843
def __ne__(self, other):
844
return not (self == other)
847
def find_format(klass, a_bzrdir):
848
"""Return the format for the branch object in a_bzrdir."""
850
transport = a_bzrdir.get_branch_transport(None)
851
format_string = transport.get("format").read()
852
return klass._formats[format_string]
853
except errors.NoSuchFile:
854
raise errors.NotBranchError(path=transport.base)
856
raise errors.UnknownFormatError(format=format_string, kind='branch')
859
def get_default_format(klass):
860
"""Return the current default format."""
861
return klass._default_format
863
def get_reference(self, a_bzrdir):
864
"""Get the target reference of the branch in a_bzrdir.
866
format probing must have been completed before calling
867
this method - it is assumed that the format of the branch
868
in a_bzrdir is correct.
870
:param a_bzrdir: The bzrdir to get the branch data from.
871
:return: None if the branch is not a reference branch.
876
def set_reference(self, a_bzrdir, to_branch):
877
"""Set the target reference of the branch in a_bzrdir.
879
format probing must have been completed before calling
880
this method - it is assumed that the format of the branch
881
in a_bzrdir is correct.
883
:param a_bzrdir: The bzrdir to set the branch reference for.
884
:param to_branch: branch that the checkout is to reference
886
raise NotImplementedError(self.set_reference)
888
def get_format_string(self):
889
"""Return the ASCII format string that identifies this format."""
890
raise NotImplementedError(self.get_format_string)
892
def get_format_description(self):
893
"""Return the short format description for this format."""
894
raise NotImplementedError(self.get_format_description)
896
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
898
"""Initialize a branch in a bzrdir, with specified files
900
:param a_bzrdir: The bzrdir to initialize the branch in
901
:param utf8_files: The files to create as a list of
902
(filename, content) tuples
903
:param set_format: If True, set the format with
904
self.get_format_string. (BzrBranch4 has its format set
906
:return: a branch in this format
908
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
909
branch_transport = a_bzrdir.get_branch_transport(self)
911
'metadir': ('lock', lockdir.LockDir),
912
'branch4': ('branch-lock', lockable_files.TransportLock),
914
lock_name, lock_class = lock_map[lock_type]
915
control_files = lockable_files.LockableFiles(branch_transport,
916
lock_name, lock_class)
917
control_files.create_lock()
918
control_files.lock_write()
920
control_files.put_utf8('format', self.get_format_string())
922
for file, content in utf8_files:
923
control_files.put_utf8(file, content)
925
control_files.unlock()
926
return self.open(a_bzrdir, _found=True)
928
def initialize(self, a_bzrdir):
929
"""Create a branch of this format in a_bzrdir."""
930
raise NotImplementedError(self.initialize)
932
def is_supported(self):
933
"""Is this format supported?
935
Supported formats can be initialized and opened.
936
Unsupported formats may not support initialization or committing or
937
some other features depending on the reason for not being supported.
941
def open(self, a_bzrdir, _found=False):
942
"""Return the branch object for a_bzrdir
944
_found is a private parameter, do not use it. It is used to indicate
945
if format probing has already be done.
947
raise NotImplementedError(self.open)
950
def register_format(klass, format):
951
klass._formats[format.get_format_string()] = format
954
def set_default_format(klass, format):
955
klass._default_format = format
958
def unregister_format(klass, format):
959
assert klass._formats[format.get_format_string()] is format
960
del klass._formats[format.get_format_string()]
963
return self.get_format_string().rstrip()
965
def supports_tags(self):
966
"""True if this format supports tags stored in the branch"""
967
return False # by default
969
# XXX: Probably doesn't really belong here -- mbp 20070212
970
def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
972
branch_transport = a_bzrdir.get_branch_transport(self)
973
control_files = lockable_files.LockableFiles(branch_transport,
974
lock_filename, lock_class)
975
control_files.create_lock()
976
control_files.lock_write()
978
for filename, content in utf8_files:
979
control_files.put_utf8(filename, content)
981
control_files.unlock()
984
class BranchHooks(Hooks):
985
"""A dictionary mapping hook name to a list of callables for branch hooks.
987
e.g. ['set_rh'] Is the list of items to be called when the
988
set_revision_history function is invoked.
992
"""Create the default hooks.
994
These are all empty initially, because by default nothing should get
998
# Introduced in 0.15:
999
# invoked whenever the revision history has been set
1000
# with set_revision_history. The api signature is
1001
# (branch, revision_history), and the branch will
1004
# invoked after a push operation completes.
1005
# the api signature is
1007
# containing the members
1008
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1009
# where local is the local target branch or None, master is the target
1010
# master branch, and the rest should be self explanatory. The source
1011
# is read locked and the target branches write locked. Source will
1012
# be the local low-latency branch.
1013
self['post_push'] = []
1014
# invoked after a pull operation completes.
1015
# the api signature is
1017
# containing the members
1018
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1019
# where local is the local branch or None, master is the target
1020
# master branch, and the rest should be self explanatory. The source
1021
# is read locked and the target branches write locked. The local
1022
# branch is the low-latency branch.
1023
self['post_pull'] = []
1024
# invoked before a commit operation takes place.
1025
# the api signature is
1026
# (local, master, old_revno, old_revid, future_revno, future_revid,
1027
# tree_delta, future_tree).
1028
# old_revid is NULL_REVISION for the first commit to a branch
1029
# tree_delta is a TreeDelta object describing changes from the basis
1030
# revision, hooks MUST NOT modify this delta
1031
# future_tree is an in-memory tree obtained from
1032
# CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
1033
self['pre_commit'] = []
1034
# invoked after a commit operation completes.
1035
# the api signature is
1036
# (local, master, old_revno, old_revid, new_revno, new_revid)
1037
# old_revid is NULL_REVISION for the first commit to a branch.
1038
self['post_commit'] = []
1039
# invoked after a uncommit operation completes.
1040
# the api signature is
1041
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1042
# local is the local branch or None, master is the target branch,
1043
# and an empty branch recieves new_revno of 0, new_revid of None.
1044
self['post_uncommit'] = []
1046
# Invoked after the tip of a branch changes.
1047
# the api signature is
1048
# (params) where params is a ChangeBranchTipParams with the members
1049
# (branch, old_revno, new_revno, old_revid, new_revid)
1050
self['post_change_branch_tip'] = []
1053
# install the default hooks into the Branch class.
1054
Branch.hooks = BranchHooks()
1057
class ChangeBranchTipParams(object):
1058
"""Object holding parameters passed to *_change_branch_tip hooks.
1060
There are 5 fields that hooks may wish to access:
1062
:ivar branch: the branch being changed
1063
:ivar old_revno: revision number before the change
1064
:ivar new_revno: revision number after the change
1065
:ivar old_revid: revision id before the change
1066
:ivar new_revid: revision id after the change
1068
The revid fields are strings. The revno fields are integers.
1071
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1072
"""Create a group of ChangeBranchTip parameters.
1074
:param branch: The branch being changed.
1075
:param old_revno: Revision number before the change.
1076
:param new_revno: Revision number after the change.
1077
:param old_revid: Tip revision id before the change.
1078
:param new_revid: Tip revision id after the change.
1080
self.branch = branch
1081
self.old_revno = old_revno
1082
self.new_revno = new_revno
1083
self.old_revid = old_revid
1084
self.new_revid = new_revid
1087
class BzrBranchFormat4(BranchFormat):
1088
"""Bzr branch format 4.
1091
- a revision-history file.
1092
- a branch-lock lock file [ to be shared with the bzrdir ]
1095
def get_format_description(self):
1096
"""See BranchFormat.get_format_description()."""
1097
return "Branch format 4"
1099
def initialize(self, a_bzrdir):
1100
"""Create a branch of this format in a_bzrdir."""
1101
utf8_files = [('revision-history', ''),
1102
('branch-name', ''),
1104
return self._initialize_helper(a_bzrdir, utf8_files,
1105
lock_type='branch4', set_format=False)
1108
super(BzrBranchFormat4, self).__init__()
1109
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1111
def open(self, a_bzrdir, _found=False):
1112
"""Return the branch object for a_bzrdir
1114
_found is a private parameter, do not use it. It is used to indicate
1115
if format probing has already be done.
1118
# we are being called directly and must probe.
1119
raise NotImplementedError
1120
return BzrBranch(_format=self,
1121
_control_files=a_bzrdir._control_files,
1123
_repository=a_bzrdir.open_repository())
1126
return "Bazaar-NG branch format 4"
1129
class BzrBranchFormat5(BranchFormat):
1130
"""Bzr branch format 5.
1133
- a revision-history file.
1135
- a lock dir guarding the branch itself
1136
- all of this stored in a branch/ subdirectory
1137
- works with shared repositories.
1139
This format is new in bzr 0.8.
1142
def get_format_string(self):
1143
"""See BranchFormat.get_format_string()."""
1144
return "Bazaar-NG branch format 5\n"
1146
def get_format_description(self):
1147
"""See BranchFormat.get_format_description()."""
1148
return "Branch format 5"
1150
def initialize(self, a_bzrdir):
1151
"""Create a branch of this format in a_bzrdir."""
1152
utf8_files = [('revision-history', ''),
1153
('branch-name', ''),
1155
return self._initialize_helper(a_bzrdir, utf8_files)
1158
super(BzrBranchFormat5, self).__init__()
1159
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1161
def open(self, a_bzrdir, _found=False):
1162
"""Return the branch object for a_bzrdir
1164
_found is a private parameter, do not use it. It is used to indicate
1165
if format probing has already be done.
1168
format = BranchFormat.find_format(a_bzrdir)
1169
assert format.__class__ == self.__class__
1171
transport = a_bzrdir.get_branch_transport(None)
1172
control_files = lockable_files.LockableFiles(transport, 'lock',
1174
return BzrBranch5(_format=self,
1175
_control_files=control_files,
1177
_repository=a_bzrdir.find_repository())
1178
except errors.NoSuchFile:
1179
raise errors.NotBranchError(path=transport.base)
1182
class BzrBranchFormat6(BzrBranchFormat5):
1183
"""Branch format with last-revision and tags.
1185
Unlike previous formats, this has no explicit revision history. Instead,
1186
this just stores the last-revision, and the left-hand history leading
1187
up to there is the history.
1189
This format was introduced in bzr 0.15
1190
and became the default in 0.91.
1193
def get_format_string(self):
1194
"""See BranchFormat.get_format_string()."""
1195
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1197
def get_format_description(self):
1198
"""See BranchFormat.get_format_description()."""
1199
return "Branch format 6"
1201
def initialize(self, a_bzrdir):
1202
"""Create a branch of this format in a_bzrdir."""
1203
utf8_files = [('last-revision', '0 null:\n'),
1204
('branch.conf', ''),
1207
return self._initialize_helper(a_bzrdir, utf8_files)
1209
def open(self, a_bzrdir, _found=False):
1210
"""Return the branch object for a_bzrdir
1212
_found is a private parameter, do not use it. It is used to indicate
1213
if format probing has already be done.
1216
format = BranchFormat.find_format(a_bzrdir)
1217
assert format.__class__ == self.__class__
1218
transport = a_bzrdir.get_branch_transport(None)
1219
control_files = lockable_files.LockableFiles(transport, 'lock',
1221
return BzrBranch6(_format=self,
1222
_control_files=control_files,
1224
_repository=a_bzrdir.find_repository())
1226
def supports_tags(self):
1230
class BranchReferenceFormat(BranchFormat):
1231
"""Bzr branch reference format.
1233
Branch references are used in implementing checkouts, they
1234
act as an alias to the real branch which is at some other url.
1241
def get_format_string(self):
1242
"""See BranchFormat.get_format_string()."""
1243
return "Bazaar-NG Branch Reference Format 1\n"
1245
def get_format_description(self):
1246
"""See BranchFormat.get_format_description()."""
1247
return "Checkout reference format 1"
1249
def get_reference(self, a_bzrdir):
1250
"""See BranchFormat.get_reference()."""
1251
transport = a_bzrdir.get_branch_transport(None)
1252
return transport.get('location').read()
1254
def set_reference(self, a_bzrdir, to_branch):
1255
"""See BranchFormat.set_reference()."""
1256
transport = a_bzrdir.get_branch_transport(None)
1257
location = transport.put_bytes('location', to_branch.base)
1259
def initialize(self, a_bzrdir, target_branch=None):
1260
"""Create a branch of this format in a_bzrdir."""
1261
if target_branch is None:
1262
# this format does not implement branch itself, thus the implicit
1263
# creation contract must see it as uninitializable
1264
raise errors.UninitializableFormat(self)
1265
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1266
branch_transport = a_bzrdir.get_branch_transport(self)
1267
branch_transport.put_bytes('location',
1268
target_branch.bzrdir.root_transport.base)
1269
branch_transport.put_bytes('format', self.get_format_string())
1271
a_bzrdir, _found=True,
1272
possible_transports=[target_branch.bzrdir.root_transport])
1275
super(BranchReferenceFormat, self).__init__()
1276
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1278
def _make_reference_clone_function(format, a_branch):
1279
"""Create a clone() routine for a branch dynamically."""
1280
def clone(to_bzrdir, revision_id=None):
1281
"""See Branch.clone()."""
1282
return format.initialize(to_bzrdir, a_branch)
1283
# cannot obey revision_id limits when cloning a reference ...
1284
# FIXME RBC 20060210 either nuke revision_id for clone, or
1285
# emit some sort of warning/error to the caller ?!
1288
def open(self, a_bzrdir, _found=False, location=None,
1289
possible_transports=None):
1290
"""Return the branch that the branch reference in a_bzrdir points at.
1292
_found is a private parameter, do not use it. It is used to indicate
1293
if format probing has already be done.
1296
format = BranchFormat.find_format(a_bzrdir)
1297
assert format.__class__ == self.__class__
1298
if location is None:
1299
location = self.get_reference(a_bzrdir)
1300
real_bzrdir = bzrdir.BzrDir.open(
1301
location, possible_transports=possible_transports)
1302
result = real_bzrdir.open_branch()
1303
# this changes the behaviour of result.clone to create a new reference
1304
# rather than a copy of the content of the branch.
1305
# I did not use a proxy object because that needs much more extensive
1306
# testing, and we are only changing one behaviour at the moment.
1307
# If we decide to alter more behaviours - i.e. the implicit nickname
1308
# then this should be refactored to introduce a tested proxy branch
1309
# and a subclass of that for use in overriding clone() and ....
1311
result.clone = self._make_reference_clone_function(result)
1315
# formats which have no format string are not discoverable
1316
# and not independently creatable, so are not registered.
1317
__format5 = BzrBranchFormat5()
1318
__format6 = BzrBranchFormat6()
1319
BranchFormat.register_format(__format5)
1320
BranchFormat.register_format(BranchReferenceFormat())
1321
BranchFormat.register_format(__format6)
1322
BranchFormat.set_default_format(__format6)
1323
_legacy_formats = [BzrBranchFormat4(),
1326
class BzrBranch(Branch):
1327
"""A branch stored in the actual filesystem.
1329
Note that it's "local" in the context of the filesystem; it doesn't
1330
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1331
it's writable, and can be accessed via the normal filesystem API.
1334
def __init__(self, _format=None,
1335
_control_files=None, a_bzrdir=None, _repository=None):
1336
"""Create new branch object at a particular location."""
1337
Branch.__init__(self)
1338
if a_bzrdir is None:
1339
raise ValueError('a_bzrdir must be supplied')
1341
self.bzrdir = a_bzrdir
1342
# self._transport used to point to the directory containing the
1343
# control directory, but was not used - now it's just the transport
1344
# for the branch control files. mbp 20070212
1345
self._base = self.bzrdir.transport.clone('..').base
1346
self._format = _format
1347
if _control_files is None:
1348
raise ValueError('BzrBranch _control_files is None')
1349
self.control_files = _control_files
1350
self._transport = _control_files._transport
1351
self.repository = _repository
1354
return '%s(%r)' % (self.__class__.__name__, self.base)
1358
def _get_base(self):
1359
"""Returns the directory containing the control directory."""
1362
base = property(_get_base, doc="The URL for the root of this branch.")
1364
def abspath(self, name):
1365
"""See Branch.abspath."""
1366
return self.control_files._transport.abspath(name)
1369
@deprecated_method(zero_sixteen)
1371
def get_root_id(self):
1372
"""See Branch.get_root_id."""
1373
tree = self.repository.revision_tree(self.last_revision())
1374
return tree.get_root_id()
1376
def is_locked(self):
1377
return self.control_files.is_locked()
1379
def lock_write(self, token=None):
1380
repo_token = self.repository.lock_write()
1382
token = self.control_files.lock_write(token=token)
1384
self.repository.unlock()
1388
def lock_read(self):
1389
self.repository.lock_read()
1391
self.control_files.lock_read()
1393
self.repository.unlock()
1397
# TODO: test for failed two phase locks. This is known broken.
1399
self.control_files.unlock()
1401
self.repository.unlock()
1402
if not self.control_files.is_locked():
1403
# we just released the lock
1404
self._clear_cached_state()
1406
def peek_lock_mode(self):
1407
if self.control_files._lock_count == 0:
1410
return self.control_files._lock_mode
1412
def get_physical_lock_status(self):
1413
return self.control_files.get_physical_lock_status()
1416
def print_file(self, file, revision_id):
1417
"""See Branch.print_file."""
1418
return self.repository.print_file(file, revision_id)
1420
def _write_revision_history(self, history):
1421
"""Factored out of set_revision_history.
1423
This performs the actual writing to disk.
1424
It is intended to be called by BzrBranch5.set_revision_history."""
1425
self.control_files.put_bytes(
1426
'revision-history', '\n'.join(history))
1429
def set_revision_history(self, rev_history):
1430
"""See Branch.set_revision_history."""
1431
if 'evil' in debug.debug_flags:
1432
mutter_callsite(3, "set_revision_history scales with history.")
1433
self._write_revision_history(rev_history)
1434
self._clear_cached_state()
1435
self._cache_revision_history(rev_history)
1436
for hook in Branch.hooks['set_rh']:
1437
hook(self, rev_history)
1439
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1440
"""Run the post_change_branch_tip hooks."""
1441
hooks = Branch.hooks['post_change_branch_tip']
1444
new_revno, new_revid = self.last_revision_info()
1445
params = ChangeBranchTipParams(
1446
self, old_revno, new_revno, old_revid, new_revid)
1451
def set_last_revision_info(self, revno, revision_id):
1452
"""Set the last revision of this branch.
1454
The caller is responsible for checking that the revno is correct
1455
for this revision id.
1457
It may be possible to set the branch last revision to an id not
1458
present in the repository. However, branches can also be
1459
configured to check constraints on history, in which case this may not
1462
revision_id = _mod_revision.ensure_null(revision_id)
1463
old_revno, old_revid = self.last_revision_info()
1464
history = self._lefthand_history(revision_id)
1465
assert len(history) == revno, '%d != %d' % (len(history), revno)
1466
self.set_revision_history(history)
1467
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1469
def _gen_revision_history(self):
1470
history = self.control_files.get('revision-history').read().split('\n')
1471
if history[-1:] == ['']:
1472
# There shouldn't be a trailing newline, but just in case.
1476
def _lefthand_history(self, revision_id, last_rev=None,
1478
if 'evil' in debug.debug_flags:
1479
mutter_callsite(4, "_lefthand_history scales with history.")
1480
# stop_revision must be a descendant of last_revision
1481
graph = self.repository.get_graph()
1482
if last_rev is not None:
1483
if not graph.is_ancestor(last_rev, revision_id):
1484
# our previous tip is not merged into stop_revision
1485
raise errors.DivergedBranches(self, other_branch)
1486
# make a new revision history from the graph
1487
parents_map = graph.get_parent_map([revision_id])
1488
if revision_id not in parents_map:
1489
raise errors.NoSuchRevision(self, revision_id)
1490
current_rev_id = revision_id
1492
# Do not include ghosts or graph origin in revision_history
1493
while (current_rev_id in parents_map and
1494
len(parents_map[current_rev_id]) > 0):
1495
new_history.append(current_rev_id)
1496
current_rev_id = parents_map[current_rev_id][0]
1497
parents_map = graph.get_parent_map([current_rev_id])
1498
new_history.reverse()
1502
def generate_revision_history(self, revision_id, last_rev=None,
1504
"""Create a new revision history that will finish with revision_id.
1506
:param revision_id: the new tip to use.
1507
:param last_rev: The previous last_revision. If not None, then this
1508
must be a ancestory of revision_id, or DivergedBranches is raised.
1509
:param other_branch: The other branch that DivergedBranches should
1510
raise with respect to.
1512
self.set_revision_history(self._lefthand_history(revision_id,
1513
last_rev, other_branch))
1516
def update_revisions(self, other, stop_revision=None, overwrite=False):
1517
"""See Branch.update_revisions."""
1520
other_last_revno, other_last_revision = other.last_revision_info()
1521
if stop_revision is None:
1522
stop_revision = other_last_revision
1523
if _mod_revision.is_null(stop_revision):
1524
# if there are no commits, we're done.
1526
# whats the current last revision, before we fetch [and change it
1528
last_rev = _mod_revision.ensure_null(self.last_revision())
1529
# we fetch here so that we don't process data twice in the common
1530
# case of having something to pull, and so that the check for
1531
# already merged can operate on the just fetched graph, which will
1532
# be cached in memory.
1533
self.fetch(other, stop_revision)
1534
# Check to see if one is an ancestor of the other
1536
heads = self.repository.get_graph().heads([stop_revision,
1538
if heads == set([last_rev]):
1539
# The current revision is a decendent of the target,
1542
elif heads == set([stop_revision, last_rev]):
1543
# These branches have diverged
1544
raise errors.DivergedBranches(self, other)
1545
assert heads == set([stop_revision])
1546
if other_last_revision == stop_revision:
1547
self.set_last_revision_info(other_last_revno,
1548
other_last_revision)
1550
# TODO: jam 2007-11-29 Is there a way to determine the
1551
# revno without searching all of history??
1553
self.generate_revision_history(stop_revision)
1555
self.generate_revision_history(stop_revision,
1556
last_rev=last_rev, other_branch=other)
1560
def basis_tree(self):
1561
"""See Branch.basis_tree."""
1562
return self.repository.revision_tree(self.last_revision())
1565
def pull(self, source, overwrite=False, stop_revision=None,
1566
_hook_master=None, run_hooks=True, possible_transports=None):
1569
:param _hook_master: Private parameter - set the branch to
1570
be supplied as the master to push hooks.
1571
:param run_hooks: Private parameter - if false, this branch
1572
is being called because it's the master of the primary branch,
1573
so it should not run its hooks.
1575
result = PullResult()
1576
result.source_branch = source
1577
result.target_branch = self
1580
result.old_revno, result.old_revid = self.last_revision_info()
1581
self.update_revisions(source, stop_revision, overwrite=overwrite)
1582
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
1583
result.new_revno, result.new_revid = self.last_revision_info()
1585
result.master_branch = _hook_master
1586
result.local_branch = self
1588
result.master_branch = self
1589
result.local_branch = None
1591
for hook in Branch.hooks['post_pull']:
1597
def _get_parent_location(self):
1598
_locs = ['parent', 'pull', 'x-pull']
1601
return self.control_files.get(l).read().strip('\n')
1602
except errors.NoSuchFile:
1607
def push(self, target, overwrite=False, stop_revision=None,
1608
_override_hook_source_branch=None):
1611
This is the basic concrete implementation of push()
1613
:param _override_hook_source_branch: If specified, run
1614
the hooks passing this Branch as the source, rather than self.
1615
This is for use of RemoteBranch, where push is delegated to the
1616
underlying vfs-based Branch.
1618
# TODO: Public option to disable running hooks - should be trivial but
1622
result = self._push_with_bound_branches(target, overwrite,
1624
_override_hook_source_branch=_override_hook_source_branch)
1629
def _push_with_bound_branches(self, target, overwrite,
1631
_override_hook_source_branch=None):
1632
"""Push from self into target, and into target's master if any.
1634
This is on the base BzrBranch class even though it doesn't support
1635
bound branches because the *target* might be bound.
1638
if _override_hook_source_branch:
1639
result.source_branch = _override_hook_source_branch
1640
for hook in Branch.hooks['post_push']:
1643
bound_location = target.get_bound_location()
1644
if bound_location and target.base != bound_location:
1645
# there is a master branch.
1647
# XXX: Why the second check? Is it even supported for a branch to
1648
# be bound to itself? -- mbp 20070507
1649
master_branch = target.get_master_branch()
1650
master_branch.lock_write()
1652
# push into the master from this branch.
1653
self._basic_push(master_branch, overwrite, stop_revision)
1654
# and push into the target branch from this. Note that we push from
1655
# this branch again, because its considered the highest bandwidth
1657
result = self._basic_push(target, overwrite, stop_revision)
1658
result.master_branch = master_branch
1659
result.local_branch = target
1663
master_branch.unlock()
1666
result = self._basic_push(target, overwrite, stop_revision)
1667
# TODO: Why set master_branch and local_branch if there's no
1668
# binding? Maybe cleaner to just leave them unset? -- mbp
1670
result.master_branch = target
1671
result.local_branch = None
1675
def _basic_push(self, target, overwrite, stop_revision):
1676
"""Basic implementation of push without bound branches or hooks.
1678
Must be called with self read locked and target write locked.
1680
result = PushResult()
1681
result.source_branch = self
1682
result.target_branch = target
1683
result.old_revno, result.old_revid = target.last_revision_info()
1685
target.update_revisions(self, stop_revision)
1686
except errors.DivergedBranches:
1690
target.set_revision_history(self.revision_history())
1691
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
1692
result.new_revno, result.new_revid = target.last_revision_info()
1695
def get_parent(self):
1696
"""See Branch.get_parent."""
1698
assert self.base[-1] == '/'
1699
parent = self._get_parent_location()
1702
# This is an old-format absolute path to a local branch
1703
# turn it into a url
1704
if parent.startswith('/'):
1705
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1707
return urlutils.join(self.base[:-1], parent)
1708
except errors.InvalidURLJoin, e:
1709
raise errors.InaccessibleParent(parent, self.base)
1711
def set_push_location(self, location):
1712
"""See Branch.set_push_location."""
1713
self.get_config().set_user_option(
1714
'push_location', location,
1715
store=_mod_config.STORE_LOCATION_NORECURSE)
1718
def set_parent(self, url):
1719
"""See Branch.set_parent."""
1720
# TODO: Maybe delete old location files?
1721
# URLs should never be unicode, even on the local fs,
1722
# FIXUP this and get_parent in a future branch format bump:
1723
# read and rewrite the file. RBC 20060125
1725
if isinstance(url, unicode):
1727
url = url.encode('ascii')
1728
except UnicodeEncodeError:
1729
raise errors.InvalidURL(url,
1730
"Urls must be 7-bit ascii, "
1731
"use bzrlib.urlutils.escape")
1732
url = urlutils.relative_url(self.base, url)
1733
self._set_parent_location(url)
1735
def _set_parent_location(self, url):
1737
self.control_files._transport.delete('parent')
1739
assert isinstance(url, str)
1740
self.control_files.put_bytes('parent', url + '\n')
1743
class BzrBranch5(BzrBranch):
1744
"""A format 5 branch. This supports new features over plain branches.
1746
It has support for a master_branch which is the data for bound branches.
1754
super(BzrBranch5, self).__init__(_format=_format,
1755
_control_files=_control_files,
1757
_repository=_repository)
1760
def pull(self, source, overwrite=False, stop_revision=None,
1761
run_hooks=True, possible_transports=None):
1762
"""Pull from source into self, updating my master if any.
1764
:param run_hooks: Private parameter - if false, this branch
1765
is being called because it's the master of the primary branch,
1766
so it should not run its hooks.
1768
bound_location = self.get_bound_location()
1769
master_branch = None
1770
if bound_location and source.base != bound_location:
1771
# not pulling from master, so we need to update master.
1772
master_branch = self.get_master_branch(possible_transports)
1773
master_branch.lock_write()
1776
# pull from source into master.
1777
master_branch.pull(source, overwrite, stop_revision,
1779
return super(BzrBranch5, self).pull(source, overwrite,
1780
stop_revision, _hook_master=master_branch,
1781
run_hooks=run_hooks)
1784
master_branch.unlock()
1786
def get_bound_location(self):
1788
return self._transport.get_bytes('bound')[:-1]
1789
except errors.NoSuchFile:
1793
def get_master_branch(self, possible_transports=None):
1794
"""Return the branch we are bound to.
1796
:return: Either a Branch, or None
1798
This could memoise the branch, but if thats done
1799
it must be revalidated on each new lock.
1800
So for now we just don't memoise it.
1801
# RBC 20060304 review this decision.
1803
bound_loc = self.get_bound_location()
1807
return Branch.open(bound_loc,
1808
possible_transports=possible_transports)
1809
except (errors.NotBranchError, errors.ConnectionError), e:
1810
raise errors.BoundBranchConnectionFailure(
1814
def set_bound_location(self, location):
1815
"""Set the target where this branch is bound to.
1817
:param location: URL to the target branch
1820
self.control_files.put_utf8('bound', location+'\n')
1823
self.control_files._transport.delete('bound')
1824
except errors.NoSuchFile:
1829
def bind(self, other):
1830
"""Bind this branch to the branch other.
1832
This does not push or pull data between the branches, though it does
1833
check for divergence to raise an error when the branches are not
1834
either the same, or one a prefix of the other. That behaviour may not
1835
be useful, so that check may be removed in future.
1837
:param other: The branch to bind to
1840
# TODO: jam 20051230 Consider checking if the target is bound
1841
# It is debatable whether you should be able to bind to
1842
# a branch which is itself bound.
1843
# Committing is obviously forbidden,
1844
# but binding itself may not be.
1845
# Since we *have* to check at commit time, we don't
1846
# *need* to check here
1848
# we want to raise diverged if:
1849
# last_rev is not in the other_last_rev history, AND
1850
# other_last_rev is not in our history, and do it without pulling
1852
self.set_bound_location(other.base)
1856
"""If bound, unbind"""
1857
return self.set_bound_location(None)
1860
def update(self, possible_transports=None):
1861
"""Synchronise this branch with the master branch if any.
1863
:return: None or the last_revision that was pivoted out during the
1866
master = self.get_master_branch(possible_transports)
1867
if master is not None:
1868
old_tip = _mod_revision.ensure_null(self.last_revision())
1869
self.pull(master, overwrite=True)
1870
if self.repository.get_graph().is_ancestor(old_tip,
1871
_mod_revision.ensure_null(self.last_revision())):
1877
class BzrBranch6(BzrBranch5):
1879
def __init__(self, *args, **kwargs):
1880
super(BzrBranch6, self).__init__(*args, **kwargs)
1881
self._last_revision_info_cache = None
1882
self._partial_revision_history_cache = []
1884
def _clear_cached_state(self):
1885
super(BzrBranch6, self)._clear_cached_state()
1886
self._last_revision_info_cache = None
1887
self._partial_revision_history_cache = []
1890
def last_revision_info(self):
1891
"""Return information about the last revision.
1893
:return: A tuple (revno, revision_id).
1895
if self._last_revision_info_cache is None:
1896
self._last_revision_info_cache = self._last_revision_info()
1897
return self._last_revision_info_cache
1899
def _last_revision_info(self):
1900
revision_string = self.control_files.get('last-revision').read()
1901
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1902
revision_id = cache_utf8.get_cached_utf8(revision_id)
1904
return revno, revision_id
1906
def _write_last_revision_info(self, revno, revision_id):
1907
"""Simply write out the revision id, with no checks.
1909
Use set_last_revision_info to perform this safely.
1911
Does not update the revision_history cache.
1912
Intended to be called by set_last_revision_info and
1913
_write_revision_history.
1915
assert revision_id is not None, "Use NULL_REVISION, not None"
1916
out_string = '%d %s\n' % (revno, revision_id)
1917
self.control_files.put_bytes('last-revision', out_string)
1920
def set_last_revision_info(self, revno, revision_id):
1921
revision_id = _mod_revision.ensure_null(revision_id)
1922
old_revno, old_revid = self.last_revision_info()
1923
if self._get_append_revisions_only():
1924
self._check_history_violation(revision_id)
1925
self._write_last_revision_info(revno, revision_id)
1926
self._clear_cached_state()
1927
self._last_revision_info_cache = revno, revision_id
1928
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1930
def _check_history_violation(self, revision_id):
1931
last_revision = _mod_revision.ensure_null(self.last_revision())
1932
if _mod_revision.is_null(last_revision):
1934
if last_revision not in self._lefthand_history(revision_id):
1935
raise errors.AppendRevisionsOnlyViolation(self.base)
1937
def _gen_revision_history(self):
1938
"""Generate the revision history from last revision
1940
self._extend_partial_history()
1941
return list(reversed(self._partial_revision_history_cache))
1943
def _extend_partial_history(self, stop_index=None, stop_revision=None):
1944
"""Extend the partial history to include a given index
1946
If a stop_index is supplied, stop when that index has been reached.
1947
If a stop_revision is supplied, stop when that revision is
1948
encountered. Otherwise, stop when the beginning of history is
1951
:param stop_index: The index which should be present. When it is
1952
present, history extension will stop.
1953
:param revision_id: The revision id which should be present. When
1954
it is encountered, history extension will stop.
1956
repo = self.repository
1957
if len(self._partial_revision_history_cache) == 0:
1958
iterator = repo.iter_reverse_revision_history(self.last_revision())
1960
start_revision = self._partial_revision_history_cache[-1]
1961
iterator = repo.iter_reverse_revision_history(start_revision)
1962
#skip the last revision in the list
1963
next_revision = iterator.next()
1964
assert next_revision == start_revision
1965
for revision_id in iterator:
1966
self._partial_revision_history_cache.append(revision_id)
1967
if (stop_index is not None and
1968
len(self._partial_revision_history_cache) > stop_index):
1970
if revision_id == stop_revision:
1973
def _write_revision_history(self, history):
1974
"""Factored out of set_revision_history.
1976
This performs the actual writing to disk, with format-specific checks.
1977
It is intended to be called by BzrBranch5.set_revision_history.
1979
if len(history) == 0:
1980
last_revision = 'null:'
1982
if history != self._lefthand_history(history[-1]):
1983
raise errors.NotLefthandHistory(history)
1984
last_revision = history[-1]
1985
if self._get_append_revisions_only():
1986
self._check_history_violation(last_revision)
1987
self._write_last_revision_info(len(history), last_revision)
1990
def _set_parent_location(self, url):
1991
"""Set the parent branch"""
1992
self._set_config_location('parent_location', url, make_relative=True)
1995
def _get_parent_location(self):
1996
"""Set the parent branch"""
1997
return self._get_config_location('parent_location')
1999
def set_push_location(self, location):
2000
"""See Branch.set_push_location."""
2001
self._set_config_location('push_location', location)
2003
def set_bound_location(self, location):
2004
"""See Branch.set_push_location."""
2006
config = self.get_config()
2007
if location is None:
2008
if config.get_user_option('bound') != 'True':
2011
config.set_user_option('bound', 'False', warn_masked=True)
2014
self._set_config_location('bound_location', location,
2016
config.set_user_option('bound', 'True', warn_masked=True)
2019
def _get_bound_location(self, bound):
2020
"""Return the bound location in the config file.
2022
Return None if the bound parameter does not match"""
2023
config = self.get_config()
2024
config_bound = (config.get_user_option('bound') == 'True')
2025
if config_bound != bound:
2027
return self._get_config_location('bound_location', config=config)
2029
def get_bound_location(self):
2030
"""See Branch.set_push_location."""
2031
return self._get_bound_location(True)
2033
def get_old_bound_location(self):
2034
"""See Branch.get_old_bound_location"""
2035
return self._get_bound_location(False)
2037
def set_append_revisions_only(self, enabled):
2042
self.get_config().set_user_option('append_revisions_only', value,
2045
def _get_append_revisions_only(self):
2046
value = self.get_config().get_user_option('append_revisions_only')
2047
return value == 'True'
2049
def _synchronize_history(self, destination, revision_id):
2050
"""Synchronize last revision and revision history between branches.
2052
This version is most efficient when the destination is also a
2053
BzrBranch6, but works for BzrBranch5, as long as the destination's
2054
repository contains all the lefthand ancestors of the intended
2055
last_revision. If not, set_last_revision_info will fail.
2057
:param destination: The branch to copy the history into
2058
:param revision_id: The revision-id to truncate history at. May
2059
be None to copy complete history.
2061
source_revno, source_revision_id = self.last_revision_info()
2062
if revision_id is None:
2063
revno, revision_id = source_revno, source_revision_id
2064
elif source_revision_id == revision_id:
2065
# we know the revno without needing to walk all of history
2066
revno = source_revno
2068
# To figure out the revno for a random revision, we need to build
2069
# the revision history, and count its length.
2070
# We don't care about the order, just how long it is.
2071
# Alternatively, we could start at the current location, and count
2072
# backwards. But there is no guarantee that we will find it since
2073
# it may be a merged revision.
2074
revno = len(list(self.repository.iter_reverse_revision_history(
2076
destination.set_last_revision_info(revno, revision_id)
2078
def _make_tags(self):
2079
return BasicTags(self)
2082
def generate_revision_history(self, revision_id, last_rev=None,
2084
"""See BzrBranch5.generate_revision_history"""
2085
history = self._lefthand_history(revision_id, last_rev, other_branch)
2086
revno = len(history)
2087
self.set_last_revision_info(revno, revision_id)
2090
def get_rev_id(self, revno, history=None):
2091
"""Find the revision id of the specified revno."""
2093
return _mod_revision.NULL_REVISION
2095
last_revno, last_revision_id = self.last_revision_info()
2096
if revno <= 0 or revno > last_revno:
2097
raise errors.NoSuchRevision(self, revno)
2099
if history is not None:
2100
assert len(history) == last_revno, 'revno/history mismatch'
2101
return history[revno - 1]
2103
index = last_revno - revno
2104
if len(self._partial_revision_history_cache) <= index:
2105
self._extend_partial_history(stop_index=index)
2106
if len(self._partial_revision_history_cache) > index:
2107
return self._partial_revision_history_cache[index]
2109
raise errors.NoSuchRevision(self, revno)
2112
def revision_id_to_revno(self, revision_id):
2113
"""Given a revision id, return its revno"""
2114
if _mod_revision.is_null(revision_id):
2117
index = self._partial_revision_history_cache.index(revision_id)
2119
self._extend_partial_history(stop_revision=revision_id)
2120
index = len(self._partial_revision_history_cache) - 1
2121
if self._partial_revision_history_cache[index] != revision_id:
2122
raise errors.NoSuchRevision(self, revision_id)
2123
return self.revno() - index
2126
######################################################################
2127
# results of operations
2130
class _Result(object):
2132
def _show_tag_conficts(self, to_file):
2133
if not getattr(self, 'tag_conflicts', None):
2135
to_file.write('Conflicting tags:\n')
2136
for name, value1, value2 in self.tag_conflicts:
2137
to_file.write(' %s\n' % (name, ))
2140
class PullResult(_Result):
2141
"""Result of a Branch.pull operation.
2143
:ivar old_revno: Revision number before pull.
2144
:ivar new_revno: Revision number after pull.
2145
:ivar old_revid: Tip revision id before pull.
2146
:ivar new_revid: Tip revision id after pull.
2147
:ivar source_branch: Source (local) branch object.
2148
:ivar master_branch: Master branch of the target, or None.
2149
:ivar target_branch: Target/destination branch object.
2153
# DEPRECATED: pull used to return the change in revno
2154
return self.new_revno - self.old_revno
2156
def report(self, to_file):
2158
if self.old_revid == self.new_revid:
2159
to_file.write('No revisions to pull.\n')
2161
to_file.write('Now on revision %d.\n' % self.new_revno)
2162
self._show_tag_conficts(to_file)
2165
class PushResult(_Result):
2166
"""Result of a Branch.push operation.
2168
:ivar old_revno: Revision number before push.
2169
:ivar new_revno: Revision number after push.
2170
:ivar old_revid: Tip revision id before push.
2171
:ivar new_revid: Tip revision id after push.
2172
:ivar source_branch: Source branch object.
2173
:ivar master_branch: Master branch of the target, or None.
2174
:ivar target_branch: Target/destination branch object.
2178
# DEPRECATED: push used to return the change in revno
2179
return self.new_revno - self.old_revno
2181
def report(self, to_file):
2182
"""Write a human-readable description of the result."""
2183
if self.old_revid == self.new_revid:
2184
to_file.write('No new revisions to push.\n')
2186
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2187
self._show_tag_conficts(to_file)
2190
class BranchCheckResult(object):
2191
"""Results of checking branch consistency.
2196
def __init__(self, branch):
2197
self.branch = branch
2199
def report_results(self, verbose):
2200
"""Report the check results via trace.note.
2202
:param verbose: Requests more detailed display of what was checked,
2205
note('checked branch %s format %s',
2207
self.branch._format)
2210
class Converter5to6(object):
2211
"""Perform an in-place upgrade of format 5 to format 6"""
2213
def convert(self, branch):
2214
# Data for 5 and 6 can peacefully coexist.
2215
format = BzrBranchFormat6()
2216
new_branch = format.open(branch.bzrdir, _found=True)
2218
# Copy source data into target
2219
new_branch._write_last_revision_info(*branch.last_revision_info())
2220
new_branch.set_parent(branch.get_parent())
2221
new_branch.set_bound_location(branch.get_bound_location())
2222
new_branch.set_push_location(branch.get_push_location())
2224
# New branch has no tags by default
2225
new_branch.tags._set_tag_dict({})
2227
# Copying done; now update target format
2228
new_branch.control_files.put_utf8('format',
2229
format.get_format_string())
2231
# Clean up old files
2232
new_branch.control_files._transport.delete('revision-history')
2234
branch.set_parent(None)
2235
except errors.NoSuchFile:
2237
branch.set_bound_location(None)
added
removed
bzrlib/branch.py
