1
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
from bzrlib.lazy_import import lazy_import
19
lazy_import(globals(), """
23
config as _mod_config,
29
revision as _mod_revision,
35
from bzrlib.config import BranchConfig
36
from bzrlib.tag import (
42
from bzrlib.decorators import needs_read_lock, needs_write_lock
43
from bzrlib.hooks import Hooks
44
from bzrlib.symbol_versioning import (
48
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
51
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
52
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
53
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
56
# TODO: Maybe include checks for common corruption of newlines, etc?
58
# TODO: Some operations like log might retrieve the same revisions
59
# repeatedly to calculate deltas. We could perhaps have a weakref
60
# cache in memory to make this faster. In general anything can be
61
# cached in memory between lock and unlock operations. .. nb thats
62
# what the transaction identity map provides
65
######################################################################
69
"""Branch holding a history of revisions.
72
Base directory/url of the branch.
74
hooks: An instance of BranchHooks.
76
# this is really an instance variable - FIXME move it there
80
# override this to set the strategy for storing tags
82
return DisabledTags(self)
84
def __init__(self, *ignored, **ignored_too):
85
self.tags = self._make_tags()
86
self._revision_history_cache = None
87
self._revision_id_to_revno_cache = None
90
"""Break a lock if one is present from another instance.
92
Uses the ui factory to ask for confirmation if the lock may be from
95
This will probe the repository for its lock as well.
97
self.control_files.break_lock()
98
self.repository.break_lock()
99
master = self.get_master_branch()
100
if master is not None:
104
def open(base, _unsupported=False, possible_transports=None):
105
"""Open the branch rooted at base.
107
For instance, if the branch is at URL/.bzr/branch,
108
Branch.open(URL) -> a Branch instance.
110
control = bzrdir.BzrDir.open(base, _unsupported,
111
possible_transports=possible_transports)
112
return control.open_branch(_unsupported)
115
def open_from_transport(transport, _unsupported=False):
116
"""Open the branch rooted at transport"""
117
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
118
return control.open_branch(_unsupported)
121
def open_containing(url, possible_transports=None):
122
"""Open an existing branch which contains url.
124
This probes for a branch at url, and searches upwards from there.
126
Basically we keep looking up until we find the control directory or
127
run into the root. If there isn't one, raises NotBranchError.
128
If there is one and it is either an unrecognised format or an unsupported
129
format, UnknownFormatError or UnsupportedFormatError are raised.
130
If there is one, it is returned, along with the unused portion of url.
132
control, relpath = bzrdir.BzrDir.open_containing(url,
134
return control.open_branch(), relpath
136
def get_config(self):
137
return BranchConfig(self)
140
return self.get_config().get_nickname()
142
def _set_nick(self, nick):
143
self.get_config().set_user_option('nickname', nick, warn_masked=True)
145
nick = property(_get_nick, _set_nick)
148
raise NotImplementedError(self.is_locked)
150
def lock_write(self):
151
raise NotImplementedError(self.lock_write)
154
raise NotImplementedError(self.lock_read)
157
raise NotImplementedError(self.unlock)
159
def peek_lock_mode(self):
160
"""Return lock mode for the Branch: 'r', 'w' or None"""
161
raise NotImplementedError(self.peek_lock_mode)
163
def get_physical_lock_status(self):
164
raise NotImplementedError(self.get_physical_lock_status)
167
def get_revision_id_to_revno_map(self):
168
"""Return the revision_id => dotted revno map.
170
This will be regenerated on demand, but will be cached.
172
:return: A dictionary mapping revision_id => dotted revno.
173
This dictionary should not be modified by the caller.
175
if self._revision_id_to_revno_cache is not None:
176
mapping = self._revision_id_to_revno_cache
178
mapping = self._gen_revno_map()
179
self._cache_revision_id_to_revno(mapping)
180
# TODO: jam 20070417 Since this is being cached, should we be returning
182
# I would rather not, and instead just declare that users should not
183
# modify the return value.
186
def _gen_revno_map(self):
187
"""Create a new mapping from revision ids to dotted revnos.
189
Dotted revnos are generated based on the current tip in the revision
191
This is the worker function for get_revision_id_to_revno_map, which
192
just caches the return value.
194
:return: A dictionary mapping revision_id => dotted revno.
196
last_revision = self.last_revision()
197
revision_graph = repository._old_get_graph(self.repository,
199
merge_sorted_revisions = tsort.merge_sort(
204
revision_id_to_revno = dict((rev_id, revno)
205
for seq_num, rev_id, depth, revno, end_of_merge
206
in merge_sorted_revisions)
207
return revision_id_to_revno
209
def leave_lock_in_place(self):
210
"""Tell this branch object not to release the physical lock when this
213
If lock_write doesn't return a token, then this method is not supported.
215
self.control_files.leave_in_place()
217
def dont_leave_lock_in_place(self):
218
"""Tell this branch object to release the physical lock when this
219
object is unlocked, even if it didn't originally acquire it.
221
If lock_write doesn't return a token, then this method is not supported.
223
self.control_files.dont_leave_in_place()
225
@deprecated_method(deprecated_in((0, 16, 0)))
226
def abspath(self, name):
227
"""Return absolute filename for something in the branch
229
XXX: Robert Collins 20051017 what is this used for? why is it a branch
230
method and not a tree method.
232
raise NotImplementedError(self.abspath)
234
def bind(self, other):
235
"""Bind the local branch the other branch.
237
:param other: The branch to bind to
240
raise errors.UpgradeRequired(self.base)
243
def fetch(self, from_branch, last_revision=None, pb=None):
244
"""Copy revisions from from_branch into this branch.
246
:param from_branch: Where to copy from.
247
:param last_revision: What revision to stop at (None for at the end
249
:param pb: An optional progress bar to use.
251
Returns the copied revision count and the failed revisions in a tuple:
254
if self.base == from_branch.base:
257
nested_pb = ui.ui_factory.nested_progress_bar()
262
from_branch.lock_read()
264
if last_revision is None:
265
pb.update('get source history')
266
last_revision = from_branch.last_revision()
267
last_revision = _mod_revision.ensure_null(last_revision)
268
return self.repository.fetch(from_branch.repository,
269
revision_id=last_revision,
272
if nested_pb is not None:
276
def get_bound_location(self):
277
"""Return the URL of the branch we are bound to.
279
Older format branches cannot bind, please be sure to use a metadir
284
def get_old_bound_location(self):
285
"""Return the URL of the branch we used to be bound to
287
raise errors.UpgradeRequired(self.base)
289
def get_commit_builder(self, parents, config=None, timestamp=None,
290
timezone=None, committer=None, revprops=None,
292
"""Obtain a CommitBuilder for this branch.
294
:param parents: Revision ids of the parents of the new revision.
295
:param config: Optional configuration to use.
296
:param timestamp: Optional timestamp recorded for commit.
297
:param timezone: Optional timezone for timestamp.
298
:param committer: Optional committer to set for commit.
299
:param revprops: Optional dictionary of revision properties.
300
:param revision_id: Optional revision id.
304
config = self.get_config()
306
return self.repository.get_commit_builder(self, parents, config,
307
timestamp, timezone, committer, revprops, revision_id)
309
def get_master_branch(self, possible_transports=None):
310
"""Return the branch we are bound to.
312
:return: Either a Branch, or None
316
def get_revision_delta(self, revno):
317
"""Return the delta for one revision.
319
The delta is relative to its mainline predecessor, or the
320
empty tree for revision 1.
322
rh = self.revision_history()
323
if not (1 <= revno <= len(rh)):
324
raise errors.InvalidRevisionNumber(revno)
325
return self.repository.get_revision_delta(rh[revno-1])
327
def print_file(self, file, revision_id):
328
"""Print `file` to stdout."""
329
raise NotImplementedError(self.print_file)
331
def set_revision_history(self, rev_history):
332
raise NotImplementedError(self.set_revision_history)
334
def _cache_revision_history(self, rev_history):
335
"""Set the cached revision history to rev_history.
337
The revision_history method will use this cache to avoid regenerating
338
the revision history.
340
This API is semi-public; it only for use by subclasses, all other code
341
should consider it to be private.
343
self._revision_history_cache = rev_history
345
def _cache_revision_id_to_revno(self, revision_id_to_revno):
346
"""Set the cached revision_id => revno map to revision_id_to_revno.
348
This API is semi-public; it only for use by subclasses, all other code
349
should consider it to be private.
351
self._revision_id_to_revno_cache = revision_id_to_revno
353
def _clear_cached_state(self):
354
"""Clear any cached data on this branch, e.g. cached revision history.
356
This means the next call to revision_history will need to call
357
_gen_revision_history.
359
This API is semi-public; it only for use by subclasses, all other code
360
should consider it to be private.
362
self._revision_history_cache = None
363
self._revision_id_to_revno_cache = None
365
def _gen_revision_history(self):
366
"""Return sequence of revision hashes on to this branch.
368
Unlike revision_history, this method always regenerates or rereads the
369
revision history, i.e. it does not cache the result, so repeated calls
372
Concrete subclasses should override this instead of revision_history so
373
that subclasses do not need to deal with caching logic.
375
This API is semi-public; it only for use by subclasses, all other code
376
should consider it to be private.
378
raise NotImplementedError(self._gen_revision_history)
381
def revision_history(self):
382
"""Return sequence of revision ids on this branch.
384
This method will cache the revision history for as long as it is safe to
387
if 'evil' in debug.debug_flags:
388
mutter_callsite(3, "revision_history scales with history.")
389
if self._revision_history_cache is not None:
390
history = self._revision_history_cache
392
history = self._gen_revision_history()
393
self._cache_revision_history(history)
397
"""Return current revision number for this branch.
399
That is equivalent to the number of revisions committed to
402
return self.last_revision_info()[0]
405
"""Older format branches cannot bind or unbind."""
406
raise errors.UpgradeRequired(self.base)
408
def set_append_revisions_only(self, enabled):
409
"""Older format branches are never restricted to append-only"""
410
raise errors.UpgradeRequired(self.base)
412
def last_revision(self):
413
"""Return last revision id, or NULL_REVISION."""
414
return self.last_revision_info()[1]
416
def last_revision_info(self):
417
"""Return information about the last revision.
419
:return: A tuple (revno, last_revision_id).
421
rh = self.revision_history()
424
return (revno, rh[-1])
426
return (0, _mod_revision.NULL_REVISION)
428
def missing_revisions(self, other, stop_revision=None):
429
"""Return a list of new revisions that would perfectly fit.
431
If self and other have not diverged, return a list of the revisions
432
present in other, but missing from self.
434
self_history = self.revision_history()
435
self_len = len(self_history)
436
other_history = other.revision_history()
437
other_len = len(other_history)
438
common_index = min(self_len, other_len) -1
439
if common_index >= 0 and \
440
self_history[common_index] != other_history[common_index]:
441
raise errors.DivergedBranches(self, other)
443
if stop_revision is None:
444
stop_revision = other_len
446
if stop_revision > other_len:
447
raise errors.NoSuchRevision(self, stop_revision)
448
return other_history[self_len:stop_revision]
450
def update_revisions(self, other, stop_revision=None, overwrite=False,
452
"""Pull in new perfect-fit revisions.
454
:param other: Another Branch to pull from
455
:param stop_revision: Updated until the given revision
456
:param overwrite: Always set the branch pointer, rather than checking
457
to see if it is a proper descendant.
458
:param graph: A Graph object that can be used to query history
459
information. This can be None.
462
raise NotImplementedError(self.update_revisions)
464
def revision_id_to_revno(self, revision_id):
465
"""Given a revision id, return its revno"""
466
if _mod_revision.is_null(revision_id):
468
history = self.revision_history()
470
return history.index(revision_id) + 1
472
raise errors.NoSuchRevision(self, revision_id)
474
def get_rev_id(self, revno, history=None):
475
"""Find the revision id of the specified revno."""
477
return _mod_revision.NULL_REVISION
479
history = self.revision_history()
480
if revno <= 0 or revno > len(history):
481
raise errors.NoSuchRevision(self, revno)
482
return history[revno - 1]
484
def pull(self, source, overwrite=False, stop_revision=None,
485
possible_transports=None):
486
"""Mirror source into this branch.
488
This branch is considered to be 'local', having low latency.
490
:returns: PullResult instance
492
raise NotImplementedError(self.pull)
494
def push(self, target, overwrite=False, stop_revision=None):
495
"""Mirror this branch into target.
497
This branch is considered to be 'local', having low latency.
499
raise NotImplementedError(self.push)
501
def basis_tree(self):
502
"""Return `Tree` object for last revision."""
503
return self.repository.revision_tree(self.last_revision())
505
def rename_one(self, from_rel, to_rel):
508
This can change the directory or the filename or both.
510
raise NotImplementedError(self.rename_one)
512
def move(self, from_paths, to_name):
515
to_name must exist as a versioned directory.
517
If to_name exists and is a directory, the files are moved into
518
it, keeping their old names. If it is a directory,
520
Note that to_name is only the last component of the new name;
521
this doesn't change the directory.
523
This returns a list of (from_path, to_path) pairs for each
526
raise NotImplementedError(self.move)
528
def get_parent(self):
529
"""Return the parent location of the branch.
531
This is the default location for push/pull/missing. The usual
532
pattern is that the user can override it by specifying a
535
raise NotImplementedError(self.get_parent)
537
def _set_config_location(self, name, url, config=None,
538
make_relative=False):
540
config = self.get_config()
544
url = urlutils.relative_url(self.base, url)
545
config.set_user_option(name, url, warn_masked=True)
547
def _get_config_location(self, name, config=None):
549
config = self.get_config()
550
location = config.get_user_option(name)
555
def get_submit_branch(self):
556
"""Return the submit location of the branch.
558
This is the default location for bundle. The usual
559
pattern is that the user can override it by specifying a
562
return self.get_config().get_user_option('submit_branch')
564
def set_submit_branch(self, location):
565
"""Return the submit location of the branch.
567
This is the default location for bundle. The usual
568
pattern is that the user can override it by specifying a
571
self.get_config().set_user_option('submit_branch', location,
574
def get_public_branch(self):
575
"""Return the public location of the branch.
577
This is is used by merge directives.
579
return self._get_config_location('public_branch')
581
def set_public_branch(self, location):
582
"""Return the submit location of the branch.
584
This is the default location for bundle. The usual
585
pattern is that the user can override it by specifying a
588
self._set_config_location('public_branch', location)
590
def get_push_location(self):
591
"""Return the None or the location to push this branch to."""
592
push_loc = self.get_config().get_user_option('push_location')
595
def set_push_location(self, location):
596
"""Set a new push location for this branch."""
597
raise NotImplementedError(self.set_push_location)
599
def set_parent(self, url):
600
raise NotImplementedError(self.set_parent)
604
"""Synchronise this branch with the master branch if any.
606
:return: None or the last_revision pivoted out during the update.
610
def check_revno(self, revno):
612
Check whether a revno corresponds to any revision.
613
Zero (the NULL revision) is considered valid.
616
self.check_real_revno(revno)
618
def check_real_revno(self, revno):
620
Check whether a revno corresponds to a real revision.
621
Zero (the NULL revision) is considered invalid
623
if revno < 1 or revno > self.revno():
624
raise errors.InvalidRevisionNumber(revno)
627
def clone(self, to_bzrdir, revision_id=None):
628
"""Clone this branch into to_bzrdir preserving all semantic values.
630
revision_id: if not None, the revision history in the new branch will
631
be truncated to end with revision_id.
633
result = self._format.initialize(to_bzrdir)
634
self.copy_content_into(result, revision_id=revision_id)
638
def sprout(self, to_bzrdir, revision_id=None):
639
"""Create a new line of development from the branch, into to_bzrdir.
641
revision_id: if not None, the revision history in the new branch will
642
be truncated to end with revision_id.
644
result = self._format.initialize(to_bzrdir)
645
self.copy_content_into(result, revision_id=revision_id)
646
result.set_parent(self.bzrdir.root_transport.base)
649
def _synchronize_history(self, destination, revision_id):
650
"""Synchronize last revision and revision history between branches.
652
This version is most efficient when the destination is also a
653
BzrBranch5, but works for BzrBranch6 as long as the revision
654
history is the true lefthand parent history, and all of the revisions
655
are in the destination's repository. If not, set_revision_history
658
:param destination: The branch to copy the history into
659
:param revision_id: The revision-id to truncate history at. May
660
be None to copy complete history.
662
if revision_id == _mod_revision.NULL_REVISION:
664
new_history = self.revision_history()
665
if revision_id is not None and new_history != []:
667
new_history = new_history[:new_history.index(revision_id) + 1]
669
rev = self.repository.get_revision(revision_id)
670
new_history = rev.get_history(self.repository)[1:]
671
destination.set_revision_history(new_history)
674
def copy_content_into(self, destination, revision_id=None):
675
"""Copy the content of self into destination.
677
revision_id: if not None, the revision history in the new branch will
678
be truncated to end with revision_id.
680
self._synchronize_history(destination, revision_id)
682
parent = self.get_parent()
683
except errors.InaccessibleParent, e:
684
mutter('parent was not accessible to copy: %s', e)
687
destination.set_parent(parent)
688
self.tags.merge_to(destination.tags)
692
"""Check consistency of the branch.
694
In particular this checks that revisions given in the revision-history
695
do actually match up in the revision graph, and that they're all
696
present in the repository.
698
Callers will typically also want to check the repository.
700
:return: A BranchCheckResult.
702
mainline_parent_id = None
703
last_revno, last_revision_id = self.last_revision_info()
704
real_rev_history = list(self.repository.iter_reverse_revision_history(
706
real_rev_history.reverse()
707
if len(real_rev_history) != last_revno:
708
raise errors.BzrCheckError('revno does not match len(mainline)'
709
' %s != %s' % (last_revno, len(real_rev_history)))
710
# TODO: We should probably also check that real_rev_history actually
711
# matches self.revision_history()
712
for revision_id in real_rev_history:
714
revision = self.repository.get_revision(revision_id)
715
except errors.NoSuchRevision, e:
716
raise errors.BzrCheckError("mainline revision {%s} not in repository"
718
# In general the first entry on the revision history has no parents.
719
# But it's not illegal for it to have parents listed; this can happen
720
# in imports from Arch when the parents weren't reachable.
721
if mainline_parent_id is not None:
722
if mainline_parent_id not in revision.parent_ids:
723
raise errors.BzrCheckError("previous revision {%s} not listed among "
725
% (mainline_parent_id, revision_id))
726
mainline_parent_id = revision_id
727
return BranchCheckResult(self)
729
def _get_checkout_format(self):
730
"""Return the most suitable metadir for a checkout of this branch.
731
Weaves are used if this branch's repository uses weaves.
733
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
734
from bzrlib.repofmt import weaverepo
735
format = bzrdir.BzrDirMetaFormat1()
736
format.repository_format = weaverepo.RepositoryFormat7()
738
format = self.repository.bzrdir.checkout_metadir()
739
format.set_branch_format(self._format)
742
def create_checkout(self, to_location, revision_id=None,
743
lightweight=False, accelerator_tree=None,
745
"""Create a checkout of a branch.
747
:param to_location: The url to produce the checkout at
748
:param revision_id: The revision to check out
749
:param lightweight: If True, produce a lightweight checkout, otherwise,
750
produce a bound branch (heavyweight checkout)
751
:param accelerator_tree: A tree which can be used for retrieving file
752
contents more quickly than the revision tree, i.e. a workingtree.
753
The revision tree will be used for cases where accelerator_tree's
754
content is different.
755
:param hardlink: If true, hard-link files from accelerator_tree,
757
:return: The tree of the created checkout
759
t = transport.get_transport(to_location)
762
format = self._get_checkout_format()
763
checkout = format.initialize_on_transport(t)
764
from_branch = BranchReferenceFormat().initialize(checkout, self)
766
format = self._get_checkout_format()
767
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
768
to_location, force_new_tree=False, format=format)
769
checkout = checkout_branch.bzrdir
770
checkout_branch.bind(self)
771
# pull up to the specified revision_id to set the initial
772
# branch tip correctly, and seed it with history.
773
checkout_branch.pull(self, stop_revision=revision_id)
775
tree = checkout.create_workingtree(revision_id,
776
from_branch=from_branch,
777
accelerator_tree=accelerator_tree,
779
basis_tree = tree.basis_tree()
780
basis_tree.lock_read()
782
for path, file_id in basis_tree.iter_references():
783
reference_parent = self.reference_parent(file_id, path)
784
reference_parent.create_checkout(tree.abspath(path),
785
basis_tree.get_reference_revision(file_id, path),
792
def reconcile(self, thorough=True):
793
"""Make sure the data stored in this branch is consistent."""
794
from bzrlib.reconcile import BranchReconciler
795
reconciler = BranchReconciler(self, thorough=thorough)
796
reconciler.reconcile()
799
def reference_parent(self, file_id, path):
800
"""Return the parent branch for a tree-reference file_id
801
:param file_id: The file_id of the tree reference
802
:param path: The path of the file_id in the tree
803
:return: A branch associated with the file_id
805
# FIXME should provide multiple branches, based on config
806
return Branch.open(self.bzrdir.root_transport.clone(path).base)
808
def supports_tags(self):
809
return self._format.supports_tags()
812
class BranchFormat(object):
813
"""An encapsulation of the initialization and open routines for a format.
815
Formats provide three things:
816
* An initialization routine,
820
Formats are placed in an dict by their format string for reference
821
during branch opening. Its not required that these be instances, they
822
can be classes themselves with class methods - it simply depends on
823
whether state is needed for a given format or not.
825
Once a format is deprecated, just deprecate the initialize and open
826
methods on the format class. Do not deprecate the object, as the
827
object will be created every time regardless.
830
_default_format = None
831
"""The default format used for new branches."""
834
"""The known formats."""
836
def __eq__(self, other):
837
return self.__class__ is other.__class__
839
def __ne__(self, other):
840
return not (self == other)
843
def find_format(klass, a_bzrdir):
844
"""Return the format for the branch object in a_bzrdir."""
846
transport = a_bzrdir.get_branch_transport(None)
847
format_string = transport.get("format").read()
848
return klass._formats[format_string]
849
except errors.NoSuchFile:
850
raise errors.NotBranchError(path=transport.base)
852
raise errors.UnknownFormatError(format=format_string, kind='branch')
855
def get_default_format(klass):
856
"""Return the current default format."""
857
return klass._default_format
859
def get_reference(self, a_bzrdir):
860
"""Get the target reference of the branch in a_bzrdir.
862
format probing must have been completed before calling
863
this method - it is assumed that the format of the branch
864
in a_bzrdir is correct.
866
:param a_bzrdir: The bzrdir to get the branch data from.
867
:return: None if the branch is not a reference branch.
872
def set_reference(self, a_bzrdir, to_branch):
873
"""Set the target reference of the branch in a_bzrdir.
875
format probing must have been completed before calling
876
this method - it is assumed that the format of the branch
877
in a_bzrdir is correct.
879
:param a_bzrdir: The bzrdir to set the branch reference for.
880
:param to_branch: branch that the checkout is to reference
882
raise NotImplementedError(self.set_reference)
884
def get_format_string(self):
885
"""Return the ASCII format string that identifies this format."""
886
raise NotImplementedError(self.get_format_string)
888
def get_format_description(self):
889
"""Return the short format description for this format."""
890
raise NotImplementedError(self.get_format_description)
892
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
894
"""Initialize a branch in a bzrdir, with specified files
896
:param a_bzrdir: The bzrdir to initialize the branch in
897
:param utf8_files: The files to create as a list of
898
(filename, content) tuples
899
:param set_format: If True, set the format with
900
self.get_format_string. (BzrBranch4 has its format set
902
:return: a branch in this format
904
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
905
branch_transport = a_bzrdir.get_branch_transport(self)
907
'metadir': ('lock', lockdir.LockDir),
908
'branch4': ('branch-lock', lockable_files.TransportLock),
910
lock_name, lock_class = lock_map[lock_type]
911
control_files = lockable_files.LockableFiles(branch_transport,
912
lock_name, lock_class)
913
control_files.create_lock()
914
control_files.lock_write()
916
utf8_files += [('format', self.get_format_string())]
918
for (filename, content) in utf8_files:
919
branch_transport.put_bytes(
921
mode=control_files._file_mode)
923
control_files.unlock()
924
return self.open(a_bzrdir, _found=True)
926
def initialize(self, a_bzrdir):
927
"""Create a branch of this format in a_bzrdir."""
928
raise NotImplementedError(self.initialize)
930
def is_supported(self):
931
"""Is this format supported?
933
Supported formats can be initialized and opened.
934
Unsupported formats may not support initialization or committing or
935
some other features depending on the reason for not being supported.
939
def open(self, a_bzrdir, _found=False):
940
"""Return the branch object for a_bzrdir
942
_found is a private parameter, do not use it. It is used to indicate
943
if format probing has already be done.
945
raise NotImplementedError(self.open)
948
def register_format(klass, format):
949
klass._formats[format.get_format_string()] = format
952
def set_default_format(klass, format):
953
klass._default_format = format
956
def unregister_format(klass, format):
957
del klass._formats[format.get_format_string()]
960
return self.get_format_string().rstrip()
962
def supports_tags(self):
963
"""True if this format supports tags stored in the branch"""
964
return False # by default
967
class BranchHooks(Hooks):
968
"""A dictionary mapping hook name to a list of callables for branch hooks.
970
e.g. ['set_rh'] Is the list of items to be called when the
971
set_revision_history function is invoked.
975
"""Create the default hooks.
977
These are all empty initially, because by default nothing should get
981
# Introduced in 0.15:
982
# invoked whenever the revision history has been set
983
# with set_revision_history. The api signature is
984
# (branch, revision_history), and the branch will
987
# invoked after a push operation completes.
988
# the api signature is
990
# containing the members
991
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
992
# where local is the local target branch or None, master is the target
993
# master branch, and the rest should be self explanatory. The source
994
# is read locked and the target branches write locked. Source will
995
# be the local low-latency branch.
996
self['post_push'] = []
997
# invoked after a pull operation completes.
998
# the api signature is
1000
# containing the members
1001
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1002
# where local is the local branch or None, master is the target
1003
# master branch, and the rest should be self explanatory. The source
1004
# is read locked and the target branches write locked. The local
1005
# branch is the low-latency branch.
1006
self['post_pull'] = []
1007
# invoked before a commit operation takes place.
1008
# the api signature is
1009
# (local, master, old_revno, old_revid, future_revno, future_revid,
1010
# tree_delta, future_tree).
1011
# old_revid is NULL_REVISION for the first commit to a branch
1012
# tree_delta is a TreeDelta object describing changes from the basis
1013
# revision, hooks MUST NOT modify this delta
1014
# future_tree is an in-memory tree obtained from
1015
# CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
1016
self['pre_commit'] = []
1017
# invoked after a commit operation completes.
1018
# the api signature is
1019
# (local, master, old_revno, old_revid, new_revno, new_revid)
1020
# old_revid is NULL_REVISION for the first commit to a branch.
1021
self['post_commit'] = []
1022
# invoked after a uncommit operation completes.
1023
# the api signature is
1024
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1025
# local is the local branch or None, master is the target branch,
1026
# and an empty branch recieves new_revno of 0, new_revid of None.
1027
self['post_uncommit'] = []
1029
# Invoked after the tip of a branch changes.
1030
# the api signature is
1031
# (params) where params is a ChangeBranchTipParams with the members
1032
# (branch, old_revno, new_revno, old_revid, new_revid)
1033
self['post_change_branch_tip'] = []
1036
# install the default hooks into the Branch class.
1037
Branch.hooks = BranchHooks()
1040
class ChangeBranchTipParams(object):
1041
"""Object holding parameters passed to *_change_branch_tip hooks.
1043
There are 5 fields that hooks may wish to access:
1045
:ivar branch: the branch being changed
1046
:ivar old_revno: revision number before the change
1047
:ivar new_revno: revision number after the change
1048
:ivar old_revid: revision id before the change
1049
:ivar new_revid: revision id after the change
1051
The revid fields are strings. The revno fields are integers.
1054
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1055
"""Create a group of ChangeBranchTip parameters.
1057
:param branch: The branch being changed.
1058
:param old_revno: Revision number before the change.
1059
:param new_revno: Revision number after the change.
1060
:param old_revid: Tip revision id before the change.
1061
:param new_revid: Tip revision id after the change.
1063
self.branch = branch
1064
self.old_revno = old_revno
1065
self.new_revno = new_revno
1066
self.old_revid = old_revid
1067
self.new_revid = new_revid
1070
class BzrBranchFormat4(BranchFormat):
1071
"""Bzr branch format 4.
1074
- a revision-history file.
1075
- a branch-lock lock file [ to be shared with the bzrdir ]
1078
def get_format_description(self):
1079
"""See BranchFormat.get_format_description()."""
1080
return "Branch format 4"
1082
def initialize(self, a_bzrdir):
1083
"""Create a branch of this format in a_bzrdir."""
1084
utf8_files = [('revision-history', ''),
1085
('branch-name', ''),
1087
return self._initialize_helper(a_bzrdir, utf8_files,
1088
lock_type='branch4', set_format=False)
1091
super(BzrBranchFormat4, self).__init__()
1092
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1094
def open(self, a_bzrdir, _found=False):
1095
"""Return the branch object for a_bzrdir
1097
_found is a private parameter, do not use it. It is used to indicate
1098
if format probing has already be done.
1101
# we are being called directly and must probe.
1102
raise NotImplementedError
1103
return BzrBranch(_format=self,
1104
_control_files=a_bzrdir._control_files,
1106
_repository=a_bzrdir.open_repository())
1109
return "Bazaar-NG branch format 4"
1112
class BzrBranchFormat5(BranchFormat):
1113
"""Bzr branch format 5.
1116
- a revision-history file.
1118
- a lock dir guarding the branch itself
1119
- all of this stored in a branch/ subdirectory
1120
- works with shared repositories.
1122
This format is new in bzr 0.8.
1125
def get_format_string(self):
1126
"""See BranchFormat.get_format_string()."""
1127
return "Bazaar-NG branch format 5\n"
1129
def get_format_description(self):
1130
"""See BranchFormat.get_format_description()."""
1131
return "Branch format 5"
1133
def initialize(self, a_bzrdir):
1134
"""Create a branch of this format in a_bzrdir."""
1135
utf8_files = [('revision-history', ''),
1136
('branch-name', ''),
1138
return self._initialize_helper(a_bzrdir, utf8_files)
1141
super(BzrBranchFormat5, self).__init__()
1142
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1144
def open(self, a_bzrdir, _found=False):
1145
"""Return the branch object for a_bzrdir
1147
_found is a private parameter, do not use it. It is used to indicate
1148
if format probing has already be done.
1151
format = BranchFormat.find_format(a_bzrdir)
1152
if format.__class__ != self.__class__:
1153
raise AssertionError("wrong format %r found for %r" %
1156
transport = a_bzrdir.get_branch_transport(None)
1157
control_files = lockable_files.LockableFiles(transport, 'lock',
1159
return BzrBranch5(_format=self,
1160
_control_files=control_files,
1162
_repository=a_bzrdir.find_repository())
1163
except errors.NoSuchFile:
1164
raise errors.NotBranchError(path=transport.base)
1167
class BzrBranchFormat6(BzrBranchFormat5):
1168
"""Branch format with last-revision and tags.
1170
Unlike previous formats, this has no explicit revision history. Instead,
1171
this just stores the last-revision, and the left-hand history leading
1172
up to there is the history.
1174
This format was introduced in bzr 0.15
1175
and became the default in 0.91.
1178
def get_format_string(self):
1179
"""See BranchFormat.get_format_string()."""
1180
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1182
def get_format_description(self):
1183
"""See BranchFormat.get_format_description()."""
1184
return "Branch format 6"
1186
def initialize(self, a_bzrdir):
1187
"""Create a branch of this format in a_bzrdir."""
1188
utf8_files = [('last-revision', '0 null:\n'),
1189
('branch.conf', ''),
1192
return self._initialize_helper(a_bzrdir, utf8_files)
1194
def open(self, a_bzrdir, _found=False):
1195
"""Return the branch object for a_bzrdir
1197
_found is a private parameter, do not use it. It is used to indicate
1198
if format probing has already be done.
1201
format = BranchFormat.find_format(a_bzrdir)
1202
if format.__class__ != self.__class__:
1203
raise AssertionError("wrong format %r found for %r" %
1205
transport = a_bzrdir.get_branch_transport(None)
1206
control_files = lockable_files.LockableFiles(transport, 'lock',
1208
return BzrBranch6(_format=self,
1209
_control_files=control_files,
1211
_repository=a_bzrdir.find_repository())
1213
def supports_tags(self):
1217
class BranchReferenceFormat(BranchFormat):
1218
"""Bzr branch reference format.
1220
Branch references are used in implementing checkouts, they
1221
act as an alias to the real branch which is at some other url.
1228
def get_format_string(self):
1229
"""See BranchFormat.get_format_string()."""
1230
return "Bazaar-NG Branch Reference Format 1\n"
1232
def get_format_description(self):
1233
"""See BranchFormat.get_format_description()."""
1234
return "Checkout reference format 1"
1236
def get_reference(self, a_bzrdir):
1237
"""See BranchFormat.get_reference()."""
1238
transport = a_bzrdir.get_branch_transport(None)
1239
return transport.get('location').read()
1241
def set_reference(self, a_bzrdir, to_branch):
1242
"""See BranchFormat.set_reference()."""
1243
transport = a_bzrdir.get_branch_transport(None)
1244
location = transport.put_bytes('location', to_branch.base)
1246
def initialize(self, a_bzrdir, target_branch=None):
1247
"""Create a branch of this format in a_bzrdir."""
1248
if target_branch is None:
1249
# this format does not implement branch itself, thus the implicit
1250
# creation contract must see it as uninitializable
1251
raise errors.UninitializableFormat(self)
1252
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1253
branch_transport = a_bzrdir.get_branch_transport(self)
1254
branch_transport.put_bytes('location',
1255
target_branch.bzrdir.root_transport.base)
1256
branch_transport.put_bytes('format', self.get_format_string())
1258
a_bzrdir, _found=True,
1259
possible_transports=[target_branch.bzrdir.root_transport])
1262
super(BranchReferenceFormat, self).__init__()
1263
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1265
def _make_reference_clone_function(format, a_branch):
1266
"""Create a clone() routine for a branch dynamically."""
1267
def clone(to_bzrdir, revision_id=None):
1268
"""See Branch.clone()."""
1269
return format.initialize(to_bzrdir, a_branch)
1270
# cannot obey revision_id limits when cloning a reference ...
1271
# FIXME RBC 20060210 either nuke revision_id for clone, or
1272
# emit some sort of warning/error to the caller ?!
1275
def open(self, a_bzrdir, _found=False, location=None,
1276
possible_transports=None):
1277
"""Return the branch that the branch reference in a_bzrdir points at.
1279
_found is a private parameter, do not use it. It is used to indicate
1280
if format probing has already be done.
1283
format = BranchFormat.find_format(a_bzrdir)
1284
if format.__class__ != self.__class__:
1285
raise AssertionError("wrong format %r found for %r" %
1287
if location is None:
1288
location = self.get_reference(a_bzrdir)
1289
real_bzrdir = bzrdir.BzrDir.open(
1290
location, possible_transports=possible_transports)
1291
result = real_bzrdir.open_branch()
1292
# this changes the behaviour of result.clone to create a new reference
1293
# rather than a copy of the content of the branch.
1294
# I did not use a proxy object because that needs much more extensive
1295
# testing, and we are only changing one behaviour at the moment.
1296
# If we decide to alter more behaviours - i.e. the implicit nickname
1297
# then this should be refactored to introduce a tested proxy branch
1298
# and a subclass of that for use in overriding clone() and ....
1300
result.clone = self._make_reference_clone_function(result)
1304
# formats which have no format string are not discoverable
1305
# and not independently creatable, so are not registered.
1306
__format5 = BzrBranchFormat5()
1307
__format6 = BzrBranchFormat6()
1308
BranchFormat.register_format(__format5)
1309
BranchFormat.register_format(BranchReferenceFormat())
1310
BranchFormat.register_format(__format6)
1311
BranchFormat.set_default_format(__format6)
1312
_legacy_formats = [BzrBranchFormat4(),
1315
class BzrBranch(Branch):
1316
"""A branch stored in the actual filesystem.
1318
Note that it's "local" in the context of the filesystem; it doesn't
1319
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1320
it's writable, and can be accessed via the normal filesystem API.
1322
:ivar _transport: Transport for file operations on this branch's
1323
control files, typically pointing to the .bzr/branch directory.
1324
:ivar repository: Repository for this branch.
1325
:ivar base: The url of the base directory for this branch; the one
1326
containing the .bzr directory.
1329
def __init__(self, _format=None,
1330
_control_files=None, a_bzrdir=None, _repository=None):
1331
"""Create new branch object at a particular location."""
1332
Branch.__init__(self)
1333
if a_bzrdir is None:
1334
raise ValueError('a_bzrdir must be supplied')
1336
self.bzrdir = a_bzrdir
1337
self._base = self.bzrdir.transport.clone('..').base
1338
# XXX: We should be able to just do
1339
# self.base = self.bzrdir.root_transport.base
1340
# but this does not quite work yet -- mbp 20080522
1341
self._format = _format
1342
if _control_files is None:
1343
raise ValueError('BzrBranch _control_files is None')
1344
self.control_files = _control_files
1345
self._transport = _control_files._transport
1346
self.repository = _repository
1349
return '%s(%r)' % (self.__class__.__name__, self.base)
1353
def _get_base(self):
1354
"""Returns the directory containing the control directory."""
1357
base = property(_get_base, doc="The URL for the root of this branch.")
1359
@deprecated_method(deprecated_in((0, 16, 0)))
1360
def abspath(self, name):
1361
"""See Branch.abspath."""
1362
return self._transport.abspath(name)
1364
def is_locked(self):
1365
return self.control_files.is_locked()
1367
def lock_write(self, token=None):
1368
repo_token = self.repository.lock_write()
1370
token = self.control_files.lock_write(token=token)
1372
self.repository.unlock()
1376
def lock_read(self):
1377
self.repository.lock_read()
1379
self.control_files.lock_read()
1381
self.repository.unlock()
1385
# TODO: test for failed two phase locks. This is known broken.
1387
self.control_files.unlock()
1389
self.repository.unlock()
1390
if not self.control_files.is_locked():
1391
# we just released the lock
1392
self._clear_cached_state()
1394
def peek_lock_mode(self):
1395
if self.control_files._lock_count == 0:
1398
return self.control_files._lock_mode
1400
def get_physical_lock_status(self):
1401
return self.control_files.get_physical_lock_status()
1404
def print_file(self, file, revision_id):
1405
"""See Branch.print_file."""
1406
return self.repository.print_file(file, revision_id)
1408
def _write_revision_history(self, history):
1409
"""Factored out of set_revision_history.
1411
This performs the actual writing to disk.
1412
It is intended to be called by BzrBranch5.set_revision_history."""
1413
self._transport.put_bytes(
1414
'revision-history', '\n'.join(history),
1415
mode=self.control_files._file_mode)
1418
def set_revision_history(self, rev_history):
1419
"""See Branch.set_revision_history."""
1420
if 'evil' in debug.debug_flags:
1421
mutter_callsite(3, "set_revision_history scales with history.")
1422
self._write_revision_history(rev_history)
1423
self._clear_cached_state()
1424
self._cache_revision_history(rev_history)
1425
for hook in Branch.hooks['set_rh']:
1426
hook(self, rev_history)
1428
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1429
"""Run the post_change_branch_tip hooks."""
1430
hooks = Branch.hooks['post_change_branch_tip']
1433
new_revno, new_revid = self.last_revision_info()
1434
params = ChangeBranchTipParams(
1435
self, old_revno, new_revno, old_revid, new_revid)
1440
def set_last_revision_info(self, revno, revision_id):
1441
"""Set the last revision of this branch.
1443
The caller is responsible for checking that the revno is correct
1444
for this revision id.
1446
It may be possible to set the branch last revision to an id not
1447
present in the repository. However, branches can also be
1448
configured to check constraints on history, in which case this may not
1451
revision_id = _mod_revision.ensure_null(revision_id)
1452
old_revno, old_revid = self.last_revision_info()
1453
# this old format stores the full history, but this api doesn't
1454
# provide it, so we must generate, and might as well check it's
1456
history = self._lefthand_history(revision_id)
1457
if len(history) != revno:
1458
raise AssertionError('%d != %d' % (len(history), revno))
1459
self.set_revision_history(history)
1460
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1462
def _gen_revision_history(self):
1463
history = self._transport.get_bytes('revision-history').split('\n')
1464
if history[-1:] == ['']:
1465
# There shouldn't be a trailing newline, but just in case.
1469
def _lefthand_history(self, revision_id, last_rev=None,
1471
if 'evil' in debug.debug_flags:
1472
mutter_callsite(4, "_lefthand_history scales with history.")
1473
# stop_revision must be a descendant of last_revision
1474
graph = self.repository.get_graph()
1475
if last_rev is not None:
1476
if not graph.is_ancestor(last_rev, revision_id):
1477
# our previous tip is not merged into stop_revision
1478
raise errors.DivergedBranches(self, other_branch)
1479
# make a new revision history from the graph
1480
parents_map = graph.get_parent_map([revision_id])
1481
if revision_id not in parents_map:
1482
raise errors.NoSuchRevision(self, revision_id)
1483
current_rev_id = revision_id
1485
# Do not include ghosts or graph origin in revision_history
1486
while (current_rev_id in parents_map and
1487
len(parents_map[current_rev_id]) > 0):
1488
new_history.append(current_rev_id)
1489
current_rev_id = parents_map[current_rev_id][0]
1490
parents_map = graph.get_parent_map([current_rev_id])
1491
new_history.reverse()
1495
def generate_revision_history(self, revision_id, last_rev=None,
1497
"""Create a new revision history that will finish with revision_id.
1499
:param revision_id: the new tip to use.
1500
:param last_rev: The previous last_revision. If not None, then this
1501
must be a ancestory of revision_id, or DivergedBranches is raised.
1502
:param other_branch: The other branch that DivergedBranches should
1503
raise with respect to.
1505
self.set_revision_history(self._lefthand_history(revision_id,
1506
last_rev, other_branch))
1509
def update_revisions(self, other, stop_revision=None, overwrite=False,
1511
"""See Branch.update_revisions."""
1514
other_revno, other_last_revision = other.last_revision_info()
1515
stop_revno = None # unknown
1516
if stop_revision is None:
1517
stop_revision = other_last_revision
1518
if _mod_revision.is_null(stop_revision):
1519
# if there are no commits, we're done.
1521
stop_revno = other_revno
1523
# what's the current last revision, before we fetch [and change it
1525
last_rev = _mod_revision.ensure_null(self.last_revision())
1526
# we fetch here so that we don't process data twice in the common
1527
# case of having something to pull, and so that the check for
1528
# already merged can operate on the just fetched graph, which will
1529
# be cached in memory.
1530
self.fetch(other, stop_revision)
1531
# Check to see if one is an ancestor of the other
1534
graph = self.repository.get_graph()
1535
heads = graph.heads([stop_revision, last_rev])
1536
if heads == set([last_rev]):
1537
# The current revision is a decendent of the target,
1540
elif heads == set([stop_revision, last_rev]):
1541
# These branches have diverged
1542
raise errors.DivergedBranches(self, other)
1543
elif heads != set([stop_revision]):
1544
raise AssertionError("invalid heads: %r" % heads)
1545
if stop_revno is None:
1547
graph = self.repository.get_graph()
1548
this_revno, this_last_revision = self.last_revision_info()
1549
stop_revno = graph.find_distance_to_null(stop_revision,
1550
[(other_last_revision, other_revno),
1551
(this_last_revision, this_revno)])
1552
self.set_last_revision_info(stop_revno, stop_revision)
1556
def basis_tree(self):
1557
"""See Branch.basis_tree."""
1558
return self.repository.revision_tree(self.last_revision())
1561
def pull(self, source, overwrite=False, stop_revision=None,
1562
_hook_master=None, run_hooks=True, possible_transports=None):
1565
:param _hook_master: Private parameter - set the branch to
1566
be supplied as the master to push hooks.
1567
:param run_hooks: Private parameter - if false, this branch
1568
is being called because it's the master of the primary branch,
1569
so it should not run its hooks.
1571
result = PullResult()
1572
result.source_branch = source
1573
result.target_branch = self
1576
# We assume that during 'pull' the local repository is closer than
1578
graph = self.repository.get_graph(source.repository)
1579
result.old_revno, result.old_revid = self.last_revision_info()
1580
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._transport.get_bytes(l).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
# We assume that during 'push' this repository is closer than
1687
graph = self.repository.get_graph(target.repository)
1688
target.update_revisions(self, stop_revision, overwrite=overwrite,
1690
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
1691
result.new_revno, result.new_revid = target.last_revision_info()
1694
def get_parent(self):
1695
"""See Branch.get_parent."""
1696
parent = self._get_parent_location()
1699
# This is an old-format absolute path to a local branch
1700
# turn it into a url
1701
if parent.startswith('/'):
1702
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1704
return urlutils.join(self.base[:-1], parent)
1705
except errors.InvalidURLJoin, e:
1706
raise errors.InaccessibleParent(parent, self.base)
1708
def set_push_location(self, location):
1709
"""See Branch.set_push_location."""
1710
self.get_config().set_user_option(
1711
'push_location', location,
1712
store=_mod_config.STORE_LOCATION_NORECURSE)
1715
def set_parent(self, url):
1716
"""See Branch.set_parent."""
1717
# TODO: Maybe delete old location files?
1718
# URLs should never be unicode, even on the local fs,
1719
# FIXUP this and get_parent in a future branch format bump:
1720
# read and rewrite the file. RBC 20060125
1722
if isinstance(url, unicode):
1724
url = url.encode('ascii')
1725
except UnicodeEncodeError:
1726
raise errors.InvalidURL(url,
1727
"Urls must be 7-bit ascii, "
1728
"use bzrlib.urlutils.escape")
1729
url = urlutils.relative_url(self.base, url)
1730
self._set_parent_location(url)
1732
def _set_parent_location(self, url):
1734
self._transport.delete('parent')
1736
self._transport.put_bytes('parent', url + '\n',
1737
mode=self.control_files._file_mode)
1740
class BzrBranch5(BzrBranch):
1741
"""A format 5 branch. This supports new features over plain branches.
1743
It has support for a master_branch which is the data for bound branches.
1751
super(BzrBranch5, self).__init__(_format=_format,
1752
_control_files=_control_files,
1754
_repository=_repository)
1757
def pull(self, source, overwrite=False, stop_revision=None,
1758
run_hooks=True, possible_transports=None):
1759
"""Pull from source into self, updating my master if any.
1761
:param run_hooks: Private parameter - if false, this branch
1762
is being called because it's the master of the primary branch,
1763
so it should not run its hooks.
1765
bound_location = self.get_bound_location()
1766
master_branch = None
1767
if bound_location and source.base != bound_location:
1768
# not pulling from master, so we need to update master.
1769
master_branch = self.get_master_branch(possible_transports)
1770
master_branch.lock_write()
1773
# pull from source into master.
1774
master_branch.pull(source, overwrite, stop_revision,
1776
return super(BzrBranch5, self).pull(source, overwrite,
1777
stop_revision, _hook_master=master_branch,
1778
run_hooks=run_hooks)
1781
master_branch.unlock()
1783
def get_bound_location(self):
1785
return self._transport.get_bytes('bound')[:-1]
1786
except errors.NoSuchFile:
1790
def get_master_branch(self, possible_transports=None):
1791
"""Return the branch we are bound to.
1793
:return: Either a Branch, or None
1795
This could memoise the branch, but if thats done
1796
it must be revalidated on each new lock.
1797
So for now we just don't memoise it.
1798
# RBC 20060304 review this decision.
1800
bound_loc = self.get_bound_location()
1804
return Branch.open(bound_loc,
1805
possible_transports=possible_transports)
1806
except (errors.NotBranchError, errors.ConnectionError), e:
1807
raise errors.BoundBranchConnectionFailure(
1811
def set_bound_location(self, location):
1812
"""Set the target where this branch is bound to.
1814
:param location: URL to the target branch
1817
self._transport.put_bytes('bound', location+'\n',
1818
mode=self.bzrdir._get_file_mode())
1821
self._transport.delete('bound')
1822
except errors.NoSuchFile:
1827
def bind(self, other):
1828
"""Bind this branch to the branch other.
1830
This does not push or pull data between the branches, though it does
1831
check for divergence to raise an error when the branches are not
1832
either the same, or one a prefix of the other. That behaviour may not
1833
be useful, so that check may be removed in future.
1835
:param other: The branch to bind to
1838
# TODO: jam 20051230 Consider checking if the target is bound
1839
# It is debatable whether you should be able to bind to
1840
# a branch which is itself bound.
1841
# Committing is obviously forbidden,
1842
# but binding itself may not be.
1843
# Since we *have* to check at commit time, we don't
1844
# *need* to check here
1846
# we want to raise diverged if:
1847
# last_rev is not in the other_last_rev history, AND
1848
# other_last_rev is not in our history, and do it without pulling
1850
self.set_bound_location(other.base)
1854
"""If bound, unbind"""
1855
return self.set_bound_location(None)
1858
def update(self, possible_transports=None):
1859
"""Synchronise this branch with the master branch if any.
1861
:return: None or the last_revision that was pivoted out during the
1864
master = self.get_master_branch(possible_transports)
1865
if master is not None:
1866
old_tip = _mod_revision.ensure_null(self.last_revision())
1867
self.pull(master, overwrite=True)
1868
if self.repository.get_graph().is_ancestor(old_tip,
1869
_mod_revision.ensure_null(self.last_revision())):
1875
class BzrBranch6(BzrBranch5):
1877
def __init__(self, *args, **kwargs):
1878
super(BzrBranch6, self).__init__(*args, **kwargs)
1879
self._last_revision_info_cache = None
1880
self._partial_revision_history_cache = []
1882
def _clear_cached_state(self):
1883
super(BzrBranch6, self)._clear_cached_state()
1884
self._last_revision_info_cache = None
1885
self._partial_revision_history_cache = []
1888
def last_revision_info(self):
1889
"""Return information about the last revision.
1891
:return: A tuple (revno, revision_id).
1893
if self._last_revision_info_cache is None:
1894
self._last_revision_info_cache = self._last_revision_info()
1895
return self._last_revision_info_cache
1897
def _last_revision_info(self):
1898
revision_string = self._transport.get_bytes('last-revision')
1899
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1900
revision_id = cache_utf8.get_cached_utf8(revision_id)
1902
return revno, revision_id
1904
def _write_last_revision_info(self, revno, revision_id):
1905
"""Simply write out the revision id, with no checks.
1907
Use set_last_revision_info to perform this safely.
1909
Does not update the revision_history cache.
1910
Intended to be called by set_last_revision_info and
1911
_write_revision_history.
1913
revision_id = _mod_revision.ensure_null(revision_id)
1914
out_string = '%d %s\n' % (revno, revision_id)
1915
self._transport.put_bytes('last-revision', out_string,
1916
mode=self.control_files._file_mode)
1919
def set_last_revision_info(self, revno, revision_id):
1920
revision_id = _mod_revision.ensure_null(revision_id)
1921
old_revno, old_revid = self.last_revision_info()
1922
if self._get_append_revisions_only():
1923
self._check_history_violation(revision_id)
1924
self._write_last_revision_info(revno, revision_id)
1925
self._clear_cached_state()
1926
self._last_revision_info_cache = revno, revision_id
1927
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1929
def _check_history_violation(self, revision_id):
1930
last_revision = _mod_revision.ensure_null(self.last_revision())
1931
if _mod_revision.is_null(last_revision):
1933
if last_revision not in self._lefthand_history(revision_id):
1934
raise errors.AppendRevisionsOnlyViolation(self.base)
1936
def _gen_revision_history(self):
1937
"""Generate the revision history from last revision
1939
self._extend_partial_history()
1940
return list(reversed(self._partial_revision_history_cache))
1942
def _extend_partial_history(self, stop_index=None, stop_revision=None):
1943
"""Extend the partial history to include a given index
1945
If a stop_index is supplied, stop when that index has been reached.
1946
If a stop_revision is supplied, stop when that revision is
1947
encountered. Otherwise, stop when the beginning of history is
1950
:param stop_index: The index which should be present. When it is
1951
present, history extension will stop.
1952
:param revision_id: The revision id which should be present. When
1953
it is encountered, history extension will stop.
1955
repo = self.repository
1956
if len(self._partial_revision_history_cache) == 0:
1957
iterator = repo.iter_reverse_revision_history(self.last_revision())
1959
start_revision = self._partial_revision_history_cache[-1]
1960
iterator = repo.iter_reverse_revision_history(start_revision)
1961
#skip the last revision in the list
1962
next_revision = iterator.next()
1963
for revision_id in iterator:
1964
self._partial_revision_history_cache.append(revision_id)
1965
if (stop_index is not None and
1966
len(self._partial_revision_history_cache) > stop_index):
1968
if revision_id == stop_revision:
1971
def _write_revision_history(self, history):
1972
"""Factored out of set_revision_history.
1974
This performs the actual writing to disk, with format-specific checks.
1975
It is intended to be called by BzrBranch5.set_revision_history.
1977
if len(history) == 0:
1978
last_revision = 'null:'
1980
if history != self._lefthand_history(history[-1]):
1981
raise errors.NotLefthandHistory(history)
1982
last_revision = history[-1]
1983
if self._get_append_revisions_only():
1984
self._check_history_violation(last_revision)
1985
self._write_last_revision_info(len(history), last_revision)
1988
def _set_parent_location(self, url):
1989
"""Set the parent branch"""
1990
self._set_config_location('parent_location', url, make_relative=True)
1993
def _get_parent_location(self):
1994
"""Set the parent branch"""
1995
return self._get_config_location('parent_location')
1997
def set_push_location(self, location):
1998
"""See Branch.set_push_location."""
1999
self._set_config_location('push_location', location)
2001
def set_bound_location(self, location):
2002
"""See Branch.set_push_location."""
2004
config = self.get_config()
2005
if location is None:
2006
if config.get_user_option('bound') != 'True':
2009
config.set_user_option('bound', 'False', warn_masked=True)
2012
self._set_config_location('bound_location', location,
2014
config.set_user_option('bound', 'True', warn_masked=True)
2017
def _get_bound_location(self, bound):
2018
"""Return the bound location in the config file.
2020
Return None if the bound parameter does not match"""
2021
config = self.get_config()
2022
config_bound = (config.get_user_option('bound') == 'True')
2023
if config_bound != bound:
2025
return self._get_config_location('bound_location', config=config)
2027
def get_bound_location(self):
2028
"""See Branch.set_push_location."""
2029
return self._get_bound_location(True)
2031
def get_old_bound_location(self):
2032
"""See Branch.get_old_bound_location"""
2033
return self._get_bound_location(False)
2035
def set_append_revisions_only(self, enabled):
2040
self.get_config().set_user_option('append_revisions_only', value,
2043
def _get_append_revisions_only(self):
2044
value = self.get_config().get_user_option('append_revisions_only')
2045
return value == 'True'
2047
def _synchronize_history(self, destination, revision_id):
2048
"""Synchronize last revision and revision history between branches.
2050
This version is most efficient when the destination is also a
2051
BzrBranch6, but works for BzrBranch5, as long as the destination's
2052
repository contains all the lefthand ancestors of the intended
2053
last_revision. If not, set_last_revision_info will fail.
2055
:param destination: The branch to copy the history into
2056
:param revision_id: The revision-id to truncate history at. May
2057
be None to copy complete history.
2059
source_revno, source_revision_id = self.last_revision_info()
2060
if revision_id is None:
2061
revno, revision_id = source_revno, source_revision_id
2062
elif source_revision_id == revision_id:
2063
# we know the revno without needing to walk all of history
2064
revno = source_revno
2066
# To figure out the revno for a random revision, we need to build
2067
# the revision history, and count its length.
2068
# We don't care about the order, just how long it is.
2069
# Alternatively, we could start at the current location, and count
2070
# backwards. But there is no guarantee that we will find it since
2071
# it may be a merged revision.
2072
revno = len(list(self.repository.iter_reverse_revision_history(
2074
destination.set_last_revision_info(revno, revision_id)
2076
def _make_tags(self):
2077
return BasicTags(self)
2080
def generate_revision_history(self, revision_id, last_rev=None,
2082
"""See BzrBranch5.generate_revision_history"""
2083
history = self._lefthand_history(revision_id, last_rev, other_branch)
2084
revno = len(history)
2085
self.set_last_revision_info(revno, revision_id)
2088
def get_rev_id(self, revno, history=None):
2089
"""Find the revision id of the specified revno."""
2091
return _mod_revision.NULL_REVISION
2093
last_revno, last_revision_id = self.last_revision_info()
2094
if revno <= 0 or revno > last_revno:
2095
raise errors.NoSuchRevision(self, revno)
2097
if history is not None:
2098
return history[revno - 1]
2100
index = last_revno - revno
2101
if len(self._partial_revision_history_cache) <= index:
2102
self._extend_partial_history(stop_index=index)
2103
if len(self._partial_revision_history_cache) > index:
2104
return self._partial_revision_history_cache[index]
2106
raise errors.NoSuchRevision(self, revno)
2109
def revision_id_to_revno(self, revision_id):
2110
"""Given a revision id, return its revno"""
2111
if _mod_revision.is_null(revision_id):
2114
index = self._partial_revision_history_cache.index(revision_id)
2116
self._extend_partial_history(stop_revision=revision_id)
2117
index = len(self._partial_revision_history_cache) - 1
2118
if self._partial_revision_history_cache[index] != revision_id:
2119
raise errors.NoSuchRevision(self, revision_id)
2120
return self.revno() - index
2123
######################################################################
2124
# results of operations
2127
class _Result(object):
2129
def _show_tag_conficts(self, to_file):
2130
if not getattr(self, 'tag_conflicts', None):
2132
to_file.write('Conflicting tags:\n')
2133
for name, value1, value2 in self.tag_conflicts:
2134
to_file.write(' %s\n' % (name, ))
2137
class PullResult(_Result):
2138
"""Result of a Branch.pull operation.
2140
:ivar old_revno: Revision number before pull.
2141
:ivar new_revno: Revision number after pull.
2142
:ivar old_revid: Tip revision id before pull.
2143
:ivar new_revid: Tip revision id after pull.
2144
:ivar source_branch: Source (local) branch object.
2145
:ivar master_branch: Master branch of the target, or None.
2146
:ivar target_branch: Target/destination branch object.
2150
# DEPRECATED: pull used to return the change in revno
2151
return self.new_revno - self.old_revno
2153
def report(self, to_file):
2155
if self.old_revid == self.new_revid:
2156
to_file.write('No revisions to pull.\n')
2158
to_file.write('Now on revision %d.\n' % self.new_revno)
2159
self._show_tag_conficts(to_file)
2162
class PushResult(_Result):
2163
"""Result of a Branch.push operation.
2165
:ivar old_revno: Revision number before push.
2166
:ivar new_revno: Revision number after push.
2167
:ivar old_revid: Tip revision id before push.
2168
:ivar new_revid: Tip revision id after push.
2169
:ivar source_branch: Source branch object.
2170
:ivar master_branch: Master branch of the target, or None.
2171
:ivar target_branch: Target/destination branch object.
2175
# DEPRECATED: push used to return the change in revno
2176
return self.new_revno - self.old_revno
2178
def report(self, to_file):
2179
"""Write a human-readable description of the result."""
2180
if self.old_revid == self.new_revid:
2181
to_file.write('No new revisions to push.\n')
2183
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2184
self._show_tag_conficts(to_file)
2187
class BranchCheckResult(object):
2188
"""Results of checking branch consistency.
2193
def __init__(self, branch):
2194
self.branch = branch
2196
def report_results(self, verbose):
2197
"""Report the check results via trace.note.
2199
:param verbose: Requests more detailed display of what was checked,
2202
note('checked branch %s format %s',
2204
self.branch._format)
2207
class Converter5to6(object):
2208
"""Perform an in-place upgrade of format 5 to format 6"""
2210
def convert(self, branch):
2211
# Data for 5 and 6 can peacefully coexist.
2212
format = BzrBranchFormat6()
2213
new_branch = format.open(branch.bzrdir, _found=True)
2215
# Copy source data into target
2216
new_branch._write_last_revision_info(*branch.last_revision_info())
2217
new_branch.set_parent(branch.get_parent())
2218
new_branch.set_bound_location(branch.get_bound_location())
2219
new_branch.set_push_location(branch.get_push_location())
2221
# New branch has no tags by default
2222
new_branch.tags._set_tag_dict({})
2224
# Copying done; now update target format
2225
new_branch._transport.put_bytes('format',
2226
format.get_format_string(),
2227
mode=new_branch.control_files._file_mode)
2229
# Clean up old files
2230
new_branch._transport.delete('revision-history')
2232
branch.set_parent(None)
2233
except errors.NoSuchFile:
2235
branch.set_bound_location(None)
added
removed
bzrlib/branch.py
